From ebe33e93aed93153ce85e5858124933ea58c5265 Mon Sep 17 00:00:00 2001
From: gcharang <21151592+gcharang@users.noreply.github.com>
Date: Mon, 8 Jul 2024 17:46:22 +0530
Subject: [PATCH] corrections to json
---
.../api/legacy/coin_activation/index.mdx | 2 +-
.../get_nft_list/index.mdx | 1 -
.../refresh_nft_metadata/index.mdx | 16 +++++++--------
.../non_fungible_tokens/update_nft/index.mdx | 15 +++++++-------
.../api/v20-dev/task_enable_qtum/index.mdx | 2 +-
.../api/v20-dev/task_enable_utxo/index.mdx | 2 +-
.../v20-dev/zhtlc_coins/activation/index.mdx | 4 ++--
.../api/v20/enable_bch_with_tokens/index.mdx | 20 ++++++++++---------
.../api/v20/enable_eth_with_tokens/index.mdx | 8 ++++----
9 files changed, 36 insertions(+), 34 deletions(-)
diff --git a/src/pages/komodo-defi-framework/api/legacy/coin_activation/index.mdx b/src/pages/komodo-defi-framework/api/legacy/coin_activation/index.mdx
index f4b633ab..747c32a5 100644
--- a/src/pages/komodo-defi-framework/api/legacy/coin_activation/index.mdx
+++ b/src/pages/komodo-defi-framework/api/legacy/coin_activation/index.mdx
@@ -66,7 +66,7 @@ Komodo DeFi Framework is a true cross chain, cross protocol Decentralized Exchan
| Structure | Type | Description |
| ---------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| coin | string | Ticker of coin to activate |
-| servers | array of objects | List of [Electrum servers] (https://github.com/KomodoPlatform/coins/tree/master/electrums) |
+| servers | array of objects | List of \[Electrum servers] ([https://github.com/KomodoPlatform/coins/tree/master/electrums](https://github.com/KomodoPlatform/coins/tree/master/electrums)) |
| servers.url | string | Electrum server URL |
| servers.protocol | string (optional, defaults to `TCP`) | Transport protocol used by Komodo DeFi Framework API to connect to the electrum server (`TCP` or `SSL`) |
| servers.disable\_cert\_verification | bool (optional, defaults to `false`.) | If `true`, this disables server SSL/TLS certificate verification (e.g. to use self-signed certificate). Use at your own risk |
diff --git a/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/get_nft_list/index.mdx b/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/get_nft_list/index.mdx
index 3f429bc9..e0ca4a41 100644
--- a/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/get_nft_list/index.mdx
+++ b/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/get_nft_list/index.mdx
@@ -30,7 +30,6 @@ Returns a list of the NFTs owned by the user, shown in descending order of the `
| skipped | integer | The number of NFTs in your wallet excluded by the request filters. |
| total | integer | The total number of NFTs in your wallet matching the request filters. |
-
#### 📌 Example with no optional params
diff --git a/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/refresh_nft_metadata/index.mdx b/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/refresh_nft_metadata/index.mdx
index b0f8f79a..edccee26 100644
--- a/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/refresh_nft_metadata/index.mdx
+++ b/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/refresh_nft_metadata/index.mdx
@@ -8,14 +8,14 @@ This method refreshes metadata of one NFT and metadata of related transactions w
### Request Parameters
-| Parameter | Type | Description |
-| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| chain | string | Chains which holds the NFT you would like to updated metadata for. |
-| token\_address | string | Token address. |
-| token\_id | string | Token ID. |
-| proxy\_auth | boolean | Indicates whether authentication is required for accessing the proxy URLs (true if authentication is necessary, otherwise false). |
-| url | string | URL link to the Moralis API proxy base url ([https://moralis-proxy.komodo.earth](https://moralis-proxy.komodo.earth)) or equivalent (if proxy_auth is set to true, will need to provide a new Komodo Proxy URL). |
-| url\_antispam | string | URL link to the [Antispam API proxy base url](https://nft.antispam.dragonhound.info) or equivalent. [docs](https://nft.antispam.dragonhound.info/docs). |
+| Parameter | Type | Description |
+| -------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| chain | string | Chains which holds the NFT you would like to updated metadata for. |
+| token\_address | string | Token address. |
+| token\_id | string | Token ID. |
+| proxy\_auth | boolean | Indicates whether authentication is required for accessing the proxy URLs (true if authentication is necessary, otherwise false). |
+| url | string | URL link to the Moralis API proxy base url ([https://moralis-proxy.komodo.earth](https://moralis-proxy.komodo.earth)) or equivalent (if proxy\_auth is set to true, will need to provide a new Komodo Proxy URL). |
+| url\_antispam | string | URL link to the [Antispam API proxy base url](https://nft.antispam.dragonhound.info) or equivalent. [docs](https://nft.antispam.dragonhound.info/docs). |
If there are no errors, this request will return an empty response.
diff --git a/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/update_nft/index.mdx b/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/update_nft/index.mdx
index 1071bb42..c063b6e4 100644
--- a/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/update_nft/index.mdx
+++ b/src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/update_nft/index.mdx
@@ -21,12 +21,12 @@ These coins can be activated using the [enable\_eth\_with\_tokens](/komodo-defi-
### Request Parameters
-| Parameter | Type | Description |
-| ------------- | ------- | --------------------------------------------------------------------------------------------------------------- |
-| chains | array | List of networks to scan for NFTs. Options are: `POLYGON`, `FANTOM`, `ETH`, `BSC`, or `AVALANCHE`. |
-| proxy\_auth | boolean | Indicates whether authentication is required for accessing the proxy URLs (true if necessary, false otherwise). |
-| url | string | URL link to the [Moralis API proxy base url](https://moralis-proxy.komodo.earth) or equivalent (if proxy_auth is set to true, will need to provide a new Komodo Proxy URL). |
-| url\_antispam | string | URL link to the [Antispam API proxy base url](https://nft.antispam.dragonhound.info) or equivalent. |
+| Parameter | Type | Description |
+| ------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| chains | array | List of networks to scan for NFTs. Options are: `POLYGON`, `FANTOM`, `ETH`, `BSC`, or `AVALANCHE`. |
+| proxy\_auth | boolean | Indicates whether authentication is required for accessing the proxy URLs (true if necessary, false otherwise). |
+| url | string | URL link to the [Moralis API proxy base url](https://moralis-proxy.komodo.earth) or equivalent (if proxy\_auth is set to true, will need to provide a new Komodo Proxy URL). |
+| url\_antispam | string | URL link to the [Antispam API proxy base url](https://nft.antispam.dragonhound.info) or equivalent. |
If there are no errors, this request will return an empty response.
@@ -42,12 +42,13 @@ These coins can be activated using the [enable\_eth\_with\_tokens](/komodo-defi-
"method": "update_nft",
"mmrpc": "2.0",
"params": {
- "chains": [
+ "chains": [
"POLYGON"
],
"url": "https://moralis-proxy.komodo.earth",
"url_antispam": "https://nft.antispam.dragonhound.info",
"proxy_auth": false
+ }
}
```
diff --git a/src/pages/komodo-defi-framework/api/v20-dev/task_enable_qtum/index.mdx b/src/pages/komodo-defi-framework/api/v20-dev/task_enable_qtum/index.mdx
index eab45f04..eab9e0d0 100644
--- a/src/pages/komodo-defi-framework/api/v20-dev/task_enable_qtum/index.mdx
+++ b/src/pages/komodo-defi-framework/api/v20-dev/task_enable_qtum/index.mdx
@@ -23,7 +23,7 @@ QTUM coins are activated using this method. For UTXO coins, refer to [task::enab
| .mode | object | An object containing RPC type and data parameters as below. |
| ..rpc | string | UTXO RPC mode. Options: `{ "rpc":"Native" }` if running a native blockchain node, or `"rpc":"Electrum"` to use electrum RPCs. If using electrum, a list of electrum servers is required under `rpc_data.servers` |
| ..rpc\_data | object | An object containing electrum server information. |
-| ...servers | list | A list of electrum server URLs (https://github.com/KomodoPlatform/coins/tree/master/electrums) |
+| ...servers | list | A list of electrum server URLs ([https://github.com/KomodoPlatform/coins/tree/master/electrums](https://github.com/KomodoPlatform/coins/tree/master/electrums)) |
| ....url | object | The url and port of a coins electrum server |
| ....ws\_url | object | Optional. Used to define electrum server url/port for websocket connections. |
| ....protocol | object | Defines electrum server protocol as `TCP` or `SSL`. Defaults to `TCP` |
diff --git a/src/pages/komodo-defi-framework/api/v20-dev/task_enable_utxo/index.mdx b/src/pages/komodo-defi-framework/api/v20-dev/task_enable_utxo/index.mdx
index 0676dec3..c0e16b98 100644
--- a/src/pages/komodo-defi-framework/api/v20-dev/task_enable_utxo/index.mdx
+++ b/src/pages/komodo-defi-framework/api/v20-dev/task_enable_utxo/index.mdx
@@ -23,7 +23,7 @@ UTXO coins are activated using this method. For QTUM coins, refer to [task::enab
| .mode | object | An object containing RPC type and data parameters as below. |
| ..rpc | string | UTXO RPC mode. Options: `{ "rpc":"Native" }` if running a native blockchain node, or `"rpc":"Electrum"` to use electrum RPCs. If using electrum, a list of electrum servers is required under `rpc_data.servers` |
| ..rpc\_data | object | An object containing electrum server information. |
-| ...servers | list | A list of electrum server URLs (https://github.com/KomodoPlatform/coins/tree/master/electrums) |
+| ...servers | list | A list of electrum server URLs ([https://github.com/KomodoPlatform/coins/tree/master/electrums](https://github.com/KomodoPlatform/coins/tree/master/electrums)) |
| ....url | object | The url and port of a coins electrum server |
| ....ws\_url | object | Optional. Used to define electrum server url/port for websocket connections. |
| ....protocol | object | Defines electrum server protocol as `TCP` or `SSL`. Defaults to `TCP` |
diff --git a/src/pages/komodo-defi-framework/api/v20-dev/zhtlc_coins/activation/index.mdx b/src/pages/komodo-defi-framework/api/v20-dev/zhtlc_coins/activation/index.mdx
index 73d86747..5781555f 100644
--- a/src/pages/komodo-defi-framework/api/v20-dev/zhtlc_coins/activation/index.mdx
+++ b/src/pages/komodo-defi-framework/api/v20-dev/zhtlc_coins/activation/index.mdx
@@ -44,7 +44,7 @@ export const description =
},
{
"url": "zombie.dragonhound.info:20033",
- "protocol":"SSL",
+ "protocol": "SSL",
"ws_url": "zombie.dragonhound.info:30058"
}
],
@@ -120,7 +120,7 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa
},
{
"url": "zombie.dragonhound.info:20033",
- "protocol":"SSL",
+ "protocol": "SSL",
"ws_url": "zombie.dragonhound.info:30058"
}
],
diff --git a/src/pages/komodo-defi-framework/api/v20/enable_bch_with_tokens/index.mdx b/src/pages/komodo-defi-framework/api/v20/enable_bch_with_tokens/index.mdx
index ea58c7eb..42be259c 100644
--- a/src/pages/komodo-defi-framework/api/v20/enable_bch_with_tokens/index.mdx
+++ b/src/pages/komodo-defi-framework/api/v20/enable_bch_with_tokens/index.mdx
@@ -21,8 +21,10 @@ The Komodo DeFi Framework supports Bitcoin Cash SLP tokens. Using this method, y
| requires\_notarization | boolean | Optional, defaults to `true`. Has no effect on BCH. |
| tx\_history | boolean | Optional, defaults to `true`. If `true` the Komodo DeFi Framework API will preload transaction history as a background process. Must be set to `true` to use the [my\_tx\_history](/komodo-defi-framework/api/legacy/my_tx_history/#my-tx-history) method |
| utxo\_merge\_params | object | A standard [UtxoMergeParams](/komodo-defi-framework/api/common_structures/activation/#utxo-merge-params) object. Used to reduce a wallet's UTXO count in cases where it is causing significantly slower RPC responses. |
+| | | |
+
- - Go to: https://github.com/KomodoPlatform/coins/tree/master/electrums for a full list of nodes/servers.
+ * Go to: [https://github.com/KomodoPlatform/coins/tree/master/electrums](https://github.com/KomodoPlatform/coins/tree/master/electrums) for a full list of nodes/servers.
### Response Parameters
@@ -58,12 +60,12 @@ The Komodo DeFi Framework supports Bitcoin Cash SLP tokens. Using this method, y
"rpc_data": {
"servers": [
{
- "url": "bch.imaginary.cash:50002"
- "protocol": "SSL",
+ "url": "bch.imaginary.cash:50002",
+ "protocol": "SSL"
},
{
"url": "cashnode.bch.ninja:50002",
- "protocol": "SSL",
+ "protocol": "SSL"
},
{
"url": "electrum3.cipig.net:20055",
@@ -154,12 +156,12 @@ The Komodo DeFi Framework supports Bitcoin Cash SLP tokens. Using this method, y
"rpc_data": {
"servers": [
{
- "url": "bch.imaginary.cash:50002"
- "protocol": "SSL",
+ "url": "bch.imaginary.cash:50002",
+ "protocol": "SSL"
},
{
"url": "cashnode.bch.ninja:50002",
- "protocol": "SSL",
+ "protocol": "SSL"
},
{
"url": "electrum3.cipig.net:20055",
@@ -181,9 +183,9 @@ The Komodo DeFi Framework supports Bitcoin Cash SLP tokens. Using this method, y
```
-
- #### Response
+#### Response
+
```json
{
"mmrpc": "2.0",
diff --git a/src/pages/komodo-defi-framework/api/v20/enable_eth_with_tokens/index.mdx b/src/pages/komodo-defi-framework/api/v20/enable_eth_with_tokens/index.mdx
index 4bd18f3e..6a773b7c 100644
--- a/src/pages/komodo-defi-framework/api/v20/enable_eth_with_tokens/index.mdx
+++ b/src/pages/komodo-defi-framework/api/v20/enable_eth_with_tokens/index.mdx
@@ -14,10 +14,10 @@ Additionally, it supports ERC20 tokens on the ETH chain and associated ERC20 lik
| mm2 | integer | Required if not set in `coins` file. Informs the Komodo DeFi Framework API whether or not the coin is expected to function. Accepted values are `0` or `1` |
| swap\_contract\_address | string | Address of etomic swap smart contract |
| fallback\_swap\_contract | string | Address of backup etomic swap smart contract |
-| maker\_swap\_v2\_contract | string | Backup address for the maker's swap smart contract |
-| taker\_swap\_v2\_contract | string | Backup address for the taker's swap smart contract |
-| nodes | array of objects | A list of standard [EvmNode](/komodo-defi-framework/api/common_structures/activation/#evm-node) objects. (https://github.com/KomodoPlatform/coins/tree/master/electrums).
- |
+| maker\_swap\_v2\_contract | string | Backup address for the maker's swap smart contract |
+| taker\_swap\_v2\_contract | string | Backup address for the taker's swap smart contract |
+| nodes | array of objects | A list of standard [EvmNode](/komodo-defi-framework/api/common_structures/activation/#evm-node) objects. ([https://github.com/KomodoPlatform/coins/tree/master/electrums](https://github.com/KomodoPlatform/coins/tree/master/electrums)). |
+| | | |
| erc20\_tokens\_requests | array of objects | A list of standard [TokensRequest](/komodo-defi-framework/api/common_structures/activation/#tokens-request) objects. |
| gas\_station\_decimals | integer | Optional, for ETH/ERC20 and other gas model chains. Defaults to `8`. Defines the decimals used to denominate the gas station response to gwei units. For example, the ETH gas station uses 8 decimals, which means that "average": 860 is equal to 86 gwei. While the Matic gas station uses 9 decimals, so 860 would mean 860 gwei exactly. |
| gas\_station\_policy.policy | string | Optional, for ETH/ERC20 and other gas model chains. Defaults to `"MeanAverageFast"`. Defines the method of gas price calculation from the station response. `"MeanAverageFast"` will use the mean between average and fast fields. `"Average"` will return a simple average value. |