Skip to content

Commit

Permalink
docs: update commands docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bdeneux committed Apr 7, 2023
1 parent 09a6bd0 commit 83de081
Show file tree
Hide file tree
Showing 148 changed files with 1,037 additions and 858 deletions.
1 change: 0 additions & 1 deletion docs/command/okp4d.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ Want to lean more about OKP4 network? Complete documentation is available at <ht
* [okp4d query](okp4d_query.md) - Querying subcommands
* [okp4d rollback](okp4d_rollback.md) - rollback cosmos-sdk and tendermint state by one height
* [okp4d start](okp4d_start.md) - Run the full node
* [okp4d start-with-http-tunneling](okp4d_start-with-http-tunneling.md) - Run the full node with http tunneling
* [okp4d status](okp4d_status.md) - Query remote node for status
* [okp4d tendermint](okp4d_tendermint.md) - Tendermint subcommands
* [okp4d tx](okp4d_tx.md) - Transactions subcommands
Expand Down
1 change: 1 addition & 0 deletions docs/command/okp4d_debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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
* [okp4d debug raw-bytes](okp4d_debug_raw-bytes.md) - Convert raw bytes output (eg. [10 21 13 255]) to hex
27 changes: 27 additions & 0 deletions docs/command/okp4d_debug_prefixes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## okp4d debug prefixes

List prefixes used for Human-Readable Part (HRP) in Bech32

### Synopsis

List prefixes used in Bech32 addresses.

```
okp4d debug prefixes [flags]
```

### Examples

```
okp4d debug prefixes
```

### Options

```
-h, --help help for prefixes
```

### SEE ALSO

* [okp4d debug](okp4d_debug.md) - Tool for helping with debugging your application
2 changes: 2 additions & 0 deletions docs/command/okp4d_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ okp4d export [flags]
-h, --help help for export
--home string The application home directory (default "/home/john/.okp4d")
--jail-allowed-addrs strings Comma-separated list of operator addresses of jailed validators to unjail
--modules-to-export strings Comma-separated list of modules to export. If empty, will export all modules
--output-document string Exported state is written to the given file instead of STDOUT
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/command/okp4d_gentx.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ okp4d gentx [key_name] [amount] [flags]
-a, --account-number uint The account number of the signing account (offline mode only)
--amount string Amount of coins to bond
--aux Generate aux signer data instead of sending a tx
-b, --broadcast-mode string Transaction broadcasting mode (sync|async|block) (default "sync")
-b, --broadcast-mode string Transaction broadcasting mode (sync|async) (default "sync")
--chain-id string The network chain ID (default "okp4d")
--commission-max-change-rate string The maximum commission change rate percentage (per day)
--commission-max-rate string The maximum commission rate percentage
Expand All @@ -53,7 +53,7 @@ okp4d gentx [key_name] [amount] [flags]
-h, --help help for gentx
--home string The application home directory (default "/home/john/.okp4d")
--identity string The (optional) identity signature (ex. UPort or Keybase)
--ip string The node's public IP (default "127.0.0.1")
--ip string The node's public P2P IP (default "127.0.0.1")
--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
Expand All @@ -65,6 +65,7 @@ okp4d gentx [key_name] [amount] [flags]
--offline Offline mode (does not allow any online functionality)
-o, --output string Output format (text|json) (default "json")
--output-document string Write the genesis transaction JSON document to the given file instead of the default location
--p2p-port uint The node's public P2P port (default 26656)
--pubkey string The validator's Protobuf JSON encoded public key
--security-contact string The validator's (optional) security contact email
-s, --sequence uint The sequence number of the signing account (offline mode only)
Expand Down
13 changes: 7 additions & 6 deletions docs/command/okp4d_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ okp4d init [moniker] [flags]
### Options

