Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated icatx docs #148

Merged
merged 30 commits into from
Feb 8, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
3a7c88a
updated icatx docs
swelf19 Jan 23, 2024
26e8734
comflicts resolved
swelf19 Jan 24, 2024
382d2ac
Update docs/neutron/modules/contract-manager/overview.md
swelf19 Jan 26, 2024
d86c659
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Jan 26, 2024
9ecd9e4
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Jan 26, 2024
a169c00
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Jan 26, 2024
8a1d0da
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Jan 26, 2024
b077538
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Jan 26, 2024
167e84c
review fixes. added links to the code. added node to get query result
swelf19 Jan 26, 2024
109d648
Update docs/neutron/modules/contract-manager/client.md
swelf19 Jan 29, 2024
60b4d87
Update docs/neutron/modules/contract-manager/client.md
swelf19 Jan 29, 2024
96803c7
Update docs/neutron/modules/contract-manager/overview.md
swelf19 Jan 29, 2024
cad13cb
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Jan 29, 2024
8cd94fb
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Jan 29, 2024
b0e18bf
Update versioned_docs/version-1.0/neutron/modules/interchain-txs/over…
swelf19 Jan 29, 2024
89aabac
review fixes
swelf19 Jan 31, 2024
e3d0819
missed dot
swelf19 Jan 31, 2024
877b30e
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Jan 31, 2024
e4dfc04
Update versioned_docs/version-1.0/neutron/modules/interchain-txs/over…
swelf19 Jan 31, 2024
e8e379c
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Jan 31, 2024
6ca4a9d
list formatting
swelf19 Jan 31, 2024
621c60b
removed "see logs" advice
swelf19 Jan 31, 2024
2ff0d9f
uptodate "find failed tx" tutorial
swelf19 Feb 1, 2024
bde1ba6
Update versioned_docs/version-1.0/neutron/modules/interchain-txs/over…
swelf19 Feb 8, 2024
f98e007
Update versioned_docs/version-1.0/neutron/modules/interchain-txs/over…
swelf19 Feb 8, 2024
9565a9b
review changes. improved failed icatx tutorial
swelf19 Feb 8, 2024
92ccef4
Update versioned_docs/version-1.0/neutron/modules/interchain-txs/over…
swelf19 Feb 8, 2024
8b6e4e8
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Feb 8, 2024
50f554f
Update versioned_docs/version-1.0/neutron/modules/interchain-txs/over…
swelf19 Feb 8, 2024
fb9e126
Update docs/neutron/modules/interchain-txs/overview.md
swelf19 Feb 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
review changes. improved failed icatx tutorial
  • Loading branch information
swelf19 committed Feb 8, 2024
commit 9565a9b5d86dd2725a176de68638fc0fc23bffeb
14 changes: 10 additions & 4 deletions docs/neutron/modules/interchain-txs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Using `SudoLimitWrapper` has two purposes:

## Failed interchain txs

