add ibc withdraw method

KomodoPlatform · Jul 17, 2024 · d94622a · d94622a
1 parent 93005f9
commit d94622a
Showing 1 changed file with 44 additions and 11 deletions.
diff --git a/src/pages/komodo-defi-framework/api/v20/withdraw/index.mdx b/src/pages/komodo-defi-framework/api/v20/withdraw/index.mdx
@@ -18,6 +18,7 @@ This method generates a raw transaction which should then be broadcast using [se
 | 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
 
@@ -44,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": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "mmrpc": "2.0",
     "method": "withdraw",
     "params": {
@@ -93,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": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "mmrpc": "2.0",
     "method": "withdraw",
     "params": {
@@ -122,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": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "mmrpc": "2.0",
     "method": "withdraw",
     "params": {
@@ -154,7 +155,7 @@ This method generates a raw transaction which should then be broadcast using [se
   ```json
   {
     "mmrpc": "2.0",
-    "userpass": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "method": "withdraw",
     "params": {
       "coin": "DOC",
@@ -205,7 +206,7 @@ This method generates a raw transaction which should then be broadcast using [se
   ```json
   {
     "mmrpc": "2.0",
-    "userpass": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "method": "withdraw",
     "params": {
       "coin": "DOC",
@@ -256,7 +257,7 @@ This method generates a raw transaction which should then be broadcast using [se
   ```json
   {
     "mmrpc": "2.0",
-    "userpass": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "method": "withdraw",
     "params": {
       "coin": "ETH",
@@ -304,7 +305,7 @@ This method generates a raw transaction which should then be broadcast using [se
   ```json
   {
     "mmrpc": "2.0",
-    "userpass": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "method": "withdraw",
     "params": {
       "coin": "COIN_NAME",
@@ -359,7 +360,7 @@ This method generates a raw transaction which should then be broadcast using [se
   ```json
   {
     "mmrpc": "2.0",
-    "userpass": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "method": "withdraw",
     "params": {
       "coin": "ETH",
@@ -407,7 +408,7 @@ This method generates a raw transaction which should then be broadcast using [se
   ```json
   {
     "mmrpc": "2.0",
-    "userpass": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "method": "withdraw",
     "params": {
       "coin": "QRC20",
@@ -457,7 +458,7 @@ This method generates a raw transaction which should then be broadcast using [se
   ```json
   {
     "mmrpc": "2.0",
-    "userpass": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "method": "withdraw",
     "params": {
       "coin": "QRC20",
@@ -510,7 +511,7 @@ This method generates a raw transaction which should then be broadcast using [se
   ```json
   {
     "mmrpc": "2.0",
-    "userpass": "RPC_UserP@SSW0RD",
+    "userpass": "'$userpass'",
     "method": "withdraw",
     "params": {
       "coin": "IRIS",
@@ -561,6 +562,38 @@ 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'",
+    "method": "withdraw",
+    "params": {
+      "coin": "ATOM-IBC_NUCLEUSTEST",
+      "to": "nuc16ggf7pmy0w0glzyrgd2x9mlw92csw6d9yj2qvg",
+      "amount": 0.1,
+      "memo": "In the blackest of your moments, wait with no fear.",
+      "fee": {
+        "type": "CosmosGas",
+        "gas_price": 0.05,
+        "gas_limit": 150000
+      }
+    },
+    "id": 0
+  }
+  ```
+</CodeGroup>
+
+<CollapsibleSection expandedText="Hide Response" collapsedText="Show Response">
+  ```json
+  ```
+
+  You can see the memo is included on the [block explorer](https://irishub.iobscan.io/#/txs/E00982A2A8442D7140916A34E29E287A0B1CBB4B38940372D1966BA7ACDE5BD6)
+</CollapsibleSection>
+
 ### Error Responses
 
 #### InvalidRequest: Unknown fee type