diff --git a/.pending/improvements/gaiarest/4123-Fix-typo-url-er b/.pending/improvements/gaiarest/4123-Fix-typo-url-er new file mode 100644 index 000000000..8f25a8f05 --- /dev/null +++ b/.pending/improvements/gaiarest/4123-Fix-typo-url-er @@ -0,0 +1 @@ +#4123 Fix typo, url error and outdated command description of doc clients. \ No newline at end of file diff --git a/docs/clients/lite/getting_started.md b/docs/clients/lite/getting_started.md index 7f5099402..f20441c6c 100644 --- a/docs/clients/lite/getting_started.md +++ b/docs/clients/lite/getting_started.md @@ -10,7 +10,7 @@ To start a REST server, we need to specify the following parameters: | trust-node | bool | "false" | true | Whether this LCD is connected to a trusted full node | | trust-store | DIRECTORY | "$HOME/.lcd" | false | directory for save checkpoints and validator sets | -For example:: +For example: ```bash gaiacli rest-server --chain-id=test \ diff --git a/docs/clients/lite/specification.md b/docs/clients/lite/specification.md index 032f840a5..1b6d73f6c 100644 --- a/docs/clients/lite/specification.md +++ b/docs/clients/lite/specification.md @@ -62,7 +62,7 @@ type KeyExistsProof struct { } ``` -The data structure of exist proof is shown as above. The process to build and verify existance proof +The data structure of exist proof is shown as above. The process to build and verify existence proof is shown as follows: ![Exist Proof](./pics/existProof.png) diff --git a/docs/clients/service-providers.md b/docs/clients/service-providers.md index b563153f1..b31c2d9be 100644 --- a/docs/clients/service-providers.md +++ b/docs/clients/service-providers.md @@ -18,9 +18,9 @@ There are three main pieces to consider: We will describe the steps to run and interract with a full-node for the Cosmos Hub. For other SDK-based blockchain, the process should be similar. -First, you need to [install the software](../getting-started/installation.md). +First, you need to [install the software](../cosmos-hub/installation.md). -Then, you can start [running a full-node](../getting-started/join-testnet.md). +Then, you can start [running a full-node](../cosmos-hub/join-testnet.md). ### Command-Line interface @@ -34,12 +34,13 @@ To generate a new key (default secp256k1 elliptic curve): gaiacli keys add ``` -You will be asked to create a passwords (at least 8 characters) for this key-pair. The command returns 4 informations: +You will be asked to create a passwords (at least 8 characters) for this key-pair. The command returns 5 informations: - `NAME`: Name of your key +- `TYPE`: Type of your key, always `local`. - `ADDRESS`: Your address. Used to receive funds. - `PUBKEY`: Your public key. Useful for validators. -- `Seed phrase`: 12-words phrase. **Save this seed phrase somewhere safe**. It is used to recover your private key in case you forget the password. +- `MNEMONIC`: 24-words phrase. **Save this mnemonic somewhere safe**. It is used to recover your private key in case you forget the password. You can see all your available keys by typing: @@ -62,14 +63,20 @@ gaiacli account Here is the command to send coins via the CLI: ```bash -gaiacli send --amount=10faucetToken --chain-id= --from= --to= +gaiacli tx send \ + --chain-id= \ + --from= ``` +Parameters: + +- ``: Address of the recipient. +- ``: This parameter accepts the format ``, such as `10faucetToken`. + Flags: -- `--amount`: This flag accepts the format ``. + - `--chain-id`: This flag allows you to specify the id of the chain. There will be different ids for different testnet chains and main chain. - `--from`: Name of the key of the sending account. -- `--to`: Address of the recipient. #### Help @@ -88,12 +95,12 @@ The Rest Server acts as an intermediary between the front-end and the full-node. To start the Rest server: ```bash -gaiacli advanced rest-server --node= +gaiacli rest-server --node= ``` Flags: - `--trust-node`: A boolean. If `true`, light-client verification is disabled. If `false`, it is disabled. For service providers, this should be set to `true`. By default, it set to `true`. -- `--node`: This is where you indicate the address and the port of your full-node. The format is . If the full-node is on the same machine, the address should be `tcp://localhost:26657`. +- `--node`: This is where you indicate the address and the port of your full-node. The format is ``. If the full-node is on the same machine, the address should be `tcp://localhost:26657`. - `--laddr`: This flag allows you to specify the address and port for the Rest Server (default `1317`). You will mostly use this flag only to specify the port, in which case just input "localhost" for the address. The format is . @@ -101,7 +108,7 @@ Flags: The recommended way to listen for incoming transaction is to periodically query the blockchain through the following endpoint of the LCD: -[`/bank/balance/{account}`](https://cosmos.network/rpc/#/ICS20/get_bank_balances__address_) +[`/bank/balance/{address}`](https://cosmos.network/rpc/#/ICS20/get_bank_balances__address_) ## Rest API