mfahampshire
a70e68c7bd
* Smolmix documentation * Add smolmix docs: landing page, tutorials, and developer page links * Add Exit Gateway services page (NR vs IPR) and link from existing docs * Update auto-generated command and API outputs * Reorg of tutorials and architecture pages * License information + remove TODO from docs.rs visibile comment + reorg readme * Add versions file for doc-wide versioning * Relative -> absolute links * Relative -> absolute links * Update license + add old tutorial code as examples * Streamline smolmix docs * Clippy * Clean up doc comments * Last pass * Add larger file download to list * set new versions * Clippy * Remove blake pin from docs + add version range to root Cargo.toml * Format example logging * Remove crate blocked component * Loose whitespace * Add doc verification script for inline mdx * Formatting * Components regen * Reorg + tighten text * Voicing cohesion pass + remove bloated examples * Voicing cont. * Reduce max download size * Small suggested clarifications * Max/docs voicing consistency (#6769) * Reduce max download size * voicing consistency across docs * New landing order w smolmix * Tweaks * Final tweaks
27 lines
1.1 KiB
Plaintext
27 lines
1.1 KiB
Plaintext
# Usage
|
|
|
|
## Building
|
|
The `nym-cli` binary can be built by running `cargo build --release` in the `nym/tools/nym-cli` directory.
|
|
|
|
## Usage
|
|
See the [commands](/developers/tools/nym-cli/commands) page for an overview of all command options.
|
|
|
|
## Staking on someone's behalf (for custodians)
|
|
|
|
The staking address can only perform the following actions (visible via the Nym Wallet):
|
|
|
|
- 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=""
|
|
The staking address has no ability to withdraw any coins from the parent's account.
|
|
```
|
|
|
|
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 behalf of someone else
|
|
```
|
|
./nym-cli --mnemonic <staking address mnemonic> mixnet delegators delegate --mix-id <input> --identity-key <input> --amount <input>
|
|
```
|