docs: update commands docs since cosmos update

axone-protocol · May 21, 2024 · 985a58f · 985a58f
1 parent 951117c
commit 985a58f
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 78 deletions.
diff --git a/docs/command/axoned_query.md b/docs/command/axoned_query.md
@@ -24,7 +24,6 @@ axoned query [flags]
 * [axoned query circuit](axoned_query_circuit.md)	 - Querying commands for the circuit module
 * [axoned query consensus](axoned_query_consensus.md)	 - Querying commands for the consensus module
 * [axoned query distribution](axoned_query_distribution.md)	 - Querying commands for the distribution module
-* [axoned query event-query-tx-for](axoned_query_event-query-tx-for.md)	 - Query for a transaction by hash
 * [axoned query evidence](axoned_query_evidence.md)	 - Querying commands for the evidence module
 * [axoned query feegrant](axoned_query_feegrant.md)	 - Querying commands for the feegrant module
 * [axoned query gov](axoned_query_gov.md)	 - Querying commands for the gov module
@@ -41,4 +40,5 @@ axoned query [flags]
 * [axoned query tx](axoned_query_tx.md)	 - Query for a transaction by hash, "&lt;addr&gt;/&lt;seq&gt;" combination or comma-separated signatures in a committed block
 * [axoned query txs](axoned_query_txs.md)	 - Query for paginated transactions that match a set of events
 * [axoned query upgrade](axoned_query_upgrade.md)	 - Querying commands for the upgrade module
+* [axoned query wait-tx](axoned_query_wait-tx.md)	 - Wait for a transaction to be included in a block
 * [axoned query wasm](axoned_query_wasm.md)	 - Querying commands for the wasm module
diff --git a/docs/command/axoned_query_distribution.md b/docs/command/axoned_query_distribution.md
@@ -17,11 +17,11 @@ axoned query distribution [flags]
 * [axoned query](axoned_query.md)	 - Querying subcommands
 * [axoned query distribution commission](axoned_query_distribution_commission.md)	 - Query distribution validator commission
 * [axoned query distribution community-pool](axoned_query_distribution_community-pool.md)	 - Query the amount of coins in the community pool
-* [axoned query distribution delegation-total-rewards](axoned_query_distribution_delegation-total-rewards.md)	 - Execute the DelegationTotalRewards RPC method
 * [axoned query distribution delegator-validators](axoned_query_distribution_delegator-validators.md)	 - Execute the DelegatorValidators RPC method
 * [axoned query distribution delegator-withdraw-address](axoned_query_distribution_delegator-withdraw-address.md)	 - Execute the DelegatorWithdrawAddress RPC method
 * [axoned query distribution params](axoned_query_distribution_params.md)	 - Query the current distribution parameters.
-* [axoned query distribution rewards](axoned_query_distribution_rewards.md)	 - Query all distribution delegator rewards or rewards from a particular validator
+* [axoned query distribution rewards](axoned_query_distribution_rewards.md)	 - Query all distribution delegator rewards
+* [axoned query distribution rewards-by-validator](axoned_query_distribution_rewards-by-validator.md)	 - Query all distribution delegator from a particular validator
 * [axoned query distribution slashes](axoned_query_distribution_slashes.md)	 - Query distribution validator slashes
 * [axoned query distribution validator-distribution-info](axoned_query_distribution_validator-distribution-info.md)	 - Query validator distribution info
 * [axoned query distribution validator-outstanding-rewards](axoned_query_distribution_validator-outstanding-rewards.md)	 - Query distribution outstanding (un-withdrawn) rewards for a validator and all their delegations
diff --git a/docs/command/axoned_query_distribution_delegation-total-rewards.md b/docs/command/axoned_query_distribution_delegation-total-rewards.md
diff --git a/docs/command/axoned_query_distribution_rewards-by-validator.md b/docs/command/axoned_query_distribution_rewards-by-validator.md
@@ -0,0 +1,29 @@
+## axoned query distribution rewards-by-validator
+
+Query all distribution delegator from a particular validator
+
+```
+axoned query distribution rewards-by-validator [delegator-addr] [validator-addr] [flags]
+```
+
+### Examples
+
+```
+$ axoned query distribution rewards [delegator-address] [validator-address]
+```
+
+### 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 rewards-by-validator
+      --no-indent          Do not indent JSON output
+      --node string        <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
+  -o, --output string      Output format (text|json) (default "text")
+```
+
+### SEE ALSO
+
+* [axoned query distribution](axoned_query_distribution.md)	 - Querying commands for the distribution module
diff --git a/docs/command/axoned_query_distribution_rewards.md b/docs/command/axoned_query_distribution_rewards.md
@@ -1,19 +1,19 @@
 ## axoned query distribution rewards
 
-Query all distribution delegator rewards or rewards from a particular validator
+Query all distribution delegator rewards
 
 ### Synopsis
 
-Query all rewards earned by a delegator, optionally restrict to rewards from a single validator.
+Query all rewards earned by a delegator
 
 ```
-axoned query distribution rewards [delegator-addr] [validator-addr] [flags]
+axoned query distribution rewards [delegator-addr] [flags]
 ```
 
 ### Examples
 
 ```
-$ axoned query distribution rewards [delegator-address] [validator-address]
+$ axoned query distribution rewards [delegator-address]
 ```
 
 ### Options

diff --git a/docs/command/axoned_query_event-query-tx-for.md b/docs/command/axoned_query_event-query-tx-for.md
diff --git a/docs/command/axoned_query_wait-tx.md b/docs/command/axoned_query_wait-tx.md
@@ -0,0 +1,38 @@
+## axoned query wait-tx
+
+Wait for a transaction to be included in a block
+
+### Synopsis
+
+Subscribes to a CometBFT WebSocket connection and waits for a transaction event with the given hash.
+
+```
+axoned query wait-tx [hash] [flags]
+```
+
+### Examples
+
+```
+By providing the transaction hash:
+$ axonedd q wait-tx [hash]
+
+Or, by piping a "tx" command:
+$ axonedd tx [flags] | axonedd q wait-tx
+
+```
+
+### 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 wait-tx
+      --node string        <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
+  -o, --output string      Output format (text|json) (default "text")
+      --timeout duration   The maximum time to wait for the transaction to be included in a block (default 15s)
+```
+
+### SEE ALSO
+
+* [axoned query](axoned_query.md)	 - Querying subcommands
diff --git a/docs/command/axoned_start.md b/docs/command/axoned_start.md
@@ -66,7 +66,7 @@ axoned start [flags]
       --iavl-disable-fastnode                           Disable fast node for IAVL tree
       --inter-block-cache                               Enable inter-block caching (default true)
       --inv-check-period uint                           Assert registered invariants every N blocks
-      --mempool.max-txs int                             Sets MaxTx value for the app-side mempool
+      --mempool.max-txs int                             Sets MaxTx value for the app-side mempool (default -1)
       --min-retain-blocks uint                          Minimum block height offset during ABCI commit to prune CometBFT blocks
       --minimum-gas-prices string                       Minimum gas prices to accept for transactions; Any fee in a tx must meet this minimum (e.g. 0.01photino;0.0001stake)
       --moniker string                                  node name (default "my-machine")