crypto-org-chain / chain-docs Goto Github PK

Should use https://github.com/crypto-com/chain-main/releases/tag/v0.7.0-rc1

Solution:

• Update the "Getting started" and "1-Click" contents to v0.8.1-croeseid.

Solution:

• Redirect to the discord channel.

Right now the guide tells user to do pip install .. But a more reliable way is use nix for the reproducible env.

ADDRESS=$(curl --max-time 10 -sSL "${TENDERMINT_URL}/validators?per_page=300" | jq -r --arg PUBKEY "${PUBKEY}" '.result.validators[] | select(.pub_key.value == $PUBKEY) | .address')

See link. It would not cover the case for more than 100 validators as the maximum result per page is 100.

The service could be sit in https://github.com/crypto-com/chain-main, and then we can document it in the chain docs.

In the near future, we should have a script that loads the latest gRPC definitions and generate a new doc reference.

the Stargate compatibility may take some time: iqlusioninc/tmkms#161
so maybe better to omit for now / have some placeholder saying that one can use tmkms once the support is ready?

The issue:
A common error message
Error: RPC error -32603 - Internal error: timed out waiting for tx to be included in a block
sometimes pop up especially for larger txs such as fetching rewards/restaking.

Suggestion:

• Adding --timeout-height flag ( Thanks @leejw51crypto );
• Adding --gas-prices flag for fee adjustment.

Expected outcome:

• Guide for setting up a local devnet, with essential tx transfer and operations,
  silmar to the old Devnet: Running Latest Development Node.

can link the official Cosmos SDK docs

Documentation specifying mint_denom and bond_denom as strings at:https://chain.crypto.com/docs/chain-details/parameters.html

@lezzokafka

However, a Golang string is no more than simply a slice of bytes.

Unicode characters with accents or other modifiers can have multiple correct encodings. Forexample, the Á (a-acute) glyph can be encoded as a single character U+00C1 (the “composed” form) or as two separate characters U+0041 then U+0301 (the “decomposed” form).

Note that Golang version 1.13 and above provides strings.ToValidUTF8 which removes invalid runes but does not perform normalization. There are four standard normalization forms (http://unicode.org/reports/tr15/#Norm_Forms ), one of which NFKC (See question 2 of https://unicode.org/faq/normalization.html) is the most popular and is most suitable for the Chain application.

Option 1:

Utilize the strings.ToValidUTF8 function or the ValidString() function from the Golang utf8 package, to ensure correct character encoding immediately after byte deserialization. Further, perform string normalization to form NFKC on both deserialization and serialization to ensure a consistent string representation. The Golang norm package provides suitable functionality for this purpose.

Option 2:

Another alternative is to ensure strings consist of only ASCII. This would need to be clearly documented.

@crypto-matto 1-click deployment for the latest testnet is now available on the azure market place,
Sample doc:
https://thaler-testnet.crypto.com/docs/getting-started/thaler-testnet-azure-1click.html#azure-account-creation

State sync rapidly bootstraps a new node by discovering, fetching, and restoring a state machine snapshot from peers instead of fetching and replaying historical blocks

state sync option has to be enabled in config.toml. We can experiment and document the feature and see what's the speed improvement of it.

Azure 1-click new image is published
Should update the docs accordingly.

Current testnet tutorial instruct user to change config files manually based on the one generated default, it's difficult for user, especially for state sync configuration, there are many steps for that.
It would be easier if we provide prepared config files for download, even better, user download a tarball which includes genesis file and config files (even binary?) together.

Need to be updated after the changes in chain-main#260.

Add local devnet docs by pystarport

• The swagger file: https://github.com/cosmos/cosmos-sdk/blob/v0.40.x/client/docs/swagger-ui/swagger.yaml

Thus far 3 separate swagger to markdown generators tools have been tried, all of them are generating seemingly good markdown docs, but the issue here is VuePress is being unable to parse the generated markdown and render. So it's still WIP

cosmos/cosmos-sdk#4527

as discussed on Monday catch-up

there are links to the technical whitepaper, consultation paper, releases etc. which are only relevant to Thaler -- so should be moved to some Thaler sub-section instead of the frontpage?

https://chain.crypto.com/docs/getting-started/croeseid-testnet.html#step-2-2-configurate-chain-maind
currently, it can only work on OSX not linux and can only run one time(not idempotent)
Also, should change seeds instead of persistent_peers

Suggestion

$ sed -i.bak -E 's#^(seeds[[:space:]]+=[[:space:]]+).*$#\1"[email protected]:26656,[email protected]:26656,[email protected]:26656"# ; s#^(create_empty_blocks_interval[[:space:]]+=[[:space:]]+).*$#\1"5s"#' ~/.chain-maind/config/config.toml

Remove outdated content from the chain docs such as the old deployment steps and Rust specific modules.

Problem:
... -> Croeseid Testnet -> Testnet Explorer
... -> Croeseid Testnet -> Testnet Faucet
both points to the thaler one,
and Testnet Explorer actually points to https://chain.crypto.com/explorer
Testnet Faucet to https://chain.crypto.com/faucet, the domain is messed up btw staging and production.

can link https://github.com/satoshilabs/slips/blob/master/slip-0044.md and https://github.com/satoshilabs/slips/blob/master/slip-0173.md

AWS 1-click new image is published
Should update the docs accordingly.

Currently the instructions of commands are modularised in different places, yet without an index page.

Suggestion:
Add further details to #Keys managements. While we have been using keyring-backend test for most of the examples.

Useful ref:
https://docs.cosmos.network/master/run-node/keyring.html.

It is provided in the chain-maind cli page but not included in the testnet docs.

the published binaries are for x86_64

it should include how to set up nitro-enclave environment
run tmkms on nitro-enclave

"Security" in design goals is italic

Module sections are all bold and not grouped under "Modules - overview"

• Similar issue with the commit
  crypto-com/thaler-docs@268bb33
  where it would only show 30 validators per page by default.
• The the public key is under the path ~/.chain-maind/config/priv_validator_key.json but
  ~/.chain-maind_testnet/config/priv_validator_key.json

We noticed an error on their documentation about the support instance types. A1, I3, T3, high memory are not supported. I3 is Xen. High memory are all bare metals which aren't supported. Could you help to point this out to them?
https://chain.crypto.com/docs/getting-started/advanced-tmkms-integration.html#setting-up-aws-nitro-enclaves-tendermint-kms-for-signing-blocks
AWS Nitro Enclaves support (to name a few) the M5, C5, R5, T3, I3, A1, P3dn, z1d, and High Memory instances. There are no additional charges on top of the cost of running supported EC2 instance types (with 4 vCPUs and above).
FYI - this is how we phrase it on our user guide (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html)
"Virtualized Nitro-based instances with at least four vCPUs, except t3, t3a, t4g, a1, c6g, c6gd, m6g, m6gd, r6g, and r6gd"

Since running pystarport serve would remove all blocks and regenerate genesis block everytime, it could be confusing for starters who have to redo all the transaction process if they stops pystarport meanwhile. Therefore, we should also include the pystarport start command in setup tutorial.

For example
1 basetcro / 10^8 = 1 cro

The term moniker is confusing from the feedback of community, it should be explained more specifically. https://chain.crypto.com/docs/getting-started/croeseid-testnet.html#step-2-configure-chain-maind