docs: update transfer docs with support for path forwarding #6813
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
crodriguezvega
requested review from
colin-axner,
AdityaSripal,
damiannolan,
chatton,
DimitrisJim and
srdtrk
as code owners
crodriguezvega
commented
Jul 12, 2024
| | ibc_transfer | receiver | \{receiver\} | | ||
| | ibc_transfer | tokens | \{jsonTokens\} | | ||
| | ibc_transfer | memo | \{memo\} | | ||
| | ibc_transfer | forwarding_hops | `nil` | |
There was a problem hiding this comment.
Set value to nil since forwarding is not supported in v1, but the attribute will still be emitted.
Comment on lines
+8
to
+10
| :::warning | ||
| This document is relevant only for fungible token transfers over channels on v1 of the ICS-20 protocol. | ||
| ::: |
There was a problem hiding this comment.
Adding a warning here on the top of each document in the ICS20 v1 folder.
Comment on lines
+34
to
+49
| #### `transfer` | ||
|
|
||
| The `transfer` command allows users to execute cross-chain token transfers from the source port ID and channel ID on the sending chain. | ||
|
|
||
| ```shell | ||
| simd tx ibc-transfer transfer [src-port] [src-channel] [receiver] [coins] [flags] | ||
| ``` | ||
|
|
||
| The `coins` parameter accepts the amount and denomination (e.g. `100uatom`) of the tokens to be transferred. | ||
|
|
||
| The additional flags that can be used with the command are: | ||
|
|
||
| - `--packet-timeout-height` to specify the timeout block height in the format `{revision}-{height}`. The default value is `0-0`, which effectively disables the timeout. Timeout height can only be absolute, therefore this option must be used in combination with `--absolute-timeouts` set to true. | ||
| - `--packet-timeout-timestamp` to specify the timeout timestamp in nanoseconds. The timeout can be either relative (fromthe current UTC time) or absolute. The default value is 10 minutes (and thus relative). The timeout is disabled when set to 0. | ||
| - `--absolute-timeouts` to interpret the timeout timestamp as an aboslute value (when set to true). The default value is false (and thus the timeout timeout is considered relative to current UTC time). | ||
| - `--memo` to specify the memo string to be sent along with the transfer packet. If forwarding is used, then the memo string will be carried through the intermediary chains to the final destination. |
There was a problem hiding this comment.
This was not present before, I added it now.
DimitrisJim
approved these changes
Jul 12, 2024
Co-authored-by: DimitrisJim <[email protected]>
…t-for-path-forwarding
chatton
approved these changes
Jul 15, 2024
There was a problem hiding this comment.
LGTM! Looks great and really in depth, thank you @crodriguezvega 🥇
| final destination. For example, given the topology below, with 3 chains and a transfer channel between | ||
| chains A and B and between chains B and C: | ||
|
|
||
|  |
There was a problem hiding this comment.
was not expected to have multiple options based on light/dark mode :D
| pairs of destination port ID, channel ID that are added on every chain where the tokens are received. | ||
|
|
||
| Please note that unwinding of vouchers is only allowed when vouchers of a single IBC denomination are | ||
| transferred (i.e. it is not possible to unwind vouchers of two different IBC denominations, since they |
There was a problem hiding this comment.
[nit] technically they could have the same path if you were to have multiple native denoms on a chain.
|
I will merge this one now, and open a PR to update when #6841 is merged (or I can update the docs there as well). |
…t-for-path-forwarding
crodriguezvega
deleted the
carlos/6608-update-transfer-docs-with-support-for-path-forwarding
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The docs as they were pre-ICS20v2 have been moved to the ICS20 v1 folder.
closes: #6608
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/).godoccomments.Files changedin the GitHub PR explorer.SonarCloud Reportin the comment section below once CI passes.