```
--chain-id string genesis file chain-id, if left blank will be randomly created (default "okp4d")
-h, --help help for init
--home string node's home directory (default "/home/john/.okp4d")
-o, --overwrite overwrite the genesis.json file
--recover provide seed phrase to recover existing key instead of creating
--staking-bond-denom string genesis file staking bond denomination, if left blank default value is 'stake'
--chain-id string genesis file chain-id, if left blank will be randomly created (default "okp4d")
--default-denom string genesis file default denomination, if left blank default value is 'stake'
-h, --help help for init
--home string node's home directory (default "/home/john/.okp4d")
--initial-height int specify the initial block height at genesis (default 1)
-o, --overwrite overwrite the genesis.json file
--recover provide seed phrase to recover existing key instead of creating
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/command/okp4d_keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The pass backend requires GnuPG: <https://gnupg.org/>
```
-h, --help help for keys
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand All @@ -44,6 +44,7 @@ The pass backend requires GnuPG: <https://gnupg.org/>
* [okp4d keys export](okp4d_keys_export.md) - Export private keys
* [okp4d keys import](okp4d_keys_import.md) - Import private keys into the local keybase
* [okp4d keys list](okp4d_keys_list.md) - List all keys
* [okp4d keys list-key-types](okp4d_keys_list-key-types.md) - List all key types
* [okp4d keys migrate](okp4d_keys_migrate.md) - Migrate keys from amino to proto serialization format
* [okp4d keys mnemonic](okp4d_keys_mnemonic.md) - Compute the bip39 mnemonic for some input entropy
* [okp4d keys parse](okp4d_keys_parse.md) - Parse address from hex to bech32 and vice versa
Expand Down
4 changes: 2 additions & 2 deletions docs/command/okp4d_keys_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ okp4d keys add &lt;name&gt; [flags]

```
--account uint32 Account number for HD derivation (less than equal 2147483647)
--algo string Key signing algorithm to generate keys for (default "secp256k1")
--coin-type uint32 coin type number for HD derivation (default 118)
--dry-run Perform action, but don't add key to local keystore
--hd-path string Manual HD Path derivation (overrides BIP44 config)
-h, --help help for add
--index uint32 Address index number for HD derivation (less than equal 2147483647)
-i, --interactive Interactively prompt user for BIP39 passphrase and mnemonic
--key-type string Key signing algorithm to generate keys for (default "secp256k1")
--ledger Store a local reference to a private key on a Ledger device
--multisig strings List of key names stored in keyring to construct a public legacy multisig key
--multisig-threshold int K out of N required signatures. For use in conjunction with --multisig (default 1)
Expand All @@ -51,7 +51,7 @@ okp4d keys add &lt;name&gt; [flags]

```
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand Down
2 changes: 1 addition & 1 deletion docs/command/okp4d_keys_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ okp4d keys delete &lt;name&gt;... [flags]

```
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand Down
2 changes: 1 addition & 1 deletion docs/command/okp4d_keys_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ okp4d keys export &lt;name&gt; [flags]

```
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand Down
2 changes: 1 addition & 1 deletion docs/command/okp4d_keys_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ okp4d keys import &lt;name&gt; &lt;keyfile&gt; [flags]

```
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand Down
30 changes: 30 additions & 0 deletions docs/command/okp4d_keys_list-key-types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## okp4d keys list-key-types

List all key types

### Synopsis

Return a list of all supported key types (also known as algos)

```
okp4d keys list-key-types [flags]
```

### Options

```
-h, --help help for list-key-types
```

### Options inherited from parent commands

```
--home string The application home directory (default "/home/john/.okp4d")
--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
--output string Output format (text|json) (default "text")
```

### SEE ALSO

* [okp4d keys](okp4d_keys.md) - Manage your application's keys
2 changes: 1 addition & 1 deletion docs/command/okp4d_keys_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ okp4d keys list [flags]

```
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand Down
2 changes: 1 addition & 1 deletion docs/command/okp4d_keys_migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ okp4d keys migrate [flags]

```
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand Down
2 changes: 1 addition & 1 deletion docs/command/okp4d_keys_mnemonic.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ okp4d keys mnemonic [flags]

```
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand Down
2 changes: 1 addition & 1 deletion docs/command/okp4d_keys_parse.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ okp4d keys parse <hex-or-bech32-address> [flags]

```
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand Down
2 changes: 1 addition & 1 deletion docs/command/okp4d_keys_rename.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ okp4d keys rename <old_name> <new_name> [flags]

```
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand Down
2 changes: 1 addition & 1 deletion docs/command/okp4d_keys_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ okp4d keys show [name_or_address [name_or_address...]] [flags]

