From 2d833c8164efb627e347d8d7d497d4c4ea42995a Mon Sep 17 00:00:00 2001 From: Arnaud Mimart <33665250+amimart@users.noreply.github.com> Date: Fri, 15 Mar 2024 10:39:14 +0100 Subject: [PATCH] feat: update generated proto & docs --- docs/command/okp4d_debug.md | 1 + docs/command/okp4d_keys_add.md | 1 + docs/command/okp4d_keys_show.md | 6 ++-- docs/command/okp4d_query_gov.md | 1 - docs/command/okp4d_query_gov_proposer.md | 32 -------------------- docs/command/okp4d_start.md | 3 +- docs/command/okp4d_tx_wasm_grant_contract.md | 8 ++--- 7 files changed, 11 insertions(+), 41 deletions(-) delete mode 100644 docs/command/okp4d_query_gov_proposer.md diff --git a/docs/command/okp4d_debug.md b/docs/command/okp4d_debug.md index 8896719d..ff2ea4ac 100644 --- a/docs/command/okp4d_debug.md +++ b/docs/command/okp4d_debug.md @@ -16,6 +16,7 @@ okp4d debug [flags] * [okp4d](okp4d.md) - OKP4 Daemon 👹 * [okp4d debug addr](okp4d_debug_addr.md) - Convert an address between hex and bech32 +* [okp4d debug codec](okp4d_debug_codec.md) - Tool for helping with debugging your application codec * [okp4d debug prefixes](okp4d_debug_prefixes.md) - List prefixes used for Human-Readable Part (HRP) in Bech32 * [okp4d debug pubkey](okp4d_debug_pubkey.md) - Decode a pubkey from proto JSON * [okp4d debug pubkey-raw](okp4d_debug_pubkey-raw.md) - Decode a ED25519 or secp256k1 pubkey from hex, base64, or bech32 diff --git a/docs/command/okp4d_keys_add.md b/docs/command/okp4d_keys_add.md index 8f059323..a6ea98b2 100644 --- a/docs/command/okp4d_keys_add.md +++ b/docs/command/okp4d_keys_add.md @@ -44,6 +44,7 @@ okp4d keys add [flags] --no-backup Don't print out seed phrase (if others are watching the terminal) --nosort Keys passed to --multisig are taken in the order they're supplied --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 ``` diff --git a/docs/command/okp4d_keys_show.md b/docs/command/okp4d_keys_show.md index 8d49a32b..b3aab371 100644 --- a/docs/command/okp4d_keys_show.md +++ b/docs/command/okp4d_keys_show.md @@ -15,13 +15,13 @@ okp4d keys show [name_or_address [name_or_address...]] [flags] ### Options ``` - -a, --address Output the address only (overrides --output) + -a, --address Output the address only (cannot be used with --output) --bech string The Bech32 prefix encoding for a key (acc|val|cons) (default "acc") - -d, --device Output the address in a ledger device + -d, --device Output the address in a ledger device (cannot be used with --pubkey) -k, --did Output the did:key only (overrides --output) -h, --help help for show --multisig-threshold int K out of N required signatures (default 1) - -p, --pubkey Output the public key only (overrides --output) + -p, --pubkey Output the public key only (cannot be used with --output) ``` ### Options inherited from parent commands diff --git a/docs/command/okp4d_query_gov.md b/docs/command/okp4d_query_gov.md index 8c350a3f..76a72436 100644 --- a/docs/command/okp4d_query_gov.md +++ b/docs/command/okp4d_query_gov.md @@ -21,7 +21,6 @@ okp4d query gov [flags] * [okp4d query gov params](okp4d_query_gov_params.md) - Query the parameters of the governance process * [okp4d query gov proposal](okp4d_query_gov_proposal.md) - Query details of a single proposal * [okp4d query gov proposals](okp4d_query_gov_proposals.md) - Query proposals with optional filters -* [okp4d query gov proposer](okp4d_query_gov_proposer.md) - Query the proposer of a governance proposal * [okp4d query gov tally](okp4d_query_gov_tally.md) - Query the tally of a proposal vote * [okp4d query gov vote](okp4d_query_gov_vote.md) - Query details of a single vote * [okp4d query gov votes](okp4d_query_gov_votes.md) - Query votes of a single proposal diff --git a/docs/command/okp4d_query_gov_proposer.md b/docs/command/okp4d_query_gov_proposer.md deleted file mode 100644 index abac8a31..00000000 --- a/docs/command/okp4d_query_gov_proposer.md +++ /dev/null @@ -1,32 +0,0 @@ -## okp4d query gov proposer - -Query the proposer of a governance proposal - -### Synopsis - -Query which address proposed a proposal with a given ID - -``` -okp4d query gov proposer [proposal-id] [flags] -``` - -### Examples - -``` -okp4d query gov proposer 1 -``` - -### Options - -``` - --grpc-addr string the gRPC endpoint to use for this chain - --grpc-insecure allow gRPC over insecure channels, if not the server must use TLS - --height int Use a specific height to query state at (this can error if the node is pruning state) - -h, --help help for proposer - --node string : to CometBFT RPC interface for this chain (default "tcp://localhost:26657") - -o, --output string Output format (text|json) (default "text") -``` - -### SEE ALSO - -* [okp4d query gov](okp4d_query_gov.md) - Querying commands for the gov module diff --git a/docs/command/okp4d_start.md b/docs/command/okp4d_start.md index d6d874bc..ab7a7387 100644 --- a/docs/command/okp4d_start.md +++ b/docs/command/okp4d_start.md @@ -39,7 +39,7 @@ okp4d start [flags] ``` --abci string specify abci transport (socket | grpc) (default "socket") - --address string Listen address (default "tcp://0.0.0.0:26658") + --address string Listen address (default "tcp://127.0.0.1:26658") --api.address string the API server address to listen on (default "tcp://localhost:1317") --api.enable Define if the API server should be enabled --api.enabled-unsafe-cors Define if CORS should be enabled (unsafe - use it at your own risk) @@ -88,6 +88,7 @@ okp4d start [flags] --rpc.laddr string RPC listen address. Port required (default "tcp://127.0.0.1:26657") --rpc.pprof_laddr string pprof listen address (https://golang.org/pkg/net/http/pprof) --rpc.unsafe enabled unsafe rpc methods + --shutdown-grace duration On Shutdown, duration to wait for resource clean up --state-sync.snapshot-interval uint State sync snapshot interval --state-sync.snapshot-keep-recent uint32 State sync snapshot to keep (default 2) --trace Provide full stack traces for errors in ABCI Log diff --git a/docs/command/okp4d_tx_wasm_grant_contract.md b/docs/command/okp4d_tx_wasm_grant_contract.md index ed395758..b46df814 100644 --- a/docs/command/okp4d_tx_wasm_grant_contract.md +++ b/docs/command/okp4d_tx_wasm_grant_contract.md @@ -6,14 +6,14 @@ Grant authorization to interact with a contract on behalf of you Grant authorization to an address. Examples: -$ okp4d tx grant contract execution <grantee_addr> <contract_addr> --allow-all-messages --max-calls 1 --no-token-transfer --expiration 1667979596 +$ okp4d tx grant contract <grantee_addr> execution <contract_addr> --allow-all-messages --max-calls 1 --no-token-transfer --expiration 1667979596 -$ okp4d tx grant contract execution <grantee_addr> <contract_addr> --allow-all-messages --max-funds 100000uwasm --expiration 1667979596 +$ okp4d tx grant contract <grantee_addr> execution <contract_addr> --allow-all-messages --max-funds 100000uwasm --expiration 1667979596 -$ okp4d tx grant contract execution <grantee_addr> <contract_addr> --allow-all-messages --max-calls 5 --max-funds 100000uwasm --expiration 1667979596 +$ okp4d tx grant contract <grantee_addr> execution <contract_addr> --allow-all-messages --max-calls 5 --max-funds 100000uwasm --expiration 1667979596 ``` -okp4d tx wasm grant contract [message_type="execution"|"migration"] [grantee] [contract_addr_bech32] --allow-raw-msgs [msg1,msg2,...] --allow-msg-keys [key1,key2,...] --allow-all-messages [flags] +okp4d tx wasm grant contract [grantee] [message_type="execution"|"migration"] [contract_addr_bech32] --allow-raw-msgs [msg1,msg2,...] --allow-msg-keys [key1,key2,...] --allow-all-messages [flags] ``` ### Options