Skip to content

Commit

Permalink
update ibc_source_channel description
Browse files Browse the repository at this point in the history
  • Loading branch information
@smk762
smk762 committed Nov 13, 2024
1 parent 5f9682b commit 9c28a90
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions src/pages/komodo-defi-framework/api/v20/withdraw/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ This method generates a raw transaction which should then be broadcast using [se

## Arguments

| Structure | Type | Description |
| -------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| coin | string | The name of the coin the user desires to withdraw. |
| to | string | Coins are withdrawn to this address. |
| amount | string (numeric) | The amount the user desires to withdraw, ignored when `max=true`. |
| memo | string | Optional. Adds a transaction memo for compatible coins (e.g. Tendermint ecosystem). |
| max | bool | Optional. Withdraw the maximum available amount. |
| fee | object | Optional. A standard [FeeInfo](/komodo-defi-framework/api/v20/#fee-info) object. |
| from | object | HD wallets only. A standard [WithdrawFromInfo](/komodo-defi-framework/api/v20/#withdraw-from-info) object. |
| ibc\_source\_channel | string | Optional, [IBC](https://tutorials.cosmos.network/academy/3-ibc/1-what-is-ibc.html) coins only. The source channel for the IBC transaction. This is only required if the \['chain\_registry\_name`value](https://github.com/KomodoPlatform/coins/blob/14bfd0ab59118ea1048eaaffba14f3270b2ab17b/coins#L14654) is not present in your`coins\` file. |
| Structure | Type | Description |
| -------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| coin | string | The name of the coin the user desires to withdraw. |
| to | string | Coins are withdrawn to this address. |
| amount | string (numeric) | The amount the user desires to withdraw, ignored when `max=true`. |
| memo | string | Optional. Adds a transaction memo for compatible coins (e.g. Tendermint ecosystem). |
| max | bool | Optional. Withdraw the maximum available amount. |
| fee | object | Optional. A standard [FeeInfo](/komodo-defi-framework/api/v20/#fee-info) object. |
| from | object | HD wallets only. A standard [WithdrawFromInfo](/komodo-defi-framework/api/v20/#withdraw-from-info) object. |
| ibc\_source\_channel | string | Tendermint IBC transfers only. The source channel for the [IBC](https://tutorials.cosmos.network/academy/3-ibc/1-what-is-ibc.html) transaction. |

### Response

Expand Down Expand Up @@ -590,8 +590,7 @@ Using the Cosmos [Ecosystem IBC protocol](https://everstake.one/blog/cosmos-ibc-
</CodeGroup>

<Note>
Though the `ibc_source_channel` is optional, the default may not always be functional. It is recommended to provide the source channel where possible.
For more information, see our guide to [finding the right IBC channel](/komodo-wallet/guides/how-to-find-the-right-ibc-channel-for-transfers/).
The `ibc_source_channel` value above is for demonstration only. For more information regarding how to set a valid value, see our guide to [finding the right IBC channel](/komodo-wallet/guides/how-to-find-the-right-ibc-channel-for-transfers/).
</Note>

<CollapsibleSection expandedText="Hide Response" collapsedText="Show Response">
Expand Down

0 comments on commit 9c28a90

Please sign in to comment.