```
--home string The application home directory (default "/home/john/.okp4d")
--keyring-backend string Select keyring's backend (os|file|test) (default "test")
--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
--output string Output format (text|json) (default "text")
```
Expand Down
3 changes: 1 addition & 2 deletions docs/command/okp4d_query.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ okp4d query [flags]
* [okp4d query ibc](okp4d_query_ibc.md) - Querying commands for the IBC module
* [okp4d query ibc-fee](okp4d_query_ibc-fee.md) - IBC relayer incentivization query subcommands
* [okp4d query ibc-transfer](okp4d_query_ibc-transfer.md) - IBC fungible token transfer query subcommands
* [okp4d query interchain-accounts](okp4d_query_interchain-accounts.md) - interchain-accounts subcommands
* [okp4d query intertx](okp4d_query_intertx.md) - Querying commands for the inter-tx module
* [okp4d query interchain-accounts](okp4d_query_interchain-accounts.md) - IBC interchain accounts query subcommands
* [okp4d query logic](okp4d_query_logic.md) - Querying commands for the logic module
* [okp4d query mint](okp4d_query_mint.md) - Querying commands for the minting module
* [okp4d query params](okp4d_query_params.md) - Querying commands for the params module
Expand Down
2 changes: 2 additions & 0 deletions docs/command/okp4d_query_bank.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,6 @@ okp4d query bank [flags]
* [okp4d query](okp4d_query.md) - Querying subcommands
* [okp4d query bank balances](okp4d_query_bank_balances.md) - Query for account balances by address
* [okp4d query bank denom-metadata](okp4d_query_bank_denom-metadata.md) - Query the client metadata for coin denominations
* [okp4d query bank send-enabled](okp4d_query_bank_send-enabled.md) - Query for send enabled entries
* [okp4d query bank spendable-balances](okp4d_query_bank_spendable-balances.md) - Query for account spendable balances by address
* [okp4d query bank total](okp4d_query_bank_total.md) - Query the total supply of coins of the chain
54 changes: 54 additions & 0 deletions docs/command/okp4d_query_bank_send-enabled.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
## okp4d query bank send-enabled

Query for send enabled entries

### Synopsis

Query for send enabled entries that have been specifically set.

To look up one or more specific denoms, supply them as arguments to this command.
To look up all denoms, do not provide any arguments.

```
okp4d query bank send-enabled [denom1 ...] [flags]
```

### Examples

```
Getting one specific entry:
$ okp4d query bank send-enabled foocoin
Getting two specific entries:
$ okp4d query bank send-enabled foocoin barcoin
Getting all entries:
$ okp4d query bank send-enabled
```

### Options

```
--count-total count total number of records in send enabled entries to query for
--grpc-addr string the gRPC endpoint to use for this chain
--grpc-insecure allow gRPC over insecure channels, if not TLS 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 send-enabled
--limit uint pagination limit of send enabled entries to query for (default 100)
--node string &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
--offset uint pagination offset of send enabled entries to query for
-o, --output string Output format (text|json) (default "text")
--page uint pagination page of send enabled entries to query for. This sets offset to a multiple of limit (default 1)
--page-key string pagination page-key of send enabled entries to query for
--reverse results are sorted in descending order
```

### Options inherited from parent commands

```
--chain-id string The network chain ID (default "okp4d")
```

### SEE ALSO

* [okp4d query bank](okp4d_query_bank.md) - Querying commands for the bank module
41 changes: 41 additions & 0 deletions docs/command/okp4d_query_bank_spendable-balances.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## okp4d query bank spendable-balances

Query for account spendable balances by address

```
okp4d query bank spendable-balances [address] [flags]
```

### Examples

```
okp4d query bank spendable-balances [address]
```

### Options

```
--count-total count total number of records in spendable balances to query for
--denom string The specific balance denomination to query for
--grpc-addr string the gRPC endpoint to use for this chain
--grpc-insecure allow gRPC over insecure channels, if not TLS 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 spendable-balances
--limit uint pagination limit of spendable balances to query for (default 100)
--node string &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
--offset uint pagination offset of spendable balances to query for
-o, --output string Output format (text|json) (default "text")
--page uint pagination page of spendable balances to query for. This sets offset to a multiple of limit (default 1)
--page-key string pagination page-key of spendable balances to query for
--reverse results are sorted in descending order
```

### Options inherited from parent commands

```
--chain-id string The network chain ID (default "okp4d")
```

### SEE ALSO

* [okp4d query bank](okp4d_query_bank.md) - Querying commands for the bank module
Loading

0 comments on commit 83de081

Please sign in to comment.