From 14c69cb35bf898f007a9851511ede233c8ac6873 Mon Sep 17 00:00:00 2001 From: smk762 Date: Wed, 23 Aug 2023 18:22:50 +0800 Subject: [PATCH 01/15] update common structures --- src/pages/atomicdex/api/v20/index.mdx | 133 +++++++++++++++++++++++--- 1 file changed, 121 insertions(+), 12 deletions(-) diff --git a/src/pages/atomicdex/api/v20/index.mdx b/src/pages/atomicdex/api/v20/index.mdx index a98947c9..047ec72a 100644 --- a/src/pages/atomicdex/api/v20/index.mdx +++ b/src/pages/atomicdex/api/v20/index.mdx @@ -1,9 +1,9 @@ -export const title = "AtomicDEX API RPC Protocol v2.0"; -export const description = "Starting with version beta-2.1.3434, the AtomicDEX API supports the standardized protocol format called mmrpc 2.0."; +export const title = "Komodo DeFi SDK RPC Protocol v2.0"; +export const description = "Starting with version beta-2.1.3434, the Komodo DeFi SDK supports the standardized protocol format called mmrpc 2.0."; -# AtomicDEX API RPC Protocol v2.0 +# Komodo DeFi SDK RPC Protocol v2.0 -Starting with version [beta-2.1.3434](https://github.com/KomodoPlatform/atomicDEX-API/releases/tag/beta-2.1.3434), the AtomicDEX API supports the standardized protocol format called `mmrpc 2.0`. +Starting with version [beta-2.1.3434](https://github.com/KomodoPlatform/komodo-defi-framework/releases/tag/beta-2.1.3434), the Komodo DeFi SDK supports the standardized protocol format called `mmrpc 2.0`. It includes a uniform request, successful and error response formats. At the moment, only a few RPC methods support the `mmrpc 2.0` protocol. @@ -12,19 +12,19 @@ It includes a uniform request, successful and error response formats. At the mom | Structure | Type | Description | | --------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| mmrpc | string | the string specifying the version of the AtomicDEX API RPC protocol. Must be exactly "2.0" | +| mmrpc | string | the string specifying the version of the Komodo DeFi SDK RPC protocol. Must be exactly "2.0" | | userpass | string (optional) | your password for protected RPC methods. Skip this field if the specified `method` is public | | method | string | the name of the method to be invoked | | params | object (optional) | a structured value that holds the parameter values to be used during the invocation of the method. This field may be omitted if the method doesn't take arguments | -| id | number (optional) | the identifier is established by the client. AtomicDEX API will reply with the same value in the Response object if the `id` field is included and not `NULL` | +| id | number (optional) | the identifier is established by the client. Komodo DeFi SDK will reply with the same value in the Response object if the `id` field is included and not `NULL` | ### Response (Success) | Structure | Type | Description | | --------- | ----------------- | ------------------------------------------------------------------------------------------- | -| mmrpc | string | the string specifying the version of the AtomicDEX API RPC protocol | -| result | object | the value of this field is determined by the method invoked on AtomicDEX API | +| mmrpc | string | the string specifying the version of the Komodo DeFi SDK RPC protocol | +| result | object | the value of this field is determined by the method invoked on Komodo DeFi SDK | | id | number (optional) | the identifier established by the client. The same value as in the Request if it was passed | @@ -32,7 +32,7 @@ It includes a uniform request, successful and error response formats. At the mom | Structure | Type | Description | | ----------- | ----------------- | ------------------------------------------------------------------------------------------- | -| mmrpc | string | the string specifying the version of the AtomicDEX API RPC protocol | +| mmrpc | string | the string specifying the version of the Komodo DeFi SDK RPC protocol | | error | string | the common error description | | error_path | string | the error path consisting of file names separated by a dot similar to JSON path notation | | error_trace | string | the error path consisting of file and line number pairs separated by ']' | @@ -106,9 +106,118 @@ It includes a uniform request, successful and error response formats. At the mom -## Common AtomicDEX-API Request / Response Objects +## Common the Komodo DeFi SDK Request / Response Objects + +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. + + +TODO: Where possible, indicate which activation methods / coins are supported for each parameter. + + +| 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](https://z.cash/technology/paramgen/). 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, BCH, UTXO & ZHTLC coins only. A standard [ActivationMode](/atomicdex/api/v20#activation-mode) object. | + + +### 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](/atomicdex/api/v20#activation-rpc-data) object. | + + +### 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 | object | ZHTLC only. Contains additional details about a coins electrum servers. | +| electrum | object | QTUM, BCH & UTXO coins only. Contains additional details about a coins electrum servers. | + + +### ActivationServers + +Contains information electrum servers for coins being used in `Electrum` or `Light` mode. + +| Parameter | Type | Description | +| ------------------------- | --------- | ---------------------------------------------------------------------------------------- | +| protocol | string | Transport protocol used by the KomoDeFi SDK to connect to the electrum server (`TCP` or `SSL`). Optional, defaults to `TCP` | +| url | string | The URL and port of an electrum server. | +| disable_cert_verification | boolean | If `true`, this disables server SSL/TLS certificate verification (e.g. to use self-signed certificate). Optional, defaults to `false` Use at your own risk! | + + + + + +#### 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"] +} +``` + + + + + + + + + + + + + + + + + + + + + + + -The folowing objects are used in the request or response of multiple AtomicDEX-API methods. ### AddressInfos @@ -119,7 +228,7 @@ The `addressInfos` object includes the following items for a given address: | ---------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | balances | object | A standard [balanceInfos](/atomicdex/api/v20#balance-infos) object. Not included in responses where `get_balances` is `false` | | derivation_method | object | A standard [DerivationMethod](/atomicdex/api/v20#derivation-method) object | -| pubkey | string | The public key associated with the seed used to launch AtomicDEX | +| pubkey | string | The public key associated with the seed used to launch the Komodo DeFi SDK | | tickers | array | A list of tokens which were successfully activated. Only included in responses where `get_balances` is `false` | From e14380c912536707fc9984418858506a48293fcf Mon Sep 17 00:00:00 2001 From: smk762 Date: Wed, 23 Aug 2023 18:56:57 +0800 Subject: [PATCH 02/15] Update common structures for activation --- src/pages/atomicdex/api/v20/index.mdx | 90 +++++++++++++++++---------- 1 file changed, 58 insertions(+), 32 deletions(-) diff --git a/src/pages/atomicdex/api/v20/index.mdx b/src/pages/atomicdex/api/v20/index.mdx index 047ec72a..2604d68c 100644 --- a/src/pages/atomicdex/api/v20/index.mdx +++ b/src/pages/atomicdex/api/v20/index.mdx @@ -106,7 +106,7 @@ It includes a uniform request, successful and error response formats. At the mom -## Common the Komodo DeFi SDK Request / Response Objects +## Common Komodo DeFi SDK Request / Response Objects The folowing objects are used in the request or response of multiple Komodo DeFi SDK methods. @@ -115,9 +115,6 @@ The folowing objects are used in the request or response of multiple Komodo DeFi The `ActivationParams` object defines additional parameters used for activation. These params may vary depending on the coin type. - -TODO: Where possible, indicate which activation methods / coins are supported for each parameter. - | Parameter | Type | Description | | ------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | @@ -130,7 +127,8 @@ TODO: Where possible, indicate which activation methods / coins are supported fo | zcash_params_path | string | ZHTLC coins only. Path to folder containing [Zcash parameters](https://z.cash/technology/paramgen/). 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, BCH, UTXO & ZHTLC coins only. A standard [ActivationMode](/atomicdex/api/v20#activation-mode) object. | +| sync_params | integer or string | ZHTLC coins only. Optional, defaults to `"earliest"`. Defines where to start scanning blockchain data upon initial activation. Options: `"earliest"` (full scan), `height` (a specific block height) or `date` (a linux timestamp). | +| mode | object | QTUM, UTXO & ZHTLC coins only. A standard [ActivationMode](/atomicdex/api/v20#activation-mode) object. | ### ActivationMode @@ -147,11 +145,11 @@ Defines the activation mode for QTUM, BCH, UTXO & ZHTLC coins. 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 | object | ZHTLC only. Contains additional details about a coins electrum servers. | -| electrum | object | QTUM, BCH & UTXO coins only. Contains additional details about a coins electrum servers. | +| 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](/atomicdex/api/v20#activation-servers) objects. | +| electrum | list of objects | QTUM, BCH & UTXO coins only. A list of standard [ActivationServers](/atomicdex/api/v20#activation-servers) objects. | ### ActivationServers @@ -160,40 +158,68 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig | Parameter | Type | Description | | ------------------------- | --------- | ---------------------------------------------------------------------------------------- | -| protocol | string | Transport protocol used by the KomoDeFi SDK to connect to the electrum server (`TCP` or `SSL`). Optional, defaults to `TCP` | -| url | string | The URL and port of an electrum server. | -| disable_cert_verification | boolean | If `true`, this disables server SSL/TLS certificate verification (e.g. to use self-signed certificate). Optional, defaults to `false` Use at your own risk! | - - +| 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! | -#### Example with balances +#### ZHTLC Example ```json -"bitcoincash:qrf5vpn78s7rjexrjhlwyzzeg7gw98k7t5qx64fztj": { - "derivation_method": { - "type": "Iguana" +{ + "activation_params": { + "mode": { + "rpc": "Light", + "rpc_data": { + "electrum_servers": [ + { + "url": "zombie.sirseven.me:10033" + }, + { + "url":"zombie.dragonhound.info:10033" + } + ], + "light_wallet_d_servers": [ + "http://zombie.sirseven.me:443", + "http://zombie.dragonhound.info:443" + ] + } }, - "pubkey": "036879df230663db4cd083c8eeb0f293f46abc460ad3c299b0089b72e6d472202c", - "balances": { - "spendable": "0.11398301", - "unspendable": "0.00001" + "zcash_params_path": "/home/username/path_to/.zcash-params", + "scan_blocks_per_iteration": 100, + "scan_interval_ms": 200, + "sync_params": { + "height": 2528700 } + } } ``` -#### Example without balances - -```json -"bitcoincash:qrf5vpn78s7rjexrjhlwyzzeg7gw98k7t5qx64fztj": { - "derivation_method": { - "type": "Iguana" +#### HD UTXO Activation (v2) +"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" + } + ] + } }, - "pubkey": "036879df230663db4cd083c8eeb0f293f46abc460ad3c299b0089b72e6d472202c", - "tickers": ["ASLP-SLP"] + "scan_policy": "scan_if_new_wallet", + "priv_key_policy": "Trezor", + "min_addresses_number": 3, + "gap_limit": 20 } -``` + From 5fe2ead478fe5cb1cb9eb2b842536c0b836f95ae Mon Sep 17 00:00:00 2001 From: smk762 Date: Wed, 23 Aug 2023 22:07:39 +0800 Subject: [PATCH 03/15] move zhtlc scan note --- src/pages/atomicdex/api/v20/index.mdx | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/pages/atomicdex/api/v20/index.mdx b/src/pages/atomicdex/api/v20/index.mdx index 2604d68c..816eb588 100644 --- a/src/pages/atomicdex/api/v20/index.mdx +++ b/src/pages/atomicdex/api/v20/index.mdx @@ -127,9 +127,20 @@ The `ActivationParams` object defines additional parameters used for activation. | zcash_params_path | string | ZHTLC coins only. Path to folder containing [Zcash parameters](https://z.cash/technology/paramgen/). 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. | -| sync_params | integer or string | ZHTLC coins only. Optional, defaults to `"earliest"`. Defines where to start scanning blockchain data upon initial activation. Options: `"earliest"` (full scan), `height` (a specific block height) or `date` (a linux timestamp). | +| 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 linux timestamp). | | mode | object | QTUM, UTXO & ZHTLC coins only. A standard [ActivationMode](/atomicdex/api/v20#activation-mode) object. | + + 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 From 441e8d07f93bbf3f6b44e42baec03ea92df83888 Mon Sep 17 00:00:00 2001 From: smk762 Date: Wed, 23 Aug 2023 22:08:09 +0800 Subject: [PATCH 04/15] add new zhtlc examples --- .../api/v20-dev/zhtlc_coins/index.mdx | 99 ++++++++++++------- 1 file changed, 63 insertions(+), 36 deletions(-) diff --git a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx index ee79aa88..22fd818e 100644 --- a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx +++ b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx @@ -20,31 +20,11 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](withdraw_tasks) me #### Arguments -| Structure | Type | Description | -| --------------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ticker | string | Ticker of coin to activate | -| activation_params | object | Contains details required for activation as explained below | -| activation_params.required_confirmations | integer | Block confirmations to wait for transactions when doing a swap. Optional, defaults to `3`. Overrides value if set in `coins` file. | -| activation_params.requires_notarization | boolean | For [dPoW](https://komodoplatform.com/en/blog/dpow-demystified/) protected coins, a `true` value will wait for transactions to be notarised when doing swaps. Optional, defaults to `false`. Overrides value if set in `coins` file. | -| activation_params.mode.rpc | string | Set as `Light` to use external electrum & lightwallet_d servers or `Native` to use local block chain data. If native, the `rpc_data` fields below are not required. | -| activation_params.mode.rpc_data | list of objects | Contains details about servers to be used for `Light` mode operation. | -| ..rpc_data.light_wallet_d_servers | list of strings | Urls which are hosting lightwallet_d servers | -| ..rpc_data.electrum_servers | list of objects | Contains additional details about a coins electrum servers. | -| ...electrum_servers.protocol | string | Transport protocol used by AtomicDEX API to connect to the electrum server (`TCP` or `SSL`). Optional, defaults to `TCP` | -| ...electrum_servers.url | string | The URL and port of an electrum server. | -| ...electrum_servers.disable_cert_verification | boolean | If `true`, this disables server SSL/TLS certificate verification (e.g. to use self-signed certificate). Optional, defaults to `false` Use at your own risk! | -| activation_params.zcash_params_path | string | Path to folder containing [Zcash parameters](https://z.cash/technology/paramgen/). Optional, defaults to standard location as defined in [this guide](https://forum.komodoplatform.com/t/installing-zcash-params/603) | -| activation_params.scan_blocks_per_iteration | integer | Sets the number of scanned blocks per iteration during `BuildingWalletDb` state. Optional, default value is 1000. | -| activation_params.scan_interval_ms | integer | Sets the interval in milliseconds between iterations of `BuildingWalletDb` state. Optional, default value is 0. | +| Structure | Type | Description | +| --------------------------------------------- | --------------- | ------------------------------------------------------------------------------- | +| ticker | string | Ticker of coin to activate | +| activation_params | object | A standard [ActivationRpcData](/atomicdex/api/v20#activation-rpc-data) object. | - - Using a smaller `scan_blocks_per_iteration` and larger `scan_interval_ms`, - will reduce the average CPU load during Z 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 Z coin activation. - #### Response @@ -54,7 +34,59 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](withdraw_tasks) me #### 📌 Examples -#### Command +#### Command with only required parameters + + +```json {{ mm2MethodDecorate : true }} +{ + "userpass": "MM2_RPC_PASSWORD", + "method": "task::enable_z_coin::init", + "mmrpc": "2.0", + "params": { + "ticker": "ZOMBIE", + "activation_params": { + "mode": { + "rpc": "Light", + "rpc_data": { + "electrum_servers": [{"url":"zombie.dragonhound.info:10033"}], + "light_wallet_d_servers": ["http://zombie.dragonhound.info:443"] + } + } + } + } +} +``` + + +#### Command to sync from block 2528700, with custom .zcash-params path and scan params + + +```json {{ mm2MethodDecorate : true }} +{ + "userpass": "MM2_RPC_PASSWORD", + "method": "task::enable_z_coin::init", + "mmrpc": "2.0", + "params": { + "ticker": "ZOMBIE", + "activation_params": { + "mode": { + "rpc": "Light", + "rpc_data": { + "electrum_servers": [{"url":"zombie.dragonhound.info:10033"}], + "light_wallet_d_servers": ["http://zombie.dragonhound.info:443"] + } + }, + "zcash_params_path": "/home/username/path_to/.zcash-params", + "scan_blocks_per_iteration": 100, + "scan_interval_ms": 200, + "sync_params": {"height": 2528700} + } + } +} +``` + + +#### Command using websockets to sync from [Proof of Keys Day](https://hackernoon.com/not-your-keys-not-your-bitcoin-jan3bitcoin-z6k3ktb), 2023. ```json {{ mm2MethodDecorate : true }} @@ -70,27 +102,22 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](withdraw_tasks) me "rpc_data": { "electrum_servers": [ { - "url": "zombie.sirseven.me:10033" - }, - { - "url":"zombie.dragonhound.info:10033" + "protocol":"SSL", + "url":"zombie.dragonhound.info:20133", + "ws_url":"zombie.dragonhound.info:30059" } ], - "light_wallet_d_servers": [ - "http://zombie.sirseven.me:443", - "http://zombie.dragonhound.info:443" - ] + "light_wallet_d_servers": ["http://zombie.dragonhound.info:443"] } }, - "zcash_params_path": "/home/username/path_to/.zcash-params", - "scan_blocks_per_iteration": 100, - "scan_interval_ms": 200 + "sync_params": {"date": 1672704000} } } } ``` + #### Response From d8f954b2cffcb570740d83bbc8e60751082df6f0 Mon Sep 17 00:00:00 2001 From: smk762 Date: Thu, 24 Aug 2023 21:33:35 +0800 Subject: [PATCH 05/15] add example, add update responses --- .../api/v20-dev/zhtlc_coins/index.mdx | 72 ++++++++++++++----- 1 file changed, 54 insertions(+), 18 deletions(-) diff --git a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx index 22fd818e..0b379081 100644 --- a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx +++ b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx @@ -86,6 +86,34 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](withdraw_tasks) me ``` +#### Command to sync sapling activation height (earliest) + + +```json {{ mm2MethodDecorate : true }} +{ + "userpass": "MM2_RPC_PASSWORD", + "method": "task::enable_z_coin::init", + "mmrpc": "2.0", + "params": { + "ticker": "ZOMBIE", + "activation_params": { + "mode": { + "rpc": "Light", + "rpc_data": { + "electrum_servers": [{"url":"zombie.dragonhound.info:10033"}], + "light_wallet_d_servers": ["http://zombie.dragonhound.info:443"] + } + }, + "zcash_params_path": "/home/username/path_to/.zcash-params", + "scan_blocks_per_iteration": 100, + "scan_interval_ms": 200, + "sync_params": "earliest" + } + } +} +``` + + #### Command using websockets to sync from [Proof of Keys Day](https://hackernoon.com/not-your-keys-not-your-bitcoin-jan3bitcoin-z6k3ktb), 2023. @@ -162,7 +190,7 @@ After initiating z coin enabling, you can use the `task_id` to check progress. "method": "task::enable_z_coin::status", "mmrpc": "2.0", "params": { - "task_id": "$TASK_ID", + "task_id": 0, "forget_if_finished": false } } @@ -243,29 +271,22 @@ After initiating z coin enabling, you can use the `task_id` to check progress. } ``` -#### Response (no Zcash Params) +#### Response (CoinCreationError - no Zcash Params) ```json { - "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:103] z_coin_activation:192] z_coin:761]", - "error_type": "CoinCreationError", - "error_data": { - "ticker": "ZOMBIE", - "error": "ZCashParamsNotFound" - } - } - }, - "id": null + 'error': 'Error on platform coin ZOMBIE creation: ZCashParamsNotFound', + 'error_path': 'lib.z_coin_activation.z_coin', + 'error_trace': 'lib:104] z_coin_activation:218] z_coin:1007]', + 'error_type': 'CoinCreationError', + 'error_data': { + 'ticker': 'ZOMBIE', + 'error': 'ZCashParamsNotFound' + } } ``` -#### Response (error - no such task) +#### Response (error - NoSuchTask) You'll see this if the task number does not exist, or the task has already completed. @@ -281,6 +302,21 @@ You'll see this if the task number does not exist, or the task has already compl } ``` +#### Response (error - InvalidRequest) + +```json +{ + 'mmrpc': '2.0', + 'error': 'Error parsing request: invalid value: integer `-205`, expected u64', + 'error_path': 'dispatcher', + 'error_trace': 'dispatcher:109]', + 'error_type': 'InvalidRequest', + 'error_data': 'invalid value: integer `-205`, expected u64', + 'id': None +} +``` + + ## task_enable_z_coin_cancel From 0f5b6b9d35e09dda49d372257baf049d047a6557 Mon Sep 17 00:00:00 2001 From: smk762 Date: Fri, 8 Sep 2023 23:47:10 +0800 Subject: [PATCH 06/15] unix is cooler than linux --- src/pages/atomicdex/api/v20/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/atomicdex/api/v20/index.mdx b/src/pages/atomicdex/api/v20/index.mdx index 5a570611..182e7baf 100644 --- a/src/pages/atomicdex/api/v20/index.mdx +++ b/src/pages/atomicdex/api/v20/index.mdx @@ -124,7 +124,7 @@ The `ActivationParams` object defines additional parameters used for activation. | zcash_params_path | string | ZHTLC coins only. Path to folder containing [Zcash parameters](https://z.cash/technology/paramgen/). 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. | -| 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 linux timestamp). | +| 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). | | mode | object | QTUM, UTXO & ZHTLC coins only. A standard [ActivationMode](/atomicdex/api/v20#activation-mode) object. | From f292769c2ed3a653a82ed25dd5f9842e8ddadd44 Mon Sep 17 00:00:00 2001 From: smk762 Date: Sat, 9 Sep 2023 22:34:04 +0800 Subject: [PATCH 07/15] update codegroup tags --- .../api/v20-dev/zhtlc_coins/index.mdx | 42 +++++++++---------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx index 4bd2a868..5034fc45 100644 --- a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx +++ b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx @@ -35,10 +35,10 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 #### 📌 Examples -#### Command with only required parameters +#### Enable Z coin without any optional parameters - -```json {{ mm2MethodDecorate : true }} + +```json { "userpass": "MM2_RPC_PASSWORD", "method": "task::enable_z_coin::init", @@ -59,10 +59,10 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 ``` -#### Command to sync from block 2528700, with custom .zcash-params path and scan params +#### Sync from block 2528700, with custom `.zcash-params` path and scan params - -```json {{ mm2MethodDecorate : true }} + +```json { "userpass": "MM2_RPC_PASSWORD", "method": "task::enable_z_coin::init", @@ -87,10 +87,10 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 ``` -#### Command to sync sapling activation height (earliest) +#### Sync from sapling activation height (earliest) - -```json {{ mm2MethodDecorate : true }} + +```json { "userpass": "MM2_RPC_PASSWORD", "method": "task::enable_z_coin::init", @@ -115,10 +115,10 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 ``` -#### Command using websockets to sync from [Proof of Keys Day](https://hackernoon.com/not-your-keys-not-your-bitcoin-jan3bitcoin-z6k3ktb), 2023. +#### Using websockets to sync from [Proof of Keys Day](https://hackernoon.com/not-your-keys-not-your-bitcoin-jan3bitcoin-z6k3ktb), 2023. - -```json {{ mm2MethodDecorate : true }} + +```json { "userpass": "MM2_RPC_PASSWORD", "method": "task::enable_z_coin::init", @@ -163,7 +163,7 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 ## task\_enable\_z\_coin\_status -After initiating z coin enabling, you can use the `task_id` to check progress. +Z coins need to build sync a local block cache and wallet database before they can be used. Using `task_id` as an input, this method will return the current status of the activation process. #### Arguments @@ -181,10 +181,10 @@ After initiating z coin enabling, you can use the `task_id` to check progress. #### 📌 Examples -#### Command +#### Status of Z coin activation - -```json {{ mm2MethodDecorate : true }} + +```json { "userpass": "MM2_RPC_PASSWORD", "method": "task::enable_z_coin::status", @@ -386,8 +386,8 @@ If you want to cancel the enabling process before it has completed, you can use #### Command - - ```json {{ mm2MethodDecorate : true }} + + ```json { "userpass": "MM2_RPC_PASSWORD", "method": "task::enable_z_coin::cancel", @@ -474,10 +474,10 @@ To get the transaction history for ZHTLC coins, you need to use this special met #### 📌 Examples -#### Command +#### Z Coin Transaction History - - ```json {{ mm2MethodDecorate : true }} + + ```json { "userpass": "MM2_RPC_PASSWORD", "method": "z_coin_tx_history", From f4d277bc1d8a97f0ed2f26a31b9d2098fbd5189e Mon Sep 17 00:00:00 2001 From: smk762 Date: Mon, 11 Sep 2023 23:09:38 +0800 Subject: [PATCH 08/15] fix param nesting --- .../api/v20-dev/zhtlc_coins/index.mdx | 20 +++++++++---------- src/pages/atomicdex/api/v20/index.mdx | 14 +++++-------- 2 files changed, 15 insertions(+), 19 deletions(-) diff --git a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx index 37040077..7a3c2c7d 100644 --- a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx +++ b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx @@ -84,13 +84,13 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 "rpc": "Light", "rpc_data": { "electrum_servers": [{"url":"zombie.dragonhound.info:10033"}], - "light_wallet_d_servers": ["http://zombie.dragonhound.info:443"] + "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, - "sync_params": {"height": 2528700} + "scan_interval_ms": 200 } } } @@ -112,13 +112,13 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 "rpc": "Light", "rpc_data": { "electrum_servers": [{"url":"zombie.dragonhound.info:10033"}], - "light_wallet_d_servers": ["http://zombie.dragonhound.info:443"] - } + "light_wallet_d_servers": ["http://zombie.dragonhound.info:443"], + "sync_params": "earliest" + }, }, "zcash_params_path": "/home/username/path_to/.zcash-params", "scan_blocks_per_iteration": 100, - "scan_interval_ms": 200, - "sync_params": "earliest" + "scan_interval_ms": 200 } } } @@ -146,10 +146,10 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 "ws_url":"zombie.dragonhound.info:30059" } ], - "light_wallet_d_servers": ["http://zombie.dragonhound.info:443"] + "light_wallet_d_servers": ["http://zombie.dragonhound.info:443"], + "sync_params": {"date": 1672704000} } - }, - "sync_params": {"date": 1672704000} + } } } ``` diff --git a/src/pages/atomicdex/api/v20/index.mdx b/src/pages/atomicdex/api/v20/index.mdx index 381dfca0..9999ef28 100644 --- a/src/pages/atomicdex/api/v20/index.mdx +++ b/src/pages/atomicdex/api/v20/index.mdx @@ -124,7 +124,6 @@ The `ActivationParams` object defines additional parameters used for activation. | zcash_params_path | string | ZHTLC coins only. Path to folder containing [Zcash parameters](https://z.cash/technology/paramgen/). 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. | -| 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). | | mode | object | QTUM, UTXO & ZHTLC coins only. A standard [ActivationMode](/atomicdex/api/v20#activation-mode) object. | @@ -158,6 +157,7 @@ Contains information about electrum & lightwallet_d servers for coins being used | 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](/atomicdex/api/v20#activation-servers) objects. | | electrum | list of objects | QTUM, BCH & UTXO coins only. A list of standard [ActivationServers](/atomicdex/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 @@ -182,25 +182,21 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig "rpc": "Light", "rpc_data": { "electrum_servers": [ - { - "url": "zombie.sirseven.me:10033" - }, { "url":"zombie.dragonhound.info:10033" } ], "light_wallet_d_servers": [ - "http://zombie.sirseven.me:443", "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, - "sync_params": { - "height": 2528700 - } + "scan_interval_ms": 200 } } ``` From 7b60ee4f44c401866013bb8a5090947e51f11ea4 Mon Sep 17 00:00:00 2001 From: gcharang <21151592+gcharang@users.noreply.github.com> Date: Tue, 12 Sep 2023 15:34:08 +0530 Subject: [PATCH 09/15] fix some errors in code blocks --- .../api/v20-dev/zhtlc_coins/index.mdx | 34 ++++++++----------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx index 7a3c2c7d..a0035c23 100644 --- a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx +++ b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx @@ -152,6 +152,7 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 } } } +} ``` @@ -252,11 +253,10 @@ Z coins need to build sync a local block cache and wallet database before they c "latest_block": 269656 } } - } - }, + }, "id": null -} -``` + } + ``` #### Response (CoinCreationError - no Zcash Params) @@ -289,23 +289,17 @@ You'll see this if the task number does not exist, or the task has already compl } ``` -#### Response (error - InvalidRequest) - -```json -{ - 'mmrpc': '2.0', - 'error': 'Error parsing request: invalid value: integer `-205`, expected u64', - 'error_path': 'dispatcher', - 'error_trace': 'dispatcher:109]', - 'error_type': 'InvalidRequest', - 'error_data': 'invalid value: integer `-205`, expected u64', - 'id': None -} -``` - + #### Response (error - InvalidRequest) - }, - "id": null + ```json + { + 'mmrpc': '2.0', + 'error': 'Error parsing request: invalid value: integer `-205`, expected u64', + 'error_path': 'dispatcher', + 'error_trace': 'dispatcher:109]', + 'error_type': 'InvalidRequest', + 'error_data': 'invalid value: integer `-205`, expected u64', + 'id': None } ``` From 36c20445a13e3e9b58c5dcf3c03b3dfa4e838ad3 Mon Sep 17 00:00:00 2001 From: smk762 Date: Fri, 15 Sep 2023 15:45:44 +0800 Subject: [PATCH 10/15] Adds note about earliest param re: sapling height --- src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx index 7a3c2c7d..9f200d49 100644 --- a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx +++ b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx @@ -99,6 +99,8 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 #### Sync from sapling activation height (earliest) +The Z coin lightwallet client only supports blocks that are post-sapling. The sapling activation height for Z coins can be found in the [coins file](https://github.com/KomodoPlatform/coins/blob/master/coins) + ```json { From 1db593f5271d305169462ab7831bedb3ce59d855 Mon Sep 17 00:00:00 2001 From: smk762 Date: Fri, 15 Sep 2023 20:35:19 +0800 Subject: [PATCH 11/15] fix json errors --- .../api/v20-dev/zhtlc_coins/index.mdx | 33 +++++++++---------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx index 6f8a1e49..ae4cbc58 100644 --- a/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx +++ b/src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx @@ -65,7 +65,6 @@ To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20 } } } -} ``` @@ -264,13 +263,13 @@ Z coins need to build sync a local block cache and wallet database before they c ```json { - 'error': 'Error on platform coin ZOMBIE creation: ZCashParamsNotFound', - 'error_path': 'lib.z_coin_activation.z_coin', - 'error_trace': 'lib:104] z_coin_activation:218] z_coin:1007]', - 'error_type': 'CoinCreationError', - 'error_data': { - 'ticker': 'ZOMBIE', - 'error': 'ZCashParamsNotFound' + "error": "Error on platform coin ZOMBIE creation: ZCashParamsNotFound", + "error_path": "lib.z_coin_activation.z_coin", + "error_trace": "lib:104] z_coin_activation:218] z_coin:1007]", + "error_type": "CoinCreationError", + "error_data": { + "ticker": "ZOMBIE", + "error": "ZCashParamsNotFound" } } ``` @@ -294,15 +293,15 @@ You'll see this if the task number does not exist, or the task has already compl #### Response (error - InvalidRequest) ```json - { - 'mmrpc': '2.0', - 'error': 'Error parsing request: invalid value: integer `-205`, expected u64', - 'error_path': 'dispatcher', - 'error_trace': 'dispatcher:109]', - 'error_type': 'InvalidRequest', - 'error_data': 'invalid value: integer `-205`, expected u64', - 'id': None - } +{ + "mmrpc": "2.0", + "error": "Error parsing request: invalid value: integer `-205`, expected u64", + "error_path": "dispatcher", + "error_trace": "dispatcher:109]", + "error_type": "InvalidRequest", + "error_data": "invalid value: integer `-205`, expected u64", + "id": 42 +} ``` #### Response (Enabling complete) From 0345b27f5f3569b27db5ac9174833ccb2ccf21ac Mon Sep 17 00:00:00 2001 From: gcharang <21151592+gcharang@users.noreply.github.com> Date: Fri, 22 Sep 2023 15:35:51 +0530 Subject: [PATCH 12/15] update --- filepathSlugs.json | 4930 +++++++++++++++++ utils/js/file_presence_structure_checker.js | 2 +- utils/js/package.json | 2 + ...validate_update_internal_links_userpass.js | 8 +- 4 files changed, 4937 insertions(+), 5 deletions(-) create mode 100644 filepathSlugs.json diff --git a/filepathSlugs.json b/filepathSlugs.json new file mode 100644 index 00000000..6beae96c --- /dev/null +++ b/filepathSlugs.json @@ -0,0 +1,4930 @@ +{ + "src/pages/antara/api/assets/index.mdx": [ + "assets", + "introduction", + "assets-module-flow", + "sellers-perspective", + "buyers-perspective", + "assetsaddress", + "arguments", + "response", + "examples", + "tokenask", + "arguments-2", + "response-2", + "examples-2", + "tokenbid", + "arguments-3", + "response-3", + "examples-3", + "tokencancelask", + "arguments-4", + "response-4", + "examples-4", + "tokencancelbid", + "arguments-5", + "response-5", + "examples-5", + "tokenfillask", + "arguments-6", + "response-6", + "examples-6", + "tokenfillbid", + "arguments-7", + "response-7", + "examples-7", + "tokenorders", + "arguments-8", + "response-8", + "examples-8", + "mytokenorders" + ], + "src/pages/antara/api/channels/index.mdx": [ + "channels", + "introduction", + "channels-module-flow", + "channelsaddress", + "arguments", + "response", + "examples", + "channelsclose", + "arguments-2", + "response-2", + "examples-2", + "channelsinfo", + "arguments-3", + "response-3", + "examples-3", + "channelsopen", + "arguments-4", + "response-4", + "examples-4", + "channelspayment", + "arguments-5", + "response-5", + "examples-5", + "channelsrefund", + "arguments-6", + "response-6", + "examples-6" + ], + "src/pages/antara/api/custom/index.mdx": [ + "custom-cc-wip", + "blockchain-core-concepts", + "goal-of-our-antara-module", + "use-jl777-branch", + "customcc-h-header-file-definitions-of-functions-and-variables", + "name-of-our-custom-cclib", + "declaration-of-constants", + "declarations-of-the-rpc-calls", + "declaration-of-functions", + "automatic-wiring-custom-rpc-function-dispatcher", + "customcc-cpp-file-implementation-of-functions" + ], + "src/pages/antara/api/dice/index.mdx": [ + "dice", + "introduction", + "diceaddfunds", + "arguments", + "response", + "examples", + "diceaddress", + "arguments-2", + "response-2", + "examples-2", + "dicebet", + "arguments-3", + "response-3", + "examples-3", + "dicefinish", + "arguments-4", + "response-4", + "examples-4", + "dicefund", + "arguments-5", + "response-5", + "examples-5", + "diceinfo", + "arguments-6", + "response-6", + "examples-6", + "dicelist", + "arguments-7", + "response-7", + "examples-7", + "dicestatus", + "arguments-8", + "response-8", + "examples-8" + ], + "src/pages/antara/api/dilithium/index.mdx": [ + "dilithium", + "introduction", + "dilithium-module-flow", + "tutorial-availability", + "handleinfo", + "arguments", + "response", + "when-a-handle-is-available", + "when-a-handle-is-already-registered-by-the-node-executing-the-command", + "examples", + "when-a-handle-is-available-2", + "command", + "response-2", + "when-a-handle-is-already-registered-by-the-node-executing-the-command-2", + "command-2", + "response-3", + "keypair", + "arguments-2", + "response-4", + "examples-2", + "command-3", + "response-5", + "qsend", + "arguments-3", + "response-6", + "examples-3", + "command-4", + "response-7", + "broadcast-the-hex", + "response-8", + "register", + "arguments-4", + "response-9", + "examples-4", + "command-5", + "response-10", + "broadcast-the-hex-2", + "response-11", + "send", + "arguments-5", + "response-12", + "examples-5", + "command-6", + "response-13", + "broadcast-the-hex-3", + "response-14", + "sign", + "arguments-6", + "response-15", + "examples-6", + "command-7", + "response-16", + "spend", + "arguments-7", + "response-17", + "examples-7", + "command-8", + "response-18", + "broadcast-the-hex-4", + "response-19", + "verify", + "arguments-8", + "response-20", + "examples-8", + "command-9", + "response-21" + ], + "src/pages/antara/api/faucet/index.mdx": [ + "faucet", + "introduction", + "faucetaddress", + "arguments", + "response", + "examples", + "faucetfund", + "arguments-2", + "response-2", + "examples-2", + "faucetget", + "arguments-3", + "response-3", + "examples-3", + "faucetinfo", + "arguments-4", + "response-4", + "examples-4" + ], + "src/pages/antara/api/gaming/index.mdx": [ + "gaming", + "introduction", + "config", + "load-configuration", + "public-function", + "usage-pattern", + "template-parameters", + "function-parameters", + "response", + "example", + "core", + "version", + "public-function-2", + "usage-pattern-2", + "function-parameters-2", + "response-2", + "example-2", + "ecs-system-manager", + "system-manager", + "public-function-3", + "usage-pattern-3", + "destructor", + "function-parameters-3", + "response-3", + "example-3", + "receive-add-base-system", + "public-function-4", + "usage-pattern-4", + "function-parameters-4", + "response-4", + "start", + "public-function-5", + "usage-pattern-5", + "function-parameters-5", + "response-5", + "example-4", + "update", + "public-function-6", + "usage-pattern-6", + "function-parameters-6", + "response-6", + "example-5", + "update-systems", + "public-function-7", + "usage-pattern-7", + "function-parameters-7", + "response-7", + "example-6", + "get-system-1", + "public-function-8", + "usage-pattern-8", + "function-and-template-type", + "response-8", + "get-system-2", + "public-function-9", + "usage-pattern-9", + "function-and-template-type-2", + "response-9", + "example-7", + "get-systems-1", + "public-function-10", + "usage-pattern-10", + "function-and-template-type-3", + "response-10", + "example-8", + "get-systems-2", + "public-function-11", + "usage-pattern-11", + "function-and-template-type-4", + "response-11", + "example-9", + "has-system", + "public-function-12", + "usage-pattern-12", + "template-type", + "response-12", + "example-10", + "has-systems-1", + "public-function-13", + "usage-pattern-13", + "template-type-2", + "response-13", + "example-11", + "has-systems-2", + "public-function-14", + "usage-pattern-14", + "template-type-3", + "response-14", + "example-12", + "has-systems-3", + "public-function-15", + "usage-pattern-15", + "template-type-4", + "response-15", + "example-13", + "has-systems-4", + "public-function-16", + "usage-pattern-16", + "template-type-5", + "response-16", + "example-14", + "mark-system", + "public-function-17", + "usage-pattern-17", + "template-type-6", + "response-17", + "example-15", + "mark-systems-1", + "public-function-18", + "usage-pattern-18", + "template-type-7", + "response-18", + "example-16", + "mark-systems-2", + "public-function-19", + "usage-pattern-19", + "template-type-8", + "response-19", + "example-17", + "enable-system", + "public-function-20", + "usage-pattern-20", + "template-type-9", + "response-20", + "example-18", + "enable-systems", + "public-function-21", + "usage-pattern-21", + "template-type-10", + "response-21", + "example-19", + "disable-system", + "public-function-22", + "usage-pattern-22", + "template-type-11", + "response-22", + "example-20", + "disable-systems", + "public-function-23", + "usage-pattern-23", + "template-type-12", + "response-23", + "example-21", + "nb-systems-1", + "public-function-24", + "usage-pattern-24", + "template-type-13", + "response-24", + "example-22", + "nb-systems-2", + "public-function-25", + "usage-pattern-25", + "template-type-14", + "response-25", + "example-23", + "create-system", + "public-function-26", + "usage-pattern-26", + "template-type-15", + "response-26", + "example-24", + "create-system-rt", + "public-function-27", + "usage-pattern-27", + "load-systems", + "public-function-28", + "usage-pattern-28", + "template-type-16", + "response-27", + "example-25", + "clock", + "private-type", + "usage-pattern-29", + "system-ptr", + "private-type-2", + "usage-pattern-30", + "system-array", + "private-type-3", + "usage-pattern-31", + "system-registry", + "private-type-4", + "usage-pattern-32", + "systems-queue", + "private-type-5", + "add-system", + "private-function", + "usage-pattern-33", + "entity-registry", + "private-data-members", + "event-key", + "event-key-pressed", + "public-functions", + "key-pressed-1", + "usage-pattern-34", + "template-type-17", + "response-28", + "example-26", + "key-pressed-2", + "usage-pattern-35", + "public-members", + "antara-gaming-input-key-key", + "bool-alt-false", + "bool-control-false", + "bool-shift-false", + "bool-system-false", + "event-key-released", + "public-functions-2", + "key-released", + "usage-pattern-36", + "template-type-18", + "response-29", + "example-27", + "key-released-2", + "usage-pattern-37", + "public-members-2", + "input-key-key", + "event-quit-game", + "quit-game", + "public-functions-3", + "quit-game-1", + "usage-pattern-38", + "template-type-19", + "response-30", + "example-28", + "quit-game-2", + "usage-pattern-39", + "public-members-3", + "return-value", + "usage-pattern-40", + "public-static-attributes", + "invoker-dispatcher", + "usage-pattern-41", + "sfml", + "sfml-audio-system", + "usage-pattern-42", + "public-functions-4", + "audio-system", + "usage-pattern-43", + "function-parameters-8", + "response-31", + "update-2", + "usage-pattern-44", + "function-parameters-9", + "response-32", + "sfml-component-sound", + "public-members-4", + "sound" + ], + "src/pages/antara/api/gateways/index.mdx": [ + "gateways", + "introduction", + "tutorial-availability", + "gatewaysaddress", + "arguments", + "response", + "examples", + "gatewaysbind", + "arguments-2", + "response-2", + "examples-2", + "gatewaysdeposit", + "arguments-3", + "response-3", + "examples-3", + "gatewaysdumpprivkey", + "arguments-4", + "response-4", + "examples-4", + "gatewaysexternaladdress", + "arguments-5", + "response-5", + "examples-5", + "gatewaysinfo", + "arguments-6", + "response-6", + "examples-6", + "gatewayslist", + "arguments-7", + "response-7", + "examples-7", + "gatewayswithdraw", + "arguments-8", + "response-8", + "examples-8" + ], + "src/pages/antara/api/heir/index.mdx": [ + "heir", + "introduction", + "heir-module-flow", + "heiradd", + "arguments", + "response", + "examples", + "step-1-create-a-raw-transaction-in-coins-and-get-the-hex-value", + "step-2-broadcast-raw-transaction", + "step-3-decode-raw-transaction-to-ensure-values-are-sane-optional", + "heiraddress", + "arguments-2", + "response-2", + "example", + "heirclaim", + "arguments-3", + "response-3", + "examples-2", + "step-1-create-a-raw-transaction-in-coins-and-get-the-hex-value-2", + "step-2-broadcast-raw-transaction-2", + "heirfund", + "arguments-4", + "response-4", + "examples-3", + "step-1-create-a-raw-transaction-in-coins-and-get-the-hex-value-3", + "step-2-broadcast-raw-transaction-3", + "step-3-decode-the-raw-transaction-to-ensure-the-values-are-sane-optional", + "heirinfo", + "arguments-5", + "response-5", + "example-2", + "heirlist", + "arguments-6", + "response-6", + "example-3" + ], + "src/pages/antara/api/index.mdx": [ + "antara-api" + ], + "src/pages/antara/api/musig/index.mdx": [ + "mu-sig", + "introduction", + "mu-sig-module-flow", + "tutorial-availability", + "calcmsg", + "arguments", + "response", + "examples", + "combine", + "arguments-2", + "response-2", + "examples-2", + "commit", + "arguments-3", + "response-3", + "examples-3", + "nonce", + "arguments-4", + "response-4", + "examples-4", + "partialsig", + "arguments-5", + "response-5", + "examples-5", + "send", + "arguments-6", + "response-6", + "examples-6", + "session", + "arguments-7", + "response-7", + "examples-7", + "spend", + "arguments-8", + "response-8", + "examples-8", + "verify", + "arguments-9", + "response-9", + "examples-9" + ], + "src/pages/antara/api/oracles/index.mdx": [ + "oracles", + "introduction", + "oracles-module-flow", + "oraclesaddress", + "arguments", + "response", + "examples", + "oraclescreate", + "arguments-2", + "response-2", + "examples-2", + "oraclesdata", + "examples-for-data-submission", + "example-a", + "example-b", + "arguments-3", + "response-3", + "examples-3", + "oraclesfund", + "arguments-4", + "examples-4", + "oraclesinfo", + "arguments-5", + "response-4", + "examples-5", + "oracleslist", + "arguments-6", + "response-5", + "examples-6", + "oraclesregister", + "arguments-7", + "response-6", + "examples-7", + "oraclessamples", + "arguments-8", + "response-7", + "examples-8", + "oraclessubscribe", + "arguments-9", + "response-8", + "examples-9" + ], + "src/pages/antara/api/payments/index.mdx": [ + "payments", + "introduction", + "payments-module-flow", + "paymentscreate", + "arguments", + "response", + "examples", + "command", + "broadcast-the-transaction", + "paymentsfund", + "arguments-2", + "response-2", + "examples-2", + "command-2", + "broadcast-the-transaction-2", + "destopret-optional", + "examples-3", + "command-3", + "broadcast-the-transaction-3", + "paymentsinfo", + "arguments-3", + "response-3", + "examples-4", + "command-4", + "paymentslist", + "arguments-4", + "response-4", + "examples-5", + "command-5", + "paymentsmerge", + "arguments-5", + "response-5", + "examples-6", + "command-6", + "broadcast-the-transaction-4", + "paymentsrelease", + "arguments-6", + "response-6", + "examples-7", + "command-7", + "broadcast-the-transaction-5", + "paymentstxidopret", + "arguments-7", + "response-7", + "additional-details", + "allocation", + "script-pubkey", + "pubkey-mutation", + "address-substitution", + "command-8", + "examples-8", + "command-9", + "broadcast-the-transaction-6" + ], + "src/pages/antara/api/pegs/index.mdx": [ + "pegs", + "introduction", + "module-methodology", + "associated-modules", + "a-brief-explanation-of-pegs-functionality", + "creating-a-tokenized-cryptocurrency-to-back-the-stablecoin", + "creating-a-reliable-rate-of-exchange-between-the-stablecoin-and-the-backing-cryptocurrency", + "offering-the-exchange-between-stablecoin-and-backing-cryptocurrency", + "managing-price-volatility", + "value-of-backing-cryptocurrency-increases", + "value-of-backing-cryptocurrency-decreases", + "yellow-zone", + "red-zone", + "preventing-account-liquidation", + "pegs-antara-module-flow", + "tutorial-availability", + "pegsaccounthistory", + "arguments", + "response", + "examples", + "pegsaccountinfo", + "arguments-2", + "response-2", + "examples-2", + "pegsaddress", + "arguments-3", + "response-3", + "examples-3", + "pegscreate", + "arguments-4", + "response-4", + "examples-4", + "pegsexchange", + "arguments-5", + "response-5", + "examples-5", + "pegsfund", + "arguments-6", + "response-6", + "examples-6", + "pegsget", + "arguments-7", + "response-7", + "examples-7", + "pegsinfo", + "arguments-8", + "response-8", + "examples-8", + "pegsliquidate", + "arguments-9", + "response-9", + "examples-9", + "pegsredeem", + "arguments-10", + "response-10", + "examples-10", + "pegsworstaccounts", + "arguments-11" + ], + "src/pages/antara/api/prices/index.mdx": [ + "prices", + "introduction", + "the-prices-modules-requires-a-separate-technology-called-a-dto", + "manners-of-obtaining-data", + "manner-of-preventing-miner-manipulation", + "a-brief-explanation-of-margin-trading-leveraged-trading", + "summary-of-a-brief-explanation-to-margin-trading", + "synthetic-prices-and-their-calculation", + "a-forth-like-syntax-for-synthetic-calculations", + "usage", + "understanding-stacks", + "inserting-and-deleting-elements", + "komodo-stack-api-symbols", + "synthetic-price-weights", + "example", + "operations-involving-1-price", + "example-2", + "operations-involving-2-prices", + "example-3", + "operations-involving-3-prices", + "mypriceslist", + "arguments", + "response", + "examples", + "prices-2", + "arguments-2", + "response-2", + "examples-2", + "pricesaddfunding", + "arguments-3", + "response-3", + "examples-3", + "pricesaddress", + "arguments-4", + "response-4", + "examples-4", + "pricesbet", + "arguments-5", + "response-5", + "examples-5", + "pricescashout", + "arguments-6", + "response-6", + "examples-6", + "pricesgetorderbook", + "arguments-7", + "response-7", + "examples-7", + "pricesinfo", + "arguments-8", + "response-8", + "examples-8", + "priceslist", + "arguments-9", + "response-9", + "examples-9", + "pricesrefillfund", + "arguments-10", + "response-10", + "examples-10", + "pricesrekt", + "arguments-11", + "response-11", + "examples-11" + ], + "src/pages/antara/api/rewards/index.mdx": [ + "rewards", + "introduction", + "rewards-antara-module-flow", + "rewardsaddfunding", + "arguments", + "response", + "examples", + "rewardsaddress", + "arguments-2", + "response-2", + "examples-2", + "rewardscreatefunding", + "arguments-3", + "response-3", + "examples-3", + "rewardsinfo", + "arguments-4", + "response-4", + "examples-4", + "rewardslist", + "arguments-5", + "response-5", + "examples-5", + "rewardslock", + "arguments-6", + "response-6", + "examples-6", + "rewardsunlock", + "arguments-7", + "response-7", + "examples-7" + ], + "src/pages/antara/api/rogue/index.mdx": [ + "rogue", + "tutorial-availability", + "bailout", + "arguments", + "response", + "examples", + "extract", + "arguments-2", + "response-2", + "examples-2", + "gameinfo", + "arguments-3", + "response-3", + "examples-3", + "games", + "arguments-4", + "response-4", + "examples-4", + "highlander", + "highlander-rewards", + "rewards-in-single-player-mode", + "rewards-in-multi-player-mode", + "arguments-5", + "response-5", + "examples-5", + "keystrokes", + "arguments-6", + "response-6", + "examples-6", + "newgame", + "arguments-7", + "response-7", + "examples-7", + "pending", + "arguments-8", + "response-8", + "examples-8", + "playerinfo", + "tips-on-finding-character-information", + "arguments-9", + "response-9", + "examples-9", + "players", + "arguments-10", + "response-10", + "examples-10", + "register", + "arguments-11", + "response-11", + "examples-11", + "setname", + "arguments-12", + "response-12", + "examples-12" + ], + "src/pages/antara/api/sudoku/index.mdx": [ + "sudoku", + "introduction", + "sudoku-module-flow", + "installation", + "requirements", + "install-dependencies", + "linux", + "clone-and-compile-komodo", + "linux-2", + "update-komodod", + "set-pubkey-value", + "step-1-start-the-chain", + "step-2", + "step-3", + "step-4", + "install-sudoku-graphical-user-interface-gui", + "linux-3", + "install-dependencies-2", + "install-the-gui", + "start-sudoku-gui", + "gen", + "arguments", + "response", + "examples", + "pending", + "arguments-2", + "response-2", + "examples-2", + "solution", + "arguments-3", + "response-3", + "examples-3", + "txidinfo", + "arguments-4", + "response-4", + "examples-4" + ], + "src/pages/antara/api/tokens/index.mdx": [ + "tokens", + "introduction", + "tokenaddress", + "arguments", + "response", + "examples", + "tokenbalance", + "arguments-2", + "response-2", + "examples-2", + "tokencreate", + "non-fungible-tokens", + "fractional-tokens", + "arguments-3", + "response-3", + "examples-3", + "tokeninfo", + "arguments-4", + "response-4", + "examples-4", + "tokenlist", + "arguments-5", + "response-5", + "examples-5", + "tokentransfer", + "arguments-6", + "response-6", + "examples-6" + ], + "src/pages/antara/index.mdx": [ + "introduction-to-antara", + "about-the-antara-section", + "conceptual-overview", + "about-antara-setup", + "about-antara-tutorials", + "about-antara-api" + ], + "src/pages/antara/setup/antara-customizations/index.mdx": [ + "antara-customizations", + "ac-adaptivepow", + "understanding-difficulty-stranding", + "ac-adaptivepow-adjusts-the-difficulty-level", + "ac-algo", + "ac-blocktime", + "examples", + "ac-cbmaturity", + "ac-cbopret", + "examples-2", + "ac-cc", + "ac-cc-0", + "ac-cc-1", + "ac-cc-2-to-99", + "ac-cc-100-to-9999", + "summary-of-ac-cc", + "examples-3", + "ac-ccactivate", + "examples-4", + "before-using-ac-ccactivate", + "after-using-ac-ccactivate", + "ac-ccenable", + "ac-cclib", + "ac-decay", + "examples-5", + "ac-end", + "examples-6", + "ac-eras", + "ac-eras-combined-with-ac-cbmaturity", + "ac-eras-instructions", + "ac-feeds", + "basic-usage", + "ac-feeds-example", + "polling-the-same-url-multiple-times", + "method-of-handling-when-the-internal-parser-is-inadequate", + "ac-feed-parameters", + "results-array-members", + "results-object-members", + "specification-for-the-custom-parser-library", + "initializing-price-feed-configuration", + "ac-founders", + "ac-founders-reward", + "examples-7", + "ac-halving", + "examples-8", + "ac-name", + "examples-9", + "ac-notarypay", + "examples-10", + "ac-perc", + "ac-perc-without-ac-founders", + "ac-perc-with-ac-founders", + "examples-11", + "ac-prices", + "examples-12", + "ac-pubkey", + "examples-13", + "ac-public", + "examples-14", + "ac-reward", + "examples-15", + "ac-sapling", + "ac-script", + "finding-the-script-pub-key", + "command", + "response", + "command-2", + "response-txid", + "command-3", + "response-2", + "command-4", + "ac-staked", + "notes-on-how-ac-staked-functions", + "rules-for-staking-a-block", + "examples-16", + "ac-stocks", + "examples-17", + "ac-supply", + "examples-18", + "ac-snapshot", + "example", + "payments-module-functionality", + "ac-timelock", + "ac-txpow", + "ac-veruspos" + ], + "src/pages/antara/setup/index.mdx": [ + "antara-setup" + ], + "src/pages/antara/tutorials/advanced-series-0/index.mdx": [ + "an-advanced-approach-to-komodos-antara-framework", + "introduction", + "link-to-learning-path-outline", + "antara-encompasses-several-technologies", + "a-less-conceptual-discussion-of-crypto-conditions", + "crypto-conditions-in-brief", + "crypto-conditions-is-based-on-an-industry-wide-proposed-standard", + "a-brief-description-of-komodo-enhancements", + "crypto-conditions-depends-upon-transactions-and-booleans", + "building-an-antara-module-is-harder-than-creating-a-balance-based-smart-contract", + "a-brief-look-at-an-antara-module-template" + ], + "src/pages/antara/tutorials/advanced-series-1/index.mdx": [ + "advanced-series-smart-chain-development-basics", + "understanding-utxos-is-important-in-antara-modules", + "observing-the-vin", + "observe-the-vouts", + "making-inferences", + "utxo-is-an-unspent-vout", + "a-utxo-is-not-spent-until-confirmation", + "formation-of-a-transaction", + "quantum-computers-cold-addresses-and-change", + "smart-chain-and-crypto-conditions-pubkey-parameter-disables-change-addresses", + "pay-to-pubkey-hash-transactions", + "pay-to-script-hash-payments", + "understanding-op-codes", + "a-new-op-code-op-check-crypto-condition" + ], + "src/pages/antara/tutorials/advanced-series-2/index.mdx": [ + "advanced-series-antara-module-development-basics", + "the-eval-code", + "validation-code", + "flexbile-pubkey-expression", + "pubkeys-and-cc-addresses", + "global-cc-address", + "vector-inputs-and-outputs", + "cc-enhances-the-script-between-vin-and-vout-to-advanced-levels", + "the-many-possibilities-of-oc-checkcryptocondition", + "introduction-to-the-remote-procedure-call-rpc", + "creating-a-global-cc-address", + "create-a-value-using-getnewaddress", + "retrieve-the-pubkey-using-validateaddress", + "restart-the-daemon-with-the-pubkey", + "ensure-the-myprivkey-function-is-properly-enabled", + "add-the-first-rpc", + "obtain-the-c-caddress", + "obtain-the-privkey-in-hex-format", + "copy-the-existing-default-rpcs-to-the-new-module", + "introduction-to-validation" + ], + "src/pages/antara/tutorials/advanced-series-3/index.mdx": [ + "advanced-series-preparing-for-heir-development", + "a-conceptual-understanding-of-the-intended-product", + "complete-the-heir-module-flow-section-optional", + "on-the-relevance-of-the-faucet-module", + "launch-the-doc-smart-chain-optional", + "create-a-pubkey", + "retrieve-doc-funds-using-the-faucet-module", + "complete-each-api-method-of-the-heir-module", + "transactions-as-a-data-source", + "command", + "response-annotated", + "value-taken-from-normal-vins", + "value-sent-to-cc-vouts", + "key-takeaways" + ], + "src/pages/antara/tutorials/advanced-series-4/index.mdx": [ + "advanced-series-final-conceptual-discussion", + "understanding-crypto-conditions", + "antara-extensions-to-crypto-conditions", + "makeup-of-a-crypto-condition", + "part-i-logical-condition", + "part-ii-logical-fulfillment", + "the-simplest-form-of-a-crypto-condition", + "antara-module-as-data-and-business-logic-layer-of-business-application", + "a-global-cc-address-in-the-antara-framework", + "antara-development-checklist", + "antara-module-architecture", + "rpc-implementations", + "antara-module-validation-code", + "the-eval-code", + "antara-module-transaction-structure", + "antara-module-sdk" + ], + "src/pages/antara/tutorials/advanced-series-5/index.mdx": [ + "advanced-series-developing-the-heir-module-prototype", + "heir-module-development", + "links-to-heir-source-code-and-building-instructions", + "downloading-and-installing-from-source", + "begin-development", + "create-the-eval-code", + "global-cc-address", + "heir-module-transactions", + "the-initial-transaction-creating-a-fund", + "the-add-coins-transaction", + "the-claim-coins-transaction", + "heir-module-rpc-implementations", + "heirfund", + "descriptions-of-the-heirfund-syntax", + "adding-the-command-to-the-source-file", + "add-the-rpc-function-declaration", + "the-two-levels-of-an-rpc-implementation", + "second-level-implementation", + "implementing-heirfund-transaction-creation", + "adding-inputs-to-the-transaction", + "adding-outputs-to-the-transaction", + "implementing-the-heirclaim-rpc", + "heirclaim-syntax", + "add-the-rpc-command-to-komodo-cli", + "transaction-creation-code-for-heirclaim-rpc", + "implementations-for-heiradd-heirlist-and-heirinfo", + "heir-module-helper-functions", + "simplified-add1of2-address-inputs-function-implementation", + "simplified-implementation-of-the-find-latest-owner-tx-function", + "heir-module-validation", + "simplified-validation-function-implementation", + "guidelines-for-validation", + "heir-module-validation-rules", + "heir-validate-implementation", + "validation-code-errors" + ], + "src/pages/antara/tutorials/advanced-series-6/index.mdx": [ + "advanced-series-miscellaneous", + "terminology", + "cc-contract-patterns", + "baton-pattern", + "marker-pattern", + "txidaddress-pattern", + "create-an-unspendable-public-key-for-a-transaction-id", + "create-a-cc-vout-with-1-of-2-pubkeys-one-of-which-is-txid-pubkey", + "spend-1-of-2-pubkey-outputs-with-a-txid-pubkey-in-a-previous-transaction", + "application-data-in-a-crypto-condition-vout-cc-opret", + "various-tips-and-tricks-in-antara-module-development", + "test-chain-mining-issue", + "limits-on-add-normal-inputs-function-calls-per-transaction", + "troubleshooting-node-syncing-on-test-cc-chain", + "deadlocks-in-validation-code" + ], + "src/pages/antara/tutorials/beginner-series-part-0/index.mdx": [ + "komodo-developer-path-preparation", + "introduction", + "full-overview-of-komodo-developer-path-tutorials", + "menu-options-in-docker-images", + "rapid-summary-tl-dr", + "the-unique-nature-of-the-docker-image-tutorials", + "sending-commands-to-the-docker-images-seed-node", + "install-docker", + "estimated-time-2-minutes", + "download-komodo-image", + "estimated-time-3-minutes", + "optional-install-the-reduced-size-docker-image", + "check-the-local-image", + "command", + "expected-response", + "start-komodo-development-container", + "estimated-time-10-seconds", + "optional-for-smaller-docker-image-only-mount-the-local-zcash-parameters", + "follow-the-guided-tutorial-blockchain-starter-kit", + "estimated-time-4-minutes", + "begin-guided-tutorial", + "estimated-time-20-seconds" + ], + "src/pages/antara/tutorials/beginner-series-part-1/index.mdx": [ + "komodo-developer-path-create-a-blockchain", + "create-a-blockchain", + "estimated-time-10-minutes", + "select-the-appropriate-tutorial-from-the-menu", + "create-a-seed-node", + "estimated-time-1-minute", + "create-mining-node", + "estimated-time-1-minute-2", + "start-mining", + "estimated-time-1-minute-3", + "validate-an-address", + "estimated-time-1-minute-4", + "import-private-key-for-the-wallet", + "check-the-wallet-balance", + "estimated-time-1-minute-5", + "list-unspent-transactions-utxos", + "estimated-time-1-minute-6", + "stop-mining", + "estimated-time-1-minute-7", + "optional-shut-down-both-nodes" + ], + "src/pages/antara/tutorials/beginner-series-part-2/index.mdx": [ + "komodo-developer-path-using-a-faucet", + "total-estimated-time-15-minutes", + "introduction", + "the-expected-current-state-of-our-tut-1-smart-chain", + "next-steps-in-the-tutorial", + "send-all-funds-to-self", + "estimated-time-2-minutes", + "send-funds-to-the-faucet", + "estimated-time-1-minute", + "claim-a-small-amount-of-funds-from-the-faucet", + "estimated-time-5-minutes", + "validate-the-seed-wallet", + "claim-funds-from-the-faucet", + "check-for-the-returned-coins", + "estimated-time-1-minute-2" + ], + "src/pages/antara/tutorials/beginner-series-part-3/index.mdx": [ + "komodo-developer-path-connecting-to-another-programming-environment", + "total-estimated-time-10-20-minutes", + "introduction", + "inquiring-about-language-wrappers", + "obtaining-the-necessary-passwords-and-credentials", + "estimated-time-1-minute", + "using-curl", + "estimated-time-5-minutes", + "conceptualizing-the-curl-command", + "installing-jq", + "the-anatomy-of-a-curl-command", + "command", + "response", + "mine-on-the-seed-node-using-curl", + "command-2", + "response-2", + "discover-the-state-of-mining-on-the-seed-node", + "command-3", + "response-3", + "stop-mining-on-the-seed-node", + "response-4" + ], + "src/pages/antara/tutorials/beginner-series-part-4/index.mdx": [ + "komodo-developer-path-understanding-tokens", + "introduction", + "conceptualizing-tokens", + "a-token-is-a-satoshi", + "fungible-token-creation", + "non-fungible-token-creation", + "attaching-data-to-tokens", + "create-a-token-set-on-tut-1-smart-chain", + "seed-or-mining-node-rpc-tokenlist-and-tokeninfo-to-find-details-of-the-tokens", + "create-silver-tokens", + "create-rock-tokens", + "create-a-non-fungible-token", + "compare-the-tokens-on-one-node-against-the-other", + "tutorial-series-conclusion" + ], + "src/pages/antara/tutorials/dilithium-module-tutorial/index.mdx": [ + "dilithium-module-tutorial", + "introduction", + "installation", + "the-musig-test-smart-chain", + "command", + "a-note-regarding-the-installation-of-the-necessary-libraries-in-the-source-code", + "stop-the-daemon-and-install-the-appropriate-cclib-module", + "begin-walkthrough", + "understand-the-comparison-between-q-transactions-and-z-transactions", + "start-the-daemon-with-a-pubkey-and-backup-its-privkey", + "command-2", + "response", + "backup-the-private-key-to-your-pubkey", + "create-a-dilithium-keypair", + "command-3", + "response-2", + "check-for-handle-availability", + "command-4", + "response-3", + "register-an-available-handle", + "command-5", + "response-4", + "broadcast-the-raw-transaction", + "response-5", + "command-6", + "response-6", + "send-coins-to-the-handle", + "response-7", + "response-8", + "broadcast-the-returned-hex-value", + "response-9", + "send-coins-from-one-handle-to-another", + "obtain-the-destpubtxid-from-the-komodo-fan-handle", + "command-7", + "response-10", + "the-meaning-of-q-utxo", + "send-funds-using-qsend", + "understanding-the-inputs-and-outputs-of-a-q-q-transaction", + "click-button-below-to-view-full-response", + "breaking-down-the-response", + "transaction-vins-inputs", + "observe-the-vouts-outputs", + "the-first-output-vout0", + "optional-check-the-address-belongs-to-the-handle", + "command-8", + "the-second-output-vout1", + "command-9", + "response-11", + "the-final-output-opreturn-vout", + "create-a-complex-qsend-transaction", + "the-change-transaction-to-komodo-haxor", + "obtaining-the-destpubtxids-for-other-handles", + "obtaining-the-script-pubkey-for-r-addresses", + "send-the-qsend-transaction", + "broadcast-the-transaction-using-sendrawtransaction", + "understanding-the-inputs-and-outputs-of-the-above-transaction", + "convert-the-opreturn-hex-value-to-big-endian", + "find-the-balance-of-an-arbitrary-handle", + "obtain-the-antara-address-for-the-handle", + "note-the-eval-code", + "note-the-function-value", + "obtain-the-destpubtxids-of-the-inputs-and-the-outputs", + "create-a-customized-function-to-determine-the-full-handle", + "repeat-the-same-process-for-vout0", + "repeat-this-process-on-each-utxo" + ], + "src/pages/antara/tutorials/gateways-module-tutorial/index.mdx": [ + "gateways-module-tutorial", + "tutorial", + "manually-compile-and-install-komodo-from-source", + "create-a-new-blockchain", + "create-a-token-to-represent-an-external-cryptocurrency", + "decide-the-number-of-tokens-to-create", + "creating-the-tokens", + "create-an-oracle", + "activating-gateway-binding", + "assemble-an-oracle-instance", + "using-the-gateway", + "claim-the-funds-on-the-smart-chain", + "withdrawing-kmd-funds", + "full-example", + "example-continues-from-gateway-user-node", + "user-withdraws-funds" + ], + "src/pages/antara/tutorials/index.mdx": [ + "antara-tutorials" + ], + "src/pages/antara/tutorials/introduction-to-antara-tutorials/index.mdx": [ + "introduction-to-antara-tutorials" + ], + "src/pages/antara/tutorials/musig-module-tutorial/index.mdx": [ + "musig-module-tutorial", + "installation", + "install-dependencies", + "build-instructions", + "update", + "launch-the-smart-chain", + "obtain-a-pubkey", + "acquire-funds-for-testing", + "full-example", + "step-1-combine", + "step-2-send", + "step-3-broadcast-the-hex-value-and-retrieve-the-sendtxid", + "step-4-obtain-the-change-script-value", + "step-5-calcmsg", + "step-6-session", + "node-1", + "node-2", + "step-7-commit", + "node-1-2", + "node-2-2", + "step-8-nonce", + "node-1-3", + "node-2-3", + "step-9-partialsig", + "node-1-4", + "node-2-4", + "step-10-verify", + "node-1-5", + "node-2-5", + "step-11-spend", + "node-1-6", + "node-2-6", + "step-12-sendrawtransaction", + "node-1-7" + ], + "src/pages/antara/tutorials/overview-of-antara-modules-part-i/index.mdx": [ + "overview-of-antara-modules-part-i", + "introduction", + "smart-contracts-on-the-komodo-platform", + "a-brief-review-of-bitcoin-script", + "turing-completeness", + "gas-based-smart-contract-platforms", + "pros-and-cons-of-turing-completeness", + "gas-a-way-to-avoid-infinite-loops", + "the-problem-with-the-gas-based-model", + "introducing-antara-modules", + "antara-modules-are-based-on-utxo-technology", + "antara-modules-utxo-based-smart-contracts", + "how-antara-modules-interact-with-bitcoin-script", + "antara-modules-maintain-scarcity-within-the-module", + "a-user-has-a-unique-address-for-each-antara-module", + "each-module-has-a-global-address", + "developers-set-the-rules-for-each-module-related-transaction", + "advantages-of-antara-modules", + "access-to-established-and-turing-complete-languages", + "no-need-for-a-virtual-machine", + "utxos-are-more-secure-than-balance-based-programming", + "rpcs-make-module-consumption-easy", + "instantaneous-confirmation", + "no-need-for-gas", + "difficult-to-create-but-easy-to-reuse", + "komodo-is-developing-and-testing-default-modules" + ], + "src/pages/antara/tutorials/overview-of-antara-modules-part-ii/index.mdx": [ + "overview-of-antara-modules-part-ii", + "introduction", + "assumptions-for-this-content", + "before-we-begin-a-brief-note-for-normal-developers", + "understanding-the-problem-that-antara-modules-solve", + "a-consensus-mechanism-is-not-easy-to-create-or-change", + "a-popular-but-flawed-solution-the-decentralized-virtual-machine", + "crypto-conditions-an-industry-wide-standard", + "creativity-at-the-consensus-level-without-losing-the-consensus-mechanism", + "antara-modules-in-action-accomplishing-years-worth-of-work-in-but-a-weekend" + ], + "src/pages/antara/tutorials/pegs-module-creator-tutorial/index.mdx": [ + "pegs-module-creator-tutorial", + "tutorial-overview", + "tutorial-outline", + "installation", + "dependencies", + "create-a-swap-partition-optional", + "build-the-komodo-daemon", + "obtain-a-pubkey", + "launch-the-test-smart-chain", + "create-a-token-to-represent-kmd-coins", + "create-an-oracle", + "bind-the-token-and-oracle-to-a-gateway", + "start-the-oraclefeed-software", + "create-the-peg", + "test-the-setup" + ], + "src/pages/antara/tutorials/pegs-module-user-tutorial/index.mdx": [ + "pegs-module-user-tutorial", + "tutorial-overview", + "tutorial-outline", + "installation", + "dependencies", + "create-a-swap-partition-optional", + "build-the-komodo-daemon", + "connect-and-sync-to-usdktest-and-kmd", + "sync-the-kmd-smart-chain", + "start-testing", + "deposit-kmd-in-the-associated-usdktest-gateways-address", + "obtain-the-txid-of-the-deposit-transaction", + "wait-for-the-deposit-transaction-to-reach-the-oracle", + "wait-for-the-deposit-transaction-to-be-mined", + "observe-the-txid-reach-the-oracle", + "inform-the-gateways-module-and-claim-the-tokenized-kmd", + "details", + "deposithex", + "proof", + "call-the-gatewaysdeposit-method", + "claim-the-tokenized-kmd", + "details-2", + "verify-the-returned-tokenized-kmd", + "exchange-tokenized-kmd-for-usdk-coins", + "redeeming-the-stablecoins-for-the-locked-funds", + "verify-that-the-tokens-are-redeemed", + "retrieve-the-kmd-coins-on-the-kmd-smart-chain", + "details-3", + "liquidation" + ], + "src/pages/antara/tutorials/rogue-module-tutorial/index.mdx": [ + "rogue-module-tutorial", + "introduction", + "installation", + "requirements", + "download-software-bundles", + "compile-rogue-software-manually", + "install-dependencies", + "linux", + "mac-os-osx", + "windows", + "clone-and-compile-komodo", + "linux-2", + "mac-os", + "windows-2", + "update-komodod", + "launch-the-rogue-chain-and-set-pubkey-value", + "step-1-start-the-chain", + "step-2", + "step-3", + "step-4", + "installing-the-tui-optional", + "walkthrough-for-api", + "single-player-mode-walkthrough", + "step-1", + "step-2-2", + "step-3-2", + "step-4-2", + "step-5", + "step-6-play", + "step-7-play-the-game", + "step-8-bailout", + "step-9-highlander-victory", + "multi-player-mode-walkthrough", + "step-1-create-a-multi-player-game", + "step-2-register-for-the-game", + "step-3-play-and-finish-the-game", + "gameplay-documentation", + "gameplay-modes", + "single-player-mode", + "multi-player-mode", + "the-mechanics-of-saving-trading-and-reusing-characters", + "recalling-an-existing-character", + "trading-an-existing-character" + ], + "src/pages/antara/tutorials/understanding-antara-addresses/index.mdx": [ + "understanding-antara-addresses", + "creating-and-launching-with-a-pubkey", + "cc-addresses" + ], + "src/pages/atomicdex/api/index.mdx": [ + "atomic-dex-rpc-methods" + ], + "src/pages/atomicdex/api/legacy/active_swaps/index.mdx": [ + "active-swaps", + "arguments", + "response", + "examples", + "command-without-include-status", + "command-include-status-true", + "response-uuids-only", + "response-statuses-included" + ], + "src/pages/atomicdex/api/legacy/all_swaps_uuids_by_filter/index.mdx": [ + "all-swaps-uuids-by-filter", + "arguments", + "response", + "examples", + "command-select-swaps-uuids-that-have-my-coin-doc-and-other-coin-marty", + "command-select-swaps-uuids-that-have-my-coin-doc-and-started-at-1611705600-january-27-2021-0-00-00-gmt", + "command-select-swaps-uuids-that-have-started-at-1611705600-january-27-2021-0-00-00-gmt-and-started-at-1611792001-january-28-2021-0-00-01-gmt", + "response-success" + ], + "src/pages/atomicdex/api/legacy/ban_pubkey/index.mdx": [ + "ban-pubkey", + "arguments", + "response", + "examples", + "command", + "response-success", + "response-error" + ], + "src/pages/atomicdex/api/legacy/batch_requests/index.mdx": [ + "batch-requests", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/best_orders/index.mdx": [ + "best-orders", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/legacy/buy/index.mdx": [ + "buy", + "arguments", + "response", + "examples", + "command-decimal-representation", + "command-rational-representation-in-num-rational-crate-format", + "command-rational-representation-as-fraction-object", + "command-with-confirmations-and-notarization-settings", + "command-set-to-not-save-order-history", + "command-good-till-cancelled-type", + "command-fill-or-kill-type", + "command-match-by-any", + "command-match-by-pubkeys", + "command-match-by-orders", + "response-success", + "response-error", + "response-error-2" + ], + "src/pages/atomicdex/api/legacy/cancel_all_orders/index.mdx": [ + "cancel-all-orders", + "arguments", + "response", + "examples", + "command-all-orders", + "command-cancel-by-pair", + "command-cancel-by-coin", + "response-1-order-cancelled", + "response-1-order-cancelled-and-1-is-currently-matching" + ], + "src/pages/atomicdex/api/legacy/cancel_order/index.mdx": [ + "cancel-order", + "arguments", + "response", + "examples", + "command", + "response-success", + "response-error" + ], + "src/pages/atomicdex/api/legacy/coin_activation/index.mdx": [ + "coin-activation", + "native-mode-activation", + "lite-mode-activation", + "electrum", + "arguments", + "response", + "examples", + "command-for-utxo-based-coins", + "response-success", + "command-for-utxo-based-coins-with-required-confirmations-requires-notarization-and-mm2-arguments", + "response-success-2", + "command-for-qtum-qrc-20-tokens", + "response-success-3", + "response-error-mm2-is-not-set", + "enable", + "arguments-2", + "response-2", + "examples-2", + "command-for-native-utxo-based-blockchains", + "response-3", + "command-with-required-confirmations-requires-notarization-and-mm2-arguments", + "response-4", + "command-for-ethereum-and-erc-20-based-blockchains", + "response-5", + "command-for-ethereum-and-erc-20-based-blockchains-with-gas-station-url-and-policy", + "response-6", + "command-for-polygon-matic-and-plg-20-tokens", + "response-7", + "command-for-binance-coin-bnb-and-bep-20-tokens", + "response-8" + ], + "src/pages/atomicdex/api/legacy/coins_needed_for_kick_start/index.mdx": [ + "coins-needed-for-kick-start", + "arguments", + "response", + "examples", + "command", + "response-btc-and-kmd-should-be-activated-asap-in-this-case", + "response-no-swaps-and-orders-waiting-to-be-started" + ], + "src/pages/atomicdex/api/legacy/convert_utxo_address/index.mdx": [ + "convert-utxo-address", + "arguments", + "response", + "examples", + "command", + "response-success", + "response-error-coin-not-enabled", + "response-error-input-address-checksum-failed" + ], + "src/pages/atomicdex/api/legacy/convertaddress/index.mdx": [ + "convertaddress", + "arguments", + "response", + "examples", + "command-eth-single-case-address-to-mixed-checksum", + "response-2", + "command-bch-legacy-to-cash-address", + "response-3", + "command-bch-cash-address-to-legacy", + "response-4", + "command-qtum-wallet-address-to-qrc-20-contract-address", + "response-5", + "command-qrc-20-contract-address-to-qtum-wallet-address", + "response-6" + ], + "src/pages/atomicdex/api/legacy/disable_coin/index.mdx": [ + "disable-coin", + "arguments", + "response", + "examples", + "command", + "response-success", + "response-error-coin-is-not-enabled", + "response-error-active-swap-is-using-the-coin", + "response-error-the-order-is-matched-at-the-moment-but-another-order-is-cancelled" + ], + "src/pages/atomicdex/api/legacy/get_enabled_coins/index.mdx": [ + "get-enabled-coins", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/get_gossip_mesh/index.mdx": [ + "get-gossip-mesh", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/legacy/get_gossip_peer_topics/index.mdx": [ + "get-gossip-peer-topics", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/legacy/get_gossip_topic_peers/index.mdx": [ + "get-gossip-topic-peers", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/legacy/get_my_peer_id/index.mdx": [ + "get-my-peer-id", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/legacy/get_peers_info/index.mdx": [ + "get-peers-info", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/legacy/get_relay_mesh/index.mdx": [ + "get-relay-mesh", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/legacy/get_trade_fee/index.mdx": [ + "get-trade-fee-deprecated", + "arguments", + "response", + "examples", + "command-btc", + "response-2", + "command-eth", + "response-3", + "command-erc-20", + "response-4" + ], + "src/pages/atomicdex/api/legacy/help/index.mdx": [ + "help", + "arguments", + "response" + ], + "src/pages/atomicdex/api/legacy/import_swaps/index.mdx": [ + "import-swaps", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/index.mdx": [ + "atomic-dex-api-rpc-legacy" + ], + "src/pages/atomicdex/api/legacy/kmd_rewards_info/index.mdx": [ + "kmd-rewards-info", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/list_banned_pubkeys/index.mdx": [ + "list-banned-pubkeys", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/max_taker_vol/index.mdx": [ + "max-taker-vol", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/metrics/index.mdx": [ + "metrics", + "request-parameters", + "response-parameters", + "metrics-object", + "example-s", + "command", + "response" + ], + "src/pages/atomicdex/api/legacy/min_trading_vol/index.mdx": [ + "min-trading-vol", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/my_balance/index.mdx": [ + "my-balance", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/my_orders/index.mdx": [ + "my-orders", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/my_recent_swaps/index.mdx": [ + "my-recent-swaps", + "arguments", + "response", + "examples", + "command-limit-from-uuid", + "command-limit-page-number", + "command-select-swaps-that-have-my-coin-doc-and-other-coin-marty", + "command-select-swaps-that-have-my-coin-doc-and-started-at-1611705600-january-27-2021-0-00-00-gmt", + "command-select-swaps-that-have-started-at-1611705600-january-27-2021-0-00-00-gmt-and-started-at-1611792001-january-28-2021-0-00-01-gmt", + "response-success" + ], + "src/pages/atomicdex/api/legacy/my_swap_status/index.mdx": [ + "my-swap-status", + "arguments", + "response", + "maker-swap-events", + "started", + "start-failed", + "negotiated", + "negotiate-failed", + "taker-fee-validated", + "taker-fee-validate-failed", + "maker-payment-transaction-failed", + "maker-payment-sent", + "maker-payment-data-send-failed", + "maker-payment-wait-confirm-failed", + "taker-payment-received", + "taker-payment-wait-confirm-started", + "taker-payment-validate-failed", + "taker-payment-wait-confirm-failed", + "taker-payment-validated-and-confirmed", + "taker-payment-spend-failed", + "taker-payment-spent", + "taker-payment-spend-confirm-started", + "taker-payment-spend-confirm-failed", + "taker-payment-spend-confirmed", + "maker-payment-wait-refund-started", + "maker-payment-refund-failed", + "maker-payment-refunded", + "finished", + "taker-swap-events", + "started-2", + "start-failed-2", + "negotiated-2", + "negotiate-failed-2", + "taker-fee-sent", + "taker-fee-send-failed", + "maker-payment-validate-failed", + "maker-payment-received", + "maker-payment-wait-confirm-started", + "maker-payment-wait-confirm-failed-2", + "maker-payment-validated-and-confirmed", + "taker-payment-sent", + "taker-payment-transaction-failed", + "taker-payment-wait-confirm-failed-2", + "taker-payment-data-send-failed", + "taker-payment-spent-2", + "taker-payment-wait-for-spend-failed", + "maker-payment-spend-failed", + "maker-payment-spent", + "taker-payment-wait-refund-started", + "taker-payment-refund-failed", + "taker-payment-refunded", + "finished-2", + "examples", + "command", + "successful-taker-swap", + "taker-swap-failed-with-maker-payment-spend-failed-event", + "successful-maker-swap", + "maker-swap-failed-with-maker-payment-transaction-failed-event", + "response-error" + ], + "src/pages/atomicdex/api/legacy/my_tx_history/index.mdx": [ + "my-tx-history", + "arguments", + "response", + "examples", + "command", + "command-max-true", + "response-success", + "response-error", + "response-history-too-large-in-electrum-mode", + "response-sync-in-progress-for-utxo-coins", + "response-sync-in-progress-for-eth-erc-20-coins", + "response-successful-result-in-case-of-eth-erc-20-coins" + ], + "src/pages/atomicdex/api/legacy/order_status/index.mdx": [ + "order-status", + "argument", + "command", + "response-no-order-found", + "maker-order-response", + "maker-order-examples", + "maker-order-response-cancelled-order-from-history", + "response-taker-orders", + "taker-order-examples", + "response-taker-order-fullfilled", + "response-fill-or-kill-taker-order-after-timeout-with-no-match" + ], + "src/pages/atomicdex/api/legacy/orderbook/index.mdx": [ + "orderbook", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/orderbook_depth/index.mdx": [ + "orderbook-depth", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/orders_history_by_filter/index.mdx": [ + "orders-history-by-filter", + "arguments", + "response", + "examples", + "command-select-orders-from-history-that-have-order-type-taker-and-initial-action-buy", + "command-select-orders-from-history-that-have-base-doc-and-rel-marty", + "command-select-orders-from-history-that-have-base-doc-and-price-1-and-volume-1", + "command-select-orders-from-history-that-was-taker-and-created-at-1611705600-january-27-2021-0-00-00-gmt", + "command-select-orders-with-details-from-history-that-was-cancelled-because-it-timed-out", + "response-orders-only", + "response-details-included", + "response-warning-uuid-could-not-be-parsed" + ], + "src/pages/atomicdex/api/legacy/rational_number_note/index.mdx": [ + "note-about-rational-number-type" + ], + "src/pages/atomicdex/api/legacy/recover_funds_of_swap/index.mdx": [ + "recover-funds-of-swap", + "arguments", + "response", + "examples", + "command", + "response-success-spent-other-payment", + "response-success-refunded-my-payment", + "response-error-maker-payment-was-already-spent", + "response-error-swap-is-not-finished-yet" + ], + "src/pages/atomicdex/api/legacy/sell/index.mdx": [ + "sell", + "arguments", + "response", + "examples", + "command-decimal-representation", + "command-rational-representation-in-num-rational-crate-format", + "command-rational-representation-as-a-fraction-object", + "command-with-confirmations-and-notarization-settings", + "command-set-to-not-save-order-history", + "command-good-till-cancelled-type", + "command-fill-or-kill-type", + "command-match-by-any", + "command-match-by-pubkeys", + "command-match-by-orders", + "response-success", + "response-error" + ], + "src/pages/atomicdex/api/legacy/send_raw_transaction/index.mdx": [ + "send-raw-transaction", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/legacy/set_required_confirmations/index.mdx": [ + "set-required-confirmations", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/legacy/set_requires_notarization/index.mdx": [ + "set-requires-notarization", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/legacy/setprice/index.mdx": [ + "setprice", + "arguments", + "response", + "examples", + "command-with-volume", + "command-max-true", + "command-rational-representation-in-num-rational-crate-format", + "command-rational-representation-as-fraction-object", + "command-with-min-volume", + "command-with-confirmations-and-notarization-settings", + "command-set-to-not-save-order-history", + "response-success", + "response-error" + ], + "src/pages/atomicdex/api/legacy/show_priv_key/index.mdx": [ + "show-priv-key", + "arguments", + "response", + "examples", + "command", + "response-utxo-wif", + "response-0x-prefixed-eth-private-key" + ], + "src/pages/atomicdex/api/legacy/stop/index.mdx": [ + "stop", + "arguments", + "response" + ], + "src/pages/atomicdex/api/legacy/trade_preimage/index.mdx": [ + "trade-preimage-deprecated", + "arguments", + "response", + "examples", + "command-setprice", + "response-2", + "command-buy", + "response-3", + "command-erc-20-and-qrc-20", + "response-4" + ], + "src/pages/atomicdex/api/legacy/unban_pubkeys/index.mdx": [ + "unban-pubkeys", + "arguments", + "response", + "examples", + "command", + "response-success", + "command-2", + "response-success-2" + ], + "src/pages/atomicdex/api/legacy/update_maker_order/index.mdx": [ + "update-maker-order", + "arguments", + "response", + "examples", + "command-with-volume", + "command-max-true", + "command-rational-representation-in-num-rational-crate-format", + "command-rational-representation-as-fraction-object", + "command-with-min-volume", + "command-with-confirmations-and-notarization-settings", + "response-success", + "response-error" + ], + "src/pages/atomicdex/api/legacy/validateaddress/index.mdx": [ + "validateaddress", + "arguments", + "response", + "examples", + "command", + "response-valid-address", + "response-invalid-cash-address", + "response-invalid-eth-address" + ], + "src/pages/atomicdex/api/legacy/version/index.mdx": [ + "version", + "arguments", + "response", + "examples", + "command", + "response-2" + ], + "src/pages/atomicdex/api/legacy/withdraw/index.mdx": [ + "withdraw", + "arguments", + "response", + "examples", + "withdraw-utxo-based-coins", + "response-kmd-success", + "withdraw-utxo-based-coins-with-fixed-fee", + "response-success", + "response-error-attempt-to-use-eth-gas-for-utxo-coin", + "withdraw-utxo-based-coins-with-custom-fee-per-kbyte", + "response-success-2", + "response-error-attempt-to-use-eth-gas-for-utxo-coin-2", + "withdraw-eth-erc-20-and-other-eth-based-forks", + "response-success-3", + "withdraw-eth-erc-20-and-other-eth-based-forks-with-gas-limit", + "response-success-4", + "response-error-attempt-to-use-utxo-fixed-or-utxo-per-kbyte-for-eth-coin", + "withdraw-max", + "response-success-5", + "withdraw-qrc-20", + "response-success-6", + "withdraw-qrc-20-with-gas-limit" + ], + "src/pages/atomicdex/api/v20/add_delegation/index.mdx": [ + "add-delegation", + "arguments", + "examples", + "command", + "response-success", + "response-error-already-delegating" + ], + "src/pages/atomicdex/api/v20/add_node_to_version_stat/index.mdx": [ + "add-node-to-version-stat", + "arguments", + "examples", + "command", + "response-success", + "response-error-peer-id-already-in-database", + "response-error-name-already-in-database", + "response-error-invalid-peer-id" + ], + "src/pages/atomicdex/api/v20/best_orders/index.mdx": [ + "best-orders", + "arguments", + "response", + "examples", + "command-by-number", + "response-by-number-success", + "command-by-volume", + "response-by-volume-success", + "error-responses" + ], + "src/pages/atomicdex/api/v20/enable_bch_with_tokens/index.mdx": [ + "enable-bch-with-tokens", + "request-parameters", + "response-parameters", + "examples", + "request-with-tx-history-cashaddress-format-and-automated-utxo-merging", + "response", + "request-with-get-balances-set-to-false", + "response-2", + "error-types", + "platform-is-already-activated-error", + "platform-config-is-not-found-error", + "unexpected-platform-protocol-error", + "unexpected-token-protocol-error", + "platform-coin-creation-error-error", + "platform-coin-creation-error-error-native", + "platform-coin-creation-error-error-electrum-server-not-responding" + ], + "src/pages/atomicdex/api/v20/enable_erc20/index.mdx": [ + "enable-erc20", + "response", + "error-platform-coin-is-not-yet-activated", + "error-token-already-activated", + "error-token-config-not-found-in-coins-file" + ], + "src/pages/atomicdex/api/v20/enable_eth_with_tokens/index.mdx": [ + "enable-eth-with-tokens", + "request-parameters", + "response-parameters", + "examples", + "request-including-optional-gas-station-parameters", + "response", + "request-with-get-balances-set-to-false", + "response-2", + "error-types", + "platform-is-already-activated-error", + "platform-config-is-not-found-error", + "coin-protocol-parse-error-error", + "unexpected-platform-protocol-error", + "token-config-is-not-found-error", + "token-protocol-parse-error-error", + "unexpected-token-protocol-error" + ], + "src/pages/atomicdex/api/v20/enable_slp/index.mdx": [ + "enable-slp", + "response", + "error-bch-not-yet-activated", + "error-token-already-activated", + "error-token-config-not-found-in-coins-file" + ], + "src/pages/atomicdex/api/v20/enable_tendermint_token/index.mdx": [ + "enable-tendermint-token", + "response", + "error-platform-coin-is-not-yet-activated", + "error-token-already-activated", + "error-token-config-not-found-in-coins-file" + ], + "src/pages/atomicdex/api/v20/enable_tendermint_with_assets/index.mdx": [ + "enable-tendermint-with-assets", + "request-parameters", + "response-parameters", + "examples", + "request-default-optional-values", + "response", + "request-with-get-balances-set-to-false", + "response-2", + "error-types", + "platform-config-is-not-found-error", + "platform-is-already-activated-error", + "coin-protocol-parse-error", + "unexpected-platform-protocol-error", + "token-config-is-not-found-error", + "token-protocol-parse-error-error", + "unexpected-token-protocol-error" + ], + "src/pages/atomicdex/api/v20/get_public_key/index.mdx": [ + "get-public-key", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/v20/get_public_key_hash/index.mdx": [ + "get-public-key-hash", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/v20/get_raw_transaction/index.mdx": [ + "get-raw-transaction", + "arguments", + "response", + "examples", + "request-doc", + "response-success", + "request-eth", + "response-success-2", + "error-response-no-such-coin", + "error-invalid-hash", + "error-invalid-ec-signature", + "error-types" + ], + "src/pages/atomicdex/api/v20/get_staking_infos/index.mdx": [ + "get-staking-info", + "arguments", + "examples", + "command", + "response-not-currently-staking", + "response-staking-active" + ], + "src/pages/atomicdex/api/v20/index.mdx": [ + "atomic-dex-api-rpc-protocol-v2-0", + "request", + "response-success", + "response-error", + "examples", + "response-success-2", + "response-error-2", + "common-atomic-dex-api-request-response-objects", + "address-infos", + "example-with-balances", + "example-without-balances", + "balance-infos", + "derivation-method", + "evm-node", + "coin-protocol", + "coin-protocol-data", + "confirmation-targets", + "counterparty-channel-config", + "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", + "tokens-request" + ], + "src/pages/atomicdex/api/v20/message_signing/index.mdx": [ + "signing-and-verifying-messages", + "message-signing", + "arguments", + "response", + "command", + "response-success", + "error-types", + "message-verification", + "arguments-2", + "response-2", + "command-2", + "response-valid", + "response-not-valid", + "error-types-2" + ], + "src/pages/atomicdex/api/v20/my_tx_history/index.mdx": [ + "my-tx-history", + "arguments", + "response", + "request-bch-from-page-2", + "response-2", + "request-ttt-slp-with-from-id", + "response-3", + "request-iris-with-limit-50", + "response-4", + "error-cases", + "error-coin-not-active", + "error-coin-not-compatible", + "error-coin-enabled-without-tx-history-true", + "error-local-database-failed" + ], + "src/pages/atomicdex/api/v20/recreate_swap_data/index.mdx": [ + "recreate-swap-data", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/v20/remove_delegation/index.mdx": [ + "remove-delegation", + "arguments", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/v20/remove_node_from_version_stat/index.mdx": [ + "remove-node-from-version-stat", + "arguments", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/v20/start_simple_market_maker_bot/index.mdx": [ + "start-simple-market-maker-bot", + "arguments", + "examples", + "command", + "response-success", + "response-error-bot-already-started" + ], + "src/pages/atomicdex/api/v20/start_version_stat_collection/index.mdx": [ + "start-version-stat-collection", + "arguments", + "examples", + "command", + "response-success", + "response-error-invalid-peer-id-unable-to-parse" + ], + "src/pages/atomicdex/api/v20/stop_simple_market_maker_bot/index.mdx": [ + "stop-simple-market-maker-bot", + "arguments", + "examples", + "command", + "response-success", + "response-error-bot-already-stopped" + ], + "src/pages/atomicdex/api/v20/stop_version_stat_collection/index.mdx": [ + "stop-version-stat-collection", + "arguments", + "response", + "examples", + "command", + "response-success", + "response-error-stats-collection-not-running" + ], + "src/pages/atomicdex/api/v20/telegram_alerts/index.mdx": [ + "telegram-alerts-for-market-maker-bot" + ], + "src/pages/atomicdex/api/v20/trade_preimage/index.mdx": [ + "trade-preimage", + "arguments", + "result", + "error-types", + "not-sufficient-balance", + "not-sufficient-base-coin-balance", + "volume-too-low", + "no-such-coin", + "coin-is-wallet-only", + "base-equal-rel", + "invalid-param", + "price-too-low", + "transport", + "internal-error", + "examples", + "command-setprice", + "response", + "command-buy", + "response-2", + "command-sell-max", + "response-3", + "command-erc-20-and-qrc-20", + "response-4", + "response-not-sufficient-balance-error", + "response-volume-too-low-error", + "response-transport-error", + "response-incorrect-use-of-max-error" + ], + "src/pages/atomicdex/api/v20/update_version_stat_collection/index.mdx": [ + "update-version-stat-collection", + "arguments", + "examples", + "command", + "response-success", + "response-error-stats-collection-not-running" + ], + "src/pages/atomicdex/api/v20/withdraw/index.mdx": [ + "withdraw", + "arguments", + "response", + "error-types", + "not-sufficient-balance", + "zero-balance-to-withdraw-max", + "amount-too-low", + "invalid-address", + "invalid-fee-policy", + "no-such-coin", + "transport", + "internal-error", + "examples", + "withdraw-btc-kmd-and-other-btc-based-forks", + "response-kmd-success", + "response-not-sufficient-balance-error", + "withdraw-btc-kmd-and-other-btc-based-forks-fixed-fee", + "response-success", + "response-invalid-fee-policy-error-attempt-to-use-eth-gas-for-utxo-coin", + "withdraw-btc-kmd-and-other-btc-based-forks-1-coin-per-kbyte-fee", + "response-success-2", + "withdraw-eth-erc-20-and-other-eth-based-forks", + "response-success-3", + "eth-erc-20-and-other-eth-based-forks-with-gas-fee", + "response-success-4", + "response-invalid-fee-policy-error-attempt-to-use-utxo-fixed-or-utxo-per-kbyte-for-eth-coin", + "withdraw-maximum", + "response-success-5", + "withdraw-qrc-20-coins", + "response-success-6", + "withdraw-qrc-20-coins-with-gas-limit", + "withdraw-tendermint-coins-with-a-memo" + ], + "src/pages/atomicdex/api/v20-dev/account_balance_tasks/index.mdx": [ + "account-balance-tasks", + "task-account-balance-init", + "arguments", + "response", + "examples", + "command", + "response-ready-successful", + "task-account-balance-status", + "arguments-2", + "response-2", + "examples-2", + "command-2", + "response-ready-successful-2", + "task-account-balance-cancel", + "arguments-3", + "response-3", + "examples-3", + "command-3", + "response-ready-successful-3", + "response-error-task-already-finished" + ], + "src/pages/atomicdex/api/v20-dev/coin_activation_tasks/index.mdx": [ + "task-enable-utxo-init", + "arguments", + "response", + "examples", + "command", + "response-2", + "task-enable-utxo-status", + "arguments-2", + "command-2", + "response-ready-successful-trezor-mode", + "response-ready-successful-iguana-mode", + "response-in-progress", + "response-ready-error", + "task-enable-utxo-user-action", + "arguments-3", + "response-3", + "examples-2", + "command-3", + "response-success", + "task-enable-qtum-init", + "arguments-4", + "response-4", + "examples-3", + "command-4", + "response-5", + "task-enable-qtum-status", + "arguments-5", + "request", + "task-enable-qtum-user-action", + "arguments-6", + "response-6", + "examples-4", + "command-5", + "response-success-2", + "error-cases" + ], + "src/pages/atomicdex/api/v20-dev/get_current_mtp/index.mdx": [ + "get-current-mtp", + "arguments", + "response", + "examples", + "command", + "response-success" + ], + "src/pages/atomicdex/api/v20-dev/get_locked_amount/index.mdx": [ + "get-locked-amount", + "arguments", + "response", + "examples", + "command", + "response-success", + "response-error" + ], + "src/pages/atomicdex/api/v20-dev/hd_address_management/index.mdx": [ + "heirarchical-deterministic-address-management", + "can-get-new-address", + "arguments", + "response", + "examples", + "command", + "response-success-allowed", + "response-success-not-allowed", + "get-new-address", + "arguments-2", + "response-2", + "examples-2", + "command-2", + "response-success", + "response-success-not-allowed-2" + ], + "src/pages/atomicdex/api/v20-dev/hd_wallets_overview/index.mdx": [ + "hd-wallets-overview", + "initialisation-and-authentication", + "utxo-coin-activation-in-hardware-mode", + "qtum-coin-activation-in-hardware-mode", + "withdrawing-your-funds", + "viewing-hardware-wallet-coin-balances", + "creating-new-addresses", + "details-for-hw-error-error-type", + "found-unexpected-device", + "found-multiple-devices", + "no-trezor-device-available" + ], + "src/pages/atomicdex/api/v20-dev/index.mdx": [ + "atomic-dex-api-rpc-protocol-v2-0-dev", + "request", + "response-success", + "response-error", + "examples", + "command", + "response-success-2", + "response-error-2" + ], + "src/pages/atomicdex/api/v20-dev/lightning/activation/index.mdx": [ + "lightning-network-initialization-tasks", + "initialize-lightning", + "request-parameters", + "example", + "response-parameters", + "response", + "l2-config-is-not-found-error", + "invalid-request-error", + "unexpected-l2-protocol-error", + "internal-error", + "platform-coin-is-not-activated-error", + "invalid-platform-configuration-error", + "initialization-status", + "request-parameters-2", + "example-2", + "response-parameters-2", + "response-ready-success", + "response-in-progress-state", + "cancel-initialization", + "request-parameters-3", + "example-3", + "response-2", + "task-finished-error" + ], + "src/pages/atomicdex/api/v20-dev/lightning/channels/index.mdx": [ + "lightning-network-channels", + "open-a-channel", + "request-parameters", + "example-using-an-exact-amount", + "response", + "example-using-max-available-with-channel-options-and-configs", + "response-2", + "close-a-channel", + "request-parameters-2", + "example-to-force-closing-a-channel", + "response-3", + "invalid-request-error", + "no-such-channel-error", + "update-a-channel", + "request-parameters-3", + "example-to-update-all-available-channel-options", + "response-4", + "no-such-channel-error-2", + "get-channel-details", + "request-parameters-4", + "example-to-update-all-available-channel-options-2", + "response-opened-channel", + "response-closed-channel", + "invalid-request-error-2", + "get-claimable-balances", + "request-parameters-5", + "example-to-update-all-available-channel-options-3", + "response-5", + "list-open-channels-by-filter", + "request-parameters-6", + "example-without-using-filter-parameter", + "command", + "response-6", + "example-with-filter-for-inbound-channels-only", + "command-2", + "response-7", + "example-with-filter-for-a-specific-node-id", + "command-3", + "response-8", + "example-with-filter-for-a-node-with-between-100000-and-500000-satoshi-funding-value", + "command-4", + "response-9", + "list-closed-channels-by-filter", + "request-parameters-7", + "example-without-using-filter-parameter-2", + "command-5", + "response-10", + "example-with-filter-for-inbound-channels-only-2", + "command-6", + "response-11", + "example-with-filter-for-a-specific-node-id-2", + "command-7", + "response-12", + "example-with-filter-for-a-node-with-between-100000-and-500000-satoshi-funding-value-2", + "command-8", + "response-13" + ], + "src/pages/atomicdex/api/v20-dev/lightning/index.mdx": [ + "lightning-network-methods", + "lightning-network-initialization-tasks", + "lightning-network-nodes-methods", + "lightning-network-channels-methods", + "lightning-network-payments-methods", + "lightning-network-flowchart", + "lightning-network-coins-file-configuration", + "lightning-coin-config-parameters" + ], + "src/pages/atomicdex/api/v20-dev/lightning/nodes/index.mdx": [ + "lightning-network-nodes", + "connect-to-a-node", + "request-parameters", + "example", + "response-success", + "response-already-connected", + "invalid-request-error-invalid-node-address", + "connection-error-error-timed-out-waiting-to-connect-to-node-address", + "list-trusted-nodes", + "request-parameters-2", + "example-2", + "response", + "add-a-trusted-node", + "request-parameters-3", + "example-3", + "response-2", + "remove-a-trusted-node", + "request-parameters-4", + "example-4", + "response-3" + ], + "src/pages/atomicdex/api/v20-dev/lightning/payments/index.mdx": [ + "lightning-network-payments", + "generate-an-invoice", + "request-parameters", + "example", + "response", + "invalid-request-invalid-paramater-value", + "send-a-payment", + "request-parameters-2", + "example-using-invoice", + "response-2", + "example-using-keysend", + "response-3", + "payment-error-attempt-to-pay-self", + "payment-error-no-outbound-routes", + "payment-error-keysend-no-path-to-destination", + "payment-error-invoice-no-path-to-destination", + "invalid-request-request-is-missing-a-required-field", + "invalid-request-a-required-field-is-invalid", + "get-payment-details", + "request-parameters-3", + "example-2", + "no-such-payment-payment-hash-not-found", + "invalid-request-payment-hash-not-a-hash-string", + "list-payments-by-filter", + "request-parameters-4", + "example-without-filter", + "response-4", + "example-for-inbound-payment-payment-type-limit-and-pagination", + "example-for-pending-payments-between-10000-and-40000-millisatoshis", + "response-5", + "example-for-successful-payments-on-the-20th-of-april-2023", + "response-6" + ], + "src/pages/atomicdex/api/v20-dev/max_maker_vol/index.mdx": [ + "max-maker-vol", + "arguments", + "response", + "examples", + "command", + "response-success", + "response-error", + "response-balance-too-low", + "response-transport-error" + ], + "src/pages/atomicdex/api/v20-dev/trezor_initialisation/index.mdx": [ + "trezor-initialisation", + "task-init-trezor-init", + "arguments", + "response", + "examples", + "command-without-device-pubkey", + "command-with-device-pubkey", + "response-success", + "task-init-trezor-status", + "arguments-2", + "response-2", + "examples-2", + "command", + "response-in-progress", + "response-ready-successful", + "error-responses-by-error-type", + "task-init-trezor-cancel", + "arguments-3", + "response-3", + "examples-3", + "command-2", + "response-ready-successful-2", + "response-error-task-already-finished", + "task-init-trezor-user-action", + "arguments-4", + "response-4", + "examples-4", + "command-for-trezor-pin", + "command-for-trezor-passphrase", + "response-success-2" + ], + "src/pages/atomicdex/api/v20-dev/withdraw_tasks/index.mdx": [ + "withdraw-tasks", + "task-withdraw-init", + "arguments", + "response", + "examples", + "command", + "command-max-true", + "command-custom-utxo-fixed-fee", + "command-custom-utxo-per-kbyte-fee", + "command-hw-hd-wallet-derivation-path-option", + "command-hw-hd-wallet-account-id-chain-and-address-id-option", + "response-2", + "task-withdraw-status", + "arguments-2", + "response-3", + "examples-2", + "command-2", + "response-generating-transaction", + "response-generating-transaction-complete", + "response-generating-kmd-transaction-complete-with-rewards-info", + "response-no-such-task-task-expired", + "response-error-waiting-for-user-to-confirm-signing-on-hardware-wallet-device", + "task-withdraw-cancel", + "arguments-3", + "response-4", + "examples-3", + "command-3", + "response-success", + "response-error-no-such-task-task-expired", + "response-error-task-already-finished" + ], + "src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx": [ + "zhtlc-coin-methods", + "task-enable-z-coin-init", + "arguments", + "response", + "examples", + "command", + "response-2", + "task-enable-z-coin-status", + "arguments-2", + "response-3", + "examples-2", + "command-2", + "response-activating-coin-enabling-has-started", + "response-updating-blocks-cache", + "response-building-wallet-db", + "response-enabling-complete", + "response-no-zcash-params", + "response-error-no-such-task", + "task-enable-z-coin-cancel", + "arguments-3", + "response-4", + "examples-3", + "command-3", + "response-success", + "response-success-already-finished", + "response-error-no-such-task-2", + "z-coin-tx-history", + "arguments-4", + "response-5", + "examples-4", + "command-4", + "response-success-2", + "response-error-coin-not-supported", + "response-error-coin-not-active" + ], + "src/pages/atomicdex/changelog/index.mdx": [ + "change-log", + "list-of-changes" + ], + "src/pages/atomicdex/index.mdx": [ + "introduction-to-atomic-dex", + "about-the-atomic-dex-section", + "conceptual-overview", + "about-atomic-dex-setup", + "about-atomic-dex-tutorials", + "about-atomic-dex-api" + ], + "src/pages/atomicdex/mobile/add-and-activate-coins-on-atomicdex-mobile/index.mdx": [ + "how-to-add-and-activate-coins-on-atomic-dex-mobile" + ], + "src/pages/atomicdex/mobile/delete-seed-from-atomicdex-mobile/index.mdx": [ + "how-to-delete-seed-wallet-from-atomic-dex-mobile" + ], + "src/pages/atomicdex/mobile/index.mdx": [ + "how-to-create-a-new-wallet-using-atomic-dex-mobile" + ], + "src/pages/atomicdex/mobile/perform-cross-chain-atomic-swaps-using-atomicdex-mobile/index.mdx": [ + "how-to-perform-cross-chain-atomic-swaps-using-atomic-dex-mobile", + "prerequisites", + "instructions" + ], + "src/pages/atomicdex/mobile/recover-seed-on-atomicdex-mobile/index.mdx": [ + "how-to-recover-seed-on-atomic-dex-mobile" + ], + "src/pages/atomicdex/mobile/restore-wallet-using-atomicdex-mobile/index.mdx": [ + "how-to-restore-wallet-using-atomic-dex-mobile" + ], + "src/pages/atomicdex/mobile/view-ongoing-orders-and-swap-history-on-atomicdex-mobile/index.mdx": [ + "how-to-view-ongoing-orders-and-swap-history-on-atomic-dex-mobile", + "view-ongoing-swaps-and-orders", + "view-your-swap-history" + ], + "src/pages/atomicdex/mobile/view-your-receiving-address-to-send-funds-for-trading/index.mdx": [ + "how-to-view-your-receiving-address-to-send-funds-for-trading" + ], + "src/pages/atomicdex/mobile/withdraw-or-send-funds-using-atomicdex-mobile/index.mdx": [ + "how-to-withdraw-or-send-funds-using-atomic-dex-mobile" + ], + "src/pages/atomicdex/setup/configure-mm2-json/index.mdx": [ + "atomic-dex-api-configuration", + "mm-2-json", + "configuration-parameters", + "example-allowing-weak-password", + "example-not-allowing-weak-password", + "example-for-hd-wallets", + "coins-file-configuration", + "optional-environment-variables", + "what-now" + ], + "src/pages/atomicdex/setup/index.mdx": [ + "installing-the-atomic-dex-api", + "minimum-requirements-for-installation", + "note-about-linux", + "note-about-installing-on-windows", + "note-about-32-bit-operating-systems", + "installing-dependencies", + "rust", + "cmake-version-3-12-or-higher", + "build-tools-for-your-os", + "linux", + "windows-follow-these-instructions-for-msvc", + "mac-os-install-x-code-via-the-app-store", + "install-additional-dependencies", + "install-additional-rust-components", + "install-jq", + "linux-2", + "mac-os", + "windows", + "build-atomic-dex-api", + "mac-os-2" + ], + "src/pages/atomicdex/tutorials/additional-information-about-atomicdex/index.mdx": [ + "additional-notes", + "a-back-end-for-front-end-implementations", + "new-features-of-atomic-dex-api-desktop", + "new-off-chain-technology", + "rust-implementation", + "multi-threading-and-other-multi-tasking-improvements", + "atomic-dex-api-for-mobile-new", + "add-your-coin-to-the-atomic-dex-api", + "features-carried-from-mm-1", + "spv-based-trading", + "liquidity-multiplication" + ], + "src/pages/atomicdex/tutorials/atomicdex-metrics/index.mdx": [ + "atomic-dex-metrics", + "setting-up-log-recording", + "requesting-metrics-manually", + "prometheus-integration", + "configuring-prometheus-to-monitor-the-atomic-dex-api", + "starting-prometheus-and-grafana", + "using-the-graphing-interface", + "prometheus", + "grafana" + ], + "src/pages/atomicdex/tutorials/atomicdex-walkthrough/index.mdx": [ + "atomic-dex-api-walkthrough", + "setting-up-the-coin-list", + "launching-the-atomic-dex-api", + "mm-2-json-minimal-configuration", + "setting-userpass-environment-variable", + "connect-to-the-selected-coin-networks", + "get-marty-from-the-faucet", + "the-atomic-dex-orderbook", + "initiate-a-swap" + ], + "src/pages/atomicdex/tutorials/coins-file-update/index.mdx": [ + "how-to-update-the-coins-file-to-work-with-the-latest-atomic-dex-api", + "instructions", + "examples", + "utxo-coin", + "old-format", + "new-format", + "erc-20-token", + "old-format-2", + "new-format-2" + ], + "src/pages/atomicdex/tutorials/how-to-become-a-liquidity-provider/index.mdx": [ + "how-to-become-a-liquidity-provider-on-atomic-dex", + "requirements", + "virtual-private-server-recommended", + "home-based-connection", + "get-the-atomic-dex-api-and-coins-configuration-file", + "step-1-get-the-atomic-dex-api-binary", + "downloading-from-the-official-repository-option-1", + "building-from-source-option-2", + "step-2-download-the-coins-configuration-file", + "command", + "running-the-atomic-dex-api", + "step-1-download-and-edit-scripts-to-provide-liquidity-for-the-kmd-ltc-pair", + "create-a-secure-seed-phrase", + "edit-the-start-sh-file", + "create-an-rpc-control-user-password", + "place-the-user-password-into-the-start-sh-file", + "example", + "edit-the-userpass-file", + "step-2-start-the-atomic-dex-api", + "command-2", + "step-3-connect-to-the-coin-networks-kmd-and-ltc", + "connect-to-the-kmd-network", + "command-3", + "response", + "connect-to-the-ltc-network", + "command-4", + "response-2", + "connecting-to-a-network-other-than-kmd-or-ltc", + "trading", + "step-0-query-the-current-orderbooks", + "command-5", + "command-6", + "step-1-fund-the-address", + "response-3", + "step-2-place-an-order", + "command-7", + "response-4", + "step-3-check-the-status-of-an-order", + "command-8", + "response-5", + "step-4-withdrawal-of-coins", + "command-9", + "response-6", + "command-10", + "response-7", + "miscellaneous", + "stop", + "command-11", + "response-8", + "view-all-the-orders-placed-by-our-node", + "command-12", + "response-9", + "cancel-an-order", + "command-13", + "response-10" + ], + "src/pages/atomicdex/tutorials/how-to-compile-mm2-from-source/index.mdx": [ + "how-to-compile-atomic-dex-api-from-source", + "installing-dependencies", + "step-1-os-packages", + "command", + "step-2-install-rust", + "command-2", + "step-3-install-rust-components", + "command-3", + "command-4", + "command-optional-skip-this-step-if-it-fails", + "install-the-atomic-dex-api", + "step-1-download-source-code", + "step-2-compile-source-code", + "command-5" + ], + "src/pages/atomicdex/tutorials/index.mdx": [ + "introduction-to-atomic-dex", + "why-is-atomic-dex-special", + "understanding-the-most-common-method-of-cryptocurrency-exchange", + "trading-between-blockchains-is-a-challenge", + "the-centralized-exchange-as-a-method", + "problems-with-centralized-exchanges", + "pros-and-cons-of-the-centralized-exchange", + "a-decentralized-exchange-can-bring-greater-safety", + "types-of-decentralized-exchanges", + "the-decentralized-gateway", + "atomic-swaps-are-a-significantly-superior-basis-for-exchange", + "technical-comparisons", + "komodos-leadership-in-atomic-swap-technology", + "capabilities-of-komodo-software", + "atomic-dex-software-is-an-industry-wide-invitation" + ], + "src/pages/atomicdex/tutorials/listing-a-coin-on-atomicdex/index.mdx": [ + "prerequisites-for-a-coin-to-be-compatible-with-atomic-dex-api", + "1-coins-json-config-required", + "1a-general-parameters-for-all-coins", + "1b-utxo-coins-btc-ltc-kmd-zec-dash-doge-dgb", + "utxo-coin-example", + "antara-smartchain-example", + "1c-evm-like-tokens-eth-erc-20-matic-plg-20-bnb-bep-20", + "erc-20-token-example", + "bep-20-token-example", + "1d-qrc-20-tokens", + "2-icon-file-required", + "3-explorer-url-required-excluding-tokens", + "4-electrum-servers-optional-required-for-listing-in-mobile-guis", + "5-ethereum-info-file-required-for-evm-like-platforms", + "5-forex-nomics-coin-gecko-and-coin-paprika-price-ids-optional", + "6-derivation-path", + "7-trezor-coin-name-optional", + "8-successful-swap-confirmation" + ], + "src/pages/atomicdex/tutorials/query-the-mm2-database/index.mdx": [ + "how-to-query-the-mm-2-sq-lite-database", + "my-swaps", + "query", + "response", + "stats-swaps", + "query-2", + "response-2", + "my-orders", + "query-3", + "response-3", + "nodes", + "query-4", + "respose", + "stats-nodes", + "query-5", + "response-4" + ], + "src/pages/atomicdex/tutorials/setup-atomicdex-aws/index.mdx": [ + "how-to-setup-and-use-the-atomic-dex-api-on-an-aws-ec-2-instance", + "create-the-atomic-dex-setup-script", + "install-aws-cli-get-aws-access-credentials", + "installation", + "create-an-ec-2-instance" + ], + "src/pages/historical/cc-jl/chapter00/index.mdx": [ + "chapter-00-bitcoin-protocol-basics" + ], + "src/pages/historical/cc-jl/chapter01/index.mdx": [ + "chapter-01-op-checkcryptocondition" + ], + "src/pages/historical/cc-jl/chapter02/index.mdx": [ + "chapter-02-cc-contract-basics" + ], + "src/pages/historical/cc-jl/chapter03/index.mdx": [ + "chapter-03-cc-vins-and-vouts" + ], + "src/pages/historical/cc-jl/chapter04/index.mdx": [ + "chapter-04-cc-rpc-extensions" + ], + "src/pages/historical/cc-jl/chapter05/index.mdx": [ + "chapter-05-cc-validation" + ], + "src/pages/historical/cc-jl/chapter06/index.mdx": [ + "chapter-06-faucet-example" + ], + "src/pages/historical/cc-jl/chapter07/index.mdx": [ + "chapter-07-rewards-example", + "createfunding", + "addfunding", + "lock", + "unlock" + ], + "src/pages/historical/cc-jl/chapter08/index.mdx": [ + "chapter-08-assets-example", + "create", + "transfer", + "buyoffer", + "cancelbuy", + "fillbuy", + "selloffer", + "cancel", + "fillsell" + ], + "src/pages/historical/cc-jl/chapter09/index.mdx": [ + "chapter-09-dice-example", + "createfunding", + "addfunding-entropy", + "bet", + "loser", + "winner", + "timeout" + ], + "src/pages/historical/cc-jl/chapter10/index.mdx": [ + "chapter-10-channels-example", + "the-following-are-the-rpc-calls", + "channelsopen", + "channelspayment", + "channelsclose", + "channelsrefund", + "channelsinfo", + "vin-vout-allocation", + "open", + "payment", + "close", + "refund" + ], + "src/pages/historical/cc-jl/chapter11/index.mdx": [ + "chapter-11-oracles-example", + "the-following-are-the-rpc-calls", + "vin-vout-allocation", + "create", + "register", + "subscribe", + "data" + ], + "src/pages/historical/cc-jl/chapter12/index.mdx": [ + "chapter-12-limitless-possibilities" + ], + "src/pages/historical/cc-jl/chapter13/index.mdx": [ + "chapter-13-different-languages" + ], + "src/pages/historical/cc-jl/chapter14/index.mdx": [ + "chapter-14-runtime-bindings" + ], + "src/pages/historical/cc-jl/chapter15/index.mdx": [ + "chapter-15-rpc-based-d-apps" + ], + "src/pages/historical/cc-jl/faq/index.mdx": [ + "frequently-asked-questions" + ], + "src/pages/historical/cc-jl/index.mdx": [ + "how-to-write-utxo-based-cc-modules-for-kmd-based-chains-by-jl777", + "introduction" + ], + "src/pages/historical/index.mdx": [ + "historical-documentation" + ], + "src/pages/historical/whitepaper/chapter1/index.mdx": [ + "a-foundational-discussion-of-blockchain-security", + "what-is-a-consensus-mechanism", + "the-double-spend-problem", + "the-consensus-mechanism-provides-security-against-a-double-spend", + "a-miner-competes-to-add-blocks-to-the-network-s-history-in-exchange-for-a-reward", + "step-one-preparing-the-preliminary-information", + "the-mempool-is-the-collection-of-all-raw-transactions-waiting-to-be-processed", + "creating-transaction-hashes", + "the-cascade-effect-changing-one-bit-of-data-changes-the-entire-result", + "step-one-continued-finishing-the-preliminary-calculations", + "step-two-the-race-to-finish-first", + "step-three-bob-finds-the-nonce" + ], + "src/pages/historical/whitepaper/chapter2/index.mdx": [ + "pow-is-currently-the-most-secure-form-of-consensus-mechanisms", + "speed-and-power-are-of-the-essence", + "the-network-effect-bitcoin-s-ability-to-dominate-begins", + "the-longest-chain-rule-the-secret-sauce-of-pow-domination", + "the-simple-effects-of-the-longest-chain-rule", + "a-tale-of-two-blockchains", + "an-internal-conflict-of-interest-arises-within-the-bitcoin-network", + "the-longest-chain-rule-the-history-which-is-longer-first-wins", + "the-easy-way-to-destroy-a-po-w-network-the-51-attack", + "size-is-yet-another-reason-behind-bitcoin-s-current-success-among-po-w-networks", + "the-hard-way-to-destroy-a-po-w-network-the-genesis-attack", + "a-genesis-attack-on-the-bitcoin-network", + "the-more-realistic-dangers-of-the-genesis-attack", + "the-financial-and-eco-unfriendly-problems-with-all-po-w-networks", + "po-w-networks-are-expensive", + "miners-are-free-to-mine-other-networks", + "the-primary-alternative-consensus-mechanism-proof-of-stake", + "the-security-risks-and-shortcomings-of-po-s", + "a-summary-of-the-po-w-consensus-mechanism" + ], + "src/pages/historical/whitepaper/chapter3/index.mdx": [ + "the-komodo-solution", + "abstract-of-the-delayed-proof-of-work-consensus-mechanism-d-pow", + "a-note-about-komodo-s-iguana-core-technology", + "a-brief-discussion-on-the-security-provided-by-the-notary-nodes", + "the-notarization-process", + "step-one-gathering-the-appropriate-data", + "block-607240", + "kmd", + "step-two-notarizing-the-data-to-a-secure-location", + "step-three-notarizing-the-po-w-network-information-back-to-the-kmd-main-chain", + "understanding-security-and-economic-incentives-in-the-komodo-d-po-w-network", + "easy-difficulty-in-d-po-w-the-key-to-notary-nodes-financial-incentives", + "the-d-po-w-system-has-sixty-four-elected-notary-nodes", + "each-notary-node-gets-one-chance-per-every-sixty-five-blocks-to-mine-on-easy", + "the-free-for-all-period", + "komodo-s-protective-measures-in-action", + "notarizations-provide-a-defense-against-both-the-51-attack-and-the-genesis-attack", + "considering-an-attack-on-the-notarization-process", + "the-d-pow-consensus-mechanism-is-inherent-in-all-komodo-asset-chains" + ], + "src/pages/historical/whitepaper/chapter4/index.mdx": [ + "abstract-of-the-decentralized-initial-coin-offering", + "the-challenges-in-current-ico-platforms", + "specific-weaknesses-in-the-centralized-ico-model", + "third-party-discrimination", + "centralization-of-technology-whale-manipulation-theft-and-human-error", + "lack-of-privacy", + "third-party-discrimination-via-the-centralized-ico", + "centralization-of-ico-technology-whales-hackers-and-human-error", + "the-manipulative-behavior-of-whales", + "hackers-and-human-error", + "the-right-to-barter-in-private", + "the-blockchain-industry-needs-a-solution-and-komodo-presents-an-answer" + ], + "src/pages/historical/whitepaper/chapter5/index.mdx": [ + "the-komodo-solution", + "the-decentralized-initial-coin-offering", + "the-process-of-creating-a-new-blockchain-in-the-komodo-ecosystem", + "the-first-command-to-create-a-new-coin", + "the-features-of-the-new-asset-chain", + "generating-and-mining-the-new-coins", + "the-entire-coin-supply-is-distributed-in-the-genesis-block", + "notarizing-to-the-komodo-main-chain", + "the-distribution-of-coins", + "the-trials-and-travails-of-the-centralized-ico-method", + "enter-the-d-ico", + "powered-by-komodo-s-barter-dex-and-jumblr-technology", + "the-many-solutions-of-the-d-ico-model-security-privacy-decentralization-and-freedom" + ], + "src/pages/historical/whitepaper/chapter6/index.mdx": [ + "abstract-barter-dex", + "introduction", + "the-beginnings-and-travails-of-decentralized-exchanges", + "barter-dex-a-complete-solution", + "recent-improvements-in-barter-dex", + "barterdex-technology", + "order-matching", + "order-matching-with-full-relay-and-non-relay-nodes", + "jumblr-technology-adds-privacy", + "iguana-core-provides-the-foundation-for-our-smart-address-feature", + "the-utxo-an-elusive-yet-fundamental-concept", + "comparing-the-utxo-to-fiat-money", + "understanding-cryptocurrencies-and-their-utxos", + "a-satoshi-is-the-smallest-divisible-unit-of-a-cryptocurrency", + "a-utxo-is-a-packet-of-satoshis-just-as-a-fiat-dollar-bill-is-a-packet-of-pennies", + "trading-on-barterdex", + "how-barter-dex-deals-with-order-offers-and-utxos", + "detailed-explanations-of-the-barterdex-process", + "atomic-swaps-on-the-komodo-barter-dex", + "introducing-alice-and-bob", + "alice-and-bob-make-a-deal", + "incentives-and-disincentives-to-maintain-good-behavior", + "1-alice-sends-dexfee", + "2-bob-successfully-sends-bobdeposit", + "3-alice-successfully-sends-alicepayment", + "4-bob-sends-bobpayment", + "5-alice-spends-bobpayment", + "6-bob-spends-alicepayment", + "7-bob-reclaims-bobdeposit", + "additional-barter-dex-atomic-swap-details", + "a-more-detailed-explanation-of-the-atomic-swap-connection-process", + "the-dex-fee-dexfee", + "dealing-with-confirmations", + "zero-confirmations", + "speed-mode-an-experimental-feature-using-time-locked-deposits", + "realtime-metrics", + "orderbook-propagation", + "the-barter-dex-api", + "a-brief-discussion-on-the-future-of-barter-dex" + ], + "src/pages/historical/whitepaper/chapter7/index.mdx": [ + "abstract-jumblr", + "introduction", + "the-option-of-privacy-is-essential-to-the-komodo-ecosystem", + "challenges-for-privacy-centric-systems-and-the-komodo-solution", + "the-komodo-solution", + "an-introduction-to-jumblr", + "a-brief-explanation-of-the-two-foundational-technologies", + "komodo-coin-kmd", + "kmd-began-as-a-fork-of-zcash", + "barter-dex", + "iguana-core", + "komodod", + "the-jumblr-process", + "anonymizing-native-komodo-coin-kmd", + "user-actions", + "jumblr-deposit-km-daddress", + "jumblr-secret-secret-km-daddress", + "additional-security-layers", + "jumblr-s-process-of-breaking-down-funds", + "jumblr-s-process-of-moving-the-individual-lots-into-a-private-address", + "option-1-jumblr-performs-the-next-action", + "option-2-does-nothing", + "additional-privacy-considerations", + "the-timing-attack", + "the-knapsack-attack", + "further-security-enhancements-to-combat-the-timing-and-knapsack-attacks", + "more-defense-against-the-knapsack-attack-multiple-secret-addresses", + "further-enhancements-against-the-timing-attack", + "offering-privacy-to-other-cryptocurrencies", + "the-current-jumblr-process-manual-non-kmd-to-kmd-trading-on-barter-dex", + "future-capabilities-jumblr-automates-the-barter-dex-trading-process-for-the-user", + "a-word-on-risks-inherent-in-jumblr-and-the-komodo-ecosystem", + "jumblr-provides-the-komodo-ecosystem-with-privacy" + ], + "src/pages/historical/whitepaper/chapter8/index.mdx": [ + "final-notes-regarding-the-komodo-project", + "fiat-pegged-cryptocurrencies", + "smart-contracts-on-the-komodo-platform", + "bitcoin-protocol-based-smart-contracts", + "crypto-conditions-merkle-root-of-merkle-root-mo-m-and-customized-asset-chains", + "rewards", + "conclusion" + ], + "src/pages/historical/whitepaper/index.mdx": [ + "komodo-advanced-blockchain-technology-focused-on-freedom", + "intoduction-to-komodo" + ], + "src/pages/historical/whitepaper/references/index.mdx": [ + "acknowledgements-and-references" + ], + "src/pages/index.mdx": [ + "komodo-api-documentation", + "create-smart-chains", + "explore-antara-modules", + "browse-komodo-api" + ], + "src/pages/smart-chains/api/address/index.mdx": [ + "address-index", + "getaddressbalance", + "arguments", + "response", + "examples", + "getaddressdeltas", + "arguments-2", + "response-2", + "examples-2", + "getaddressmempool", + "arguments-3", + "response-3", + "examples-3", + "getaddresstxids", + "arguments-4", + "response-4", + "examples-4", + "getaddressutxos", + "arguments-5", + "response-5", + "examples-5", + "getsnapshot", + "arguments-6", + "response-6", + "examples-6" + ], + "src/pages/smart-chains/api/blockchain/index.mdx": [ + "blockchain", + "coinsupply", + "arguments", + "response", + "examples", + "getbestblockhash", + "arguments-2", + "response-2", + "examples-2", + "getblock", + "arguments-3", + "response-verbose-true", + "response-3", + "examples-3", + "getblockchaininfo", + "arguments-4", + "response-4", + "examples-4", + "getblockcount", + "arguments-5", + "response-5", + "examples-5", + "getblockhash", + "arguments-6", + "response-6", + "examples-6", + "getblockhashes", + "arguments-7", + "response-7", + "examples-7", + "getblockheader", + "arguments-8", + "response-verbose-true-2", + "response-verbose-false", + "examples-8", + "getchaintips", + "arguments-9", + "response-8", + "possible-values-for-the-returned-status-property", + "examples-9", + "getchaintxstats", + "arguments-10", + "response-9", + "examples-10", + "getdifficulty", + "arguments-11", + "response-10", + "examples-11", + "getlastsegidstakes", + "arguments-12", + "response-11", + "examples-12", + "getmempoolinfo", + "arguments-13", + "response-12", + "examples-13", + "getrawmempool", + "arguments-14", + "response-verbose-false-2", + "response-verbose-true-3", + "examples-14", + "getspentinfo", + "arguments-15", + "response-13", + "examples-15", + "gettxout", + "arguments-16", + "response-14", + "examples-16", + "gettxoutproof", + "arguments-17", + "response-15", + "examples-17", + "gettxoutsetinfo", + "arguments-18", + "response-16", + "examples-18", + "kvsearch", + "arguments-19", + "response-17", + "examples-19", + "kvupdate", + "arguments-20", + "response-18", + "examples-20", + "minerids", + "arguments-21", + "response-19", + "examples-21", + "notaries", + "arguments-22", + "response-20", + "examples-22", + "verifychain", + "arguments-23", + "response-21", + "examples-23", + "verifytxoutproof", + "arguments-24", + "response-22", + "examples-24" + ], + "src/pages/smart-chains/api/cclib/index.mdx": [ + "cc-lib", + "cclib", + "cclib-formatting", + "array-formatting-for-terminal", + "array-formatting-for-bash-scripts", + "arguments", + "response", + "examples", + "cclibaddress", + "arguments-2", + "response-2", + "examples-2", + "cclibinfo", + "arguments-3", + "response-3", + "examples-3" + ], + "src/pages/smart-chains/api/control/index.mdx": [ + "control", + "getnotarysendmany", + "getiguanajson", + "getinfo", + "arguments", + "response", + "examples", + "help", + "arguments-2", + "response-2", + "examples-2", + "stop", + "arguments-3", + "response-3", + "examples-3" + ], + "src/pages/smart-chains/api/crosschain/index.mdx": [ + "cross-chain-api", + "introduction", + "different-methods-of-migration-using-the-komodo-platform", + "crosschain-api-flow", + "requirement", + "mo-mo-m-notarized-migration", + "workflow-of-the-mo-mo-m-value-migration", + "migrate-createburntransaction", + "arguments", + "response", + "examples", + "migrate-converttoexport", + "arguments-2", + "response-2", + "examples-2", + "migrate-createimporttransaction", + "arguments-3", + "response-3", + "examples-3", + "migrate-completeimporttransaction", + "arguments-4", + "response-4", + "examples-4", + "notarization-backup-solution", + "alternative-transfer-method-flow", + "migrate-checkburntransactionsource", + "arguments-5", + "response-5", + "examples-5", + "migrate-createnotaryapprovaltransaction", + "arguments-6", + "response-6", + "examples-6", + "self-import-api", + "selfimport", + "requirements", + "self-import-flow", + "arguments-7", + "response-7", + "examples-7", + "node1", + "node2", + "node1-2", + "notary-api", + "calc-mo-m", + "arguments-8", + "response-8", + "examples-8", + "mo-mo-mdata", + "arguments-9", + "response-9", + "examples-9", + "assetchainproof", + "arguments-10", + "response-10", + "examples-10", + "get-notarisations-for-block", + "arguments-11", + "response-11", + "examples-11", + "scan-notarisations-db", + "arguments-12", + "response-12", + "examples-12", + "user-api", + "getimports", + "arguments-13", + "response-13", + "examples-13", + "getwalletburntransactions", + "arguments-14", + "response-14", + "examples-14" + ], + "src/pages/smart-chains/api/disclosure/index.mdx": [ + "disclosure", + "z-getpaymentdisclosure", + "arguments", + "response", + "examples", + "z-validatepaymentdisclosure", + "arguments-2", + "response-2", + "examples-2" + ], + "src/pages/smart-chains/api/generate/index.mdx": [ + "generating", + "generate", + "arguments", + "response", + "examples", + "getgenerate", + "arguments-2", + "response-2", + "examples-2", + "setgenerate", + "arguments-3", + "response-3", + "examples-3", + "activate-mining-with-maximum-available-processors", + "activate-staking", + "activate-mining-with-4-threads", + "check-the-setting", + "turn-off-generation", + "turning-the-setting-on-via-json-rpc", + "arguments-4", + "response-4", + "examples-4" + ], + "src/pages/smart-chains/api/index.mdx": [ + "smart-chain-api" + ], + "src/pages/smart-chains/api/jumblr/index.mdx": [ + "jumblr", + "basic-instructions", + "examples", + "jumblr-deposit", + "arguments", + "response", + "examples-2", + "jumblr-pause", + "arguments-2", + "response-2", + "examples-3", + "jumblr-resume", + "arguments-3", + "response-3", + "examples-4", + "jumblr-secret", + "arguments-4", + "response-4", + "examples-5" + ], + "src/pages/smart-chains/api/mining/index.mdx": [ + "mining", + "getblocksubsidy", + "arguments", + "response", + "examples", + "getblocktemplate", + "a-note-on-unique-mining-circumstances", + "arguments-2", + "response-2", + "examples-2", + "getlocalsolps", + "arguments-3", + "response-3", + "examples-3", + "getmininginfo", + "arguments-4", + "response-4", + "examples-4", + "getnetworkhashps", + "arguments-5", + "response-5", + "examples-5", + "getnetworksolps", + "arguments-6", + "response-6", + "examples-6", + "prioritisetransaction", + "arguments-7", + "response-7", + "examples-7", + "submitblock", + "arguments-8", + "response-8", + "examples-8" + ], + "src/pages/smart-chains/api/network/index.mdx": [ + "network", + "addnode", + "arguments", + "response", + "examples", + "clearbanned", + "arguments-2", + "response-2", + "examples-2", + "disconnectnode", + "arguments-3", + "response-3", + "examples-3", + "getaddednodeinfo", + "arguments-4", + "response-4", + "examples-4", + "getconnectioncount", + "arguments-5", + "response-5", + "examples-5", + "getdeprecationinfo", + "arguments-6", + "response-6", + "examples-6", + "getnettotals", + "arguments-7", + "response-7", + "examples-7", + "getnetworkinfo", + "arguments-8", + "response-8", + "examples-8", + "getpeerinfo", + "arguments-9", + "response-9", + "examples-9", + "listbanned", + "arguments-10", + "response-10", + "examples-10", + "ping", + "arguments-11", + "response-11", + "examples-11", + "setban", + "arguments-12", + "response-12", + "examples-12" + ], + "src/pages/smart-chains/api/rawtransactions/index.mdx": [ + "rawtransactions", + "createrawtransaction", + "arguments", + "response", + "examples", + "decoderawtransaction", + "arguments-2", + "response-2", + "examples-2", + "decodescript", + "arguments-3", + "response-3", + "examples-3", + "fundrawtransaction", + "arguments-4", + "response-4", + "examples-4", + "getrawtransaction", + "arguments-5", + "response-if-verbose-is-not-set-or-set-to-0", + "response-if-verbose-0", + "examples-5", + "sendrawtransaction", + "arguments-6", + "response-5", + "examples-6", + "signrawtransaction", + "arguments-7", + "response-6", + "examples-7" + ], + "src/pages/smart-chains/api/util/index.mdx": [ + "util", + "createmultisig", + "arguments", + "response", + "examples", + "decodeccopret", + "finding-the-op-return-data-from-a-cc-transaction", + "arguments-2", + "response-2", + "examples-2", + "estimatefee", + "arguments-3", + "response-3", + "examples-3", + "estimatepriority", + "arguments-4", + "response-4", + "examples-4", + "invalidateblock", + "arguments-5", + "response-5", + "examples-5", + "reconsiderblock", + "arguments-6", + "response-6", + "examples-6", + "txnotarizedconfirmed", + "arguments-7", + "response-7", + "examples-7", + "validateaddress", + "arguments-8", + "response-8", + "examples-8", + "verifymessage", + "arguments-9", + "response-9", + "examples-9", + "z-validateaddress", + "arguments-10", + "response-10", + "examples-10" + ], + "src/pages/smart-chains/api/wallet/index.mdx": [ + "wallet", + "addmultisigaddress", + "arguments", + "response", + "examples", + "backupwallet", + "arguments-2", + "response-2", + "examples-2", + "dumpprivkey", + "arguments-3", + "response-3", + "examples-3", + "dumpwallet", + "arguments-4", + "response-4", + "examples-4", + "encryptwallet", + "arguments-5", + "response-5", + "examples-5", + "encrypt-your-wallet", + "unlock-the-wallet-for-60-seconds", + "lock-the-wallet-again-by-removing-the-passphrase", + "getaccount", + "arguments-6", + "response-6", + "examples-6", + "getaccountaddress", + "arguments-7", + "response-7", + "examples-7", + "getaddressesbyaccount", + "arguments-8", + "response-8", + "examples-8", + "getbalance", + "arguments-9", + "response-9", + "examples-9", + "getbalance64", + "getnewaddress", + "arguments-10", + "response-10", + "examples-10", + "getrawchangeaddress", + "arguments-11", + "response-11", + "examples-11", + "getreceivedbyaccount", + "arguments-12", + "response-12", + "examples-12", + "getreceivedbyaddress", + "arguments-13", + "response-13", + "examples-13", + "gettransaction", + "arguments-14", + "response-14", + "examples-14", + "getunconfirmedbalance", + "arguments-15", + "response-15", + "examples-15", + "getwalletinfo", + "arguments-16", + "response-16", + "examples-16", + "importaddress", + "arguments-17", + "response-17", + "examples-17", + "importprivkey", + "arguments-18", + "response-18", + "examples-18", + "importwallet", + "arguments-19", + "response-19", + "examples-19", + "keypoolrefill", + "arguments-20", + "response-20", + "examples-20", + "listaccounts", + "arguments-21", + "response-21", + "examples-21", + "listaddressgroupings", + "arguments-22", + "response-22", + "examples-22", + "listlockunspent", + "arguments-23", + "response-23", + "examples-23", + "listreceivedbyaccount", + "arguments-24", + "response-24", + "examples-24", + "listreceivedbyaddress", + "arguments-25", + "response-25", + "examples-25", + "listsinceblock", + "arguments-26", + "response-26", + "examples-26", + "listtransactions", + "arguments-27", + "response-27", + "examples-27", + "listunspent", + "arguments-28", + "response-28", + "examples-28", + "lockunspent", + "arguments-29", + "response-29", + "examples-29", + "move", + "arguments-30", + "response-30", + "examples-30", + "opreturn-burn", + "arguments-31", + "response-31", + "examples-31", + "command", + "response-32", + "command-2", + "response-33", + "resendwallettransactions", + "arguments-32", + "response-34", + "examples-32", + "sendfrom", + "arguments-33", + "response-35", + "examples-33", + "sendmany", + "arguments-34", + "response-36", + "examples-34", + "sendtoaddress", + "arguments-35", + "response-37", + "examples-35", + "setaccount", + "arguments-36", + "examples-36", + "setpubkey", + "arguments-37", + "response-38", + "examples-37", + "settxfee", + "arguments-38", + "response-39", + "examples-38", + "signmessage", + "arguments-39", + "response-40", + "examples-39", + "walletlock", + "arguments-40", + "response-41", + "examples-40", + "walletpassphrase", + "arguments-41", + "response-42", + "examples-41", + "walletpassphrasechange", + "arguments-42", + "response-43", + "examples-42", + "z-exportkey", + "arguments-43", + "response-44", + "examples-43", + "z-exportviewingkey", + "arguments-44", + "response-45", + "examples-44", + "z-exportwallet", + "arguments-45", + "response-46", + "examples-45", + "z-getbalance", + "arguments-46", + "response-47", + "examples-46", + "z-getnewaddress", + "arguments-47", + "response-48", + "examples-47", + "z-getoperationresult", + "arguments-48", + "response-49", + "examples-48", + "z-getoperationstatus", + "arguments-49", + "response-50", + "examples-49", + "z-gettotalbalance", + "arguments-50", + "response-51", + "examples-50", + "z-importkey", + "arguments-51", + "response-52", + "examples-51", + "z-importviewingkey", + "arguments-52", + "response-53", + "examples-52", + "z-importwallet", + "arguments-53", + "response-54", + "examples-53", + "z-listaddresses", + "arguments-54", + "response-55", + "examples-54", + "z-listoperationids", + "arguments-55", + "response-56", + "examples-55", + "z-listreceivedbyaddress", + "arguments-56", + "result", + "examples-56", + "z-listunspent", + "arguments-57", + "results", + "examples-57", + "z-mergetoaddress", + "the-fromaddresses-array", + "arguments-58", + "response-57", + "examples-58", + "z-sendmany", + "arguments-59", + "response-58", + "examples-59", + "z-shieldcoinbase", + "arguments-60", + "response-59", + "examples-60", + "zcbenchmark", + "arguments-61", + "response-60", + "zcrawjoinsplit", + "zcrawkeygen", + "zcrawreceive-zcsecretkey-encryptednote", + "zcsamplejoinsplit" + ], + "src/pages/smart-chains/changelog/index.mdx": [ + "change-log", + "list-of-changes" + ], + "src/pages/smart-chains/index.mdx": [ + "introduction-to-smart-chain-documentation", + "about-the-smart-chain-section", + "conceptual-overview", + "about-smart-chain-setup", + "about-smart-chain-tutorials", + "about-smart-chain-api" + ], + "src/pages/smart-chains/setup/common-runtime-parameters/index.mdx": [ + "common-runtime-parameters", + "introduction", + "addnode", + "examples", + "addressindex", + "examples-2", + "bantime", + "examples-3", + "bind", + "examples-4", + "connect", + "examples-5", + "conf", + "examples-6", + "datadir", + "examples-7", + "donation", + "examples-8", + "exchange", + "examples-9", + "exportdir", + "examples-10", + "gen", + "examples-11", + "genproclimit", + "examples-12", + "keypool", + "examples-13", + "listen", + "examples-14", + "maxconnections", + "examples-15", + "mempooltxinputlimit", + "port", + "examples-16", + "proxy", + "examples-17", + "pubkey", + "examples-18", + "regtest", + "examples-19", + "reindex", + "examples-20", + "rewind", + "examples-21", + "rpcallowip", + "examples-22", + "rpcbind", + "examples-23", + "rpcclienttimeout", + "examples-24", + "rpcconnect", + "examples-25", + "rpcport", + "examples-26", + "sendfreetransactions", + "examples-27", + "server", + "examples-28", + "spentindex", + "examples-29", + "stopat", + "examples-30", + "examples-31", + "testnode", + "examples-32", + "timestampindex", + "examples-33", + "txindex", + "whitebind", + "examples-34" + ], + "src/pages/smart-chains/setup/ecosystem-launch-parameters/index.mdx": [ + "ecosystem-launch-parameters" + ], + "src/pages/smart-chains/setup/index.mdx": [ + "smart-chain-setup" + ], + "src/pages/smart-chains/setup/installing-from-source/index.mdx": [ + "installing-smart-chain-software-from-source-code", + "komodod", + "komodo-cli", + "both-are-installed-automatically", + "the-two-methods-to-install-smart-chain-software", + "pre-compiled-binaries", + "building-smart-chain-software-from-source", + "linux", + "requirements", + "get-started", + "install-the-dependency-packages", + "clone-the-komodo-repository", + "fetch-the-zcash-parameters", + "build-the-komodo-daemon", + "create-the-komodo-conf-file", + "optional-tail-the-komodod-daemon", + "test-your-daemon-with-komodo-cli", + "backup-your-wallet", + "mac-os", + "requirements-2", + "ensure-command-line-tools-are-installed", + "ensure-brew-is-installed", + "use-brew-to-install-dependencies", + "clone-the-komodo-repository-2", + "fetch-the-zcash-parameters-2", + "compile-komodo", + "create-configuration-file", + "run-komodo", + "track-the-syncing-progress", + "using-the-tail-command", + "using-komodo-cli-and-getinfo", + "backup-your-wallet-2", + "windows", + "install-dependencies", + "install-rust", + "configure-the-compiler-to-use-posix-thread-model", + "clone-the-komodo-repository-3", + "fetch-the-zcash-parameters-3", + "build-the-komodo-daemon-2", + "create-the-komodo-directory", + "create-the-configuration-file", + "create-the-directory-for-the-zcash-parameters", + "run-smart-chain-software", + "verify-syncing-progress", + "backup-your-wallet-3" + ], + "src/pages/smart-chains/setup/interacting-with-smart-chains/index.mdx": [ + "interacting-with-komodo-chains", + "using-komodo-cli", + "using-curl", + "location-of-conf-file" + ], + "src/pages/smart-chains/setup/nspv/index.mdx": [ + "n-spv", + "introduction", + "installation", + "enabling-the-n-spv-client", + "property-descriptions", + "tips-and-suggestions-for-working-with-the-magic-number", + "example", + "interacting-with-the-n-spv-client", + "curl-commands-using-named-parameters", + "curl-command-using-the-json2-0-interface", + "accessing-localhost-in-the-browser", + "example-2", + "p", + "example-3", + "broadcast", + "arguments", + "response", + "examples", + "command", + "getinfo", + "arguments-2", + "response-2", + "examples-2", + "command-2", + "getnewaddress", + "arguments-3", + "response-3", + "examples-3", + "command-without-arguments", + "command-to-get-the-seed-words-in-italian", + "getpeerinfo", + "arguments-4", + "response-4", + "examples-4", + "command-3", + "hdrsproof", + "arguments-5", + "response-5", + "examples-5", + "command-4", + "help", + "arguments-6", + "response-6", + "examples-6", + "command-5", + "listtransactions", + "arguments-7", + "response-7", + "examples-7", + "command-6", + "listunspent", + "arguments-8", + "response-8", + "examples-8", + "command-7", + "login", + "arguments-9", + "response-9", + "examples-9", + "command-8", + "logout", + "arguments-10", + "response-10", + "examples-10", + "command-9", + "mempool", + "arguments-11", + "response-11", + "examples-11", + "command-10", + "notarizations", + "arguments-12", + "response-12", + "examples-12", + "command-11", + "spend", + "arguments-13", + "response-13", + "examples-13", + "command-12", + "spentinfo", + "arguments-14", + "response-14", + "examples-14", + "command-13", + "stop", + "arguments-15", + "response-15", + "examples-15", + "command-14", + "txproof", + "arguments-16", + "response-16", + "examples-16", + "command-15" + ], + "src/pages/smart-chains/setup/smart-chain-maintenance/index.mdx": [ + "smart-chain-maintenance", + "manually-deleting-blockchain-data", + "files-to-delete", + "default-location-for-files" + ], + "src/pages/smart-chains/setup/updating-from-source/index.mdx": [ + "updating-smart-chain-software-from-source", + "linux", + "navigate-to-your-komodo-directory", + "reset-your-local-repository", + "clean-the-source-directory", + "update-your-local-source-code", + "compile-the-latest-komodo-binary", + "restart-the-komodod-daemon", + "rapid-update-method", + "mac-os", + "navigate-to-your-komodo-directory-2", + "reset-your-local-repository-2", + "clean-the-source-directory-2", + "update-your-local-source-code-2", + "compile-the-latest-komodo-binary-2", + "restart-the-komodod-daemon-2", + "rapid-update-method-2", + "windows", + "build-the-new-executables", + "move-executables-to-windows-os" + ], + "src/pages/smart-chains/tutorials/basic-environment-setup-for-linux-vps/index.mdx": [ + "basic-environment-setup-for-linux-vps", + "introduction", + "rent-a-vps", + "recommended-minimum-server-specifications", + "connect-to-your-vps", + "initial-vps-setup" + ], + "src/pages/smart-chains/tutorials/create-a-default-smart-chain/index.mdx": [ + "creating-komodo-smart-chains", + "introduction", + "requirements-for-creating-a-new-chain", + "basic-info-for-connecting-at-least-two-nodes", + "part-i-creating-a-new-komodo-smart-chain", + "mac-and-gnu-linux", + "windows", + "verify-the-response", + "part-ii-connecting-the-second-node", + "node1", + "node2", + "node1-2", + "querying-the-smart-chain", + "example-commands", + "secure-this-smart-chain-with-delayed-proof-of-work", + "a-note-about-low-activity-blockchains" + ], + "src/pages/smart-chains/tutorials/creating-a-smart-chain-on-a-single-node/index.mdx": [ + "creating-a-smart-chain-on-a-single-node", + "introduction", + "tutorial-prerequisites", + "launch-the-first-daemon", + "command", + "response-truncated", + "test-komodo-cli", + "create-a-data-directory-for-the-second-daemon", + "the-helloworld-conf-file", + "launch-the-second-daemon", + "using-curl", + "source-the-first-daemons-conf-file", + "source-the-second-daemons-conf-file" + ], + "src/pages/smart-chains/tutorials/index.mdx": [ + "antara-tutorials" + ], + "src/pages/smart-chains/tutorials/introduction-to-smart-chain-tutorials/index.mdx": [ + "introduction-to-smart-chain-tutorials" + ], + "src/pages/smart-chains/tutorials/multisignature-transaction-creation-and-walkthrough/index.mdx": [ + "multisignature-transaction-creation-and-walkthrough", + "introduction", + "get-a-new-address-public-key-and-private-key", + "node-one", + "generate-a-new-address", + "command", + "response", + "get-the-public-key-using-validateaddress", + "command-2", + "response-2", + "get-the-private-key", + "command-3", + "response-3", + "a-summarization-of-data-from-node-one", + "node-two", + "generate-a-new-address-2", + "command-4", + "response-4", + "get-the-pubkey-value-using-validateaddress", + "command-5", + "response-5", + "get-the-private-key-2", + "command-6", + "response-6", + "summarization-of-data-from-node-two", + "create-a-multisig-address", + "command-7", + "response-7", + "fund-the-multisig-address", + "command-8", + "response-8", + "create-the-raw-transaction", + "command-9", + "response-9", + "sign-the-raw-transaction", + "sign-using-node-one", + "command-10", + "response-10", + "sign-using-node-two", + "command-11", + "response-11", + "broadcast-the-transaction", + "command-12", + "response-12", + "useful-links" + ], + "src/pages/smart-chains/tutorials/running-komodo-software-in-debug-mode/index.mdx": [ + "running-komodo-software-in-debug-mode", + "introduction", + "install-gdb", + "run-komodo-daemon-with-gdb-tool", + "retrieving-backtrace-data", + "command" + ], + "src/pages/smart-chains/tutorials/smart-chain-api-basics/index.mdx": [ + "smart-chain-api-basics", + "api-tutorials-introduction", + "tutorial-topics-outline", + "tutorial-prerequisites", + "komodod-and-komodo-cli", + "komodo-api-fundamentals-tutorial", + "create-a-regtest-blockchain", + "ac-supply", + "ac-name", + "observe-the-response", + "smart-chain-supply", + "configuration-file-location", + "relevant-rpc-data", + "explanation-of-all-initial-daemon-output", + "querying-the-blockchain-using-komodo-cli", + "access-a-daemon-via-komodo-cli-on-a-smart-chain", + "using-the-getinfo-api-method", + "command", + "response", + "querying-the-blockchain-using-curl", + "sourcing-the-configuration-file", + "executing-the-curl-command", + "preparing-your-local-wallet", + "preparing-your-wallet-using-komodo-cli", + "getnewaddress", + "validateaddress", + "dumpprivkey", + "preparing-your-wallet-using-curl", + "getnewaddress-2", + "command-2", + "response-2", + "validateaddress-2", + "command-3", + "response-3", + "dumpprivkey-2", + "command-4", + "response-4", + "generating-blocks-and-getting-the-new-coins", + "understanding-the-coinbase-transaction", + "generating-blocks-using-komodo-cli", + "generate", + "command-5", + "response-5", + "getblock", + "command-6", + "response-6", + "gettransaction", + "command-7", + "response-7", + "generating-blocks-using-curl", + "generate-2", + "getblock-2", + "gettransaction-2", + "inspecting-the-wallet", + "listing-unspent-transactions-using-komodo-cli", + "listunspent", + "listing-unspent-transactions-using-curl", + "setting-the-pubkey-parameter", + "stopping-the-daemon-using-komodo-cli", + "command-8", + "response-8", + "stopping-the-daemon-using-curl", + "command-9", + "response-9", + "restarting-the-smart-chain-with-the-pubkey-parameter", + "command-10", + "closing" + ], + "src/pages/start-here/about-komodo-platform/index.mdx": [ + "komodo-platform-overview", + "security", + "scalability", + "interoperability", + "adaptability", + "together-the-komodo-platform-is-unlike-anything-else", + "komodos-white-label-software-brings-your-innovation-to-market-faster", + "installing-using-and-testing-komodo-software-is-free" + ], + "src/pages/start-here/about-komodo-platform/orientation/index.mdx": [ + "documentation-orientation", + "intended-audience-of-this-technical-documentation-website", + "assumptions-for-this-documentation", + "familiarity-with-the-concept-of-blockchain-technology", + "simple-programming-skills", + "a-note-regarding-komodo-language-compatibility", + "a-normal-developer-in-the-komodo-ecosystem", + "an-advanced-antara-developer", + "the-cost-of-a-smart-chain", + "installation-and-testing-is-free", + "production-smart-chains-typically-require-komodos-security-services", + "the-cost-of-using-atomic-dex-software", + "differences-between-kmd-and-a-smart-chain", + "licensing-information" + ], + "src/pages/start-here/about-komodo-platform/product-introductions/index.mdx": [ + "product-introductions", + "smart-chains-and-antara", + "smart-chains-rely-on-the-next-step-in-blockchain-evolution-the-antara-framework", + "comparing-a-smart-chain-to-a-smart-contract-platform", + "smart-chains-and-antara-create-a-convenient-development-workflow", + "the-architecture-of-antara-powered-smart-chains", + "antara-api", + "antara-modules", + "antara-smart-chains", + "komodo-platform", + "advantages-of-the-antara-framework", + "programmable-daemon", + "modular-design", + "autonomous-and-sovereign", + "turing-complete", + "no-gas-fees", + "antara-module-library", + "create-your-own-modules", + "atomic-dex", + "enjoy-all-the-benefits-of-the-old-system-and-of-the-new", + "skip-the-centralized-middleman-and-trade-directly-with-your-trading-partner", + "keep-your-private-keys-private-at-all-times", + "join-the-crowd-or-start-a-new-one", + "no-off-chain-settlements-required", + "integrate-your-smart-chain-asset-with-our-software" + ], + "src/pages/start-here/about-komodo-platform/simple-installations/index.mdx": [ + "simple-installations", + "smart-chain-installation", + "link-to-download-software", + "installing-the-simple-downloadable-files", + "using-the-official-docker-image", + "see-the-smart-chains-documentation-for-further-details", + "atomic-dex-installation", + "installing-atomic-dex-software", + "using-the-official-docker-image-2", + "additional-atomic-dex-documentation" + ], + "src/pages/start-here/core-technology-discussions/antara/index.mdx": [ + "the-antara-framework", + "introduction", + "the-three-layers-of-the-antara-framework", + "generating-customizable-smart-chains", + "core-level-antara-modules", + "antara-application-programmable-interface", + "antara-smart-chains", + "antara-modules", + "antara-integration-layer", + "antara-smart-chains-2", + "antara-modules-2", + "antara-integration-layer-2" + ], + "src/pages/start-here/core-technology-discussions/atomicdex/index.mdx": [ + "atomic-dex-and-atomic-swaps", + "introduction", + "current-problems-in-cryptocurrency-exchange", + "centralized-exchanges-are-popular-but-limited", + "the-concept-and-shortcomings-of-a-normal-decentralized-exchange", + "atomic-dex-a-complete-solution", + "the-decentralized-orderbook", + "order-matching-with-full-relay-and-non-relay-nodes", + "one-passphrase-many-addresses", + "atomic-swaps", + "the-value-of-the-atomic-swap", + "atomic-dex-manages-a-public-trading-profile-for-maker-and-taker", + "introducing-taker-and-maker", + "taker-makes-a-request", + "maker-answers-taker", + "taker-and-maker-are-committed", + "incentives-and-disincentives-to-maintain-good-behavior", + "1-taker-sends-dexfee", + "2-maker-successfully-sends-makerpayment", + "3-taker-successfully-sends-takerpayment", + "4-maker-spends-takerpayment", + "5-taker-spends-makerpayment", + "additional-details", + "always-manage-risk-appropriately", + "the-connection-is-the-true-challenge-of-an-atomic-swap", + "the-dex-fee", + "dealing-with-confirmations", + "atomic-dex-is-entirely-experimental-and-should-be-treated-as-such", + "the-atomic-dex-api" + ], + "src/pages/start-here/core-technology-discussions/delayed-proof-of-work/index.mdx": [ + "delayed-proof-of-work", + "a-foundational-discussion-of-blockchain-security", + "what-is-a-consensus-mechanism", + "the-double-spend-problem", + "the-consensus-mechanism-provides-security-against-a-double-spend", + "a-miner-competes-to-add-blocks-to-the-network-s-history-in-exchange-for-a-reward", + "step-one-preparing-the-preliminary-information", + "the-mempool-is-the-collection-of-all-raw-transactions-waiting-to-be-processed", + "creating-transaction-hashes", + "the-cascade-effect-changing-one-bit-of-data-changes-the-entire-result", + "step-one-continued-finishing-the-preliminary-calculations", + "step-two-the-race-to-finish-first", + "step-three-bob-finds-the-nonce", + "the-dominance-of-the-proof-of-work-consensus-mechanism", + "proof-of-work-po-w-fosters-ever-increasing-security", + "speed-and-power-are-of-the-essence", + "the-network-effect-bitcoin-s-ability-to-dominate-begins", + "the-longest-chain-rule-the-true-secret-sauce-of-po-w-domination", + "the-simple-effects-of-the-longest-chain-rule", + "a-tale-of-two-blockchains", + "an-internal-conflict-of-interest-arises-within-the-bitcoin-network", + "the-longest-chain-rule-the-history-which-is-longer-first-wins", + "the-51-attack", + "size-is-yet-another-reason-behind-bitcoin-s-current-success-among-po-w-networks", + "the-genesis-attack", + "a-genesis-attack-on-the-bitcoin-network", + "the-more-realistic-dangers-of-the-genesis-attack", + "the-financial-and-eco-unfriendly-problems-with-all-po-w-networks", + "po-w-networks-are-expensive", + "miners-are-free-to-mine-other-networks", + "the-primary-alternative-proof-of-stake", + "the-security-risks-and-shortcomings-of-po-s", + "a-summary-of-the-po-w-consensus-mechanism", + "the-komodo-solution-delayed-proof-of-work-d-pow", + "a-note-about-komodo-s-iguana-core-technology", + "an-overview-of-notary-nodes", + "notary-nodes-are-elected-it-professionals", + "notary-nodes-hash-and-notarize-the-komodo-ecosystem-history", + "notary-node-power-is-restricted-to-history-transfer-and-nothing-more", + "users-need-only-wait-until-they-are-satisfied-with-a-transactions-number-of-notarizations-and-other-security-features", + "the-notarization-process", + "step-one-gathering-the-appropriate-data", + "block-hash", + "block-height", + "name-of-komodo-smart-chain", + "creating-a-notarization", + "step-two-notarizing-the-data-to-a-secure-location", + "step-three-notarizing-the-po-w-network-information-back-to-the-kmd-main-chain", + "extending-notarization-to-komodo-smart-chains", + "notarization-extends-to-each-participating-smart-chain", + "notarization-flow", + "only-the-most-recent-notarization-matters", + "understanding-security-and-economic-incentives", + "easy-difficulty-in-d-po-w-the-key-to-notary-nodes-financial-incentives", + "notary-nodes-are-special-miners-on-the-kmd-blockchain", + "each-notary-node-gets-one-chance-per-every-sixty-five-blocks-to-mine-on-easy", + "komodo-s-protective-measures-in-action", + "notarizations-provide-a-defense-against-both-the-51-attack-and-the-genesis-attack", + "defense-against-the-genesis-attack", + "defense-against-the-51-attack", + "before-notarization", + "notarization-to-the-kmd-main-chain", + "notarization-to-ltc", + "considering-an-attack-on-the-notarization-process", + "the-d-pow-consensus-mechanism-is-inherent-in-all-komodo-smart-chains" + ], + "src/pages/start-here/core-technology-discussions/index.mdx": [ + "introduction", + "note-on-changes-since-whitepaper-creation-cr-2019" + ], + "src/pages/start-here/core-technology-discussions/initial-dex-offering/index.mdx": [ + "initial-dex-offering-ido", + "abstract", + "the-challenges-in-current-ico-platforms", + "specific-weaknesses-in-the-centralized-ico-model", + "third-party-discrimination", + "centralization-of-technology-theft-and-human-error", + "lack-of-privacy", + "third-party-discrimination-via-the-centralized-ico", + "centralization-of-ico-technology-hackers-and-human-error", + "hackers-and-human-error", + "the-right-to-barter-in-private", + "the-blockchain-industry-needs-a-solution", + "the-initial-dex-offering", + "the-process-of-creating-a-new-blockchain-in-the-komodo-ecosystem", + "the-first-command-to-create-a-new-coin", + "the-features-of-the-new-smart-chain", + "generating-and-mining-the-new-coins", + "the-entire-coin-supply-is-distributed-in-the-genesis-block", + "notarizing-to-the-komodo-main-chain", + "the-distribution-of-coins", + "observations-on-the-centralized-ico-method", + "enter-the-ido", + "powered-by-komodo-s-atomic-dex-and-privacy-technology", + "the-many-solutions-of-the-ido-model-security-privacy-decentralization-and-freedom", + "ways-an-ido-can-be-conducted", + "the-straightforward-method", + "a-slightly-more-involved-method", + "easy-method-be-featured-on-atomic-dex" + ], + "src/pages/start-here/core-technology-discussions/miscellaneous/index.mdx": [ + "miscellaneous", + "details-regarding-kmd-main-chain", + "rewards", + "the-nature-of-privacy-features-in-the-komodo-ecosystem", + "the-option-of-privacy-is-essential", + "privacy-issues-in-popular-privacy-centric-blockchains", + "komodos-approach-to-privacy-technologies", + "private-and-non-private-addresses", + "transparent-addresses", + "private-addresses", + "method-of-moving-funds-privately", + "transparent-to-private", + "private-to-private", + "private-to-transparent", + "additional-privacy-considerations", + "the-timing-attack", + "the-knapsack-attack", + "a-word-on-risks-inherent-in-zk-snark-technology", + "the-utxo-an-elusive-yet-fundamental-concept", + "comparing-the-utxo-to-fiat-money", + "understanding-cryptocurrencies-and-their-utxos", + "a-satoshi-is-the-smallest-divisible-unit-of-a-cryptocurrency", + "a-utxo-is-a-packet-of-satoshis-just-as-a-fiat-dollar-bill-is-a-packet-of-pennies", + "conclusion" + ], + "src/pages/start-here/core-technology-discussions/references/index.mdx": [ + "acknowledgements-and-references" + ], + "src/pages/start-here/index.mdx": [ + "start-here" + ], + "src/pages/start-here/learning-launchpad/common-terminology-and-concepts/index.mdx": [ + "common-terminology-and-concepts", + "51-attack", + "process-of-conducting-a-51-attack", + "komodos-d-po-w-security-service-is-designed-to-prevent-51-attacks", + "antara-address", + "antara-customization", + "antara-framework", + "antara-module", + "asset", + "atomic-swap", + "block", + "block-explorer", + "block-reward", + "burn", + "cc-address", + "cc-transaction", + "centralized-exchange-cex", + "cluster", + "coinbase", + "confirmation", + "consensus-mechanism", + "cross-chain-syncing", + "crypto-condition-cc", + "daemon", + "decentralization", + "decentralized-exchange-dex", + "initial-dex-offering-ido", + "delayed-proof-of-work-d-po-w", + "dependency", + "double-spend", + "equihash-algorithm", + "gas", + "genesis-attack", + "genesis-block", + "hash-rate", + "iguana-core", + "jumblr", + "liquidity-maker", + "liquidity-pool", + "liquidity-taker", + "magic", + "mempool", + "miner", + "multi-chain-syncing", + "multi-chain-architecture", + "node", + "nonce", + "notarization", + "notary-node", + "on-demand-notarization", + "orderbook", + "passphrase", + "proof-of-stake-po-s", + "proof-of-work", + "public-key-pubkey", + "remote-procedure-call-rpc", + "runtime-fork", + "satoshi", + "spv-electrum-server", + "seed-node", + "smart-chain", + "smart-contract", + "staker", + "t-address", + "t-transaction", + "terminal", + "token", + "trade-clearing", + "trade-matching", + "trustless", + "turing-complete", + "tx", + "txid", + "utxo", + "virtual-machine-interpreter", + "z-address", + "z-transaction", + "zcash-parameters", + "zk-snark" + ], + "src/pages/start-here/learning-launchpad/index.mdx": [ + "learning-path-outline", + "introduction", + "a-description-of-our-intended-audience", + "the-normal-komodo-developer", + "the-advanced-komodo-developer", + "how-each-type-of-developer-should-approach-the-educational-outlines", + "step-0-install-komodo-software", + "step-1-reach-out-to-our-community-on-discord", + "step-2-begin-a-conceptual-understanding-of-komodos-software", + "platform-overview", + "product-introductions", + "doc-orientation", + "step-3-read-the-core-technology-discussions-section", + "introduction-2", + "delayed-proof-of-work", + "initial-dex-offering-ido", + "the-antara-framework", + "atomic-dex-and-atomic-swaps", + "miscellaneous", + "step-4-complete-the-beginner-series-in-the-antara-tutorials-section", + "step-5-familiarize-yourself-with-smart-chain-api-basics", + "step-6-enhance-your-development-environment-and-experience", + "basic-environment-setup-for-linux-vps", + "creating-komodo-smart-chains", + "creating-a-smart-chain-on-a-single-node", + "running-komodo-software-in-debug-mode", + "updating-smart-chain-software-from-source-code", + "ecosystem-launch-parameters", + "learn-how-to-manually-delete-blockchain-data", + "common-runtime-parameters", + "step-7-experiment-with-antara-customizations", + "step-8-read-the-overview-of-antara-modules-part-i", + "step-9-read-the-overview-of-antara-modules-part-ii", + "step-10-understand-antara-addresses", + "step-11-experiment-with-the-default-heir-antara-module", + "step-12-experiment-with-the-tokens-antara-module", + "step-13-read-the-introduction-to-atomic-dex", + "step-14-experiment-with-atomic-swaps", + "step-15-begin-the-advanced-development-tutorial", + "step-16-inspect-komodo-community-bounties" + ] +} \ No newline at end of file diff --git a/utils/js/file_presence_structure_checker.js b/utils/js/file_presence_structure_checker.js index 6277b726..38d9b457 100644 --- a/utils/js/file_presence_structure_checker.js +++ b/utils/js/file_presence_structure_checker.js @@ -149,4 +149,4 @@ if (errorString !== "") { throw new Error(errorString); } else { console.log("file presence checker generated no errors.") -} +} \ No newline at end of file diff --git a/utils/js/package.json b/utils/js/package.json index 081c655b..cff348ff 100644 --- a/utils/js/package.json +++ b/utils/js/package.json @@ -11,6 +11,8 @@ "license": "ISC", "type": "module", "devDependencies": { + "@sindresorhus/slugify": "^2.2.1", + "acorn": "^8.10.0", "remark": "^14.0.3", "remark-gfm": "^3.0.1", "remark-mdx": "^2.3.0", diff --git a/utils/js/validate_update_internal_links_userpass.js b/utils/js/validate_update_internal_links_userpass.js index 940dc722..c261989b 100644 --- a/utils/js/validate_update_internal_links_userpass.js +++ b/utils/js/validate_update_internal_links_userpass.js @@ -15,9 +15,9 @@ import * as acorn from "acorn" (async function () { try { let filepaths = [] - // const filepathSlugs = {} + // const filepathSlugs = {} walkDir("./src/pages", filepath => filepaths.push(filepath)); -/* + for (let index = 0; index < filepaths.length; index++) { const filePath = filepaths[index]; await remark().use(mdxAnnotations.remark).use(remarkMdx).use(() => (tree) => { @@ -33,8 +33,8 @@ import * as acorn from "acorn" // console.log(slugs); }).process(fs.readFileSync(filePath, 'utf-8')); } - */ - // fs.writeFileSync("filepathSlugs.json", JSON.stringify(filepathSlugs, null, 2)) + + fs.writeFileSync("filepathSlugs.json", JSON.stringify(filepathSlugs, null, 2)) let filepathSlugs = JSON.parse(fs.readFileSync("filepathSlugs.json")) for (let index = 0; index < filepaths.length; index++) { const filePath = filepaths[index]; From 09497bac9cc34a897cc1c3a063b26ee9bfc986a9 Mon Sep 17 00:00:00 2001 From: gaeacodes Date: Fri, 22 Sep 2023 15:57:50 +0530 Subject: [PATCH 13/15] slugs WIP --- utils/js/package-lock.json | 127 ++++- utils/js/package.json | 1 + ...validate_update_internal_links_userpass.js | 456 ++++++++++-------- 3 files changed, 364 insertions(+), 220 deletions(-) diff --git a/utils/js/package-lock.json b/utils/js/package-lock.json index 8736c558..b094cff5 100644 --- a/utils/js/package-lock.json +++ b/utils/js/package-lock.json @@ -9,6 +9,9 @@ "version": "1.0.0", "license": "ISC", "devDependencies": { + "@sindresorhus/slugify": "^2.2.1", + "acorn": "^8.10.0", + "mdx-annotations": "^0.1.3", "remark": "^14.0.3", "remark-gfm": "^3.0.1", "remark-mdx": "^2.3.0", @@ -16,6 +19,37 @@ "unist-util-visit": "^5.0.0" } }, + "node_modules/@sindresorhus/slugify": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/@sindresorhus/slugify/-/slugify-2.2.1.tgz", + "integrity": "sha512-MkngSCRZ8JdSOCHRaYd+D01XhvU3Hjy6MGl06zhOk614hp9EOAp5gIkBeQg7wtmxpitU6eAL4kdiRMcJa2dlrw==", + "dev": true, + "dependencies": { + "@sindresorhus/transliterate": "^1.0.0", + "escape-string-regexp": "^5.0.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@sindresorhus/transliterate": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/transliterate/-/transliterate-1.6.0.tgz", + "integrity": "sha512-doH1gimEu3A46VX6aVxpHTeHrytJAG6HgdxntYnCFiIFHEM/ZGpG8KiZGBChchjQmG0XFIBL552kBTjVcMZXwQ==", + "dev": true, + "dependencies": { + "escape-string-regexp": "^5.0.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/@types/acorn": { "version": "4.0.6", "resolved": "https://registry.npmjs.org/@types/acorn/-/acorn-4.0.6.tgz", @@ -242,6 +276,26 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/estree-util-visit": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/estree-util-visit/-/estree-util-visit-1.2.1.tgz", + "integrity": "sha512-xbgqcrkIVbIG+lI/gzbvd9SGTJL4zqJKBFttUl5pP27KhAjtMKbX/mQXJ7qgyXpMgVy/zvpm0xoQQaGL8OloOw==", + "dev": true, + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/unist": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-visit/node_modules/@types/unist": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.8.tgz", + "integrity": "sha512-d0XxK3YTObnWVp6rZuev3c49+j4Lo8g4L1ZRm9z5L0xpoZycUPshHgczK5gsUMaZOstjVYYi09p5gYvUtfChYw==", + "dev": true + }, "node_modules/extend": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", @@ -724,6 +778,65 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/mdx-annotations": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/mdx-annotations/-/mdx-annotations-0.1.3.tgz", + "integrity": "sha512-2XrOlQeBDUa8GirNHy/Y7BR1h/P+vzk+1G2rzAfqJ+lg6JcEOKMCqsVkpVFSw0hdzpVuj9BnoNeA+aU1XPTkoA==", + "dev": true, + "dependencies": { + "acorn": "^8.8.1", + "estree-util-visit": "^1.2.0", + "unist-util-visit": "^4.1.1" + } + }, + "node_modules/mdx-annotations/node_modules/@types/unist": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.8.tgz", + "integrity": "sha512-d0XxK3YTObnWVp6rZuev3c49+j4Lo8g4L1ZRm9z5L0xpoZycUPshHgczK5gsUMaZOstjVYYi09p5gYvUtfChYw==", + "dev": true + }, + "node_modules/mdx-annotations/node_modules/unist-util-is": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-5.2.1.tgz", + "integrity": "sha512-u9njyyfEh43npf1M+yGKDGVPbY/JWEemg5nH05ncKPfi+kBbKBJoTdsogMu33uhytuLlv9y0O7GH7fEdwLdLQw==", + "dev": true, + "dependencies": { + "@types/unist": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdx-annotations/node_modules/unist-util-visit": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-4.1.2.tgz", + "integrity": "sha512-MSd8OUGISqHdVvfY9TPhyK2VdUrPgxkUtWSuMHF6XAAFuL4LokseigBnZtPnJMu+FbynTkFNnFlyjxpVKujMRg==", + "dev": true, + "dependencies": { + "@types/unist": "^2.0.0", + "unist-util-is": "^5.0.0", + "unist-util-visit-parents": "^5.1.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdx-annotations/node_modules/unist-util-visit-parents": { + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-5.1.3.tgz", + "integrity": "sha512-x6+y8g7wWMyQhL1iZfhIPhDAs7Xwbn9nRosDXl7qoPTSCy0yNxnKc+hWokFifWQIDGi154rdUqKvbCa4+1kLhg==", + "dev": true, + "dependencies": { + "@types/unist": "^2.0.0", + "unist-util-is": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/micromark": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/micromark/-/micromark-3.2.0.tgz", @@ -1318,20 +1431,6 @@ "integrity": "sha512-d0XxK3YTObnWVp6rZuev3c49+j4Lo8g4L1ZRm9z5L0xpoZycUPshHgczK5gsUMaZOstjVYYi09p5gYvUtfChYw==", "dev": true }, - "node_modules/micromark-util-events-to-acorn/node_modules/estree-util-visit": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/estree-util-visit/-/estree-util-visit-1.2.1.tgz", - "integrity": "sha512-xbgqcrkIVbIG+lI/gzbvd9SGTJL4zqJKBFttUl5pP27KhAjtMKbX/mQXJ7qgyXpMgVy/zvpm0xoQQaGL8OloOw==", - "dev": true, - "dependencies": { - "@types/estree-jsx": "^1.0.0", - "@types/unist": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, "node_modules/micromark-util-html-tag-name": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-1.2.0.tgz", diff --git a/utils/js/package.json b/utils/js/package.json index cff348ff..ba8f7fe0 100644 --- a/utils/js/package.json +++ b/utils/js/package.json @@ -13,6 +13,7 @@ "devDependencies": { "@sindresorhus/slugify": "^2.2.1", "acorn": "^8.10.0", + "mdx-annotations": "^0.1.3", "remark": "^14.0.3", "remark-gfm": "^3.0.1", "remark-mdx": "^2.3.0", diff --git a/utils/js/validate_update_internal_links_userpass.js b/utils/js/validate_update_internal_links_userpass.js index c261989b..cab9ac69 100644 --- a/utils/js/validate_update_internal_links_userpass.js +++ b/utils/js/validate_update_internal_links_userpass.js @@ -1,184 +1,228 @@ -import { visit, SKIP } from 'unist-util-visit' -import { is } from "unist-util-is"; -import fs from 'fs'; -import { constants } from "fs" -import { remark } from 'remark' -import remarkMdx from 'remark-mdx' -import remarkGfm from 'remark-gfm' -import { mdxAnnotations } from 'mdx-annotations' -import path from 'path' -import { toString } from "mdast-util-to-string"; +import * as acorn from "acorn"; + +import { SKIP, visit } from "unist-util-visit"; +import { constants } from "fs"; +import fs from "fs"; +import { is } from "unist-util-is"; +import { mdxAnnotations } from "mdx-annotations"; +import path from "path"; +import { remark } from "remark"; +import remarkGfm from "remark-gfm"; +import remarkMdx from "remark-mdx"; import { slugifyWithCounter } from "@sindresorhus/slugify"; -import * as acorn from "acorn" +import { toString } from "mdast-util-to-string"; (async function () { - try { - let filepaths = [] - // const filepathSlugs = {} - walkDir("./src/pages", filepath => filepaths.push(filepath)); - - for (let index = 0; index < filepaths.length; index++) { - const filePath = filepaths[index]; - await remark().use(mdxAnnotations.remark).use(remarkMdx).use(() => (tree) => { - const slugs = []; - - let slugify = slugifyWithCounter(); - // Visit all heading nodes and collect their values - visit(tree, 'heading', (node) => { - const slug = slugify(toString(node)); - slugs.push(slug); - }); - filepathSlugs[filePath] = slugs - // console.log(slugs); - }).process(fs.readFileSync(filePath, 'utf-8')); - } + try { + let filepaths = []; + walkDir("./src/pages", (filepath) => filepaths.push(filepath)); + /* + const filepathSlugs = {}; - fs.writeFileSync("filepathSlugs.json", JSON.stringify(filepathSlugs, null, 2)) - let filepathSlugs = JSON.parse(fs.readFileSync("filepathSlugs.json")) - for (let index = 0; index < filepaths.length; index++) { - const filePath = filepaths[index]; - await processFile(filePath, filepathSlugs) - } - } catch (error) { - if (error) throw error; - } -})() - -async function processFile(filePath, filepathSlugs) { - if (!filePath.endsWith("/index.mdx")) { - throw new Error("File path doesn't end with '/index.mdx': " + filePath) - } - // if (!filePath.includes("/non_fungible_token")) { - // return - // } - console.log("Processing: " + filePath) - const file = await remark() - .use(remarkGfm) + for (let index = 0; index < filepaths.length; index++) { + const filePath = filepaths[index]; + await remark() + .use(mdxAnnotations.remark) .use(remarkMdx) .use(() => (tree) => { - //console.log("Processing: " + filePath) - const hasTitleAndDesc = tree.children.some(node => node.type === 'mdxjsEsm' && isValidTitleDescExports(node.value)) - if (!hasTitleAndDesc) { - throw new Error("File doesn't have title/description: " + filePath) - } - }) - .use(() => (tree) => { - visit(tree, 'link', (node) => { - //Process the link - node.url = processLink(node.url, filePath, filepathSlugs); - }); - }) - .use(() => (tree) => { - visit(tree, (node, nodeIndex, parentNode) => { - if (!filePath.includes("src/pages/atomicdex")) { - return SKIP; - } - // if ( - // is(node, { name: "CodeGroup" })) { - // console.log(node) - // } - try { - if ( - is(node, { name: "CodeGroup" }) && - node.attributes.some(attr => attr.type === 'mdxJsxAttribute' && attr.name === "mm2MethodDecorate" && attr.value === "true") - ) { - // console.log(node) - const originalChild = node.children[0]; - if (node.children.length !== 1 || originalChild.lang !== "json") { - throw new Error(`unexpected code block in file ${filePath} : ` + JSON.stringify()) - } - const clonedChild = JSON.parse(JSON.stringify(originalChild)); - let methodObj = JSON.parse(clonedChild.value) - methodObj.userpass = "testpsw" - clonedChild.value = JSON.stringify(methodObj, null, 2) - //console.log(clonedChild) - node.children = [clonedChild]; - return SKIP; - } - } catch (error) { - throw new Error(error) - } - - }); + const slugs = []; + + let slugify = slugifyWithCounter(); + // Visit all heading nodes and collect their values + visit(tree, "heading", (node) => { + const slug = slugify(toString(node)); + slugs.push(slug); + }); + filepathSlugs[filePath] = slugs; + // console.log(slugs); }) - .process(fs.readFileSync(filePath, 'utf-8')); - if (file) { - fs.writeFileSync(filePath, String(file)); + .process(fs.readFileSync(filePath, "utf-8")); + }*/ + /* + fs.writeFileSync( + "filepathSlugs.json", + JSON.stringify(filepathSlugs, null, 2) + );*/ + let filepathSlugs = JSON.parse(fs.readFileSync("filepathSlugs.json")); + for (let index = 0; index < filepaths.length; index++) { + const filePath = filepaths[index]; + await processFile(filePath, filepathSlugs); } + } catch (error) { + if (error) throw error; + } +})(); + +async function processFile(filePath, filepathSlugs) { + if (!filePath.endsWith("/index.mdx")) { + throw new Error("File path doesn't end with '/index.mdx': " + filePath); + } + // if (!filePath.includes("/non_fungible_token")) { + // return + // } + console.log("Processing: " + filePath); + const file = await remark() + .use(remarkGfm) + .use(remarkMdx) + .use(() => (tree) => { + //console.log("Processing: " + filePath) + const hasTitleAndDesc = tree.children.some( + (node) => + node.type === "mdxjsEsm" && isValidTitleDescExports(node.value) + ); + if (!hasTitleAndDesc) { + throw new Error("File doesn't have title/description: " + filePath); + } + }) + .use(() => (tree) => { + visit(tree, "link", (node) => { + //Process the link + node.url = processLink(node.url, filePath, filepathSlugs); + }); + }) + .use(() => (tree) => { + visit(tree, (node, nodeIndex, parentNode) => { + if (!filePath.includes("src/pages/atomicdex")) { + return SKIP; + } + // if ( + // is(node, { name: "CodeGroup" })) { + // console.log(node) + // } + try { + if ( + is(node, { name: "CodeGroup" }) && + node.attributes.some( + (attr) => + attr.type === "mdxJsxAttribute" && + attr.name === "mm2MethodDecorate" && + attr.value === "true" + ) + ) { + // console.log(node) + const originalChild = node.children[0]; + if (node.children.length !== 1 || originalChild.lang !== "json") { + throw new Error( + `unexpected code block in file ${filePath} : ` + + JSON.stringify() + ); + } + const clonedChild = JSON.parse(JSON.stringify(originalChild)); + let methodObj = JSON.parse(clonedChild.value); + methodObj.userpass = "testpsw"; + clonedChild.value = JSON.stringify(methodObj, null, 2); + //console.log(clonedChild) + node.children = [clonedChild]; + return SKIP; + } + } catch (error) { + throw new Error(error); + } + }); + }) + .process(fs.readFileSync(filePath, "utf-8")); + if (file) { + fs.writeFileSync(filePath, String(file)); + } } // Function to process a link function processLink(link, currFilePath, filepathSlugs) { - if (link.startsWith("mailto:")) { - return link + if (link.startsWith("mailto:")) { + return link; + } + const isExternalURL = /^https?:\/\//; + if (isExternalURL.test(link)) return link; + let filePath = "src/pages"; + let strippedPath = link.split("#")[0]; // strips hash + if (strippedPath.endsWith("/")) { + strippedPath = strippedPath.slice(0, -1); + } + const hash = link.split("#")[1]; + let correctUrl; + let currNormalisedDir; + const currentWorkingDirectory = process.cwd(); + currNormalisedDir = currFilePath.replace("/index.mdx", "").split("/"); + currNormalisedDir.pop(); + currNormalisedDir = currNormalisedDir.join("/"); + if ( + strippedPath.endsWith(".md") || + strippedPath.endsWith(".html") || + strippedPath.endsWith(".mdx") + ) { + let newStrippedPart = strippedPath.split("."); + newStrippedPart.pop(); + newStrippedPart = newStrippedPart.join("."); + newStrippedPart = newStrippedPart.split("/"); + let fileName = newStrippedPart.pop(); + if (fileName !== "index") { + correctUrl = strippedPath + .replace(".html", "/") + .replace(".md", "/") + .replace(".mdx", "/"); + correctUrl = + path.join(path.resolve(currNormalisedDir, correctUrl) + "/") + + (hash ? `#${hash}` : ""); } - const isExternalURL = /^https?:\/\//; - if (isExternalURL.test(link)) return link; - let filePath = "src/pages"; - let strippedPath = link.split("#")[0]; // strips hash - if (strippedPath.endsWith("/")) { - strippedPath = strippedPath.slice(0, -1) + newStrippedPart = newStrippedPart.join("/"); + strippedPath = newStrippedPart; + } + if (!correctUrl) { + if (strippedPath === "") { + correctUrl = + currFilePath + .replace("index.mdx", "") + .replace(path.join(filePath + "/").slice(0, -1), "") + + (hash ? `#${hash}` : ""); + } else { + correctUrl = + path.join(path.resolve(currNormalisedDir, strippedPath), "/") + + (hash ? `#${hash}` : ""); } - const hash = link.split("#")[1]; - let correctUrl; - let currNormalisedDir - const currentWorkingDirectory = process.cwd(); - currNormalisedDir = currFilePath.replace("/index.mdx", "").split("/") - currNormalisedDir.pop() - currNormalisedDir = currNormalisedDir.join("/") - if (strippedPath.endsWith(".md") || strippedPath.endsWith(".html") || strippedPath.endsWith(".mdx")) { - let newStrippedPart = strippedPath.split(".") - newStrippedPart.pop() - newStrippedPart = newStrippedPart.join(".") - newStrippedPart = newStrippedPart.split("/") - let fileName = newStrippedPart.pop() - if (fileName !== "index") { - correctUrl = strippedPath.replace(".html", "/").replace(".md", "/").replace(".mdx", "/") - correctUrl = path.join(path.resolve(currNormalisedDir, correctUrl) + "/") + (hash ? `#${hash}` : "") - } - newStrippedPart = newStrippedPart.join("/") - strippedPath = newStrippedPart - } - if (!correctUrl) { - if (strippedPath === "") { - correctUrl = currFilePath.replace("index.mdx", "").replace(path.join(filePath + "/").slice(0, -1), "") + (hash ? `#${hash}` : "") + } + correctUrl = correctUrl.replace( + path.join(currentWorkingDirectory, filePath), + "" + ); - } else { - correctUrl = path.join(path.resolve(currNormalisedDir, strippedPath), "/") + (hash ? `#${hash}` : "") - } - } - correctUrl = correctUrl.replace(path.join(currentWorkingDirectory, filePath), "") - - // console.log("--------------------------------") - // console.log("currNormalisedDir:" + currNormalisedDir) - // console.log(currFilePath) - // console.log(hash) - // console.log(strippedPath) - // console.log(link) - // console.log(correctUrl) - // console.log("--------------------------------") - - const internalLinkFile = path.join(filePath, correctUrl.split("#")[0] + "index.mdx") - const slug = correctUrl.split("#")[1] - if (slug && !filepathSlugs[internalLinkFile].some(slugO => slug === slugO)) { - throw new Error(`Processing file: ${currFilePath}, slug: ${slug} not present in file: ${internalLinkFile}`) - } - try { - fs.accessSync(internalLinkFile, constants.F_OK) - } catch (err) { - console.log("currNormalisedDir:" + currNormalisedDir) - console.log(currFilePath) - console.log(hash) - console.log(strippedPath) - - console.log(link) - console.log(correctUrl) - - console.error("Internal link file doesn't exist: " + internalLinkFile); - throw new Error(err) - } + // console.log("--------------------------------") + // console.log("currNormalisedDir:" + currNormalisedDir) + // console.log(currFilePath) + // console.log(hash) + // console.log(strippedPath) + // console.log(link) + // console.log(correctUrl) + // console.log("--------------------------------") + + const internalLinkFile = path.join( + filePath, + correctUrl.split("#")[0] + "index.mdx" + ); + const slug = correctUrl.split("#")[1]; + if ( + slug && + !filepathSlugs[internalLinkFile].some((slugO) => slug === slugO) + ) { + throw new Error( + `Processing file: ${currFilePath}, slug: ${slug} not present in file: ${internalLinkFile}` + ); + } + try { + fs.accessSync(internalLinkFile, constants.F_OK); + } catch (err) { + console.log("currNormalisedDir:" + currNormalisedDir); + console.log(currFilePath); + console.log(hash); + console.log(strippedPath); + + console.log(link); + console.log(correctUrl); - return correctUrl; + console.error("Internal link file doesn't exist: " + internalLinkFile); + throw new Error(err); + } + + return correctUrl; } // needs import { promises as fs } from 'fs'; @@ -196,51 +240,51 @@ function processLink(link, currFilePath, filepathSlugs) { // } export function walkDir(dirPath, callback) { - fs.readdirSync(dirPath).forEach((file) => { - const filePath = path.join(dirPath, file); - const stat = fs.statSync(filePath); - if (stat.isDirectory()) { - walkDir(filePath, callback); - - } else { - callback(filePath); - } - }); + fs.readdirSync(dirPath).forEach((file) => { + const filePath = path.join(dirPath, file); + const stat = fs.statSync(filePath); + if (stat.isDirectory()) { + walkDir(filePath, callback); + } else { + callback(filePath); + } + }); } function isValidTitleDescExports(str) { - try { - const parsed = acorn.parse(str, { - sourceType: 'module', - ecmaVersion: 2020 - }); - - let titleExported = false; - let descriptionExported = false; - for (const node of parsed.body) { - if (node.type === 'ExportNamedDeclaration') { - if (node.declaration && node.declaration.declarations) { - for (const declaration of node.declaration.declarations) { - if ( - declaration.id.name === 'title' && - declaration.init.type === 'Literal' - ) { - titleExported = true; - } - if ( - declaration.id.name === 'description' && - declaration.init.type === 'Literal' - ) { - descriptionExported = true; - } - } - } + console.log(str); + try { + const parsed = acorn.parse(str, { + sourceType: "module", + ecmaVersion: 2020, + }); + + let titleExported = false; + let descriptionExported = false; + for (const node of parsed.body) { + if (node.type === "ExportNamedDeclaration") { + if (node.declaration && node.declaration.declarations) { + for (const declaration of node.declaration.declarations) { + if ( + declaration.id.name === "title" && + declaration.init.type === "Literal" + ) { + titleExported = true; + } + if ( + declaration.id.name === "description" && + declaration.init.type === "Literal" + ) { + descriptionExported = true; } + } } - - return titleExported && descriptionExported; - } catch (e) { - //console.log(e) - return false; // Parsing error means the string is not valid JS + } } + + return titleExported && descriptionExported; + } catch (e) { + //console.log(e) + return false; // Parsing error means the string is not valid JS + } } From 1558d95c0158424af201e74905d32c0113289530 Mon Sep 17 00:00:00 2001 From: gaeacodes Date: Fri, 22 Sep 2023 16:21:48 +0530 Subject: [PATCH 14/15] file slugs WIP --- filepathSlugs.json | 28 +++++++++---- src/pages/atomicdex/api/v20/index.mdx | 4 ++ ...validate_update_internal_links_userpass.js | 40 +++++++++++-------- 3 files changed, 48 insertions(+), 24 deletions(-) diff --git a/filepathSlugs.json b/filepathSlugs.json index 6beae96c..a4d8b5d4 100644 --- a/filepathSlugs.json +++ b/filepathSlugs.json @@ -2300,14 +2300,20 @@ "response-staking-active" ], "src/pages/atomicdex/api/v20/index.mdx": [ - "atomic-dex-api-rpc-protocol-v2-0", + "komodo-de-fi-sdk-rpc-protocol-v2-0", "request", "response-success", "response-error", "examples", "response-success-2", "response-error-2", - "common-atomic-dex-api-request-response-objects", + "common-komodo-de-fi-sdk-request-response-objects", + "activation-params", + "activation-mode", + "activation-rpc-data", + "activation-servers", + "zhtlc-example", + "hd-utxo-activation-v2", "address-infos", "example-with-balances", "example-without-balances", @@ -2838,32 +2844,38 @@ "arguments", "response", "examples", - "command", + "enable-z-coin-without-any-optional-parameters", + "sync-from-block-2528700-with-custom-zcash-params-path-and-scan-params", + "sync-from-sapling-activation-height-earliest", + "using-websockets-to-sync-from-proof-of-keys-day-2023", "response-2", "task-enable-z-coin-status", "arguments-2", "response-3", "examples-2", - "command-2", + "status-of-z-coin-activation", "response-activating-coin-enabling-has-started", "response-updating-blocks-cache", "response-building-wallet-db", + "response-coin-creation-error-no-zcash-params", + "response-error-no-such-task", + "response-error-invalid-request", "response-enabling-complete", "response-no-zcash-params", - "response-error-no-such-task", + "response-error-no-such-task-2", "task-enable-z-coin-cancel", "arguments-3", "response-4", "examples-3", - "command-3", + "command", "response-success", "response-success-already-finished", - "response-error-no-such-task-2", + "response-error-no-such-task-3", "z-coin-tx-history", "arguments-4", "response-5", "examples-4", - "command-4", + "z-coin-transaction-history", "response-success-2", "response-error-coin-not-supported", "response-error-coin-not-active" diff --git a/src/pages/atomicdex/api/v20/index.mdx b/src/pages/atomicdex/api/v20/index.mdx index 54e35331..240814b8 100644 --- a/src/pages/atomicdex/api/v20/index.mdx +++ b/src/pages/atomicdex/api/v20/index.mdx @@ -202,6 +202,8 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig ``` #### HD UTXO Activation (v2) +```json +{ "activation_params": { "mode": { "rpc": "Electrum", @@ -223,6 +225,8 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig "min_addresses_number": 3, "gap_limit": 20 } +} +``` diff --git a/utils/js/validate_update_internal_links_userpass.js b/utils/js/validate_update_internal_links_userpass.js index cab9ac69..a49b50ab 100644 --- a/utils/js/validate_update_internal_links_userpass.js +++ b/utils/js/validate_update_internal_links_userpass.js @@ -17,11 +17,24 @@ import { toString } from "mdast-util-to-string"; try { let filepaths = []; walkDir("./src/pages", (filepath) => filepaths.push(filepath)); - /* - const filepathSlugs = {}; + await createFileSlugs(filepaths); + let filepathSlugs = JSON.parse(fs.readFileSync("filepathSlugs.json")); for (let index = 0; index < filepaths.length; index++) { const filePath = filepaths[index]; + await processFile(filePath, filepathSlugs); + } + } catch (error) { + if (error) throw error; + } +})(); + +async function createFileSlugs(filepaths) { + const filepathSlugs = {}; + + for (let index = 0; index < filepaths.length; index++) { + const filePath = filepaths[index]; + try { await remark() .use(mdxAnnotations.remark) .use(remarkMdx) @@ -35,24 +48,19 @@ import { toString } from "mdast-util-to-string"; slugs.push(slug); }); filepathSlugs[filePath] = slugs; - // console.log(slugs); }) .process(fs.readFileSync(filePath, "utf-8")); - }*/ - /* - fs.writeFileSync( - "filepathSlugs.json", - JSON.stringify(filepathSlugs, null, 2) - );*/ - let filepathSlugs = JSON.parse(fs.readFileSync("filepathSlugs.json")); - for (let index = 0; index < filepaths.length; index++) { - const filePath = filepaths[index]; - await processFile(filePath, filepathSlugs); + } catch (error) { + console.log(error); + throw new Error(`filePath: ${filePath}`); } - } catch (error) { - if (error) throw error; } -})(); + + fs.writeFileSync( + "filepathSlugs.json", + JSON.stringify(filepathSlugs, null, 2) + ); +} async function processFile(filePath, filepathSlugs) { if (!filePath.endsWith("/index.mdx")) { From 53c52384787ac56d342651c721337c4e9d44a225 Mon Sep 17 00:00:00 2001 From: gaeacodes Date: Fri, 22 Sep 2023 17:09:27 +0530 Subject: [PATCH 15/15] corrected slug names --- src/pages/antara/api/gaming/index.mdx | 24 +++++++++---------- ...validate_update_internal_links_userpass.js | 2 +- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/pages/antara/api/gaming/index.mdx b/src/pages/antara/api/gaming/index.mdx index b4c88267..ea860201 100644 --- a/src/pages/antara/api/gaming/index.mdx +++ b/src/pages/antara/api/gaming/index.mdx @@ -568,9 +568,9 @@ int main() #### Public Function -The `has_systems` function verifies whether or not a list of systems is already registered in the [system\_manager](#system_manager). +The `has_systems` function verifies whether or not a list of systems is already registered in the [system\_manager](#system-manager). -This function recursively calls the [has\_system](#has_system) function. +This function recursively calls the [has\_system](#has-system) function. This function is marked as [nodiscard.](https://en.cppreference.com/w/cpp/language/attributes/nodiscard) @@ -621,7 +621,7 @@ int main() #### Public Function -The `has_systems` function verifies whether or not a list of systems is already registered in the [system\_manager](#system_manager). +The `has_systems` function verifies whether or not a list of systems is already registered in the [system\_manager](#system-manager). #### Usage Pattern @@ -667,9 +667,9 @@ int main() #### Public Function -The `has_systems` function verifies whether or not a list of systems is already registered in the [system\_manager](#system_manager). +The `has_systems` function verifies whether or not a list of systems is already registered in the [system\_manager](#system-manager). -This function recursively calls the [has\_system](#has_system) function. +This function recursively calls the [has\_system](#has-system) function. This function is marked as [nodiscard.](https://en.cppreference.com/w/cpp/language/attributes/nodiscard) @@ -720,9 +720,9 @@ int main() #### Public Function -The `has_systems` function verifies whether or not a list of systems is already registered in the [system\_manager](#system_manager). +The `has_systems` function verifies whether or not a list of systems is already registered in the [system\_manager](#system-manager). -This function recursively calls the [has\_system](#has_system) function. +This function recursively calls the [has\_system](#has-system) function. This function is marked [nodiscard.](https://en.cppreference.com/w/cpp/language/attributes/nodiscard) @@ -868,7 +868,7 @@ int main() The `mark_systems` function marks a list of systems for destruction at the next tick of the game loop. -This function recursively calls the [mark\_system](#mark_system) function. +This function recursively calls the [mark\_system](#mark-system) function. This system is marked as [nodiscard.](https://en.cppreference.com/w/cpp/language/attributes/nodiscard) @@ -968,7 +968,7 @@ int main() The `enable_systems` function enables a list of systems. -This function recursively calls the [enable\_system](#enable_system) function. +This function recursively calls the [enable\_system](#enable-system) function. #### Usage Pattern @@ -1064,7 +1064,7 @@ int main() The `disable_systems` function disables a list of systems. -This function recursively calls the [disable\_system](#disable_system) function. +This function recursively calls the [disable\_system](#disable-system) function. #### Usage Pattern @@ -1263,7 +1263,7 @@ The `load_systems` function loads many os systems. {/* What does "os" mean above? Operating systems? That would make it operating systems systems */} -This function recursively calls the [create\_systems](#create_systems) function. +This function recursively calls the [create\_system](#create-system) function. #### Usage Pattern @@ -1560,7 +1560,7 @@ int main() The `key_released` function that takes no arguments is the default constructor, provided for scripting-system convenience. -Please see the [key\_released | 1](#key-released-1) function for more information. +Please see the [key\_released | 1](#key-released) function for more information. ###### Usage Pattern diff --git a/utils/js/validate_update_internal_links_userpass.js b/utils/js/validate_update_internal_links_userpass.js index a49b50ab..a92a4d96 100644 --- a/utils/js/validate_update_internal_links_userpass.js +++ b/utils/js/validate_update_internal_links_userpass.js @@ -17,7 +17,7 @@ import { toString } from "mdast-util-to-string"; try { let filepaths = []; walkDir("./src/pages", (filepath) => filepaths.push(filepath)); - await createFileSlugs(filepaths); + //await createFileSlugs(filepaths); let filepathSlugs = JSON.parse(fs.readFileSync("filepathSlugs.json")); for (let index = 0; index < filepaths.length; index++) {