Skip to content

Commit

Permalink
feat(commands): update axone-protocol/axoned commands documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bot-anik committed Jul 22, 2024
1 parent 142caa1 commit d982878
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 30 deletions.
6 changes: 6 additions & 0 deletions commands/axoned_keys_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ local keystore.
Use the --pubkey flag to add arbitrary public keys to the keystore for constructing
multisig transactions.

Use the --source flag to import mnemonic from a file in recover or interactive mode.
Example:

keys add testing --recover --source ./mnemonic.txt

You can create and store a multisig key by passing the list of key names stored in a keyring
and the minimum number of signatures required through --multisig-threshold. The keys are
sorted by address, unless the flag --nosort is set.
Expand Down Expand Up @@ -46,6 +51,7 @@ axoned keys add <name> [flags]
--pubkey string Parse a public key in JSON format and saves key info to <name> file.
--pubkey-base64 string Parse a public key in base64 format and saves key info.
--recover Provide seed phrase to recover existing key instead of creating
--source string Import mnemonic from a file (only usable when recover or interactive is passed)
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion commands/axoned_query_gov_proposals.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ axoned query gov proposals [flags]
```
axoned query gov proposals --depositor cosmos1...
axoned query gov proposals --voter cosmos1...
axoned query gov proposals --proposal-status (PROPOSAL_STATUS_DEPOSIT_PERIOD|PROPOSAL_STATUS_VOTING_PERIOD|PROPOSAL_STATUS_PASSED|PROPOSAL_STATUS_REJECTED|PROPOSAL_STATUS_FAILED)
axoned query gov proposals --proposal-status (unspecified | deposit-period | voting-period | passed | rejected | failed)
```

### Options
Expand Down
4 changes: 2 additions & 2 deletions commands/axoned_query_wait-tx.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ axoned query wait-tx [hash] [flags]

```
By providing the transaction hash:
$ axonedd q wait-tx [hash]
$ axoned q wait-tx [hash]
Or, by piping a "tx" command:
$ axonedd tx [flags] | axonedd q wait-tx
$ axoned tx [flags] | axoned q wait-tx
```

Expand Down
59 changes: 32 additions & 27 deletions commands/axoned_tx_multi-sign.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ If the --offline flag is on, the client will not reach out to an external node.
Account number or sequence number lookups are not performed so you must
set these parameters manually.

If the --skip-signature-verification flag is on, the command will not verify the
signatures in the provided signature files. This is useful when the multisig
account is a signer in a nested multisig scenario.

The current multisig implementation defaults to amino-json sign mode.
The SIGN_MODE_DIRECT sign mode is not supported.'

Expand All @@ -29,33 +33,34 @@ axoned tx multi-sign [file] [name] [[signature]...] [flags]
### Options

```
-a, --account-number uint The account number of the signing account (offline mode only)
--aux Generate aux signer data instead of sending a tx
-b, --broadcast-mode string Transaction broadcasting mode (sync|async) (default "sync")
--chain-id string The network chain ID (default "axoned")
--dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
--fee-granter string Fee granter grants fees for the transaction
--fee-payer string Fee payer pays fees for the transaction instead of deducting from the signer
--fees string Fees to pay along with transaction; eg: 10uatom
--from string Name or address of private key with which to sign
--gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically. Note: "auto" option doesn't always report accurate results. Set a valid coin value to adjust the result. Can be used instead of "fees". (default 200000)
--gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1)
--gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
--generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
-h, --help help for multi-sign
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "test")
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--ledger Use a connected Ledger device
--node string <host>:<port> to CometBFT rpc interface for this chain (default "tcp://localhost:26657")
--note string Note to add a description to the transaction (previously --memo)
--offline Offline mode (does not allow any online functionality)
--output-document string The document is written to the given file instead of STDOUT
-s, --sequence uint The sequence number of the signing account (offline mode only)
--sign-mode string Choose sign mode (direct|amino-json|direct-aux|textual), this is an advanced feature
--signature-only Print only the generated signature, then exit
--timeout-height uint Set a block timeout height to prevent the tx from being committed past a certain height
--tip string Tip is the amount that is going to be transferred to the fee payer on the target chain. This flag is only valid when used with --aux, and is ignored if the target chain didn't enable the TipDecorator
-y, --yes Skip tx broadcasting prompt confirmation
-a, --account-number uint The account number of the signing account (offline mode only)
--aux Generate aux signer data instead of sending a tx
-b, --broadcast-mode string Transaction broadcasting mode (sync|async) (default "sync")
--chain-id string The network chain ID (default "axoned")
--dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
--fee-granter string Fee granter grants fees for the transaction
--fee-payer string Fee payer pays fees for the transaction instead of deducting from the signer
--fees string Fees to pay along with transaction; eg: 10uatom
--from string Name or address of private key with which to sign
--gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically. Note: "auto" option doesn't always report accurate results. Set a valid coin value to adjust the result. Can be used instead of "fees". (default 200000)
--gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1)
--gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
--generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
-h, --help help for multi-sign
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "test")
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--ledger Use a connected Ledger device
--node string <host>:<port> to CometBFT rpc interface for this chain (default "tcp://localhost:26657")
--note string Note to add a description to the transaction (previously --memo)
--offline Offline mode (does not allow any online functionality)
--output-document string The document is written to the given file instead of STDOUT
-s, --sequence uint The sequence number of the signing account (offline mode only)
--sign-mode string Choose sign mode (direct|amino-json|direct-aux|textual), this is an advanced feature
--signature-only Print only the generated signature, then exit
--skip-signature-verification Skip signature verification
--timeout-height uint Set a block timeout height to prevent the tx from being committed past a certain height
--tip string Tip is the amount that is going to be transferred to the fee payer on the target chain. This flag is only valid when used with --aux, and is ignored if the target chain didn't enable the TipDecorator
-y, --yes Skip tx broadcasting prompt confirmation
```

### SEE ALSO
Expand Down

0 comments on commit d982878

Please sign in to comment.