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
79 lines
3.9 KiB
Markdown
79 lines
3.9 KiB
Markdown
# Ledger Live Support
|
|
|
|
Use the following instructions to interact with the Nyx blockchain (either with deployed smart contracts, or to send tokens) using your Ledger device to sign transactions.
|
|
|
|
## Prerequisites
|
|
* Download and install [Ledger Live](https://www.ledger.com/ledger-live).
|
|
* Compile the `nyxd` binary as per the instructions [here](../../operators/nodes/validator-setup). Stop after you can successfully run `nyxd` and get the helptext in your console output.
|
|
|
|
## Prepare your Ledger App
|
|
* Plug in your Ledger device
|
|
* Install the `Cosmos (ATOM)` app by following the instructions [here](https://hub.cosmos.network/main/resources/ledger.html). This app works with any Cosmos SDK chain, so you can manage your ATOM, OSMOSIS, NYM tokens, etc.
|
|
* On the device, navigate to the Cosmos app and open it
|
|
|
|
## Create a keypair
|
|
Add a reference to the ledger device on your local machine by running the following command in the same directory as your `nyxd` binary:
|
|
|
|
```
|
|
nyxd keys add ledger_account --ledger
|
|
```
|
|
|
|
## Command help with `nyxd`
|
|
More information about each command is available by consulting the help section (`--help`) at each layer of `nyxd`'s commands:
|
|
|
|
```
|
|
# logging top level command help
|
|
nyxd --help
|
|
|
|
# logging top level command help for transaction commands
|
|
nyxd tx --help
|
|
|
|
# logging top level command help for transaction commands utilising the 'bank' module
|
|
nyxd tx bank --help
|
|
```
|
|
|
|
## Sending tokens between addresses
|
|
Perform a transaction from the CLI with `nyxd`, appending the `--ledger` option to the command.
|
|
|
|
As an example, the below command will send 1 `NYM` from the ledger account to the `$DESTINATION_ACCOUNT`:
|
|
|
|
```
|
|
nyxd tx bank send ledger_account $DESTINATION_ACCOOUNT 1000000unym --ledger --node https://rpc.dev.nymte.ch:443
|
|
```
|
|
|
|
> When a command is run, the transaction will appear on the Ledger device and will require physical confirmation from the device before being signed.
|
|
|
|
## Nym-specific transactions
|
|
Nym-specific commands and queries, like bonding a Mix Node or delegating unvested tokens, are available in the `wasm` module, and follow the following pattern:
|
|
|
|
```
|
|
# Executing commands
|
|
nyxd tx wasm execute $CONTRACT_ADDRESS $JSON_MSG
|
|
|
|
# Querying the state of a smart contract
|
|
nyxd query wasm contract-state smart $CONTRACT_ADDRESS $JSON_MSG
|
|
```
|
|
|
|
You can find the value of `$CONTRACT_ADDRESS` in the [`network defaults`](https://github.com/nymtech/nym/blob/master/common/network-defaults/src/mainnet.rs) file.
|
|
|
|
The value of `$JSON_MSG` will be a blog of `json` formatted as defined for each command and query. You can find these definitions for the mixnet smart contract [here](https://github.com/nymtech/nym/blob/master/common/cosmwasm-smart-contracts/mixnet-contract/src/msg.rs) and for the vesting contract [here](https://github.com/nymtech/nym/blob/master/common/cosmwasm-smart-contracts/vesting-contract/src/messages.rs) under `ExecuteMsg` and `QueryMsg`.
|
|
|
|
### Example command execution:
|
|
#### Delegate to a Mix Node
|
|
You can delegate to a Mix Node from the CLI using `nyxd` and signing the transaction with your ledger by filling in the values of this example:
|
|
```
|
|
CONTRACT_ADDRESS=mixnet_contract_address
|
|
|
|
./nyxd tx wasm execute $CONTRACT_ADDRESS '{"delegate_to_mixnode":{"mix_identity":"MIX_NODE_IDENTITY","amount":{"amount":"100000000000","denom":"unym"}}}' --ledger --from admin --node https://rpc.dev.nymte.ch:443 --gas-prices 0.025unymt --gas auto -b block
|
|
```
|
|
|
|
> By replacing the value of `CONTRACT_ADDRESS` with the address of the vesting contract, you could use the above command to use tokens held in the vesting contract.
|
|
|
|
#### Query a vesting schedule
|
|
You can query for (e.g.) seeing the current vesting period of an address by filling in the values of the following:
|
|
```
|
|
CONTRACT_ADDRESS=vesting_contract_address
|
|
|
|
nyxd query wasm contract-state smart $CONTRACT_ADDRESS '{"get_current_vesting_period"}:{"address": "address_to_query_for"}' --ledger --from admin --node https://rpc.dev.nymte.ch:443 --chain-id qa-net --gas-prices 0.025unymt --gas auto -b block
|
|
```
|