Skip to content

Commit

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

* docs: update transfer cli docs

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

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

---------

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
(cherry picked from commit 60b9af6)

# Conflicts:
#	docs/docs/02-apps/01-transfer/09-client.md

* remove docs

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
  • Loading branch information
mergify[bot] and crodriguezvega committed Aug 22, 2024
1 parent 85a78ad commit 84ee680
Showing 1 changed file with 4 additions and 4 deletions.
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 84ee680

Please sign in to comment.