diff --git a/.github/workflows/get_data_lint_files_deploy.yml b/.github/workflows/get_data_lint_files_deploy.yml index 79ffacaa..82c74bc1 100644 --- a/.github/workflows/get_data_lint_files_deploy.yml +++ b/.github/workflows/get_data_lint_files_deploy.yml @@ -42,7 +42,8 @@ jobs: key: npm-${{ hashFiles('package-lock.json') }} restore-keys: npm- - - name: Generate configs + - name: Generate API methods table + if: github.base_ref == 'main' || github.ref == 'refs/heads/main' shell: bash run: ${GITHUB_WORKSPACE}/utils/gen_api_methods_table.py diff --git a/filepathSlugs.json b/filepathSlugs.json index ebe9f3f6..b25f55d6 100644 --- a/filepathSlugs.json +++ b/filepathSlugs.json @@ -2721,6 +2721,16 @@ "response-success-6", "withdraw-qrc-20-with-gas-limit" ], + "src/pages/komodo-defi-framework/api/v20/active_swaps/index.mdx": [ + "active-swaps", + "arguments", + "response", + "examples", + "command-without-include-status", + "response-uuids-only", + "command-include-status-true", + "response-statuses-included" + ], "src/pages/komodo-defi-framework/api/v20/add_delegation/index.mdx": [ "add-delegation", "arguments", diff --git a/src/data/sidebar.json b/src/data/sidebar.json index 9a2d322d..39d71bcf 100644 --- a/src/data/sidebar.json +++ b/src/data/sidebar.json @@ -500,6 +500,10 @@ { "title": "Swaps", "links": [ + { + "title": "active_swaps", + "href": "/komodo-defi-framework/api/v20/active_swaps/" + }, { "title": "recreate_swap_data", "href": "/komodo-defi-framework/api/v20/recreate_swap_data/" 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 41ee56bf..25d37055 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 @@ -50,12 +50,13 @@ The `RawTxInfo` object includes the following items: The `InputTxns` object includes the following items: -| Parameter | Type | Description | -| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| tx\_hash | string | The transaction id of an unspent transaction from the same wallet output. | -| index | integer | The \[output index([https://bitcoin.stackexchange.com/questions/100765/what-does-the-index-of-an-utxo-stand-for](https://bitcoin.stackexchange.com/questions/100765/what-does-the-index-of-an-utxo-stand-for))] of this unspent transaction output. | -| script\_pub\_key | string | The [scriptpubkey](https://learnmeabitcoin.com/technical/scriptPubKey) of this unspent transaction output. | -| amount | decimal | The value of this unspent transaction output. | +| Parameter | Type | Description | +| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| tx\_hash | string | The transaction id of an unspent transaction from the same wallet output. | +| index | integer | The [output index](https://bitcoin.stackexchange.com/questions/100765/what-does-the-index-of-an-utxo-stand-for) of this unspent transaction output. | +| script\_pub\_key | string | The [scriptpubkey](https://learnmeabitcoin.com/technical/scriptPubKey) of this unspent transaction output. | +| amount | float | The value of this unspent transaction output. | +| amount | | | ```json diff --git a/src/pages/komodo-defi-framework/api/index.mdx b/src/pages/komodo-defi-framework/api/index.mdx index 1cf2c1ec..894e5279 100644 --- a/src/pages/komodo-defi-framework/api/index.mdx +++ b/src/pages/komodo-defi-framework/api/index.mdx @@ -12,7 +12,7 @@ Below is a table of the currently available legacy, v2.0 and v2.0 (Dev) methods: | Legacy | v2.0 (release) | v2.0 (dev) | | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| [active\_swaps](/komodo-defi-framework/api/legacy/active_swaps/#active-swaps) | | | +| [active\_swaps](/komodo-defi-framework/api/legacy/active_swaps/#active-swaps) | [active\_swaps](/komodo-defi-framework/api/v20/active_swaps/#active-swaps) | | | | [add\_delegation](/komodo-defi-framework/api/v20/add_delegation/#add-delegation) | | | | [add\_node\_to\_version\_stat](/komodo-defi-framework/api/v20/add_node_to_version_stat/#add-node-to-version-stat) | | | [all\_swaps\_uuids\_by\_filter](/komodo-defi-framework/api/legacy/all_swaps_uuids_by_filter/#all-swaps-uuids-by-filter) | | | diff --git a/src/pages/komodo-defi-framework/api/legacy/active_swaps/index.mdx b/src/pages/komodo-defi-framework/api/legacy/active_swaps/index.mdx index 2324cae8..89860c55 100644 --- a/src/pages/komodo-defi-framework/api/legacy/active_swaps/index.mdx +++ b/src/pages/komodo-defi-framework/api/legacy/active_swaps/index.mdx @@ -4,10 +4,12 @@ export const description = # active\_swaps -**active\_swaps (include\_status)** - The `active_swaps` method returns all the swaps that are currently running on the Komodo DeFi Framework API node. + + This method has been deprecated in favor of [active\_swaps v2](/komodo-defi-framework/api/v20/active_swaps/). The legacy version does not include v2 (Trading Protocol Upgrade) swap statuses in responses (it only returns uuids for these). + + ## Arguments | Structure | Type | Description | @@ -45,7 +47,8 @@ The `active_swaps` method returns all the swaps that are currently running on th "7592a07a-2805-4050-8ab8-984480e812f0", "82cbad96-ea9f-40fb-9225-07496323e35d", "177f7fa5-c9f3-4673-a2fa-28451a123e61" - ] + ], + "statuses": null } } ``` @@ -68,122 +71,104 @@ The `active_swaps` method returns all the swaps that are currently running on th ```json { - "uuids": ["5d02843e-d1b4-488d-aad0-114d82020453"], - "statuses": { - "5d02843e-d1b4-488d-aad0-114d82020453": { - "type": "Taker", - "uuid": "5d02843e-d1b4-488d-aad0-114d82020453", - "events": [ - { - "timestamp": 1612780908698, - "event": { - "type": "Started", - "data": { - "taker_coin": "MARTY", - "maker_coin": "DOC", - "maker": "7310a8fb9fd8f198a1a21db830252ad681fccda580ed4101f3f6bfb98b34fab5", - "my_persistent_pub": "03ad6f89abc2e5beaa8a3ac28e22170659b3209fe2ddf439681b4b8f31508c36fa", - "lock_duration": 7800, - "maker_amount": "1", - "taker_amount": "1", - "maker_payment_confirmations": 1, - "maker_payment_requires_nota": false, - "taker_payment_confirmations": 1, - "taker_payment_requires_nota": false, - "taker_payment_lock": 1612788708, - "uuid": "5d02843e-d1b4-488d-aad0-114d82020453", - "started_at": 1612780908, - "maker_payment_wait": 1612784028, - "maker_coin_start_block": 793472, - "taker_coin_start_block": 797356, - "fee_to_send_taker_fee": { - "coin": "MARTY", - "amount": "0.00001" - }, - "taker_payment_trade_fee": { - "coin": "MARTY", - "amount": "0.00001" - }, - "maker_payment_spend_trade_fee": { - "coin": "DOC", - "amount": "0" - } - } - } - }, - { - "timestamp": 1612780924704, - "event": { - "type": "Negotiated", - "data": { - "maker_payment_locktime": 1612796508, - "maker_pubkey": "037310a8fb9fd8f198a1a21db830252ad681fccda580ed4101f3f6bfb98b34fab5", - "secret_hash": "026bebc2e19c243d0940dd583c9573bf10377afd" - } - } - }, - { - "timestamp": 1612780924962, - "event": { - "type": "TakerFeeSent", - "data": { - "tx_hex": "0400008085202f8901f425fbefe21f33ccb7b487df251191b27dfa7b639b04f60e5493c7ea41dbf149000000006b483045022100d5ec3e542175479bd4bd011e19b76a75e99f19cc49867e5bca9541950322c33a02207a4d1ffd674fb9760de79bb4929af44d66344b5e182de3c377186deebf6bf376012103ad6f89abc2e5beaa8a3ac28e22170659b3209fe2ddf439681b4b8f31508c36faffffffff02bcf60100000000001976a914ca1e04745e8ca0c60d8c5881531d51bec470743f88ac5ce6f305000000001976a914d55f0df6cb82630ad21a4e6049522a6f2b6c9d4588ac7c152160000000000000000000000000000000", - "tx_hash": "75323ab7acd64bd35242611fabaec560d9acf2e1f9ca28d3a4aba47a79fb49c4" - } - } - }, - { - "timestamp": 1612780935966, - "event": { - "type": "MakerPaymentReceived", - "data": { - "tx_hex": "0400008085202f89028bef955e42107c562e4e02421f25c455723a701573f86c17b4d82e35a7d8f9f7020000006b483045022100b12fc9d95acca76bf5fd8d5c6acc288b454032ba4561b1c2b1f5f33b2cf2926d022017e561bc2cd93308848674b47b2e8ebd8f074ea78e32454d5fea6f08c0b1f1e40121037310a8fb9fd8f198a1a21db830252ad681fccda580ed4101f3f6bfb98b34fab5ffffffff5dfd0b24c0f7c3cf235868cf9a26ec49574764d135796fc4e7d20e95d55a8653000000006a47304402207c752d14601d1c99892f9d6c88c8ff2f93211640a65b2ee69172a16b908b21e402206f0b66684158445888271a849ab46258ad722496ee64fde055a6f44e36ed2ccc0121037310a8fb9fd8f198a1a21db830252ad681fccda580ed4101f3f6bfb98b34fab5ffffffff0300e1f5050000000017a9141b85c1a277f44f7d77d52b78e2ba70a0becc2ff9870000000000000000166a14026bebc2e19c243d0940dd583c9573bf10377afda7d26301000000001976a91486f747b28c60ad1130bdd3f84f48eeaf1801ca9888ac87152160000000000000000000000000000000", - "tx_hash": "27dafe553246553d54f909fbbded80e6d490fdb95ca7b6807d73eca45f0d7a22" - } - } - }, - { - "timestamp": 1612780935967, - "event": { - "type": "MakerPaymentWaitConfirmStarted" - } + "uuids": [ + "44798382-8c63-4047-b5d8-70a60fa2546b" + ], + "statuses": { + "44798382-8c63-4047-b5d8-70a60fa2546b": { + "type": "Taker", + "uuid": "44798382-8c63-4047-b5d8-70a60fa2546b", + "my_order_uuid": "44798382-8c63-4047-b5d8-70a60fa2546b", + "events": [ + { + "timestamp": 1730634185287, + "event": { + "type": "Started", + "data": { + "taker_coin": "MARTY", + "maker_coin": "DOC", + "maker": "15d9c51c657ab1be4ae9d3ab6e76a619d3bccfe830d5363fa168424c0d044732", + "my_persistent_pub": "034cbf74541c1d3436bc7638a2738f64df4fee22d4443cdf11d54cea7d7f55f256", + "lock_duration": 7800, + "maker_amount": "2.4", + "taker_amount": "2.4", + "maker_payment_confirmations": 1, + "maker_payment_requires_nota": false, + "taker_payment_confirmations": 1, + "taker_payment_requires_nota": false, + "taker_payment_lock": 1730641984, + "uuid": "44798382-8c63-4047-b5d8-70a60fa2546b", + "started_at": 1730634184, + "maker_payment_wait": 1730637304, + "maker_coin_start_block": 803893, + "taker_coin_start_block": 818506, + "fee_to_send_taker_fee": { + "coin": "MARTY", + "amount": "0.00001", + "paid_from_trading_vol": false + }, + "taker_payment_trade_fee": { + "coin": "MARTY", + "amount": "0.00001", + "paid_from_trading_vol": false + }, + "maker_payment_spend_trade_fee": { + "coin": "DOC", + "amount": "0.00001", + "paid_from_trading_vol": true + }, + "maker_coin_htlc_pubkey": "034cbf74541c1d3436bc7638a2738f64df4fee22d4443cdf11d54cea7d7f55f256", + "taker_coin_htlc_pubkey": "034cbf74541c1d3436bc7638a2738f64df4fee22d4443cdf11d54cea7d7f55f256", + "p2p_privkey": null + } + } + } + ], + "maker_amount": "2.4", + "maker_coin": "DOC", + "maker_coin_usd_price": null, + "taker_amount": "2.4", + "taker_coin": "MARTY", + "taker_coin_usd_price": null, + "gui": "mm2_777", + "mm_version": "2.2.0-beta_caf803b", + "success_events": [ + "Started", + "Negotiated", + "TakerFeeSent", + "TakerPaymentInstructionsReceived", + "MakerPaymentReceived", + "MakerPaymentWaitConfirmStarted", + "MakerPaymentValidatedAndConfirmed", + "TakerPaymentSent", + "WatcherMessageSent", + "TakerPaymentSpent", + "MakerPaymentSpent", + "MakerPaymentSpentByWatcher", + "MakerPaymentSpendConfirmed", + "Finished" + ], + "error_events": [ + "StartFailed", + "NegotiateFailed", + "TakerFeeSendFailed", + "MakerPaymentValidateFailed", + "MakerPaymentWaitConfirmFailed", + "TakerPaymentTransactionFailed", + "TakerPaymentWaitConfirmFailed", + "TakerPaymentDataSendFailed", + "TakerPaymentWaitForSpendFailed", + "MakerPaymentSpendFailed", + "MakerPaymentSpendConfirmFailed", + "TakerPaymentWaitRefundStarted", + "TakerPaymentRefundStarted", + "TakerPaymentRefunded", + "TakerPaymentRefundedByWatcher", + "TakerPaymentRefundFailed", + "TakerPaymentRefundFinished" + ] } - ], - "maker_amount": "1", - "maker_coin": "DOC", - "taker_amount": "1", - "taker_coin": "MARTY", - "gui": null, - "mm_version": "23c89ced5", - "success_events": [ - "Started", - "Negotiated", - "TakerFeeSent", - "MakerPaymentReceived", - "MakerPaymentWaitConfirmStarted", - "MakerPaymentValidatedAndConfirmed", - "TakerPaymentSent", - "TakerPaymentSpent", - "MakerPaymentSpent", - "Finished" - ], - "error_events": [ - "StartFailed", - "NegotiateFailed", - "TakerFeeSendFailed", - "MakerPaymentValidateFailed", - "MakerPaymentWaitConfirmFailed", - "TakerPaymentTransactionFailed", - "TakerPaymentWaitConfirmFailed", - "TakerPaymentDataSendFailed", - "TakerPaymentWaitForSpendFailed", - "MakerPaymentSpendFailed", - "TakerPaymentWaitRefundStarted", - "TakerPaymentRefunded", - "TakerPaymentRefundFailed" - ] } - } } ``` diff --git a/src/pages/komodo-defi-framework/api/v20/active_swaps/index.mdx b/src/pages/komodo-defi-framework/api/v20/active_swaps/index.mdx new file mode 100644 index 00000000..b496d480 --- /dev/null +++ b/src/pages/komodo-defi-framework/api/v20/active_swaps/index.mdx @@ -0,0 +1,263 @@ +export const title = "Komodo DeFi Framework Method: Active Swaps (v2)"; +export const description = + "The active_swaps method returns all the swaps that are currently running on the Komodo DeFi Framework API node."; + +# active\_swaps + +The `active_swaps` method returns all the swaps that are currently running on the Komodo DeFi Framework API node. + +## Arguments + +| Structure | Type | Description | +| --------------- | ---- | ---------------------------------------------------------------------------- | +| include\_status | bool | Optional, defaults to `false`. Whether to include swap statuses in response; | + +## Response + +| Structure | Type | Description | +| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| uuids | array of strings | A list of currently active swap UUIDs. | +| statuses | object (map) | Only visible if `include_status` request parameter is `true`. A map of standard [SwapStatus](/komodo-defi-framework/api/common_structures/swaps/#swap-status) objects, delineated by the related UUID. | + +#### 📌 Examples + +#### Command (without include\_status) + + + ```json + { + "mmrpc": "2.0", + "userpass": "RPC_UserP@SSW0RD", + "method": "active_swaps", + "params": { + "include_status": false + } + } + ``` + + + + #### Response (uuids only) + + ```json + { + "result": { + "uuids": [ + "015c13bc-da79-43e1-a6d4-4ac8b3099b34", + "7592a07a-2805-4050-8ab8-984480e812f0", + "82cbad96-ea9f-40fb-9225-07496323e35d", + "177f7fa5-c9f3-4673-a2fa-28451a123e61" + ], + "statuses": {} + }, + "id": null + } + ``` + + +#### Command (include\_status = true) + + + ```json + { + "mmrpc": "2.0", + "userpass": "RPC_UserP@SSW0RD", + "method": "active_swaps", + "params": { + "include_status": true + }, + "id": 42 + } + ``` + + + + #### Response (statuses included) + + ```json + { + "mmrpc": "2.0", + "result": { + "uuids": [ + "7b60a494-f159-419c-8f41-02e10f897513" + ], + "statuses": { + "7b60a494-f159-419c-8f41-02e10f897513": { + "swap_type": "TakerV1", + "swap_data": { + "uuid": "7b60a494-f159-419c-8f41-02e10f897513", + "my_order_uuid": "7b60a494-f159-419c-8f41-02e10f897513", + "events": [ + { + "timestamp": 1730633787643, + "event": { + "type": "Started", + "data": { + "taker_coin": "MARTY", + "maker_coin": "DOC", + "maker": "15d9c51c657ab1be4ae9d3ab6e76a619d3bccfe830d5363fa168424c0d044732", + "my_persistent_pub": "034cbf74541c1d3436bc7638a2738f64df4fee22d4443cdf11d54cea7d7f55f256", + "lock_duration": 7800, + "maker_amount": "2.4", + "taker_amount": "2.4", + "maker_payment_confirmations": 1, + "maker_payment_requires_nota": false, + "taker_payment_confirmations": 1, + "taker_payment_requires_nota": false, + "taker_payment_lock": 1730641586, + "uuid": "7b60a494-f159-419c-8f41-02e10f897513", + "started_at": 1730633786, + "maker_payment_wait": 1730636906, + "maker_coin_start_block": 803888, + "taker_coin_start_block": 818500, + "fee_to_send_taker_fee": { + "coin": "MARTY", + "amount": "0.00001", + "paid_from_trading_vol": false + }, + "taker_payment_trade_fee": { + "coin": "MARTY", + "amount": "0.00001", + "paid_from_trading_vol": false + }, + "maker_payment_spend_trade_fee": { + "coin": "DOC", + "amount": "0.00001", + "paid_from_trading_vol": true + }, + "maker_coin_htlc_pubkey": "034cbf74541c1d3436bc7638a2738f64df4fee22d4443cdf11d54cea7d7f55f256", + "taker_coin_htlc_pubkey": "034cbf74541c1d3436bc7638a2738f64df4fee22d4443cdf11d54cea7d7f55f256", + "p2p_privkey": null + } + } + }, + { + "timestamp": 1730633801655, + "event": { + "type": "Negotiated", + "data": { + "maker_payment_locktime": 1730649385, + "maker_pubkey": "000000000000000000000000000000000000000000000000000000000000000000", + "secret_hash": "b476e27c0c6680ac67765163b1b5736dd7649512", + "maker_coin_swap_contract_addr": null, + "taker_coin_swap_contract_addr": null, + "maker_coin_htlc_pubkey": "0315d9c51c657ab1be4ae9d3ab6e76a619d3bccfe830d5363fa168424c0d044732", + "taker_coin_htlc_pubkey": "0315d9c51c657ab1be4ae9d3ab6e76a619d3bccfe830d5363fa168424c0d044732" + } + } + }, + { + "timestamp": 1730633802415, + "event": { + "type": "TakerFeeSent", + "data": { + "tx_hex": "0400008085202f8901a12c9c4c1c0e3ebd6329a7a0cd3c0a34a2355e5bea93b50faaa46d8889eb4ee0000000006a47304402200774c8e6fbb94df8ab73d9dbbd858326b361cc132d14c90e4ebf7d2a6bc5f9b402204fa716b684c20a3c56b28a42e63bfa3edcd3a76e261bee674f00ec0ccff674160121034cbf74541c1d3436bc7638a2738f64df4fee22d4443cdf11d54cea7d7f55f256ffffffff0290b60400000000001976a914ca1e04745e8ca0c60d8c5881531d51bec470743f88ac882e4317120000001976a914d64ad24e655ba7221ea51c7931aad5b98da77f3c88ac4a602767000000000000000000000000000000", + "tx_hash": "3febb9949f3e751c568b774719a9fbf851bc9b4c6083da8c0927e4d1c078c21c" + } + } + }, + { + "timestamp": 1730633804416, + "event": { + "type": "TakerPaymentInstructionsReceived", + "data": null + } + }, + { + "timestamp": 1730633804421, + "event": { + "type": "MakerPaymentReceived", + "data": { + "tx_hex": "0400008085202f89045c20450775f07a4c448fbfebe47fdfa058c9a25254d36874765b44e1b3aaa193020000006a473044022079e6fbe2a24beb093858c644f765403d7a23714c17bee99c0b88fdd4b1d2bfbf02206f104b94437e4ce39d6854b48c1abccd218ee42436c8b5ac29e9136d538aa89501210315d9c51c657ab1be4ae9d3ab6e76a619d3bccfe830d5363fa168424c0d044732ffffffff620a3f975950554a03ecce8a2918958e8f1a17db70e7efe420618f3622844196000000006a47304402205721b4ce8c079604ce6f5779289fdc66912e064f12c40cc174daab80534a623f0220575fcc814edbec126834ce408ecbcf7ec2d7a8df2e323273266c8b47518ba9e701210315d9c51c657ab1be4ae9d3ab6e76a619d3bccfe830d5363fa168424c0d044732ffffffff9ac8dbb806e5722c00c60623c7313c41892649531a1c134f5d700b8f85157559000000006a473044022074a909367ba10cf375fb84414bad2ee41ffb35940132d94a9033736185df4b58022032b6dd0aeb5e102584e63d294d66367e19eaa599ed438d0209a039190bca10f401210315d9c51c657ab1be4ae9d3ab6e76a619d3bccfe830d5363fa168424c0d044732ffffffff46c38d985571abe367e07c7415b278bebdaa7b6b7283a7d069dfde6fb820cb8d020000006a47304402203397ffb5b16d0c829aac977ae92d8bc76cd3e9afc17bef3da436272bb672a0bd02207b3c026e25fd70048f12c166851a1d53ff2931e5073028588dde9715d63a527501210315d9c51c657ab1be4ae9d3ab6e76a619d3bccfe830d5363fa168424c0d044732ffffffff03001c4e0e0000000017a914f9bb3725cdd5d07b6f2b5387b5cf4471a4ad0463870000000000000000166a14b476e27c0c6680ac67765163b1b5736dd7649512dee80841410500001976a9141462c3dd3f936d595c9af55978003b27c250441f88ac4b602767000000000000000000000000000000", + "tx_hash": "ebeba78542427dcf9bc720063582b99153afe6efcde49d16aacf67a8e597a41e" + } + } + }, + { + "timestamp": 1730633804421, + "event": { + "type": "MakerPaymentWaitConfirmStarted" + } + }, + { + "timestamp": 1730633836140, + "event": { + "type": "MakerPaymentValidatedAndConfirmed" + } + }, + { + "timestamp": 1730633839137, + "event": { + "type": "TakerPaymentSent", + "data": { + "tx_hex": "0400008085202f89011cc278c0d1e427098cda83604c9bbc51f8fba91947778b561c753e9f94b9eb3f010000006a473044022024b2c5bc5b23e8e774f6a8001de8f94a4e6888456722fede2be6b061d6d93c9302203805a7d1c9361fee2066e26f6196476f73f34246f60308cfafa3783a94a3cab30121034cbf74541c1d3436bc7638a2738f64df4fee22d4443cdf11d54cea7d7f55f256ffffffff03001c4e0e0000000017a914fbb04e8d9b7b4098c887aed16124291646462525870000000000000000166a14b476e27c0c6680ac67765163b1b5736dd7649512a00ef508120000001976a914d64ad24e655ba7221ea51c7931aad5b98da77f3c88ac6c602767000000000000000000000000000000", + "tx_hash": "08e94af501630e46f4b2c5d64e6851c6bc9a3828506fef9f6668938d36c7b2da" + } + } + }, + { + "timestamp": 1730633839137, + "event": { + "type": "WatcherMessageSent", + "data": [ + [ + ... + ], + [ + ... + ] + ] + } + } + ], + "maker_amount": "2.4", + "maker_coin": "DOC", + "maker_coin_usd_price": null, + "taker_amount": "2.4", + "taker_coin": "MARTY", + "taker_coin_usd_price": null, + "gui": "mm2_777", + "mm_version": "2.2.0-beta_caf803b", + "success_events": [ + "Started", + "Negotiated", + "TakerFeeSent", + "TakerPaymentInstructionsReceived", + "MakerPaymentReceived", + "MakerPaymentWaitConfirmStarted", + "MakerPaymentValidatedAndConfirmed", + "TakerPaymentSent", + "WatcherMessageSent", + "TakerPaymentSpent", + "MakerPaymentSpent", + "MakerPaymentSpentByWatcher", + "MakerPaymentSpendConfirmed", + "Finished" + ], + "error_events": [ + "StartFailed", + "NegotiateFailed", + "TakerFeeSendFailed", + "MakerPaymentValidateFailed", + "MakerPaymentWaitConfirmFailed", + "TakerPaymentTransactionFailed", + "TakerPaymentWaitConfirmFailed", + "TakerPaymentDataSendFailed", + "TakerPaymentWaitForSpendFailed", + "MakerPaymentSpendFailed", + "MakerPaymentSpendConfirmFailed", + "TakerPaymentWaitRefundStarted", + "TakerPaymentRefundStarted", + "TakerPaymentRefunded", + "TakerPaymentRefundedByWatcher", + "TakerPaymentRefundFailed", + "TakerPaymentRefundFinished" + ] + } + } + } + }, + "id": 42 + } + ``` + diff --git a/src/pages/komodo-defi-framework/api/v20/index.mdx b/src/pages/komodo-defi-framework/api/v20/index.mdx index 7d0bda1f..2a8489a5 100644 --- a/src/pages/komodo-defi-framework/api/v20/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/index.mdx @@ -385,10 +385,10 @@ Where the value indicates: ### CoinProtocol -| Parameter | Type | Description | -| -------------- | ------- | ----------------------------------------------------------------------------------------- | -| type | integer | One of the supported \[coin types]\(link TBA) | -| protocol\_data | object | A standard [CoinProtocolData](/komodo-defi-framework/api/v20/#coin-protocol-data) object. | +| 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 @@ -597,7 +597,7 @@ For requests which return many results, pagination offsets may be applied. \*\* ### HistoryTarget -Used to specify a HD wallet `account_id` or `address_id` for \[my\_tx\_history (v2)] requests. +Used to specify a HD wallet `account_id` or `address_id` for [my\_tx\_history v2](/komodo-defi-framework/api/v20/my_tx_history/) requests. | Parameter | Type | Description | | ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |