Skip to content

Commit 00f9e95

Browse files
committed
docs: update ibc-go generated docs
1 parent 45e0524 commit 00f9e95

9 files changed

+221
-3
lines changed

app/app.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ import (
129129
ibctransferkeeper "github.com/cosmos/ibc-go/v8/modules/apps/transfer/keeper"
130130
ibctransfertypes "github.com/cosmos/ibc-go/v8/modules/apps/transfer/types"
131131
ibc "github.com/cosmos/ibc-go/v8/modules/core"
132-
ibcclienttypes "github.com/cosmos/ibc-go/v8/modules/core/02-client/types"
132+
ibcclienttypes "github.com/cosmos/ibc-go/v8/modules/core/02-client/types"
133133
ibcconnectiontypes "github.com/cosmos/ibc-go/v8/modules/core/03-connection/types"
134134
ibcporttypes "github.com/cosmos/ibc-go/v8/modules/core/05-port/types"
135135
ibcexported "github.com/cosmos/ibc-go/v8/modules/core/exported"

docs/command/axoned_query_ibc_channel.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,8 @@ axoned query ibc channel [flags]
2525
* [axoned query ibc channel packet-commitment](axoned_query_ibc_channel_packet-commitment.md) - Query a packet commitment
2626
* [axoned query ibc channel packet-commitments](axoned_query_ibc_channel_packet-commitments.md) - Query all packet commitments associated with a channel
2727
* [axoned query ibc channel packet-receipt](axoned_query_ibc_channel_packet-receipt.md) - Query a packet receipt
28+
* [axoned query ibc channel params](axoned_query_ibc_channel_params.md) - Query the current ibc channel parameters
2829
* [axoned query ibc channel unreceived-acks](axoned_query_ibc_channel_unreceived-acks.md) - Query all the unreceived acks associated with a channel
2930
* [axoned query ibc channel unreceived-packets](axoned_query_ibc_channel_unreceived-packets.md) - Query all the unreceived packets associated with a channel
31+
* [axoned query ibc channel upgrade](axoned_query_ibc_channel_upgrade.md) - Query the upgrade
32+
* [axoned query ibc channel upgrade-error](axoned_query_ibc_channel_upgrade-error.md) - Query the upgrade error
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## axoned query ibc channel params
2+
3+
Query the current ibc channel parameters
4+
5+
### Synopsis
6+
7+
Query the current ibc channel parameters
8+
9+
```
10+
axoned query ibc channel params [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
axoned query ibc channel params
17+
```
18+
19+
### Options
20+
21+
```
22+
--grpc-addr string the gRPC endpoint to use for this chain
23+
--grpc-insecure allow gRPC over insecure channels, if not the server must use TLS
24+
--height int Use a specific height to query state at (this can error if the node is pruning state)
25+
-h, --help help for params
26+
--node string <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
27+
-o, --output string Output format (text|json) (default "text")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [axoned query ibc channel](axoned_query_ibc_channel.md) - IBC channel query subcommands
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## axoned query ibc channel upgrade-error
2+
3+
Query the upgrade error
4+
5+
### Synopsis
6+
7+
Query the upgrade error for a given channel
8+
9+
```
10+
axoned query ibc channel upgrade-error [port-id] [channel-id] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
axoned query ibc channel upgrade-error [port-id] [channel-id]
17+
```
18+
19+
### Options
20+
21+
```
22+
--grpc-addr string the gRPC endpoint to use for this chain
23+
--grpc-insecure allow gRPC over insecure channels, if not the server must use TLS
24+
--height int Use a specific height to query state at (this can error if the node is pruning state)
25+
-h, --help help for upgrade-error
26+
--node string <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
27+
-o, --output string Output format (text|json) (default "text")
28+
--prove show proofs for the query results (default true)
29+
```
30+
31+
### SEE ALSO
32+
33+
* [axoned query ibc channel](axoned_query_ibc_channel.md) - IBC channel query subcommands
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## axoned query ibc channel upgrade
2+
3+
Query the upgrade
4+
5+
### Synopsis
6+
7+
Query the upgrade for a given channel
8+
9+
```
10+
axoned query ibc channel upgrade [port-id] [channel-id] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
axoned query ibc channel upgrade [port-id] [channel-id]
17+
```
18+
19+
### Options
20+
21+
```
22+
--grpc-addr string the gRPC endpoint to use for this chain
23+
--grpc-insecure allow gRPC over insecure channels, if not the server must use TLS
24+
--height int Use a specific height to query state at (this can error if the node is pruning state)
25+
-h, --help help for upgrade
26+
--node string <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
27+
-o, --output string Output format (text|json) (default "text")
28+
--prove show proofs for the query results
29+
```
30+
31+
### SEE ALSO
32+
33+
* [axoned query ibc channel](axoned_query_ibc_channel.md) - IBC channel query subcommands

docs/command/axoned_tx_ibc_channel.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ axoned tx ibc channel [flags]
1515
### SEE ALSO
1616

1717
* [axoned tx ibc](axoned_tx_ibc.md) - IBC transaction subcommands
18+
* [axoned tx ibc channel prune-acknowledgements](axoned_tx_ibc_channel_prune-acknowledgements.md) - Prune expired packet acknowledgements stored in IBC state
19+
* [axoned tx ibc channel upgrade-channels](axoned_tx_ibc_channel_upgrade-channels.md) - Upgrade IBC channels
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## axoned tx ibc channel prune-acknowledgements
2+
3+
Prune expired packet acknowledgements stored in IBC state
4+
5+
### Synopsis
6+
7+
Prune expired packet acknowledgements and receipts stored in IBC state. Packet ackwnowledgements and
8+
receipts are considered expired if a channel has been upgraded.
9+
10+
```
11+
axoned tx ibc channel prune-acknowledgements [port] [channel] [limit] [flags]
12+
```
13+
14+
### Examples
15+
16+
```
17+
axoned tx ibc channel prune-acknowledgements transfer channel-0 1000
18+
```
19+
20+
### Options
21+
22+
```
23+
-a, --account-number uint The account number of the signing account (offline mode only)
24+
--aux Generate aux signer data instead of sending a tx
25+
-b, --broadcast-mode string Transaction broadcasting mode (sync|async) (default "sync")
26+
--chain-id string The network chain ID
27+
--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)
28+
--fee-granter string Fee granter grants fees for the transaction
29+
--fee-payer string Fee payer pays fees for the transaction instead of deducting from the signer
30+
--fees string Fees to pay along with transaction; eg: 10uatom
31+
--from string Name or address of private key with which to sign
32+
--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)
33+
--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)
34+
--gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
35+
--generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
36+
-h, --help help for prune-acknowledgements
37+
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
38+
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
39+
--ledger Use a connected Ledger device
40+
--node string <host>:<port> to CometBFT rpc interface for this chain (default "tcp://localhost:26657")
41+
--note string Note to add a description to the transaction (previously --memo)
42+
--offline Offline mode (does not allow any online functionality)
43+
-o, --output string Output format (text|json) (default "json")
44+
-s, --sequence uint The sequence number of the signing account (offline mode only)
45+
--sign-mode string Choose sign mode (direct|amino-json|direct-aux|textual), this is an advanced feature
46+
--timeout-height uint Set a block timeout height to prevent the tx from being committed past a certain height
47+
--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
48+
-y, --yes Skip tx broadcasting prompt confirmation
49+
```
50+
51+
### SEE ALSO
52+
53+
* [axoned tx ibc channel](axoned_tx_ibc_channel.md) - IBC channel transaction subcommands
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
## axoned tx ibc channel upgrade-channels
2+
3+
Upgrade IBC channels
4+
5+
### Synopsis
6+
7+
Submit a governance proposal to upgrade all open channels whose port matches a specified pattern
8+
(the default is transfer), optionally, an exact list of comma separated channel IDs may be specified.
9+
10+
```
11+
axoned tx ibc channel upgrade-channels [flags]
12+
```
13+
14+
### Examples
15+
16+
```
17+
axoned tx ibc channel upgrade-channels "{\"fee_version\":\"ics29-1\",\"app_version\":\"ics20-1\"}" --deposit 10stake
18+
```
19+
20+
### Options
21+
22+
```
23+
-a, --account-number uint The account number of the signing account (offline mode only)
24+
--aux Generate aux signer data instead of sending a tx
25+
-b, --broadcast-mode string Transaction broadcasting mode (sync|async) (default "sync")
26+
--chain-id string The network chain ID
27+
--channel-ids string a comma separated list of channel IDs to upgrade.
28+
--deposit string The deposit to include with the governance proposal
29+
--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)
30+
--expedited set the expedited value for the governance proposal.
31+
--fee-granter string Fee granter grants fees for the transaction
32+
--fee-payer string Fee payer pays fees for the transaction instead of deducting from the signer
33+
--fees string Fees to pay along with transaction; eg: 10uatom
34+
--from string Name or address of private key with which to sign
35+
--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)
36+
--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)
37+
--gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
38+
--generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
39+
-h, --help help for upgrade-channels
40+
--json specify true to output valid proposal.json contents, instead of submitting a governance proposal.
41+
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
42+
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
43+
--ledger Use a connected Ledger device
44+
--metadata string The metadata to include with the governance proposal
45+
--node string <host>:<port> to CometBFT rpc interface for this chain (default "tcp://localhost:26657")
46+
--note string Note to add a description to the transaction (previously --memo)
47+
--offline Offline mode (does not allow any online functionality)
48+
-o, --output string Output format (text|json) (default "json")
49+
--port-pattern string The pattern to use to match port ids. (default "transfer")
50+
-s, --sequence uint The sequence number of the signing account (offline mode only)
51+
--sign-mode string Choose sign mode (direct|amino-json|direct-aux|textual), this is an advanced feature
52+
--summary string The summary to include with the governance proposal
53+
--timeout-height uint Set a block timeout height to prevent the tx from being committed past a certain height
54+
--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
55+
--title string The title to put on the governance proposal
56+
-y, --yes Skip tx broadcasting prompt confirmation
57+
```
58+
59+
### SEE ALSO
60+
61+
* [axoned tx ibc channel](axoned_tx_ibc_channel.md) - IBC channel transaction subcommands

docs/command/axoned_tx_interchain-accounts_controller_register.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Register an interchain account on the provided connection.
77
Register an account on the counterparty chain via the
88
connection id from the source chain. Connection identifier should be for the source chain
99
and the interchain account will be created on the counterparty chain. Callers are expected to
10-
provide the appropriate application version string via \{version\} flag. Generates a new
11-
port identifier using the provided owner string, binds to the port identifier and claims
10+
provide the appropriate application version string via \{version\} flag and the desired ordering
11+
via the \{ordering\} flag. Generates a new port identifier using the provided owner string, binds to the port identifier and claims
1212
the associated capability.
1313

1414
```
@@ -38,6 +38,7 @@ axoned tx interchain-accounts controller register [connection-id] [flags]
3838
--node string <host>:<port> to CometBFT rpc interface for this chain (default "tcp://localhost:26657")
3939
--note string Note to add a description to the transaction (previously --memo)
4040
--offline Offline mode (does not allow any online functionality)
41+
--ordering string Channel ordering, can be one of: ORDER_ORDERED, ORDER_UNORDERED (default "ORDER_ORDERED")
4142
-o, --output string Output format (text|json) (default "json")
4243
-s, --sequence uint The sequence number of the signing account (offline mode only)
4344
--sign-mode string Choose sign mode (direct|amino-json|direct-aux|textual), this is an advanced feature

0 commit comments

Comments
 (0)