Skip to content

Commit

Permalink
Merge pull request #288 from KomodoPlatform/lint-fix-patches/add/ibc_…
Browse files Browse the repository at this point in the history 
…withdraw
  • Loading branch information
@gcharang
gcharang committed Jul 17, 2024
2 parents d94622a + a0ec58f commit f40c9a2
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 23 deletions.
1 change: 1 addition & 0 deletions filepathSlugs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3090,6 +3090,7 @@
"response-success-6",
"withdraw-qrc-20-coins-with-gas-limit",
"withdraw-tendermint-coins-with-a-memo-and-custom-gas-fee",
"withdraw-tendermint-ibc-coins",
"error-responses",
"invalid-request-unknown-fee-type",
"invalid-request-wrong-parameter-type",
Expand Down
45 changes: 22 additions & 23 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 | Withdraw the maximum available amount |
| fee | object | 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 | Withdraw the maximum available amount |
| fee | object | 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. |

### Response

Expand All @@ -45,7 +45,7 @@ This method generates a raw transaction which should then be broadcast using [se
<CodeGroup title="Withdraw" tag="POST" label="withdraw" mm2MethodDecorate="true">
```json
{
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"mmrpc": "2.0",
"method": "withdraw",
"params": {
Expand Down Expand Up @@ -94,7 +94,7 @@ This method generates a raw transaction which should then be broadcast using [se
<CodeGroup title="Withdraw" tag="POST" label="withdraw" mm2MethodDecorate="true">
```json
{
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"mmrpc": "2.0",
"method": "withdraw",
"params": {
Expand Down Expand Up @@ -123,7 +123,7 @@ This method generates a raw transaction which should then be broadcast using [se
<CodeGroup title="Withdraw" tag="POST" label="withdraw" mm2MethodDecorate="true">
```json
{
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"mmrpc": "2.0",
"method": "withdraw",
"params": {
Expand Down Expand Up @@ -155,7 +155,7 @@ This method generates a raw transaction which should then be broadcast using [se
```json
{
"mmrpc": "2.0",
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"method": "withdraw",
"params": {
"coin": "DOC",
Expand Down Expand Up @@ -206,7 +206,7 @@ This method generates a raw transaction which should then be broadcast using [se
```json
{
"mmrpc": "2.0",
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"method": "withdraw",
"params": {
"coin": "DOC",
Expand Down Expand Up @@ -257,7 +257,7 @@ This method generates a raw transaction which should then be broadcast using [se
```json
{
"mmrpc": "2.0",
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"method": "withdraw",
"params": {
"coin": "ETH",
Expand Down Expand Up @@ -305,7 +305,7 @@ This method generates a raw transaction which should then be broadcast using [se
```json
{
"mmrpc": "2.0",
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"method": "withdraw",
"params": {
"coin": "COIN_NAME",
Expand Down Expand Up @@ -360,7 +360,7 @@ This method generates a raw transaction which should then be broadcast using [se
```json
{
"mmrpc": "2.0",
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"method": "withdraw",
"params": {
"coin": "ETH",
Expand Down Expand Up @@ -408,7 +408,7 @@ This method generates a raw transaction which should then be broadcast using [se
```json
{
"mmrpc": "2.0",
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"method": "withdraw",
"params": {
"coin": "QRC20",
Expand Down Expand Up @@ -458,7 +458,7 @@ This method generates a raw transaction which should then be broadcast using [se
```json
{
"mmrpc": "2.0",
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"method": "withdraw",
"params": {
"coin": "QRC20",
Expand Down Expand Up @@ -511,7 +511,7 @@ This method generates a raw transaction which should then be broadcast using [se
```json
{
"mmrpc": "2.0",
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"method": "withdraw",
"params": {
"coin": "IRIS",
Expand Down Expand Up @@ -562,14 +562,13 @@ This method generates a raw transaction which should then be broadcast using [se
You can see the memo is included on the [block explorer](https://irishub.iobscan.io/#/txs/E00982A2A8442D7140916A34E29E287A0B1CBB4B38940372D1966BA7ACDE5BD6)
</CollapsibleSection>


##### Withdraw Tendermint IBC coins

<CodeGroup title="Withdraw" tag="POST" label="withdraw" mm2MethodDecorate="true">
```json
{
"mmrpc": "2.0",
"userpass": "'$userpass'",
"userpass": "RPC_UserP@SSW0RD",
"method": "withdraw",
"params": {
"coin": "ATOM-IBC_NUCLEUSTEST",
Expand Down

0 comments on commit f40c9a2

Please sign in to comment.