From d9828780e66cce1e96f843630aed0e5ec3bb9296 Mon Sep 17 00:00:00 2001 From: Bot Anik <98603954+bot-anik@users.noreply.github.com> Date: Mon, 22 Jul 2024 09:39:59 +0000 Subject: [PATCH] feat(commands): update axone-protocol/axoned commands documentation --- commands/axoned_keys_add.md | 6 +++ commands/axoned_query_gov_proposals.md | 2 +- commands/axoned_query_wait-tx.md | 4 +- commands/axoned_tx_multi-sign.md | 59 ++++++++++++++------------ 4 files changed, 41 insertions(+), 30 deletions(-) diff --git a/commands/axoned_keys_add.md b/commands/axoned_keys_add.md index 65abb6db2df..b1af0176122 100644 --- a/commands/axoned_keys_add.md +++ b/commands/axoned_keys_add.md @@ -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. @@ -46,6 +51,7 @@ axoned keys add [flags] --pubkey string Parse a public key in JSON format and saves key info to 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 diff --git a/commands/axoned_query_gov_proposals.md b/commands/axoned_query_gov_proposals.md index 235913fc9d5..d01e6773b2a 100644 --- a/commands/axoned_query_gov_proposals.md +++ b/commands/axoned_query_gov_proposals.md @@ -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 diff --git a/commands/axoned_query_wait-tx.md b/commands/axoned_query_wait-tx.md index 1d5416634e9..40cca2ddedc 100644 --- a/commands/axoned_query_wait-tx.md +++ b/commands/axoned_query_wait-tx.md @@ -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 ``` diff --git a/commands/axoned_tx_multi-sign.md b/commands/axoned_tx_multi-sign.md index 1a35fcec8a2..21882471658 100644 --- a/commands/axoned_tx_multi-sign.md +++ b/commands/axoned_tx_multi-sign.md @@ -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.' @@ -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 : 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 : 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