Not every interchaintx executes succesfully on a remote network. Some of them fail to execute with errors and then you get ibc acknowledgement with `Error` type. The error is passed into the caller contract via sudo call with SudoMsg::Error [varian](../../../tutorials/cosmwasm_ica.md#ibc-events)
Not every interchaintx executes succesfully on a remote network. Some of them fail to execute with errors and then you get ibc acknowledgement with `Error` type. The error is passed into the caller contract via sudo call with SudoMsg::Error [variant](../../../tutorials/cosmwasm_ica.md#ibc-events)

Unfortunately, to avoid the nondeterminism associated with error text generation, the error text is severely truncated by [redact down](https://github.com/cosmos/ibc-go/blob/v7.3.1/modules/apps/27-interchain-accounts/host/ibc_module.go#L115) to the error code without any additional details, before converting into AcknowledgementError.

Expand All @@ -76,8 +76,11 @@ Find the error text is possible if host chain includes ibc-go v7.2.3+, v7.3.2+,
Where:

- `binary` is a binary on the chain you are working with (the remote chain)
- `channel-id` is the ID of the ICA's channel on the remote chain's side. You can find a couterparty channel-id with CLI command `neutrond q ibc channel end <src-port> <src-channel-id>`
- `seq-id` - sequence ID of the IBC message received on the remove chain
- `seq-id` - sequence ID of the IBC message sent to the remove chain. The seq-id is returned to the contract in the [SubmitTx](./messages.md#response) response
- `channel-id` is the ID of the ICA's channel on the remote chain's side. You should know it from registration [procedure](../../../tutorials/cosmwasm-ica.md#2-register-an-interchain-account) via `SudoMsg::OpenAck` from `counterparty_channel_id` field. If you missed it you can always get counterparty channel-id with CLI command `neutrond q ibc channel end <src-port> <src-channel-id>`
- `src-channel-id` is the channel you intechain account associated with.
- `src-port` is the channel you intechain account associated with.
You should know both `src-channel-id` and `src-port` from registration [procedure](../../../tutorials/cosmwasm-ica.md#2-register-an-interchain-account). Also `src-port` is `icacontroller-<contract_address>.<ica_id>` where `ica_id` defined by you during ica registration.

Output example (filtered events):

Expand Down Expand Up @@ -109,7 +112,10 @@ Output example (filtered events):
}
```

On earlier versions of ibc-go it's barerly possible to get full text error due to [patch](https://github.com/cosmos/ibc-go/commit/fdbb508c1ca68811206d7175fb9e202c1611a43e)
On earlier versions of ibc-go it's barely possible to get full text error due to [patch](https://github.com/cosmos/ibc-go/commit/fdbb508c1ca68811206d7175fb9e202c1611a43e).

In the IBC error acknowledgement you get ABCI error and a code, e.g. `codespace: wasm, code: 5`
where codespace usually is `ModuleName`, and `code` is uniq code for the module. `codespace` and `code` pair uniq for the whole app. You can find the error description in source code. Usualy all the error of the module are [placed](https://github.com/CosmWasm/wasmd/blob/5f444cd9d393513e534cbfa9a0e938295c4e84e1/x/wasm/types/errors.go#L25) in `x/<module>/types/errors.go` where `module` is the module where the error was thrown

## Relaying

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ This reserve gas is needed to guarantee that [Failure](../contract-manager/state

## Failed interchain txs

Not every interchaintx executes succesfully on a remote network. Some of them fail to execute with errors and then you get ibc acknowledgement with `Error` type. The error is passed into the caller contract via sudo call with SudoMsg::Error [varian](../../../tutorials/cosmwasm_ica.md#ibc-events)
Not every interchaintx executes succesfully on a remote network. Some of them fail to execute with errors and then you get ibc acknowledgement with `Error` type. The error is passed into the caller contract via sudo call with SudoMsg::Error [variant](../../../tutorials/cosmwasm_ica.md#ibc-events)

Unfortunately, to avoid the nondeterminism associated with error text generation, the error text is severely truncated by [redact down](https://github.com/cosmos/ibc-go/blob/v7.3.1/modules/apps/27-interchain-accounts/host/ibc_module.go#L115) to the error code without any additional details, before converting into AcknowledgementError.

Expand All @@ -64,9 +64,12 @@ Find the error text is possible if host chain includes ibc-go v7.2.3+, v7.3.2+,

Where:

- `binary` is a binary of the chain you are working with (the remote chain)
- `channel-id` is the ID of the ICA's channel on the remote chain's side. You can find a couterparty channel-id with CLI command `neutrond q ibc channel end <src-port> <src-channel-id>`
- `seq-id` - sequence ID of the IBC message received on the remove chain
- `binary` is a binary on the chain you are working with (the remote chain)
- `seq-id` - sequence ID of the IBC message sent to the remove chain. The seq-id is returned to the contract in the [SubmitTx](./messages.md#response) response
- `channel-id` is the ID of the ICA's channel on the remote chain's side. You should know it from registration [procedure](../../../tutorials/cosmwasm-ica.md#2-register-an-interchain-account) via `SudoMsg::OpenAck` from `counterparty_channel_id` field. If you missed it you can always get counterparty channel-id with CLI command `neutrond q ibc channel end <src-port> <src-channel-id>`
- `src-channel-id` is the channel you intechain account associated with.
- `src-port` is the channel you intechain account associated with.
You should know both `src-channel-id` and `src-port` from registration [procedure](../../../tutorials/cosmwasm-ica.md#2-register-an-interchain-account). Also `src-port` is `icacontroller-<contract_address>.<ica_id>` where `ica_id` defined by you during ica registration.

Output example (filtered events):

Expand Down Expand Up @@ -98,7 +101,10 @@ Output example (filtered events):
}
```

On earlier versions of ibc-go it's barely possible to get full text error due to [patch](https://github.com/cosmos/ibc-go/commit/fdbb508c1ca68811206d7175fb9e202c1611a43e)
On earlier versions of ibc-go it's barely possible to get full text error due to [patch](https://github.com/cosmos/ibc-go/commit/fdbb508c1ca68811206d7175fb9e202c1611a43e).

In the IBC error acknowledgement you get ABCI error and a code, e.g. `codespace: wasm, code: 5`
where codespace usually is `ModuleName`, and `code` is uniq code for the module. `codespace` and `code` pair uniq for the whole app. You can find the error description in source code. Usualy all the error of the module are [placed](https://github.com/CosmWasm/wasmd/blob/5f444cd9d393513e534cbfa9a0e938295c4e84e1/x/wasm/types/errors.go#L25) in `x/<module>/types/errors.go` where `module` is the module where the error was thrown

## Relaying

Expand Down