diff --git a/data-for-gpts/all-content.txt b/data-for-gpts/all-content.txt index ae2eb7fb..61ae7725 100644 --- a/data-for-gpts/all-content.txt +++ b/data-for-gpts/all-content.txt @@ -31149,11 +31149,11 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig "rpc_data": { "electrum_servers": [ { - "url":"zombie.dragonhound.info:10033" + "url":"zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] }, "sync_params": { @@ -44371,16 +44371,16 @@ Params](https://forum.komodoplatform.com/t/installing-zcash-params/603) "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" }, { - "url": "zombie.dragonhound.info:20033", + "url": "zombie.dragonhound.info:20133", "protocol": "SSL", - "ws_url": "zombie.dragonhound.info:30058" + "ws_url": "zombie.dragonhound.info:30059" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] } }, @@ -44407,11 +44407,11 @@ Params](https://forum.komodoplatform.com/t/installing-zcash-params/603) "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": { "height": 2528700 @@ -44443,16 +44443,16 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" }, { - "url": "zombie.dragonhound.info:20033", + "url": "zombie.dragonhound.info:20133", "protocol": "SSL", - "ws_url": "zombie.dragonhound.info:30058" + "ws_url": "zombie.dragonhound.info:30059" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": "earliest" } @@ -44488,7 +44488,7 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": { "date": 1672704000 @@ -44968,11 +44968,11 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig "rpc_data": { "electrum_servers": [ { - "url":"zombie.dragonhound.info:10033" + "url":"zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] }, "sync_params": { diff --git a/data-for-gpts/komodefi-api/all-api-content.txt b/data-for-gpts/komodefi-api/all-api-content.txt index 6838baee..61f50207 100644 --- a/data-for-gpts/komodefi-api/all-api-content.txt +++ b/data-for-gpts/komodefi-api/all-api-content.txt @@ -73,11 +73,11 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig "rpc_data": { "electrum_servers": [ { - "url":"zombie.dragonhound.info:10033" + "url":"zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] }, "sync_params": { @@ -13295,16 +13295,16 @@ Params](https://forum.komodoplatform.com/t/installing-zcash-params/603) "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" }, { - "url": "zombie.dragonhound.info:20033", + "url": "zombie.dragonhound.info:20133", "protocol": "SSL", - "ws_url": "zombie.dragonhound.info:30058" + "ws_url": "zombie.dragonhound.info:30059" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] } }, @@ -13331,11 +13331,11 @@ Params](https://forum.komodoplatform.com/t/installing-zcash-params/603) "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": { "height": 2528700 @@ -13367,16 +13367,16 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" }, { - "url": "zombie.dragonhound.info:20033", + "url": "zombie.dragonhound.info:20133", "protocol": "SSL", - "ws_url": "zombie.dragonhound.info:30058" + "ws_url": "zombie.dragonhound.info:30059" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": "earliest" } @@ -13412,7 +13412,7 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": { "date": 1672704000 @@ -13892,11 +13892,11 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig "rpc_data": { "electrum_servers": [ { - "url":"zombie.dragonhound.info:10033" + "url":"zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] }, "sync_params": { diff --git a/data-for-gpts/komodefi-api/v20-api-content.txt b/data-for-gpts/komodefi-api/v20-api-content.txt index 5f068f4a..47d8b3e1 100644 --- a/data-for-gpts/komodefi-api/v20-api-content.txt +++ b/data-for-gpts/komodefi-api/v20-api-content.txt @@ -1979,16 +1979,16 @@ Params](https://forum.komodoplatform.com/t/installing-zcash-params/603) "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" }, { - "url": "zombie.dragonhound.info:20033", + "url": "zombie.dragonhound.info:20133", "protocol": "SSL", - "ws_url": "zombie.dragonhound.info:30058" + "ws_url": "zombie.dragonhound.info:30059" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] } }, @@ -2015,11 +2015,11 @@ Params](https://forum.komodoplatform.com/t/installing-zcash-params/603) "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": { "height": 2528700 @@ -2051,16 +2051,16 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" }, { - "url": "zombie.dragonhound.info:20033", + "url": "zombie.dragonhound.info:20133", "protocol": "SSL", - "ws_url": "zombie.dragonhound.info:30058" + "ws_url": "zombie.dragonhound.info:30059" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": "earliest" } @@ -2096,7 +2096,7 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": { "date": 1672704000 @@ -2576,11 +2576,11 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig "rpc_data": { "electrum_servers": [ { - "url":"zombie.dragonhound.info:10033" + "url":"zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] }, "sync_params": { diff --git a/data-for-gpts/komodo-defi-framework-content.txt b/data-for-gpts/komodo-defi-framework-content.txt index ddeb7f0c..42fdb382 100644 --- a/data-for-gpts/komodo-defi-framework-content.txt +++ b/data-for-gpts/komodo-defi-framework-content.txt @@ -73,11 +73,11 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig "rpc_data": { "electrum_servers": [ { - "url":"zombie.dragonhound.info:10033" + "url":"zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] }, "sync_params": { @@ -13295,16 +13295,16 @@ Params](https://forum.komodoplatform.com/t/installing-zcash-params/603) "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" }, { - "url": "zombie.dragonhound.info:20033", + "url": "zombie.dragonhound.info:20133", "protocol": "SSL", - "ws_url": "zombie.dragonhound.info:30058" + "ws_url": "zombie.dragonhound.info:30059" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] } }, @@ -13331,11 +13331,11 @@ Params](https://forum.komodoplatform.com/t/installing-zcash-params/603) "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": { "height": 2528700 @@ -13367,16 +13367,16 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" }, { - "url": "zombie.dragonhound.info:20033", + "url": "zombie.dragonhound.info:20133", "protocol": "SSL", - "ws_url": "zombie.dragonhound.info:30058" + "ws_url": "zombie.dragonhound.info:30059" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": "earliest" } @@ -13412,7 +13412,7 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": { "date": 1672704000 @@ -13892,11 +13892,11 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig "rpc_data": { "electrum_servers": [ { - "url":"zombie.dragonhound.info:10033" + "url":"zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] }, "sync_params": { diff --git a/filepathSlugs.json b/filepathSlugs.json index 2ae2cd94..efbf19db 100644 --- a/filepathSlugs.json +++ b/filepathSlugs.json @@ -2006,20 +2006,20 @@ ], "src/pages/komodo-defi-framework/api/common_structures/activation/index.mdx": [ "activation-structures", - "activation-params", + "account-address-info", "activation-mode", + "activation-params", "activation-rpc-data", "activation-servers", "zhtlc-example", "hd-utxo-activation-v2", + "address-derivation-path", + "address-info", + "example-with-balances", + "example-without-balances", "coin-protocol", "coin-protocol-data", "evm-node", - "v2-1-0-current-release", - "v2-2-0", - "tendermint-node", - "v2-1-0-current-release-2", - "v2-2-0-2", "swap-v2-contracts", "tokens-request", "utxo-merge-params" @@ -2028,10 +2028,7 @@ "komodo-de-fi-sdk-common-structures", "address-format", "example", - "address-info", - "example-with-balances", - "example-without-balances", - "balance-infos", + "balance-info", "derivation-method", "event-stream-config", "numeric-formats-value", @@ -2173,9 +2170,16 @@ ], "src/pages/komodo-defi-framework/api/common_structures/wallet/index.mdx": [ "wallet-operations-structures", - "raw-tx-info", + "history-target", + "example", "input-txns", - "pay-for-gas" + "new-address-info", + "pay-for-gas", + "raw-tx-info", + "scan-addresses-info", + "wallet-balance-info", + "withdraw-from-info", + "wallet-account-info" ], "src/pages/komodo-defi-framework/api/index.mdx": [ "komodo-de-fi-framework-rpc-methods" @@ -2792,12 +2796,10 @@ "request-parameters", "response-parameters", "examples", - "request-using-rpc-urls-parameter-kdf-version-2-2-0", - "response", "request-with-get-balances-set-to-false", + "response", + "request-with-get-balances-as-true", "response-2", - "request-using-nodes-parameter-kdf-version-2-2-0", - "response-3", "error-types", "platform-config-is-not-found-error", "platform-is-already-activated-error", @@ -2872,6 +2874,7 @@ "response-activating-coin-enabling-has-started", "response-updating-blocks-cache", "response-building-wallet-db", + "response-complete", "response-coin-creation-error-no-zcash-params", "response-error-no-such-task", "response-error-invalid-request", @@ -2896,45 +2899,6 @@ "response-success-2", "response-error-2", "common-komodo-de-fi-sdk-request-response-objects", - "activation-params", - "activation-mode", - "activation-rpc-data", - "activation-servers", - "zhtlc-example", - "hd-utxo-activation-v2", - "hd-utxo-activation-v2-2", - "address-derivation-path", - "address-infos", - "example-with-balances", - "example-without-balances", - "balance-info", - "derivation-method", - "coin-protocol", - "coin-protocol-data", - "confirmation-targets", - "counterparty-channel-config", - "fee-info", - "lightning-activation-params", - "lightning-channel-amount", - "lightning-channel-config", - "lightning-channel-options", - "lightning-closed-channels-filter", - "lightning-open-channels-filter", - "lightning-payment", - "lightning-payment-filter", - "lightning-payment-type", - "pagination", - "example", - "history-target", - "example-2", - "tokens-request", - "wallet-balance-info", - "withdraw-from-info", - "fee-info-2", - "scan-addresses-info", - "new-address-info", - "wallet-account-info", - "account-address-info", "error-types", "not-sufficient-balance", "response-not-sufficient-balance-error", diff --git a/postman/collections/komodo_defi.postman_collection.json b/postman/collections/komodo_defi.postman_collection.json index 6db1efd6..3916ac2b 100644 --- a/postman/collections/komodo_defi.postman_collection.json +++ b/postman/collections/komodo_defi.postman_collection.json @@ -238,8 +238,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -2671,8 +2671,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -2726,8 +2726,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -4596,16 +4596,66 @@ ], "body": { "mode": "raw", - "raw": "{\r\n \"userpass\": \"{{userpass}}\",\r\n \"mmrpc\": \"2.0\",\r\n \"method\": \"task::enable_z_coin::init\",\r\n \"params\": {\r\n \"ticker\": \"ZOMBIE\",\r\n \"activation_params\": {\r\n \"mode\": {\r\n \"rpc\": \"Light\", // Accepted values: \"Native\", \"Light\"\r\n \"rpc_data\": {\r\n \"electrum_servers\": [\r\n {\r\n \"url\": \"zombie.dragonhound.info:10033\"\r\n // \"protocol\": \"TCP\" // Accepted values: \"TCP\", \"SSL\", \"WS\", \"WSS\"\r\n // \"disable_cert_verification\": false\r\n }\r\n ],\r\n \"light_wallet_d_servers\": [\r\n \"http://zombie.sirseven.me:443\",\r\n \"http://zombie.dragonhound.info:443\"\r\n ]\r\n } // Required only if: \"rpc\": \"Light\"\r\n }\r\n // \"required_confirmations\": 1, // Default: Coin Config\r\n // \"requires_notarization\": false, // Default: Coin Config\r\n }\r\n }\r\n // \"id\": null // Accepted values: Integers\r\n}" + "raw": "{\r\n \"userpass\": \"{{userpass}}\",\r\n \"mmrpc\": \"2.0\",\r\n \"method\": \"task::enable_z_coin::init\",\r\n \"params\": {\r\n \"ticker\": \"ZOMBIE\",\r\n \"activation_params\": {\r\n \"mode\": {\r\n \"rpc\": \"Light\", // Accepted values: \"Native\", \"Light\"\r\n \"rpc_data\": {\r\n \"electrum_servers\": [\r\n {\r\n \"url\": \"zombie.dragonhound.info:10133\"\r\n // \"protocol\": \"TCP\" // Accepted values: \"TCP\", \"SSL\", \"WS\", \"WSS\"\r\n // \"disable_cert_verification\": false\r\n }\r\n ],\r\n \"light_wallet_d_servers\": [\r\n \"http://zombie.sirseven.me:443\",\r\n \"http://zombie.dragonhound.info:1443\"\r\n ]\r\n } // Required only if: \"rpc\": \"Light\"\r\n }\r\n // \"required_confirmations\": 1, // Default: Coin Config\r\n // \"requires_notarization\": false, // Default: Coin Config\r\n }\r\n }\r\n // \"id\": null // Accepted values: Integers\r\n}" }, "url": { "raw": "{{address}}", "host": [ "{{address}}" ] - } + }, + "description": "``` json\n{\n \"mmrpc\": \"\",\n \"result\": {\n \"task_id\": 0\n },\n \"id\": null\n}\n\n ```\n\n[https://komodoplatform.com/en/docs/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_z_coin/](https://komodoplatform.com/en/docs/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_z_coin/)" }, - "response": [] + "response": [ + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"userpass\": \"{{userpass}}\",\r\n \"mmrpc\": \"2.0\",\r\n \"method\": \"task::enable_z_coin::init\",\r\n \"params\": {\r\n \"ticker\": \"ZOMBIE\",\r\n \"activation_params\": {\r\n \"mode\": {\r\n \"rpc\": \"Light\", // Accepted values: \"Native\", \"Light\"\r\n \"rpc_data\": {\r\n \"electrum_servers\": [\r\n {\r\n \"url\": \"zombie.dragonhound.info:10133\"\r\n // \"protocol\": \"TCP\" // Accepted values: \"TCP\", \"SSL\", \"WS\", \"WSS\"\r\n // \"disable_cert_verification\": false\r\n }\r\n ],\r\n \"light_wallet_d_servers\": [\r\n \"http://zombie.sirseven.me:443\",\r\n \"http://zombie.dragonhound.info:1443\"\r\n ]\r\n } // Required only if: \"rpc\": \"Light\"\r\n }\r\n // \"required_confirmations\": 1, // Default: Coin Config\r\n // \"requires_notarization\": false, // Default: Coin Config\r\n }\r\n }\r\n // \"id\": null // Accepted values: Integers\r\n}" + }, + "url": { + "raw": "{{address}}", + "host": [ + "{{address}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "access-control-allow-origin", + "value": "http://localhost:3000" + }, + { + "key": "content-length", + "value": "48" + }, + { + "key": "date", + "value": "Wed, 05 Feb 2025 05:20:45 GMT" + }, + { + "key": "Content-Type", + "value": "application/json", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "{\n \"mmrpc\": \"2.0\",\n \"result\": {\n \"task_id\": 0\n },\n \"id\": null\n}" + } + ] }, { "name": "task::enable_z_coin::status", @@ -4620,7 +4670,8 @@ "\r", "pm.request.body.update(strippedData);" ], - "type": "text/javascript" + "type": "text/javascript", + "packages": {} } } ], @@ -4635,7 +4686,7 @@ ], "body": { "mode": "raw", - "raw": "{\r\n \"userpass\": \"{{userpass}}\",\r\n \"mmrpc\": \"2.0\",\r\n \"method\": \"task::enable_z_coin::status\",\r\n \"params\": {\r\n \"task_id\": 0\r\n // \"forget_if_finished\": true\r\n }\r\n // \"id\": null // Accepted values: Integers\r\n}\r\n" + "raw": "{\r\n \"userpass\": \"{{userpass}}\",\r\n \"mmrpc\": \"2.0\",\r\n \"method\": \"task::enable_z_coin::status\",\r\n \"params\": {\r\n \"task_id\": 1\r\n // \"forget_if_finished\": true\r\n }\r\n // \"id\": null // Accepted values: Integers\r\n}\r\n" }, "url": { "raw": "{{address}}", @@ -4644,7 +4695,141 @@ ] } }, - "response": [] + "response": [ + { + "name": "Error: ZCashParamsNotFound", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"userpass\": \"{{userpass}}\",\r\n \"mmrpc\": \"2.0\",\r\n \"method\": \"task::enable_z_coin::status\",\r\n \"params\": {\r\n \"task_id\": 0\r\n // \"forget_if_finished\": true\r\n }\r\n // \"id\": null // Accepted values: Integers\r\n}\r\n" + }, + "url": { + "raw": "{{address}}", + "host": [ + "{{address}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "plain", + "header": [ + { + "key": "access-control-allow-origin", + "value": "http://localhost:3000" + }, + { + "key": "content-length", + "value": "336" + }, + { + "key": "date", + "value": "Wed, 05 Feb 2025 05:27:16 GMT" + } + ], + "cookie": [], + "body": "{\"mmrpc\":\"2.0\",\"result\":{\"status\":\"Error\",\"details\":{\"error\":\"Error on platform coin ZOMBIE creation: ZCashParamsNotFound\",\"error_path\":\"lib.z_coin_activation.z_coin\",\"error_trace\":\"lib:104] z_coin_activation:247] z_coin:1032]\",\"error_type\":\"CoinCreationError\",\"error_data\":{\"ticker\":\"ZOMBIE\",\"error\":\"ZCashParamsNotFound\"}}},\"id\":null}" + }, + { + "name": "Error: SPV Unavailable", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"userpass\": \"{{userpass}}\",\r\n \"mmrpc\": \"2.0\",\r\n \"method\": \"task::enable_z_coin::status\",\r\n \"params\": {\r\n \"task_id\": 1\r\n // \"forget_if_finished\": true\r\n }\r\n // \"id\": null // Accepted values: Integers\r\n}\r\n" + }, + "url": { + "raw": "{{address}}", + "host": [ + "{{address}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "plain", + "header": [ + { + "key": "access-control-allow-origin", + "value": "http://localhost:3000" + }, + { + "key": "content-length", + "value": "417" + }, + { + "key": "date", + "value": "Wed, 05 Feb 2025 05:44:43 GMT" + } + ], + "cookie": [], + "body": "{\"mmrpc\":\"2.0\",\"result\":{\"status\":\"Error\",\"details\":{\"error\":\"Error on platform coin ZOMBIE creation: All the current light clients are unavailable.\",\"error_path\":\"lib.z_coin_activation.z_coin.z_rpc\",\"error_trace\":\"lib:104] z_coin_activation:247] z_coin:925] z_rpc:524] z_rpc:191]\",\"error_type\":\"CoinCreationError\",\"error_data\":{\"ticker\":\"ZOMBIE\",\"error\":\"All the current light clients are unavailable.\"}}},\"id\":null}" + }, + { + "name": "Success", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"userpass\": \"{{userpass}}\",\r\n \"mmrpc\": \"2.0\",\r\n \"method\": \"task::enable_z_coin::status\",\r\n \"params\": {\r\n \"task_id\": 1\r\n // \"forget_if_finished\": true\r\n }\r\n // \"id\": null // Accepted values: Integers\r\n}\r\n" + }, + "url": { + "raw": "{{address}}", + "host": [ + "{{address}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "access-control-allow-origin", + "value": "http://localhost:3000" + }, + { + "key": "content-length", + "value": "361" + }, + { + "key": "date", + "value": "Mon, 10 Feb 2025 01:30:14 GMT" + }, + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": "", + "type": "text" + } + ], + "cookie": [], + "body": "{\n \"mmrpc\": \"2.0\",\n \"result\": {\n \"status\": \"Ok\",\n \"details\": {\n \"ticker\": \"ZOMBIE\",\n \"current_block\": 794431,\n \"wallet_balance\": {\n \"wallet_type\": \"Iguana\",\n \"address\": \"zs1e3puxpnal8ljjrqlxv4jctlyndxnm5a3mj5rarjvp0qv72hmm9caduxk9asu9kyc6erfx4zsauj\",\n \"balance\": {\n \"spendable\": \"0\",\n \"unspendable\": \"0\"\n }\n },\n \"first_sync_block\": {\n \"requested\": 792991,\n \"is_pre_sapling\": false,\n \"actual\": 792991\n }\n }\n },\n \"id\": null\n}" + } + ] }, { "name": "task::enable_z_coin::user_action", @@ -5630,8 +5815,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -5726,8 +5911,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -5781,8 +5966,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -5836,8 +6021,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -5891,8 +6076,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -5946,8 +6131,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -6001,8 +6186,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -6225,7 +6410,7 @@ "{{address}}" ] }, - "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#get-a-list-of-nfts](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#get-a-list-of-nfts)" + "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#get-a-list-of-nfts](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#get-a-list-of-nfts)" }, "response": [ { @@ -6248,7 +6433,7 @@ "{{address}}" ] }, - "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#get-a-list-of-nfts](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#get-a-list-of-nfts)" + "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#get-a-list-of-nfts](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#get-a-list-of-nfts)" }, "_postman_previewlanguage": "JSON", "header": [], @@ -6275,7 +6460,7 @@ "{{address}}" ] }, - "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#get-a-list-of-nfts](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#get-a-list-of-nfts)" + "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#get-a-list-of-nfts](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#get-a-list-of-nfts)" }, "_postman_previewlanguage": "JSON", "header": [], @@ -6316,7 +6501,7 @@ "{{address}}" ] }, - "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#get-a-list-of-nft-transfers](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#get-a-list-of-nft-transfers)" + "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#get-a-list-of-nft-transfers](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#get-a-list-of-nft-transfers)" }, "response": [] }, @@ -6352,7 +6537,7 @@ "{{address}}" ] }, - "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#get-nft-metadata](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#get-nft-metadata)" + "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#get-nft-metadata](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#get-nft-metadata)" }, "response": [] }, @@ -6388,7 +6573,7 @@ "{{address}}" ] }, - "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#refresh-nft-metadata](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#refresh-nft-metadata)" + "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#refresh-nft-metadata](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#refresh-nft-metadata)" }, "response": [] }, @@ -6425,7 +6610,7 @@ "{{address}}" ] }, - "description": "DevDocs Link: [https://komodoplatform.com/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/update_nft/](https://komodoplatform.com/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/update_nft/)" + "description": "DevDocs Link: [https://komodoplatform.com/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/update_nft/](https://komodoplatform.com/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/update_nft/)" }, "response": [ { @@ -6503,7 +6688,7 @@ "{{address}}" ] }, - "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#withdraw-nfts](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#withdraw-nfts)" + "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#withdraw-nfts](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#withdraw-nfts)" }, "response": [] }, @@ -6539,7 +6724,7 @@ "{{address}}" ] }, - "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#erc-1155-withdraw-example](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/#erc-1155-withdraw-example)" + "description": "[https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#erc-1155-withdraw-example](https://nft-methods.komodo-docs-revamp-2023.pages.dev/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/#erc-1155-withdraw-example)" }, "response": [ { @@ -6603,7 +6788,7 @@ "{{address}}" ] }, - "description": "DevDocs Link: https://komodoplatform.com/en/docs/komodo-defi-framework/api/v20/non_fungible_tokens/clear_nft_db/" + "description": "DevDocs Link: https://komodoplatform.com/en/docs/komodo-defi-framework/api/v20-dev/non_fungible_tokens/clear_nft_db/" }, "response": [ { @@ -6899,8 +7084,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -7167,8 +7352,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -7863,8 +8048,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -8002,8 +8187,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -8057,8 +8242,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -8211,7 +8396,8 @@ "\r", "pm.request.body.update(strippedData);" ], - "type": "text/javascript" + "type": "text/javascript", + "packages": {} } } ], @@ -8250,7 +8436,8 @@ "\r", "pm.request.body.update(strippedData);" ], - "type": "text/javascript" + "type": "text/javascript", + "packages": {} } } ], @@ -8265,7 +8452,7 @@ ], "body": { "mode": "raw", - "raw": "{\r\n \"userpass\": \"{{userpass}}\",\r\n \"mmrpc\": \"2.0\",\r\n \"method\": \"task::withdraw::status\",\r\n \"params\": {\r\n \"task_id\": 0\r\n // \"forget_if_finished\": true\r\n }\r\n // \"id\": null // Accepted values: Integers\r\n}\r\n" + "raw": "{\r\n \"userpass\": \"{{userpass}}\",\r\n \"mmrpc\": \"2.0\",\r\n \"method\": \"task::withdraw::status\",\r\n \"params\": {\r\n \"task_id\": 0,\r\n \"forget_if_finished\": false\r\n }\r\n // \"id\": null // Accepted values: Integers\r\n}\r\n" }, "url": { "raw": "{{address}}", @@ -9067,8 +9254,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -9122,8 +9309,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -9177,8 +9364,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -9504,8 +9691,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -10753,8 +10940,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -12002,8 +12189,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -12608,8 +12795,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -12746,8 +12933,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], @@ -13316,8 +13503,8 @@ "header": [ { "key": "Content-Type", - "name": "Content-Type", "value": "application/json", + "name": "Content-Type", "type": "text" } ], diff --git a/src/pages/komodo-defi-framework/api/common_structures/activation/index.mdx b/src/pages/komodo-defi-framework/api/common_structures/activation/index.mdx index 57e97af8..9ebc8014 100644 --- a/src/pages/komodo-defi-framework/api/common_structures/activation/index.mdx +++ b/src/pages/komodo-defi-framework/api/common_structures/activation/index.mdx @@ -3,22 +3,78 @@ export const description = "The Komodo DeFi SDK uses a variety of activation met # Activation Structures +### AccountAddressInfo + +The `AccountAddressInfo` object includes the following items for active addresses in the activation response for a coin in HD mode: + +| Parameter | Type | Description | +| ---------------- | ------ | ----------------------------------------------------------------------------------------------------------- | +| address | string | The account address for a specific derivation path under the `account_index`. | +| derivation\_path | string | The [BIP44 derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) of the address. | +| chain | string | `External` or `Internal`, as defined in the activation request. | +| balance | object | A standard [balanceInfo](/komodo-defi-framework/api/common_structures/#balance-info) object. | + + + ```json + { + "address": "RXNtAyDSsY3DS3VxTpJegzoHU9bUX54j56", + "derivation_path": "m/44'/141'/0'/0/0", + "chain": "External", + "balance": { + "spendable": "7.64018255", + "unspendable": "0" + } + } + ``` + + +### ActivationMode + +Defines the activation mode for QTUM, BCH, UTXO & ZHTLC coins. + +| Parameter | Type | Description | +| --------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| rpc | string | `Native` if running a native blockchain node, `Electrum` if using electrum servers or `Light` for ZHTLC coins. | +| rpc\_data | object | `Electrum` or `Light` mode only. A standard [ActivationRpcData](/komodo-defi-framework/api/common_structures/activation/#activation-rpc-data) object. | + + + ```json + { + "mode": { + "rpc": "Electrum", + "rpc_data": { + "servers": [ + { + "url": "electrum1.cipig.net:10020" + }, + { + "url": "electrum2.cipig.net:10020" + } + ] + } + }, + } + ``` + + ### ActivationParams The `ActivationParams` object defines additional parameters used for activation. These params may vary depending on the coin type. -| Parameter | Type | Description | -| ---------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| required\_confirmations | integer | Optional. Confirmations to wait for steps in swap. Defaults to value in the coins file if not set. | -| requires\_notarization | boolean | Optional, defaults to `false`. For [dPoW](https://komodoplatform.com/en/blog/dpow-demystified/) protected coins, a `true` value will wait for transactions to be notarised when doing swaps. Overrides value if set in `coins` file. | -| priv\_key\_policy | string | Defaults to `ContextPrivKey`. Set as `Trezor` to activate in Trezor mode. | -| min\_addresses\_number | integer | HD wallets only. How many additional addreesses to generate at a minimum. | -| scan\_policy | string | HD wallets only. Whether or not to scan for new addresses. Select from `do_not_scan`, `scan_if_new_wallet` or `scan`. Note that `scan` will result in multple requests to the Komodo DeFi SDK. | -| gap\_limit | integer | HD wallets only. The max number of empty addresses in a row. If transactions were sent to an address outside the `gap_limit`, they will not be identified when scanning. | -| zcash\_params\_path | string | ZHTLC coins only. Path to folder containing Zcash parameters. Optional, defaults to standard location as defined in [this guide](https://forum.komodoplatform.com/t/installing-zcash-params/603) | -| scan\_blocks\_per\_iteration | integer | ZHTLC coins only. Sets the number of scanned blocks per iteration during `BuildingWalletDb` state. Optional, default value is 1000. | -| scan\_interval\_ms | integer | ZHTLC coins only. Sets the interval in milliseconds between iterations of `BuildingWalletDb` state. Optional, default value is 0. | -| mode | object | QTUM, UTXO & ZHTLC coins only. A standard [ActivationMode](/komodo-defi-framework/api/common_structures/activation/#activation-mode) object. | +| Parameter | Type | Description | +| ---------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| required\_confirmations | integer | Optional. Confirmations to wait for steps in swap. Defaults to value in the coins file if not set. | +| requires\_notarization | boolean | Optional, defaults to `false`. For [dPoW](https://komodoplatform.com/en/blog/dpow-demystified/) protected coins, a `true` value will wait for transactions to be notarised when doing swaps. Overrides value if set in `coins` file. | +| mode | object | QTUM, UTXO & ZHTLC coins only. A standard [ActivationMode](/komodo-defi-framework/api/common_structures/activation/#activation-mode) object. | +| zcash\_params\_path | string | ZHTLC coins only. Path to folder containing [Zcash parameters](https://z.cash/learn/). Optional, defaults to standard location as defined in [this guide](https://forum.komodoplatform.com/t/installing-zcash-params/603) | +| scan\_blocks\_per\_iteration | integer | ZHTLC coins only. Sets the number of scanned blocks per iteration during `BuildingWalletDb` state. Optional, default value is 1000. | +| scan\_interval\_ms | integer | ZHTLC coins only. Sets the interval in milliseconds between iterations of `BuildingWalletDb` state. Optional, default value is 0. | +| tx\_history | boolean | Optional. Enable transaction history scanning. When active, the Komodo DeFi Framework API will collect transaction history data for local storage, and allow use of the [my\_tx\_history (v2)](/komodo-defi-framework/api/v20/wallet/tx/my_tx_history/) method. | +| min\_addresses\_number | integer | Optional, HD wallets only. Number of addresses to generate. If not specified, addresses will be generated up to `path_to_address::address_index`. | +| scan\_policy | string | Optional, HD wallets only. Whether or not to scan for new addresses. Select from `do_not_scan`, `scan_if_new_wallet` or `scan`. Defaults to `scan_if_new_wallet`. Note that `scan` will result in multple requests to the Komodo DeFi API and may take some time to complete. | +| gap\_limit | integer | Optional, HD wallets only. The max number of empty addresses in a row. Transactions sent to an address outside the `gap_limit`, will not be identified when scanning. Defaults to `20`. | +| path\_to\_address | object | Optional, HD wallets only. A standard [AddressDerivationPath](/komodo-defi-framework/api/common_structures/activation/#address-derivation-path) object. | +| get\_balances | boolean | Optional, defaults to `true`. If `false`, coin and token balances will not be returned in the response, and the response will be returned more quickly. | For ZHTLC coins, older wallets need to set the `sync_params` field to a date before its @@ -32,15 +88,6 @@ The `ActivationParams` object defines additional parameters used for activation. load during ZHTLC coin activation. -### ActivationMode - -Defines the activation mode for QTUM, BCH, UTXO & ZHTLC coins. - -| Parameter | Type | Description | -| --------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| rpc | string | `Native` if running a native blockchain node, `Electrum` if using electrum servers or `Light` for ZHTLC coins. | -| rpc\_data | object | `Electrum` or `Light` mode only. A standard [ActivationRpcData](/komodo-defi-framework/api/common_structures/activation/#activation-rpc-data) object. | - ### ActivationRpcData Contains information about electrum & lightwallet\_d servers for coins being used in `Electrum` or `Light` mode. @@ -78,11 +125,11 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig "rpc_data": { "electrum_servers": [ { - "url":"zombie.dragonhound.info:10033" + "url":"zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] }, "sync_params": { @@ -125,81 +172,91 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig ``` -### CoinProtocol +### AddressDerivationPath -| Parameter | Type | Description | -| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -| type | integer | One of the Coin Types supported by the Komodo DeFi Framework | -| protocol\_data | object | A standard [CoinProtocolData](/komodo-defi-framework/api/common_structures/activation/#coin-protocol-data) object. | +The `AddressDerivationPath` object defines the account / change / address\_index of the [derivation path](https://medium.com/mycrypto/wtf-is-a-derivation-path-c3493ca2eb52) used for your wallet. Using different values for `account_id` or `address_id` parameters will result in a different address and private key for each combination. The `chain` parameter is used to specify if the change from a transaction. Set to `External` for addresses that are intended to be visible outside of the wallet (e.g. for receiving payments). `Internal` is used for addresses which are not meant to be visible outside of the wallet and is used to return the leftover change from a transaction. -### CoinProtocolData +| Parameter | Type | Description | +| ----------- | ------- | ---------------------------------------------------------------------------------------- | +| account\_id | integer | Optional, defaults to `0`. Used as a layer of separation or hierarchy. | +| chain | string | Optional. Accepted values are `External` (0) and `Internal` (1). Defaults to `External`. | +| address\_id | integer | Optional, defaults to `0`. Used as a layer of separation or hierarchy. | -| Parameter | Type | Description | -| --------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------- | -| platform | string | Indicates the platform parent coin for EMV-like protocols, or the coin used for lightning nodes. | -| network | string | Either `mainnet` or \`testnet | -| confirmation\_targets | object | A standard [ConfirmationTargets](/komodo-defi-framework/api/common_structures/lightning/#confirmation-targets) object. | + + ```json + { + "path_to_address": { + "account_id": 0, + "chain": "External", + "address_id": 1 + } + } + ``` + -### EvmNode +### AddressInfo -The `EvmNode` object includes the following items for a given coin or token: +The `AddressInfo` object includes the following items for a given address: -| Parameter | Type | Description | -| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------- | -| url | string | URL of an RPC node | -| komodo\_auth | boolean | Optional, defaults to `false`. Must be set to `true` to access RPC nodes run officially by the Komodo Platform team | +| Parameter | Type | Description | +| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| balances | object | A standard [balanceInfo](/komodo-defi-framework/api/common_structures/#balance-info) object. Not included in responses where `get_balances` is `false` | +| derivation\_method | object | A standard [DerivationMethod](/komodo-defi-framework/api/common_structures/#derivation-method) object | +| pubkey | string | The public key associated with the seed used to launch Komodo DeFi Framework | +| tickers | array | A list of tokens which were successfully activated. Only included in responses where `get_balances` is `false` | -#### v2.1.0 (current release) + + #### Example with balances - ```json - { - "url": "http://eth1.cipig.net:8555", - "komodo_proxy": false + "bitcoincash:qrf5vpn78s7rjexrjhlwyzzeg7gw98k7t5qx64fztj": { + "derivation_method": { + "type": "Iguana" + }, + "pubkey": "036879df230663db4cd083c8eeb0f293f46abc460ad3c299b0089b72e6d472202c", + "balances": { + "spendable": "0.11398301", + "unspendable": "0.00001" + } } ``` - - - - Prior to the v2.2.0 release, the `gui_auth` field was used to access RPC nodes run officially by the Komodo Platform team. This field was replaced with the `komodo_proxy` field in the v2.2.0 release. - -#### v2.2.0+ + #### Example without balances - ```json - { - "url": "https://nucleus-rpc.alpha.komodo.earth", - "komodo_proxy": true + "bitcoincash:qrf5vpn78s7rjexrjhlwyzzeg7gw98k7t5qx64fztj": { + "derivation_method": { + "type": "Iguana" + }, + "pubkey": "036879df230663db4cd083c8eeb0f293f46abc460ad3c299b0089b72e6d472202c", + "tickers": ["ASLP-SLP"] } ``` -### TendermintNode +### CoinProtocol -The `TendermintNode` object includes the following items for a given coin or token: +| Parameter | Type | Description | +| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | +| type | integer | One of the Coin Types supported by the Komodo DeFi Framework | +| protocol\_data | object | A standard [CoinProtocolData](/komodo-defi-framework/api/common_structures/activation/#coin-protocol-data) object. | -| Parameter | Type | Description | -| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| url | string | URL of an RPC node | -| komodo\_auth | boolean | Optional, defaults to `false`. Must be set to `true` to access RPC nodes run behind [komodo-defi-proxy](https://github.com/KomodoPlatform/komodo-defi-proxy) | +### CoinProtocolData -#### v2.1.0 (current release) +| Parameter | Type | Description | +| --------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------- | +| platform | string | Indicates the platform parent coin for EMV-like protocols, or the coin used for lightning nodes. | +| network | string | Either `mainnet` or \`testnet | +| confirmation\_targets | object | A standard [ConfirmationTargets](/komodo-defi-framework/api/common_structures/lightning/#confirmation-targets) object. | - - ```json - { - "url": "http://eth1.cipig.net:8555", - "komodo_proxy": false - } - ``` - +### EvmNode - - Prior to the v2.2.0 release, the `gui_auth` field was used to access RPC nodes run officially by the Komodo Platform team. This field was replaced with the `komodo_proxy` field in the v2.2.0 release. - +The `EvmNode` object includes the following items for a given coin or token: -#### v2.2.0+ +| Parameter | Type | Description | +| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------- | +| url | string | URL of an RPC node | +| komodo\_proxy | boolean | Optional, defaults to `false`. Must be set to `true` to access RPC nodes run officially by the Komodo Platform team | ```json diff --git a/src/pages/komodo-defi-framework/api/common_structures/index.mdx b/src/pages/komodo-defi-framework/api/common_structures/index.mdx index 4f4f1af5..751214fd 100644 --- a/src/pages/komodo-defi-framework/api/common_structures/index.mdx +++ b/src/pages/komodo-defi-framework/api/common_structures/index.mdx @@ -37,49 +37,9 @@ Structures which are used in more than one section are listed below: ``` -### AddressInfo +### BalanceInfo -The `AddressInfo` object includes the following items for a given address: - -| Parameter | Type | Description | -| ------------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| balances | object | A standard [balanceInfos](/komodo-defi-framework/api/common_structures/#balance-infos) object. Not included in responses where `get_balances` is `false` | -| derivation\_method | object | A standard [DerivationMethod](/komodo-defi-framework/api/common_structures/#derivation-method) object | -| pubkey | string | The public key associated with the seed used to launch Komodo DeFi Framework | -| tickers | array | A list of tokens which were successfully activated. Only included in responses where `get_balances` is `false` | - - - #### Example with balances - - ```json - "bitcoincash:qrf5vpn78s7rjexrjhlwyzzeg7gw98k7t5qx64fztj": { - "derivation_method": { - "type": "Iguana" - }, - "pubkey": "036879df230663db4cd083c8eeb0f293f46abc460ad3c299b0089b72e6d472202c", - "balances": { - "spendable": "0.11398301", - "unspendable": "0.00001" - } - } - ``` - - #### Example without balances - - ```json - "bitcoincash:qrf5vpn78s7rjexrjhlwyzzeg7gw98k7t5qx64fztj": { - "derivation_method": { - "type": "Iguana" - }, - "pubkey": "036879df230663db4cd083c8eeb0f293f46abc460ad3c299b0089b72e6d472202c", - "tickers": ["ASLP-SLP"] - } - ``` - - -### BalanceInfos - -The `balanceInfos` object includes the following items for a given coin or token: +The `balanceInfo` object includes the following items for a given coin or token: | Parameter | Type | Description | | ----------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ | diff --git a/src/pages/komodo-defi-framework/api/common_structures/wallet/index.mdx b/src/pages/komodo-defi-framework/api/common_structures/wallet/index.mdx index 68bda449..0b6a55d1 100644 --- a/src/pages/komodo-defi-framework/api/common_structures/wallet/index.mdx +++ b/src/pages/komodo-defi-framework/api/common_structures/wallet/index.mdx @@ -3,46 +3,34 @@ export const description = "Starting with version beta-2.1.3434, the Komodo DeFi # Wallet Operations Structures -### RawTxInfo +### HistoryTarget -The `RawTxInfo` object includes the following items: +Used to specify a HD wallet `account_id` or `address_id` for [my\_tx\_history v2](/komodo-defi-framework/api/v20/wallet/tx/my_tx_history/) requests. -| Parameter | Type | Description | -| ------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| tx\_hex | string | UTXO only. The raw unsigned hex of a proposed transaction. | -| prev\_txns | list | UTXO only. A list of standard [InputTxns objects](/komodo-defi-framework/api/common_structures/wallet/#input-txns). | -| to | string | ETH/EVM only. A destination address to send the funds to. | -| value | string | ETH/EVM only. The amount of funds to be sent as a string with a `0x` prefix, in [wei](https://ethereum.stackexchange.com/questions/253/the-ether-denominations-are-called-finney-szabo-and-wei-what-who-are-these-na) units. | -| gas\_limit | string | ETH/EVM only. The maximum gas to be used for sending the transaction, in [gwei](https://eth-converter.com/) units. | -| pay\_for\_gas | object | Optional, ETH/EVM only. Used for EIP-1559 fee policy config. A standard [PayForGas](/komodo-defi-framework/api/common_structures/wallet/#pay-for-gas) object. | +| Parameter | Type | Description | +| ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| type | string | Filters results by `account_id` or `address_id` part of the derivation path. | +| account\_id | integer | `ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. | +| address\_id | integer | Only required when `type` is `address_id`. `ADDRESS_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. | +| chain | string | Only required when `type` is `address_id`. `Internal`, or `External`. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change. | - - TODO: Confirm units used in ETH/EVM transactions. - + + #### Example - ```json - { - "tx_hex": "02000000010d23d763f12d77a337cc16df2696ac3f48552dda373c9977fa1f5dd8d5025cb20100000000fdffffff01f40100000000000016001488accd2145b7232b958db5cdf09336ad619541e200000000", - "prev_txns": [ - ... - ] - } + { + "type": "account_id", + "account_id": 77 + } ``` - - ```json - { - "to": "0x927DaFDDa16F1742BeFcBEAE6798090354B294A9", - "value": "0.85", - "gas_limit": "21000", - "pay_for_gas": { - "tx_type": "Eip1559", - "max_fee_per_gas": "1234.567", - "max_priority_fee_per_gas": "1.2" - } - } + { + "type": "address_id", + "account_id": 0, + "chain": "External", // Accepted values: "External" and "Internal" + "address_id": 1 + } ``` @@ -69,6 +57,17 @@ The `InputTxns` object includes the following items: ``` +### NewAddressInfo + +The `NewAddressInfo` response object includes the following items for request in HD mode: + +| Parameter | Type | Description | +| ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| address | string | The account address for a specific derivation path under the `account_index`. | +| derivation\_path | string | The [BIP44 derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) of the address. If there are no more addresses with balances within the gap limit, the address index will increment. | +| balance | object | A standard [balanceInfo](/komodo-defi-framework/api/common_structures/#balance-info) object. | +| chain | string | `Internal`, or `External`. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change. | + ### PayForGas The `PayForGas` object includes the following items: @@ -112,3 +111,117 @@ The `PayForGas` object includes the following items: } ``` + +### RawTxInfo + +The `RawTxInfo` object includes the following items: + +| Parameter | Type | Description | +| ------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| tx\_hex | string | UTXO only. The raw unsigned hex of a proposed transaction. | +| prev\_txns | list | UTXO only. A list of standard [InputTxns objects](/komodo-defi-framework/api/common_structures/wallet/#input-txns). | +| to | string | ETH/EVM only. A destination address to send the funds to. | +| value | string | ETH/EVM only. The amount of funds to be sent as a string with a `0x` prefix, in [wei](https://ethereum.stackexchange.com/questions/253/the-ether-denominations-are-called-finney-szabo-and-wei-what-who-are-these-na) units. | +| gas\_limit | string | ETH/EVM only. The maximum gas to be used for sending the transaction, in [gwei](https://eth-converter.com/) units. | +| pay\_for\_gas | object | Optional, ETH/EVM only. Used for EIP-1559 fee policy config. A standard [PayForGas](/komodo-defi-framework/api/common_structures/wallet/#pay-for-gas) object. | + + + TODO: Confirm units used in ETH/EVM transactions. + + + + ```json + { + "tx_hex": "02000000010d23d763f12d77a337cc16df2696ac3f48552dda373c9977fa1f5dd8d5025cb20100000000fdffffff01f40100000000000016001488accd2145b7232b958db5cdf09336ad619541e200000000", + "prev_txns": [ + ... + ] + } + ``` + + + + ```json + { + "to": "0x927DaFDDa16F1742BeFcBEAE6798090354B294A9", + "value": "0.85", + "gas_limit": "21000", + "pay_for_gas": { + "tx_type": "Eip1559", + "max_fee_per_gas": "1234.567", + "max_priority_fee_per_gas": "1.2" + } + } + ``` + + +### ScanAddressesInfo + +The `ScanAddressesInfo` response object includes the following items for request in HD mode: + +| Parameter | Type | Description | +| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| account\_index | integer | `ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. **Please don't confuse with the global account.** | +| derivation\_path | string | The [BIP44 derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) of the account. | +| new\_addresses | list | A list of standard [NewAddressInfo](/komodo-defi-framework/api/common_structures/wallet/#new-address-info) objects. | + + + Confirm `new_addresses` array has the structure of `NewAddressInfo`. + + +### WalletBalanceInfo + +The `WalletBalanceInfo` object includes the following items in the activation response for a coin in HD mode: + +| Parameter | Type | Description | +| ------------ | ------ | ---------------------------------------------------------------------------------------------------------------- | +| wallet\_type | string | In HD wallet mode, this will return `HD`. What are the other values? | +| accounts | object | A standard [WalletAccountInfo](/komodo-defi-framework/api/common_structures/wallet/#wallet-account-info) object. | + +```json +{ + "wallet_balance": { + "wallet_type": "HD", + "accounts": [ + ... + ] + } +} +``` + +### WithdrawFromInfo + +The `WithdrawFromInfo` response object includes the following items for HD Wallet [withdraw (v2)](/komodo-defi-framework/api/v20/wallet/tx/withdraw/) requests. +You can use either the `derivation_path` on its own, or the `account_id`, `chain` and `address_id` together. + +| Parameter | Type | Description | +| ---------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| derivation\_path | string | The [BIP44 derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) of the address. | +| account\_id | integer | `ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. **Please don't confuse with the global account.** | +| address\_id | integer | `ADDRESS_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. | +| chain | string | `Internal`, or `External`. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change. | + +### WalletAccountInfo + +The `WalletAccountInfo` object includes the following items in the activation response for a coin in HD mode: + +| Parameter | Type | Description | +| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| account\_index | integer | `ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. **Please don't confuse with the global account.** | +| derivation\_path | string | Derivation path up to the `COIN` child. E.g. `"m/44'/141'/0'"` | +| total\_balance | object | A standard [balanceInfo](/komodo-defi-framework/api/common_structures/#balance-info) object. | +| addresses | list | A list of standard [AccountAddressInfo](/komodo-defi-framework/api/common_structures/activation/#account-address-info) objects. | + +```json +{ + "account_index": 0, + "derivation_path": "m/44'/141'/0'", + "total_balance": { + "spendable": "23.08710255", + "unspendable": "0" + }, + "addresses": [ + ... + ] +} +``` diff --git a/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_bch_with_tokens/index.mdx b/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_bch_with_tokens/index.mdx index 42be259c..121a5c87 100644 --- a/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_bch_with_tokens/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_bch_with_tokens/index.mdx @@ -29,11 +29,11 @@ The Komodo DeFi Framework supports Bitcoin Cash SLP tokens. Using this method, y ### Response Parameters -| Parameter | Type | Description | -| --------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| current\_block | integer | Block height of the coin being activated | -| bch\_addresses\_infos | object | A standard [AddressInfo](/komodo-defi-framework/api/common_structures/#address-info) object. Note: the structure may vary based on the value of the `get_balances` parameter. | -| slp\_addresses\_infos | object | A standard [AddressInfo](/komodo-defi-framework/api/common_structures/#address-info) object. Note: the structure may vary based on the value of the `get_balances` parameter. | +| Parameter | Type | Description | +| --------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| current\_block | integer | Block height of the coin being activated | +| bch\_addresses\_infos | object | A standard [AddressInfo](/komodo-defi-framework/api/common_structures/activation/#address-info) object. Note: the structure may vary based on the value of the `get_balances` parameter. | +| slp\_addresses\_infos | object | A standard [AddressInfo](/komodo-defi-framework/api/common_structures/activation/#address-info) object. Note: the structure may vary based on the value of the `get_balances` parameter. | bch\_addresses\_infos and slp\_addresses\_infos are the same. This should be consolidated in the api. diff --git a/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_eth_with_tokens/index.mdx b/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_eth_with_tokens/index.mdx index c49274ca..3984af36 100644 --- a/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_eth_with_tokens/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_eth_with_tokens/index.mdx @@ -29,12 +29,12 @@ Additionally, it supports ERC20 tokens on the ETH chain and associated ERC20 lik ### Response Parameters -| Parameter | Type | Description | -| ----------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| current\_block | integer | Block height of the coin being activated | -| eth\_addresses\_infos | object | A standard [AddressInfo](/komodo-defi-framework/api/common_structures/#address-info) object. Note: the structure may vary based on the value of the `get_balances` parameter. | -| erc20\_addresses\_infos | object | A standard [AddressInfo](/komodo-defi-framework/api/common_structures/#address-info) object. Note: the structure may vary based on the value of the `get_balances` parameter. | -| nfts\_infos | list | A list of standard [NftInfoBasic](/komodo-defi-framework/api/common_structures/nfts/#nft-info) objects. | +| Parameter | Type | Description | +| ----------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| current\_block | integer | Block height of the coin being activated | +| eth\_addresses\_infos | object | A standard [AddressInfo](/komodo-defi-framework/api/common_structures/activation/#address-info) object. Note: the structure may vary based on the value of the `get_balances` parameter. | +| erc20\_addresses\_infos | object | A standard [AddressInfo](/komodo-defi-framework/api/common_structures/activation/#address-info) object. Note: the structure may vary based on the value of the `get_balances` parameter. | +| nfts\_infos | list | A list of standard [NftInfoBasic](/komodo-defi-framework/api/common_structures/nfts/#nft-info) objects. | ### 📌 Examples @@ -60,15 +60,15 @@ Additionally, it supports ERC20 tokens on the ETH chain and associated ERC20 lik "nodes": [ { "url": "https://eth1.cipig.net:18555", - "gui_auth": false + "komodo_proxy": false }, { "url": "https://eth2.cipig.net:18555", - "gui_auth": false + "komodo_proxy": false }, { "url": "https://eth3.cipig.net:18555", - "gui_auth": false + "komodo_proxy": false } ], "tx_history": true, diff --git a/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_tendermint_with_assets/index.mdx b/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_tendermint_with_assets/index.mdx index 542a3b31..5b1bbedc 100644 --- a/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_tendermint_with_assets/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/coin_activation/enable_tendermint_with_assets/index.mdx @@ -12,8 +12,7 @@ Use this method to activate Tendermint coins (COSMOS/IRIS/OSMOSIS) and IBC asset | ticker | string | Ticker of the platform protocol coin. Options: `ATOM`, `IRIS`, `OSMOSIS` | | mm2 | integer | Required if not set in `coins` file. Informs the Komodo DeFi Framework API whether or not the coin is expected to function. Accepted values are `0` or `1` | | tokens\_params | array of objects | A list of standard [TokensRequest](/komodo-defi-framework/api/common_structures/activation/#tokens-request) objects. | -| rpc\_urls | array of strings | **v2.1.0 and earlier only.** A list of RPC urls for Tendermint full node servers. | -| nodes | array of objects | **v2.2.0+ only.** A list of [TendermintNode objects](/komodo-defi-framework/api/common_structures/activation/#tendermint-node). | +| nodes | array of objects | A list of [EvmNode objects](/komodo-defi-framework/api/common_structures/activation/#evm-node). | | priv\_key\_policy | string | Optional, defaults to `ContextPrivKey`. value can be `ContextPrivKey`,`Trezor` when Komodo DeFi Framework is built for native platforms. value can be `ContextPrivKey`, `Trezor`, `Metamask` when the Komodo DeFi Framework is built targeting `wasm` | | tx\_history | boolean | Optional, defaults to `false`. If `true` the Komodo DeFi Framework API will preload transaction history as a background process. Must be set to `true` to use the [my\_tx\_history](/komodo-defi-framework/api/legacy/my_tx_history/#my-tx-history) method | | required\_confirmations | integer | Optional, defaults to `3`. When the platform coin is involved, the number of confirmations for the Komodo DeFi Framework API to wait during the transaction steps of an atomic swap | @@ -22,71 +21,17 @@ Use this method to activate Tendermint coins (COSMOS/IRIS/OSMOSIS) and IBC asset ### Response Parameters -| Parameter | Type | Description | -| ---------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| current\_block | integer | Block height of the coin being activated | -| ticker | string | Ticker of the platform protocol coin, as input in the request. | -| address | string | An address for the activated coin | -| balance | object | Only returned when `get_balances` is `true`. A standard [BalanceInfos](/komodo-defi-framework/api/common_structures/#balance-infos) object. | -| tokens\_balances | array of objects | Only returned when `get_balances` is `true`. A list of standard [AddressInfo](/komodo-defi-framework/api/common_structures/#address-info) objects, one for each token. | -| tokens\_tickers | array | Only returned when `get_balances` is `false`. A list of each token which was activated. | - - - The `rpc_urls` parameter will be replaced with the `nodes` parameter in the kdf version 2.2.0 release. Instead of a list of url strings, the `nodes` parameter will be a list of [TendermintNode objects](/komodo-defi-framework/api/common_structures/activation/#tendermint-node). - +| Parameter | Type | Description | +| ---------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| current\_block | integer | Block height of the coin being activated | +| ticker | string | Ticker of the platform protocol coin, as input in the request. | +| address | string | An address for the activated coin | +| balance | object | Only returned when `get_balances` is `true`. A standard [BalanceInfo](/komodo-defi-framework/api/common_structures/#balance-info) object. | +| tokens\_balances | array of objects | Only returned when `get_balances` is `true`. A list of standard [AddressInfo](/komodo-defi-framework/api/common_structures/activation/#address-info) objects, one for each token. | +| tokens\_tickers | array | Only returned when `get_balances` is `false`. A list of each token which was activated. | ### 📌 Examples -#### Request using `rpc_urls` parameter (kdf version \< 2.2.0) - - - ```json - { - "method": "enable_tendermint_with_assets", - "userpass": "RPC_UserP@SSW0RD", - "mmrpc": "2.0", - "params": { - "ticker": "IRIS", - "tokens_params": [ - { - "ticker": "ATOM-IBC_IRIS" - } - ], - "rpc_urls": [ - "https://iris.komodo.earth/", - "https://rpc.irishub-1.irisnet.org" - ] - } - } - ``` - - - - #### Response - - ```json - { - "mmrpc": "2.0", - "result": { - "ticker": "IRIS", - "address": "iaa16drqvl3u8sukfsu4lm3qsk28jr3fahja9vsv6k", - "current_block": 19769638, - "balance": { - "spendable": "44.147264", - "unspendable": "0" - }, - "tokens_balances": { - "ATOM-IBC_IRIS": { - "spendable": "0.028306", - "unspendable": "0" - } - } - }, - "id": null - } - ``` - - #### Request with `get_balances` set to `false` @@ -138,7 +83,7 @@ Use this method to activate Tendermint coins (COSMOS/IRIS/OSMOSIS) and IBC asset ``` -#### Request using `nodes` parameter (kdf version 2.2.0+) +#### Request with `get_balances` as `true` ```json @@ -164,7 +109,8 @@ Use this method to activate Tendermint coins (COSMOS/IRIS/OSMOSIS) and IBC asset "url": "https://rpc.irishub-1.irisnet.org", "komodo_proxy": false } - ] + ], + "get_balances": true } } ``` diff --git a/src/pages/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_z_coin/index.mdx b/src/pages/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_z_coin/index.mdx index 5781555f..6b43d8b5 100644 --- a/src/pages/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_z_coin/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_z_coin/index.mdx @@ -40,16 +40,16 @@ export const description = "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" }, { - "url": "zombie.dragonhound.info:20033", + "url": "zombie.dragonhound.info:20133", "protocol": "SSL", - "ws_url": "zombie.dragonhound.info:30058" + "ws_url": "zombie.dragonhound.info:30059" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ] } }, @@ -78,11 +78,11 @@ export const description = "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": { "height": 2528700 @@ -116,16 +116,16 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa "rpc_data": { "electrum_servers": [ { - "url": "zombie.dragonhound.info:10033" + "url": "zombie.dragonhound.info:10133" }, { - "url": "zombie.dragonhound.info:20033", + "url": "zombie.dragonhound.info:20133", "protocol": "SSL", - "ws_url": "zombie.dragonhound.info:30058" + "ws_url": "zombie.dragonhound.info:30059" } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": "earliest" } @@ -163,7 +163,7 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa } ], "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" + "http://zombie.dragonhound.info:1443" ], "sync_params": { "date": 1672704000 @@ -276,6 +276,35 @@ Z coins need to build sync a local block cache and wallet database before they c } ``` + #### Response (Complete) + + ```json + { + "mmrpc": "2.0", + "result": { + "status": "Ok", + "details": { + "ticker": "ZOMBIE", + "current_block": 794431, + "wallet_balance": { + "wallet_type": "Iguana", + "address": "zs1e3puxpnal8ljjrqlxv4jctlyndxnm5a3mj5rarjvp0qv72hmm9caduxk9asu9kyc6erfx4zsauj", + "balance": { + "spendable": "0", + "unspendable": "0" + } + }, + "first_sync_block": { + "requested": 792991, + "is_pre_sapling": false, + "actual": 792991 + } + } + }, + "id": null + } + ``` + #### Response (CoinCreationError - no Zcash Params) ```json diff --git a/src/pages/komodo-defi-framework/api/v20/index.mdx b/src/pages/komodo-defi-framework/api/v20/index.mdx index 948a0809..81843f20 100644 --- a/src/pages/komodo-defi-framework/api/v20/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/index.mdx @@ -106,662 +106,6 @@ It includes a uniform request, successful and error response formats. At the mom The folowing objects are used in the request or response of multiple Komodo DeFi SDK methods. -### ActivationParams - -The `ActivationParams` object defines additional parameters used for activation. These params may vary depending on the coin type. - -| Parameter | Type | Description | -| ---------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| required\_confirmations | integer | Optional. Confirmations to wait for steps in swap. Defaults to value in the coins file if not set. | -| requires\_notarization | boolean | Optional, defaults to `false`. For [dPoW](https://komodoplatform.com/en/blog/dpow-demystified/) protected coins, a `true` value will wait for transactions to be notarised when doing swaps. Overrides value if set in `coins` file. | -| mode | object | QTUM, UTXO & ZHTLC coins only. A standard [ActivationMode](/komodo-defi-framework/api/v20/#activation-mode) object. | -| zcash\_params\_path | string | ZHTLC coins only. Path to folder containing [Zcash parameters](https://z.cash/learn/). Optional, defaults to standard location as defined in [this guide](https://forum.komodoplatform.com/t/installing-zcash-params/603) | -| scan\_blocks\_per\_iteration | integer | ZHTLC coins only. Sets the number of scanned blocks per iteration during `BuildingWalletDb` state. Optional, default value is 1000. | -| scan\_interval\_ms | integer | ZHTLC coins only. Sets the interval in milliseconds between iterations of `BuildingWalletDb` state. Optional, default value is 0. | -| tx\_history | boolean | Optional. Enable transaction history scanning. When active, the Komodo DeFi Framework API will collect transaction history data for local storage, and allow use of the [my\_tx\_history (v2)](/komodo-defi-framework/api/v20/wallet/tx/my_tx_history/) method. | -| min\_addresses\_number | integer | Optional, HD wallets only. Number of addresses to generate. If not specified, addresses will be generated up to `path_to_address::address_index`. | -| scan\_policy | string | Optional, HD wallets only. Whether or not to scan for new addresses. Select from `do_not_scan`, `scan_if_new_wallet` or `scan`. Defaults to `scan_if_new_wallet`. Note that `scan` will result in multple requests to the Komodo DeFi API and may take some time to complete. | -| gap\_limit | integer | Optional, HD wallets only. The max number of empty addresses in a row. Transactions sent to an address outside the `gap_limit`, will not be identified when scanning. Defaults to `20`. | -| path\_to\_address | object | Optional, HD wallets only. A standard [AddressDerivationPath](/komodo-defi-framework/api/v20/#address-derivation-path) object. | -| get\_balances | boolean | Optional, defaults to `true`. If `false`, coin and token balances will not be returned in the response, and the response will be returned more quickly. | - - - Is priv\_key\_policy still a thing? - Defaults to `ContextPrivKey`. Set as `Trezor` to activate in Trezor mode. - - - - For ZHTLC coins, older wallets need to set the `sync_params` field to a date before its - first transaction to see all balance and history. This may take a long time on the first - activation, but subsequent activations will be much faster. - Using a smaller `scan_blocks_per_iteration` and larger `scan_interval_ms`, - will reduce the average CPU load during ZHTLC coin activation (at the cost of a - longer activation time). These optional fields are recommended when developing - for iOS, where a high CPU load may kill the activation process. Android & - desktop operating systems do not appear to have any problems with high CPU - load during ZHTLC coin activation. - - -### ActivationMode - -Defines the activation mode for QTUM, BCH, UTXO & ZHTLC coins. - -| Parameter | Type | Description | -| --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------- | -| rpc | string | `Native` if running a native blockchain node, `Electrum` if using electrum servers or `Light` for ZHTLC coins. | -| rpc\_data | object | `Electrum` or `Light` mode only. A standard [ActivationRpcData](/komodo-defi-framework/api/v20/#activation-rpc-data) object. | - - - ```json - { - "mode": { - "rpc": "Electrum", - "rpc_data": { - "servers": [ - { - "url": "electrum1.cipig.net:10020" - }, - { - "url": "electrum2.cipig.net:10020" - } - ] - } - }, - } - ``` - - -### ActivationRpcData - -Contains information about electrum & lightwallet\_d servers for coins being used in `Electrum` or `Light` mode. - -| Parameter | Type | Description | -| ------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| light\_wallet\_d\_servers | list | ZHTLC only. A list of urls which are hosting lightwallet\_d servers for a coin. | -| electrum\_servers | list of objects | ZHTLC only. A list of standard [ActivationServers](/komodo-defi-framework/api/v20/#activation-servers) objects. | -| electrum | list of objects | QTUM, BCH & UTXO coins only. A list of standard [ActivationServers](/komodo-defi-framework/api/v20/#activation-servers) objects. | -| sync\_params | integer or string | ZHTLC coins only. Optional, defaults to two days ago. Defines where to start scanning blockchain data upon initial activation. Options: `"earliest"` (the coin's sapling\_activation\_height), `height` (a specific block height) or `date` (a unix timestamp). | - -### ActivationServers - -Contains information electrum servers for coins being used in `Electrum` or `Light` mode. - -| Parameter | Type | Description | -| --------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| url | string | The URL and port for an electrum server. | -| ws\_url | string | Optional, for WSS only. The URL and port for an electrum server's WSS port. | -| protocol | string | Optional, defaults to `TCP`. Transport protocol used to connect to the server. Options: `TCP` or `SSL` | -| disable\_cert\_verification | boolean | Optional, defaults to `false`. If `true`, this disables server SSL/TLS certificate verification (e.g. for self-signed certificates). Use at your own risk! | - - - #### ZHTLC Example - - ```json - { - "activation_params": { - "mode": { - "rpc": "Light", - "rpc_data": { - "electrum_servers": [ - { - "url":"zombie.dragonhound.info:10033" - } - ], - "light_wallet_d_servers": [ - "http://zombie.dragonhound.info:443" - ] - }, - "sync_params": { - "height": 2528700 - } - }, - "zcash_params_path": "/home/username/path_to/.zcash-params", - "scan_blocks_per_iteration": 100, - "scan_interval_ms": 200 - } - } - ``` - - #### HD UTXO Activation (v2) - - ```json - { - "activation_params": { - "mode": { - "rpc": "Electrum", - "rpc_data": { - "servers": [ - { - "url": "electrum2.cipig.net:10001" - }, - { - "url": "electrum3.cipig.net:20001", - "ws_url": "electrum3.cipig.net:30001", - "protocol": "SSL" - } - ] - } - }, - "scan_policy": "scan_if_new_wallet", - "priv_key_policy": "Trezor", - "min_addresses_number": 3, - "gap_limit": 20 - } - } - ``` - - #### HD UTXO Activation (v2) - - ```json - { - "activation_params": { - "mode": { - "rpc": "Electrum", - "rpc_data": { - "servers": [ - { - "url": "electrum2.cipig.net:10001" - }, - { - "url": "electrum3.cipig.net:20001", - "ws_url": "electrum3.cipig.net:30001", - "protocol": "SSL" - } - ] - } - }, - "scan_policy": "scan_if_new_wallet", - "min_addresses_number": 3, - "gap_limit": 20 - } - } - ``` - - -### AddressDerivationPath - -The `AddressDerivationPath` object defines the account / change / address\_index of the [derivation path](https://medium.com/mycrypto/wtf-is-a-derivation-path-c3493ca2eb52) used for your wallet. Using different values for `account_id` or `address_id` parameters will result in a different address and private key for each combination. The `chain` parameter is used to specify if the change from a transaction. Set to `External` for addresses that are intended to be visible outside of the wallet (e.g. for receiving payments). `Internal` is used for addresses which are not meant to be visible outside of the wallet and is used to return the leftover change from a transaction. - -| Parameter | Type | Description | -| ----------- | ------- | ---------------------------------------------------------------------------------------- | -| account\_id | integer | Optional, defaults to `0`. Used as a layer of separation or hierarchy. | -| chain | string | Optional. Accepted values are `External` (0) and `Internal` (1). Defaults to `External`. | -| address\_id | integer | Optional, defaults to `0`. Used as a layer of separation or hierarchy. | - - - ```json - { - "path_to_address": { - "account_id": 0, - "chain": "External", - "address_id": 1 - } - } - ``` - - -### AddressInfos - -The `addressInfos` object includes the following items for a given address: - -| Parameter | Type | Description | -| ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------- | -| balances | object | A standard [BalanceInfo](/komodo-defi-framework/api/v20/#balance-info) object. Not included in responses where `get_balances` is `false` | -| derivation\_method | object | A standard [DerivationMethod](/komodo-defi-framework/api/v20/#derivation-method) object | -| pubkey | string | The public key associated with the seed used to launch Komodo DeFi | -| tickers | array | A list of tokens which were successfully activated. Only included in responses where `get_balances` is `false` | - - - #### Example with balances - - ```json - "bitcoincash:qrf5vpn78s7rjexrjhlwyzzeg7gw98k7t5qx64fztj": { - "derivation_method": { - "type": "Iguana" - }, - "pubkey": "036879df230663db4cd083c8eeb0f293f46abc460ad3c299b0089b72e6d472202c", - "balances": { - "spendable": "0.11398301", - "unspendable": "0.00001" - } - } - ``` - - #### Example without balances - - ```json - "bitcoincash:qrf5vpn78s7rjexrjhlwyzzeg7gw98k7t5qx64fztj": { - "derivation_method": { - "type": "Iguana" - }, - "pubkey": "036879df230663db4cd083c8eeb0f293f46abc460ad3c299b0089b72e6d472202c", - "tickers": ["ASLP-SLP"] - } - ``` - - -### BalanceInfo - -The `balanceInfo` object includes the following items for a given coin or token: - -| Parameter | Type | Description | -| ----------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ | -| spendable | string (numeric) | The available amount of a coin or token which is ready to be traded or withdrawn. | -| unspendable | string (numeric) | The amount of a coin or token which is awaiting confirmation on the block chain for an incoming or outgoing transaction. | - - - ```json - { - "spendable": "12.11398301", - "unspendable": "0.53" - } - ``` - - -### DerivationMethod - -The `DerivationMethod` object includes the following items for a given coin or token: - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------------------------------------- | -| type | string | Defines how keypairs will be generated. Possible values: `Iguana` or `HDWallet` | - - - Using the same seed or private key to generate keypairs using different derivation methods will result in a different address and private key for each method. - - -Where the value indicates: - -* `Iguana`: The coin or token is was activated using Iguana derivation (default). -* `HDWallet`: The coin or token is was activated using a Hierarchical Deterministic (HD) Wallet derivation path. - - - ```json - { - "type": "Iguana" - } - ``` - - -### CoinProtocol - -| Parameter | Type | Description | -| -------------- | ------- | -------------------------------------------------------------------------------------------- | -| type | integer | One of the supported [coin types](https://github.com/KomodoPlatform/coins/blob/master/coins) | -| protocol\_data | object | A standard [CoinProtocolData](/komodo-defi-framework/api/v20/#coin-protocol-data) object. | - -### CoinProtocolData - -| Parameter | Type | Description | -| --------------------- | ------ | ------------------------------------------------------------------------------------------------ | -| platform | string | Indicates the platform parent coin for EMV-like protocols, or the coin used for lightning nodes. | -| network | string | Either `mainnet` or \`testnet | -| confirmation\_targets | object | A standard [ConfirmationTargets](/komodo-defi-framework/api/v20/#confirmation-targets) object. | - -### ConfirmationTargets - -This object represents the number of blocks required for an on-chain lightning-related transaction to be confirmed. -It is used for estimating the transaction fee rate (`feerate`) for different transaction types in the context of permissionless transactions performed by the node. Different target types are `background`, `normal`, and `high_priority`. - -| Parameter | Type | Description | -| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| background | integer | Used for transactions that can tolerate slower confirmation times when the transaction fee rate decreases. These transactions are not time-sensitive and can afford to wait longer for confirmation. The recommended range is `12` to `144` blocks to ensure a low `feerate`. | -| normal | integer | Used for transactions that we want to confirm promptly, without significant delay (e.g, transactions for opening payment channels). These transactions are important but not critical. Suggested value is `6` blocks to ensure a moderate `feerate`. | -| high\_priority | integer | Used for transactions that require quick confirmation to prevent potential loss of funds (e.g. redeeming a Hashed Time Lock Contract (HTLC) on the blockchain before it times out). These transactions are time-critical and must be confirmed promptly to ensure the security of funds. Recommended value for `high_priority` is 1-2 blocks to ensure a high `feerate`. | - - - Using the recommended values in the above table with a coin that has a block time of 10 minutes, the equivalent time in minutes is: - - * `background`: 120 minutes to 1440 minutes (2 hours to 1 day). - * `normal`: 60 minutes (one hour). - * `high_priority`: 10 to 20 minutes. - - -### CounterpartyChannelConfig - -| Parameter | Type | Description | -| --------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| allow\_outbound\_0conf | boolean | Optional, defaults to `true`. When setting an outbound channel, it can be used straight away [without waiting](https://docs.rs/lightning/latest/lightning/util/config/struct.ChannelHandshakeLimits.html#structfield.trust_own_funding_0conf) for any on-chain confirmations. | -| force\_announced\_channel\_preference | boolean | Optional, defaults to `true`. Set to force an incoming channel to match our announced channel preference in ChannelOptions announced\_channel. | -| outbound\_channels\_confirmations | integer | Optional, defaults to `144`. Confirmations we will wait for before considering an inbound channel locked in. | -| our\_locktime\_limit | boolean | Optional, defaults to `2016`. Set to the amount of blocks we're willing to wait to claim money back to us. | -| min\_funding\_sats | boolean | Optional, defaults to `0`. Minimum allowed satoshis when an inbound channel is funded. | -| max\_funding\_sats | boolean | Optional, defaults to `16777215`. Maximum allowed satoshis when an inbound channel is funded. | -| max\_htlc\_minimum\_msat | boolean | Optional, defaults to `18446744073709551615`. The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows us to limit the maximum minimum-size they can require. | -| min\_max\_htlc\_value\_in\_flight\_msat | boolean | Optional, defaults to `0`. The remote node sets a limit on the maximum value of pending HTLCs to them at any given time to limit their funds exposure to [HTLCs](https://academy.binance.com/en/glossary/hashed-timelock-contract). This allows us to set a minimum such value. | -| max\_channel\_reserve\_sats | boolean | Optional, defaults to `18446744073709551615`. The remote node will require us to keep a certain amount in direct payment to ourselves at all time, ensuring that we are able to be punished if we broadcast an old state. This allows us to limit the amount which we will have to keep to ourselves (and cannot use for [HTLCs](https://academy.binance.com/en/glossary/hashed-timelock-contract)). | -| min\_max\_accepted\_htlcs | boolean | Optional, defaults to `0`. The remote node sets a limit on the maximum number of pending HTLCs to them at any given time. This allows us to set a minimum such value. | - -### FeeInfo - -The `FeeInfo` response object includes the following items for [withdraw (v2)](/komodo-defi-framework/api/v20/wallet/tx/withdraw/) requests: - -| Parameter | Type | Description | -| ---------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| type | string | Type of transaction fee; possible values: `UtxoFixed`, `UtxoPerKbyte`, `EthGas` | -| amount | string (numeric) | Fee amount in coin units, used only when type is `UtxoFixed` (fixed amount not depending on tx size) or `UtxoPerKbyte` (amount per Kbyte) | -| gas\_price | string (numeric) | Used only when fee type is EthGas; sets the gas price in `gwei` units | -| gas | number (integer) | Used only when fee type is EthGas; sets the gas limit for transaction | - -### LightningActivationParams - -| Parameter | Type | Description | -| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| name | string | The name of the node that will be used in [lightning explorers](https://mempool.space/testnet/lightning/node/024e2a940e0cbeda84a0d5e00fa8e83b3f4e7f98382eedb488d058e0f5636dd164/r/n) | -| listening port | integer | Optional, defaults to `9735`. The port that this node listens for incoming connections on. | -| color | string | Optional, defaults to `2b6680`. A hexadecimal color string which will be used in network graphs on [lightning explorers](https://mempool.space/testnet/lightning/node/024e2a940e0cbeda84a0d5e00fa8e83b3f4e7f98382eedb488d058e0f5636dd164/r/n) | -| payment\_retries | integer | Optional, defaults to `5`. Number of times a payment will be retried if it fails. | -| backup\_path | string | Optional. The backup path for channel backups, preferably on an external drive. | - -### LightningChannelAmount - -| Parameter | Type | Description | -| --------- | ------ | -------------------------------------------------------------------------------------- | -| type | string | `Exact` for a specific amount or `Max` for whole balance. | -| value | object | Only required if type is `Exact`. The amount in BTC you want to open the channel with. | - -### LightningChannelConfig - - - The values in this object are only used if the channel is being opened by the user. If the channel is being opened by the counterparty, the values in this object are ignored. - If not specified when using the [open\_channel](/komodo-defi-framework/api/v20/lightning/channels/#open-channel) or [update\_channel](/komodo-defi-framework/api/v20/lightning/channels/#update-channel) methods, the values in this object will default to the values set in the `coins` configuration file. - - -| Parameter | Type | Description | -| --------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| inbound\_channels\_confirmations | string | Optional, defaults to `6`. Should be set in coins file, and applies to all channels. Confirmations we will wait for before considering an inbound channel locked in. | -| max\_inbound\_in\_flight\_htlc\_percent | integer | Optional, defaults to `10`. Should be set in coins file, and applies to all channels. Sets the percentage of the channel value we will cap the total value of outstanding inbound HTLCs to. | -| our\_htlc\_minimum\_msat | integer | Optional, defaults to `1`. The smallest value HTLC we will accept to process. The channel gets closed any time our counterparty misbehaves by sending us an HTLC with a value smaller than this. | -| announced\_channel | boolean | Optional, defaults to `false`. Set to announce the channel publicly and notify all nodes that they can route via this channel. GUIs and wallet apps should be set to `false`. | -| commit\_upfront\_shutdown\_pubkey | boolean | Optional, defaults to `true`. When `true` (and the counterparty agrees), the user must use the same key for cooperative closing. This prevents a user from changing the destination address in a cooperative close, which slightly increases security (however, this option is not required if the counterparty does not support it and a channel can be accepted regardless). **Note that the key for forced closing is always fixed when opening a channel and is different from shutdown\_pubkey.** | -| counterparty\_locktime | integer | Optional, defaults to `144`. The number of blocks we require our counterparty to wait to claim their money on chainif they broadcast a revoked transaction. We have to be online at least once during this time to punish our counterparty for broadcasting a revoked transaction. We have to account also for the time to broadcast and confirm our transaction, possibly with time in between to [RBF (Replace-By-Fee)](https://bitcoinops.org/en/topics/replace-by-fee/) the spending transaction. | -| negotiate\_scid\_privacy | integer | Optional, defaults to `false`. If `true`, we attempt to negotiate the `scid_privacy` (referred to as `scid_alias` in the [BOLTs](https://github.com/lightning/bolts)) option for outbound private channels. This provides better privacy by not including our real on-chain channel UTXO in each invoice and requiring that our counterparty only relay HTLCs to us using the channel's SCID alias. | -| their\_channel\_reserve\_sats | boolean | Optional, defaults to `10000` or 1% of channel value. The minimum balance that the other node has to maintain on their side, at all times. This ensures that if our counterparty broadcasts a revoked state, we can punish them by claiming at least this value on chain. | - - - For GUIs and wallet apps, it is recommended to set `announced_channel` to `false` (the default value), as the node is not expected to be reliably online. - - -### LightningChannelOptions - -| Parameter | Type | Description | -| --------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| proportional\_fee\_in\_millionths\_sats | integer | Optional, defaults to `0`. Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in excess of proportional\_fee\_in\_millionths\_sats. | -| base\_fee\_msat | integer | Optional, defaults to `1000`. Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in excess of proportional\_fee\_in\_millionths\_sats. | -| cltv\_expiry\_delta | integer | Optional, defaults to `72`. Blocks until [CheckLockTimeVerify (CLTV)](https://academy.bit2me.com/en/que-es-cltv-bitcoin/) expiry. | -| max\_dust\_htlc\_exposure\_msat | integer | Optional, defaults to `5000000`. Limit our total exposure to in-flight [HTLCs](https://academy.binance.com/en/glossary/hashed-timelock-contract) which are burned to fees as they are too small to claim on-chain. | -| force\_close\_avoidance\_max\_fee\_sats | integer | Optional, defaults to `1000`. The additional fee we're willing to pay to avoid waiting for the counterparty's locktime to reclaim funds. | - -### LightningClosedChannelsFilter - -| Parameter | Type | Description | -| ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| channel\_id | string | Optional. Unique string identifying a channel by its ID. | -| counterparty\_node\_id | string | Optional. A hexadecimal string identifying a counterparty node. | -| funding\_tx | string | Optional. A transaction ID which added funds. | -| from\_funding\_value | integer | Optional. The minimum value of channel funding in satoshis. | -| to\_funding\_value | integer | Optional. The maximum value of channel funding in satoshis. | -| channel\_type | string | Optional. `Inbound` or `Outbound`. | -| closing\_tx | integer | Optional. A transaction ID which closed the channel. | -| closure\_reason | integer | Optional. The reason a channel was closed. | -| claiming\_tx | integer | Optional. The ID of the transaction that returned the remaining outbound funds when the channel was closed to our on-chain address. | -| from\_claimed\_balance | integer | Optional. The minimum balance of channel funds claimed in satoshis. | -| to\_claimed\_balance | integer | Optional. The maximum balance of channel funds claimed in satoshis. | -| channel\_visibility | integer | Optional. `Public` or `Private`. | - - - Response may change to be more consistent in future. - [https://github.com/KomodoPlatform/komodo-docs-mdx/pull/31#discussion\\\_r1206446309](https://github.com/KomodoPlatform/komodo-docs-mdx/pull/31#discussion\\_r1206446309) - - -### LightningOpenChannelsFilter - -| Parameter | Type | Description | -| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| channel\_id | string | Optional. Unique string identifying a channel by its ID. | -| counterparty\_node\_id | string | Optional. A hexadecimal string identifying a counterparty node. | -| funding\_tx | string | Optional. A transaction ID which added funds. | -| from\_funding\_value\_sats | integer | Optional. The minimum value of channel funding in satoshis. | -| to\_funding\_value\_sats | integer | Optional. The maximum value of channel funding in satoshis. | -| is\_outbound | boolean | Optional. If `true`, limits the response to outbound channels only. | -| from\_balance\_msat | integer | Optional. The minimum channel balance in millisatoshis. | -| to\_balance\_msat | integer | Optional. The maximum channel balance in millisatoshis. | -| from\_outbound\_capacity\_msat | integer | Optional. The minimum outbound capacity of the channel balance in millisatoshis. | -| to\_outbound\_capacity\_msat | integer | Optional. The maximum outbound capacity of the channel balance in millisatoshis. | -| from\_inbound\_capacity\_msat | integer | Optional. The minimum inbound capacity of the channel balance in millisatoshis. | -| to\_inbound\_capacity\_msat | integer | Optional. The maximum inbound capacity of the channel balance in millisatoshis. | -| confirmed | boolean | Optional. If `true`, only channels with channel opening transactions that passed the number of confirmations required for the channel to be usable will be returned. | -| is\_usable | boolean | Optional. If `true`, only channels that are confirmed and the counterparty is online, meaning that these channels can be used for payments will be returned. | -| is\_public | boolean | Optional. If `true`, only channels that our node announces to the lightning network, these channels are visible on lightning explorers will be returned. | - -### LightningPayment - -| Parameter | Type | Description | -| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| type | string | The payment type. Accepted values are `invoice` or [`keysend`](https://cdecker-lightning.readthedocs.io/lightning-keysend.7.html). | -| invoice | string | Only used if `type` is `invoice`. An identifying string which represents the invoice. | -| destination | string | Only used if `type` is `keysend`. A `node_pubkey` (which is also the node address in lightning context). Not to be confused with an onchain address. | -| amount\_in\_msat | string | Only used if `type` is `keysend`. Amount to be paid, in [millisatoshis](https://bitcoindata.science/bitcoin-units-converter.html) (A thousandth of a satoshi; the same as 0.00000000001 bitcoin). | -| expiry | string | Only used if `type` is `keysend`. Optional, defaults to `3600`. Seconds until the payment expires. | - -### LightningPaymentFilter - -| Parameter | Type | Description | -| --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------- | -| payment\_type | object | A standard `LightningPaymentType` object. | -| description | string | Optional. A note to indicate the purpose of the invoice. | -| status | string | Optional. Accepted values: `pending`, `succeeded`, `failed`. | -| from\_amount\_msat | integer | Optional. Minimum amount sent in [millisatoshis](https://bitcoindata.science/bitcoin-units-converter.html) | -| to\_amount\_msat | integer | Optional. Maximum amount sent in [millisatoshis](https://bitcoindata.science/bitcoin-units-converter.html) | -| from\_fee\_paid\_msat | integer | Optional. Minimum transaction fee paid in [millisatoshis](https://bitcoindata.science/bitcoin-units-converter.html) | -| to\_fee\_paid\_msat | integer | Optional. Maximum transaction fee paid in [millisatoshis](https://bitcoindata.science/bitcoin-units-converter.html) | -| from\_timestamp | string | Optional. Minimum timestamp (in milliseconds) of payment results to return. | -| to\_timestamp | string | Optional. Maximum timestamp (in milliseconds) of payment results to return. | - -### LightningPaymentType - -| Parameter | Type | Description | -| ----------- | ------ | ----------------------------------------------------------------------------------- | -| type | object | Accepted values are `Outbound Payment` or `Inbound Payment`. | -| destination | string | Only used if `type` is `Outbound Payment`. A pubkey which will receive the payment. | - - - Response may change in future. - See [https://github.com/KomodoPlatform/komodo-docs-mdx/pull/31#discussion\\\_r1206176530](https://github.com/KomodoPlatform/komodo-docs-mdx/pull/31#discussion\\_r1206176530) - - -### Pagination - -For requests which return many results, pagination offsets may be applied. \*\* Use either value, not both. \*\* - -| Parameter | Type | Description | -| ---------- | ------- | ------------------------------------------------------- | -| PageNumber | integer | Optional, defaults to `1`. Offset for paginated results | -| FromId | integer | Optional. Ignores any results prior to this UUID | - - - #### Example - - ```json - { - "PageNumber": 1 - } - ``` - - ```json - { - "FromId": 4 - } - ``` - - -### HistoryTarget - -Used to specify a HD wallet `account_id` or `address_id` for [my\_tx\_history v2](/komodo-defi-framework/api/v20/wallet/tx/my_tx_history/) requests. - -| Parameter | Type | Description | -| ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| type | string | Filters results by `account_id` or `address_id` part of the derivation path. | -| account\_id | integer | `ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. | -| address\_id | integer | Only required when `type` is `address_id`. `ADDRESS_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. | -| chain | string | Only required when `type` is `address_id`. `Internal`, or `External`. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change. | - - - #### Example - - ```json - { - "type": "account_id", - "account_id": 77 - } - ``` - - ```json - { - "type": "address_id", - "account_id": 0, - "chain": "External", // Accepted values: "External" and "Internal" - "address_id": 1 - } - ``` - - -### TokensRequest - -The `TokensRequest` object includes the following items for a given coin or token: - -| Parameter | Type | Description | -| ----------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | -| ticker | string | Ticker of the token to be enabled | -| required\_confirmations | integer | How many confirmations to wait during the transaction steps of an atomic swap. Overwrites value in coins file; defaults to `3` | - - - ```json - { - "ticker": "MINDS-ERC20", - "required_confirmations": 4 - } - ``` - - -### WalletBalanceInfo - -The `WalletBalanceInfo` object includes the following items in the activation response for a coin in HD mode: - -| Parameter | Type | Description | -| ------------ | ------ | ----------------------------------------------------------------------------------------------- | -| wallet\_type | string | In HD wallet mode, this will return `HD`. What are the other values? | -| accounts | object | A standard [WalletAccountInfo](/komodo-defi-framework/api/v20/#wallet-account-info) object. | - -```json -{ - "wallet_balance": { - "wallet_type": "HD", - "accounts": [ - ... - ] - } -} -``` - -### WithdrawFromInfo - -The `WithdrawFromInfo` response object includes the following items for HD Wallet [withdraw (v2)](/komodo-defi-framework/api/v20/wallet/tx/withdraw/) requests. -You can use either the `derivation_path` on its own, or the `account_id`, `chain` and `address_id` together. - -| Parameter | Type | Description | -| ---------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| derivation\_path | string | The [BIP44 derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) of the address. | -| account\_id | integer | `ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. **Please don't confuse with the global account.** | -| address\_id | integer | `ADDRESS_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. | -| chain | string | `Internal`, or `External`. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change. | - -### FeeInfo - -The `FeeInfo` response object includes the following items for [withdraw (v2)](/komodo-defi-framework/api/v20/wallet/tx/withdraw/) requests: - -| Parameter | Type | Description | -| ---------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| type | string | Type of transaction fee; possible values: `UtxoFixed`, `UtxoPerKbyte`, `EthGas` | -| amount | string (numeric) | Fee amount in coin units, used only when type is `UtxoFixed` (fixed amount not depending on tx size) or `UtxoPerKbyte` (amount per Kbyte) | -| gas\_price | string (numeric) | Used only when fee type is EthGas; sets the gas price in `gwei` units | -| gas | number (integer) | Used only when fee type is EthGas; sets the gas limit for transaction | - -### ScanAddressesInfo - -The `ScanAddressesInfo` response object includes the following items for request in HD mode: - -| Parameter | Type | Description | -| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| account\_index | integer | `ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. **Please don't confuse with the global account.** | -| derivation\_path | string | The [BIP44 derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) of the account. | -| new\_addresses | list | A list of standard [NewAddressInfo](/komodo-defi-framework/api/v20/#new-address-info) objects. | - - - Confirm `new_addresses` array has the structure of `NewAddressInfo`. - - -### NewAddressInfo - -The `NewAddressInfo` response object includes the following items for request in HD mode: - -| Parameter | Type | Description | -| ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| address | string | The account address for a specific derivation path under the `account_index`. | -| derivation\_path | string | The [BIP44 derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) of the address. If there are no more addresses with balances within the gap limit, the address index will increment. | -| balance | object | A standard [balanceInfo](/komodo-defi-framework/api/v20/#balance-info) object. | -| chain | string | `Internal`, or `External`. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change. | - -### WalletAccountInfo - -The `WalletAccountInfo` object includes the following items in the activation response for a coin in HD mode: - -| Parameter | Type | Description | -| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| account\_index | integer | `ACCOUNT_ID` child in the `m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID` BIP44 derivation path. **Please don't confuse with the global account.** | -| derivation\_path | string | Derivation path up to the `COIN` child. E.g. `"m/44'/141'/0'"` | -| total\_balance | object | A standard [balanceInfo](/komodo-defi-framework/api/v20/#balance-info) object. | -| addresses | list | A list of standard [AccountAddressInfo](/komodo-defi-framework/api/v20/#account-address-info) objects. | - -```json -{ - "account_index": 0, - "derivation_path": "m/44'/141'/0'", - "total_balance": { - "spendable": "23.08710255", - "unspendable": "0" - }, - "addresses": [ - ... - ] -} -``` - -### AccountAddressInfo - -The `AccountAddressInfo` object includes the following items for active addresses in the activation response for a coin in HD mode: - -| Parameter | Type | Description | -| ---------------- | ------ | ----------------------------------------------------------------------------------------------------------- | -| address | string | The account address for a specific derivation path under the `account_index`. | -| derivation\_path | string | The [BIP44 derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) of the address. | -| chain | string | `External` or `Internal`, as defined in the activation request. | -| balance | object | A standard [balanceInfo](/komodo-defi-framework/api/v20/#balance-info) object. | - - - ```json - { - "address": "RXNtAyDSsY3DS3VxTpJegzoHU9bUX54j56", - "derivation_path": "m/44'/141'/0'/0/0", - "chain": "External", - "balance": { - "spendable": "7.64018255", - "unspendable": "0" - } - } - ``` - - ## Error types #### NotSufficientBalance diff --git a/src/pages/komodo-defi-framework/api/v20/lightning/activation/index.mdx b/src/pages/komodo-defi-framework/api/v20/lightning/activation/index.mdx index f3b2195b..dacbcef6 100644 --- a/src/pages/komodo-defi-framework/api/v20/lightning/activation/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/lightning/activation/index.mdx @@ -211,11 +211,11 @@ The `task::enable_lightning::status` request checks the status of lightning node ### Response Parameters - | Parameter | Type | Description | - | -------------- | ------ | ------------------------------------------------------------------------------ | - | platform\_coin | string | The coin ticker for which the lightning node is being intitialized. | - | address | string | This node's address for the activated coin. | - | balance | object | A standard [BalanceInfo](/komodo-defi-framework/api/v20/#balance-info) object. | + | Parameter | Type | Description | + | -------------- | ------ | -------------------------------------------------------------------------------------------- | + | platform\_coin | string | The coin ticker for which the lightning node is being intitialized. | + | address | string | This node's address for the activated coin. | + | balance | object | A standard [balanceInfo](/komodo-defi-framework/api/common_structures/#balance-info) object. | The unspendable balance for lightning is different to a layer-1 unspendable balance. The channel reserve is part of the unspendable balance in lightning - the user will get this part of the balance on chain when closing the channel, but it can't be spent on layer 2 (lightning) because it's part of the security mechanism to prevent channel breaches and ensure that both parties fulfill their obligations within the channel. diff --git a/src/pages/komodo-defi-framework/api/v20/wallet/hd/address_management/index.mdx b/src/pages/komodo-defi-framework/api/v20/wallet/hd/address_management/index.mdx index aba69a68..d74df29f 100644 --- a/src/pages/komodo-defi-framework/api/v20/wallet/hd/address_management/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/wallet/hd/address_management/index.mdx @@ -20,9 +20,9 @@ If we don't already have too many unused addresses, we can use the `get_new_addr #### Response -| Parameter | Type | Description | -| ------------ | ------ | ------------------------------------------------------------------------------------- | -| new\_address | object | A standard [NewAddressInfo](/komodo-defi-framework/api/v20/#new-address-info) object. | +| Parameter | Type | Description | +| ------------ | ------ | ---------------------------------------------------------------------------------------------------------- | +| new\_address | object | A standard [NewAddressInfo](/komodo-defi-framework/api/common_structures/wallet/#new-address-info) object. | Some reasons you might not be able to get a new address are: @@ -133,10 +133,10 @@ Use the `task::scan_for_new_addresses::status` method to query the status of a H #### Response -| Parameter | Type | Description | -| --------- | ---------------- | ---------------------------------------------------------------------------------------------------------- | -| status | string | Status of the task. `Ok`, `InProgress` or `Error`. | -| details | string or object | Once complete, a standard [ScanAddressesInfo](/komodo-defi-framework/api/v20/#scan-addresses-info) object. | +| Parameter | Type | Description | +| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| status | string | Status of the task. `Ok`, `InProgress` or `Error`. | +| details | string or object | Once complete, a standard [ScanAddressesInfo](/komodo-defi-framework/api/common_structures/wallet/#scan-addresses-info) object. | #### 📌 Examples diff --git a/src/pages/komodo-defi-framework/api/v20/wallet/hd/task_account_balance/index.mdx b/src/pages/komodo-defi-framework/api/v20/wallet/hd/task_account_balance/index.mdx index 6852a56d..bb528e25 100644 --- a/src/pages/komodo-defi-framework/api/v20/wallet/hd/task_account_balance/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/wallet/hd/task_account_balance/index.mdx @@ -80,7 +80,7 @@ Use the `task::account_balance::status` method to view the status / response of | ...address | string | Spendable balance for this address | | ...derivation\_path | string | The The [BIP44 derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) of an address. | | ...chain | string(numeric) | `Internal` or `External`. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change. | -| ...balance | object | A map of standard [balanceInfo](/komodo-defi-framework/api/v20/#balance-info) objects, by ticker. | +| ...balance | object | A map of standard [balanceInfo](/komodo-defi-framework/api/common_structures/#balance-info) objects, by ticker. | | ....spendable | string(numeric) | Spendable balance for this address | | ....unspendable | string(numeric) | Unspendable balance for this address (e.g. from unconfirmed incoming transactions) | diff --git a/src/pages/komodo-defi-framework/api/v20/wallet/hd/task_create_new_account/index.mdx b/src/pages/komodo-defi-framework/api/v20/wallet/hd/task_create_new_account/index.mdx index e3c7137a..c3876a28 100644 --- a/src/pages/komodo-defi-framework/api/v20/wallet/hd/task_create_new_account/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/wallet/hd/task_create_new_account/index.mdx @@ -71,10 +71,10 @@ Use the `task::create_new_account::status` method to query the status of a HD ac #### Response -| Parameter | Type | Description | -| --------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| status | string | Status of the task. `Ok`, `InProgress` or `Error`. | -| details | string or object | If in progress, either `Preparing` or `RequestingAccountBalance`. Once complete, a standard [WalletAccountInfo](/komodo-defi-framework/api/v20/#wallet-account-info) object. | +| Parameter | Type | Description | +| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| status | string | Status of the task. `Ok`, `InProgress` or `Error`. | +| details | string or object | If in progress, either `Preparing` or `RequestingAccountBalance`. Once complete, a standard [WalletAccountInfo](/komodo-defi-framework/api/common_structures/wallet/#wallet-account-info) object. | #### 📌 Examples diff --git a/src/pages/komodo-defi-framework/api/v20/wallet/tx/my_tx_history/index.mdx b/src/pages/komodo-defi-framework/api/v20/wallet/tx/my_tx_history/index.mdx index ea8bd0a6..4bcd10dd 100644 --- a/src/pages/komodo-defi-framework/api/v20/wallet/tx/my_tx_history/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/wallet/tx/my_tx_history/index.mdx @@ -10,12 +10,12 @@ For all other coins, use the legacy [my\_tx\_history](/komodo-defi-framework/api ## Arguments -| parameter | Type | Description | -| --------------- | ------- | ------------------------------------------------------------------------------------------------ | -| coin | string | Ticker of the coin to get history for. | -| limit | integer | Optional. Limits the number of returned transactions. Defaults to `10`. Ignored if `max = true`. | -| paging\_options | object | Optional. A standard [Pagination](/komodo-defi-framework/api/v20/#pagination) object. | -| target | object | Optional. A standard [HistoryTarget](/komodo-defi-framework/api/v20/#history-target) object. | +| parameter | Type | Description | +| --------------- | ------- | ----------------------------------------------------------------------------------------------------------------- | +| coin | string | Ticker of the coin to get history for. | +| limit | integer | Optional. Limits the number of returned transactions. Defaults to `10`. Ignored if `max = true`. | +| paging\_options | object | Optional. A standard [Pagination](/komodo-defi-framework/api/common_structures/#pagination) object. | +| target | object | Optional. A standard [HistoryTarget](/komodo-defi-framework/api/common_structures/wallet/#history-target) object. | #### Response diff --git a/src/pages/komodo-defi-framework/api/v20/wallet/tx/withdraw/index.mdx b/src/pages/komodo-defi-framework/api/v20/wallet/tx/withdraw/index.mdx index 84448ceb..13d85ab5 100644 --- a/src/pages/komodo-defi-framework/api/v20/wallet/tx/withdraw/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/wallet/tx/withdraw/index.mdx @@ -16,8 +16,8 @@ This method generates a raw transaction which should then be broadcast using [se | 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. | +| fee | object | Optional. A standard [FeeInfo](/komodo-defi-framework/api/common_structures/#fee-info) object. | +| from | object | HD wallets only. A standard [WithdrawFromInfo](/komodo-defi-framework/api/common_structures/wallet/#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