correction of typos

This commit is contained in:
serinko
2023-08-07 12:40:28 +02:00
committed by mfahampshire
parent 9c0317ab28
commit 9652060c57
+9 -9
View File
@@ -4,14 +4,14 @@
This is a CLI tool for interacting with:
* the Nyx blockchain (account management, querying the chain state, etc)
* the smart contracts deployed on Nyx (bonding and unbonding mixnodes, collecting rewards, etc)
* the smart contracts deployed on Nyx (bonding and un-bonding mixnodes, collecting rewards, etc)
It provides a convenient wrapper around the `nymd` client, and has similar functionality to the `nyxd` binary for querying the chain or executing smart contract methods.
## Building
The `nym-cli` binary can be built by running `cargo build --release` in the `nym/tools/nym-cli` directory.
### Useage
### Usage
You can see all available commands with:
```
@@ -225,9 +225,9 @@ Bonding a mix node is a process that takes a few steps due to the need to sign a
./nym-cli --mnemonic <mnemonic> mixnet operators gateway bond --amount 100000000 --mix-port 1789 --version "1.1.13" --host "85.163.111.99" --identity-key "B6pWscxYb8sPAdKTci8zPy5AgMzn5Zx8KpWwQNCyUSU7" --location "nym-town" --sphinx-key "o6MmKHzRewpNzVwaV37ZX9G3BfK4AmfYvsQfyoyAFRk" --signature "2TujBZfer8r5QM639Yb8coD9xH6f5eXzjAT5dD7wMom9fH8D1u36d7UpPdVaaZrWsCynmYpobwMWqiMKr5kM6CprD"
```
### Unbond a node
### Un-bond a node
Unbond a mix node or gateway.
Un-bond a mix node or gateway.
```
./nym-cli mixnet operators gateway unbound --mnemonic <mnemonic>
```
@@ -270,7 +270,7 @@ Delegate to a mix node.
./nym-cli mixnet delegators delegate --amount <AMOUNT> mix-id <MIX_ID> --mnemonic <mnemonic>
```
### Undelegate Stake
### Un-delegate Stake
Remove stake from a mix node.
```
@@ -321,10 +321,10 @@ Query for vesting schedule in the [vesting smart contract](../nyx/vesting-contra
## Staking on someone's behalf (for custodians)
There is a limitation the the staking address can only perform the following actions (and are visible via the Nym Wallet:
There is a limitation the staking address can only perform the following actions (and are visible via the Nym Wallet:
- Bond on the gaƒteway's or mix node's behalf.
- Delegate or Undelegate (to a mix node in order to begin receiving rewards)
- Bond on the gateway's or mix node's behalf.
- Delegate or Un-delegate (to a mix node in order to begin receiving rewards)
- Claiming the rewards on the account
```admonish note title=""
@@ -333,7 +333,7 @@ The staking address has no ability to withdraw any coins from the parent's accou
The staking address must maintain the same level of security as the parent mnemonic; while the parent mnemonic's delegations and bonding events will be visible to the parent owner, the staking address will be the only account capable of undoing the bonding and delegating from the mix nodes or gateway.
Query for staking on behlaf of someone else
Query for staking on behalf of someone else
```
./nym-cli --mnemonic <staking address mnemonic> mixnet delegators delegate --mix-id <input> --identity-key <input> --amount <input>
```