Skip to content

Commit

Permalink
docs: update transfer cli docs (#7113)
Browse files Browse the repository at this point in the history
* docs: update transfer cli docs

* Update docs/docs/02-apps/01-transfer/09-client.md

Co-authored-by: DimitrisJim <[email protected]>

---------

Co-authored-by: DimitrisJim <[email protected]>
  • Loading branch information
crodriguezvega and DimitrisJim authored Aug 21, 2024
1 parent c832bee commit 60b9af6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/docs/02-apps/01-transfer/09-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The additional flags that can be used with the command are:
- `--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.
- `--forwarding` to specify forwarding information in the form of a comma separated list of source port ID/channel ID pairs at each intermediary chain (e.g. `transfer/channel-0,transfer/channel-1`).
- `--unwind` to specify if the tokens must be automatically unwound to there origin chain. This option can be used in combination with `--forwarding` to forward the tokens to the final destination after unwinding. When this flag is true, the `coins` option must specify a single coin.
- `--unwind` to specify if the tokens must be automatically unwound to there origin chain. This option can be used in combination with `--forwarding` to forward the tokens to the final destination after unwinding. When this flag is true, the tokens specified in the `coins` option must all have the same denomination trace path (i.e. all tokens must be IBC vouchers sharing exactly the same set of destination port/channel IDs in their denomination trace path). Arguments `[src-port]` and `[src-channel]` must not be passed if the `--unwind` flag is specified.

#### `total-escrow`

Expand Down
8 changes: 4 additions & 4 deletions modules/apps/transfer/client/cli/tx.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ packet if the coins list is a comma-separated string (e.g. 100uatom,100uosmo). T
Timeout height can be set by passing in the height string in the form {revision}-{height} using the {packet-timeout-height} flag.
Note, relative timeout height is not supported. Relative timeout timestamp is added to the value of the user's local system clock time
using the {packet-timeout-timestamp} flag. If no timeout value is set then a default relative timeout value of 10 minutes is used. IBC tokens
can be automatically unwound to their native chain using the {unwind} flag. Please note that if the {unwind} flag is used, then the transfer should contain only
a single token and the src-port and src-channel arguments must not be specified. Tokens can also be automatically forwarded through multiple chains using the {fowarding} flag and specifying
a comma-separated list of source portID/channelID pairs for each intermediary chain. {unwind} and {forwarding} flags can be used together
to first unwind IBC tokens to their native chain and then forward them to the final destination.`),
can be automatically unwound to their native chain using the {unwind} flag. Please note that if the {unwind} flag is used, then all coins must
be IBC vouchers and share exactly the same denomination trace path, and the src-port and src-channel arguments must not be specified. Tokens can also be
automatically forwarded through multiple chains using the {fowarding} flag and specifying a comma-separated list of source portID/channelID pairs for
each intermediary chain. {unwind} and {forwarding} flags can be used together to first unwind IBC tokens to their native chain and then forward them to the final destination.`),
Example: fmt.Sprintf("%s tx ibc-transfer transfer [src-port] [src-channel] [receiver] [coins]", version.AppName),
Args: cobra.RangeArgs(2, 4),
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down

0 comments on commit 60b9af6

Please sign in to comment.