Merge branch 'dev' of https://github.com/KomodoPlatform/komodo-docs-mdx…

… into dev
KomodoPlatform · Nov 25, 2024 · aa4e6e7 · aa4e6e7
2 parents 6edacf9 + 0d61b7c
commit aa4e6e7
Show file tree

Hide file tree

Showing 42 changed files with 5,610 additions and 1,198 deletions.
diff --git a/data-for-gpts/all-content.txt b/data-for-gpts/all-content.txt
diff --git a/data-for-gpts/komodefi-api/all-api-content.txt b/data-for-gpts/komodefi-api/all-api-content.txt
diff --git a/data-for-gpts/komodefi-api/v20-api-content.txt b/data-for-gpts/komodefi-api/v20-api-content.txt
diff --git a/data-for-gpts/komodefi-api/v20-dev-api-content.txt b/data-for-gpts/komodefi-api/v20-dev-api-content.txt
diff --git a/data-for-gpts/komodo-defi-framework-content.txt b/data-for-gpts/komodo-defi-framework-content.txt
diff --git a/filepathSlugs.json b/filepathSlugs.json
@@ -2020,6 +2020,7 @@
     "tendermint-node",
     "v2-1-0-current-release-2",
     "v2-2-0-2",
+    "swap-v2-contracts",
     "tokens-request",
     "utxo-merge-params"
   ],
@@ -2071,12 +2072,14 @@
   ],
   "src/pages/komodo-defi-framework/api/common_structures/nfts/index.mdx": [
     "non-fungible-token-structures",
+    "nft-info-basic",
     "nft-info",
     "nft-filter",
     "nft-transfer",
     "nft-transfer-filter",
     "nft-metadata",
-    "withdraw-nft-data"
+    "withdraw-nft-data",
+    "nft-provider"
   ],
   "src/pages/komodo-defi-framework/api/common_structures/orders/index.mdx": [
     "order-structures",
@@ -2783,14 +2786,19 @@
     "response",
     "request-with-get-balances-set-to-false",
     "response-2",
+    "request-including-nft-initialization",
+    "response-3",
+    "error-responses",
     "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"
+    "unexpected-token-protocol-error",
+    "invalid-request-error",
+    "transport-error"
   ],
   "src/pages/komodo-defi-framework/api/v20/enable_slp/index.mdx": [
     "enable-slp",
@@ -2864,6 +2872,16 @@
     "command",
     "response-2"
   ],
+  "src/pages/komodo-defi-framework/api/v20/get_mnemonic/index.mdx": [
+    "get-mnemonic",
+    "arguments",
+    "response",
+    "examples",
+    "for-encrypted-output",
+    "response-success",
+    "for-plain-text-output",
+    "response-success-2"
+  ],
   "src/pages/komodo-defi-framework/api/v20/get_public_key/index.mdx": [
     "get-public-key",
     "arguments",
@@ -3414,7 +3432,15 @@
     "example-to-clear-binance-smart-chain-and-polygon-nft-data",
     "example-to-clear-all-nft-data",
     "error-responses",
-    "unsupported-chain-type"
+    "unsupported-chain-type",
+    "invalid-request"
+  ],
+  "src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/enable_nft/index.mdx": [
+    "enable-nft",
+    "response",
+    "error-platform-coin-is-not-yet-activated",
+    "error-token-already-activated",
+    "error-token-config-not-found-in-coins-file"
   ],
   "src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/get_nft_list/index.mdx": [
     "get-a-list-of-nfts",
@@ -3442,7 +3468,8 @@
   "src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/index.mdx": [
     "non-fungible-tokens-nfts",
     "nft-information-methods",
-    "nft-transaction-methods"
+    "nft-transaction-methods",
+    "nft-utility-methods"
   ],
   "src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/query_nft_database_tables/index.mdx": [
     "query-nft-database-tables",
@@ -3456,12 +3483,16 @@
   "src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/refresh_nft_metadata/index.mdx": [
     "refresh-nft-metadata",
     "request-parameters",
-    "example"
+    "example",
+    "error-responses"
   ],
   "src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/update_nft/index.mdx": [
     "update-nft",
     "request-parameters",
-    "example"
+    "example",
+    "error-types",
+    "token-is-already-activated",
+    "token-is-already-activated-2"
   ],
   "src/pages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/withdraw_nft/index.mdx": [
     "withdraw-nfts",
@@ -3671,18 +3702,27 @@
   ],
   "src/pages/komodo-defi-framework/changelog/index.mdx": [
     "change-log",
-    "komodo-de-fi-framework-v2-1-0-beta",
-    "essential-new-features-trading-protocol-upgrade-hd-wallet-event-streaming-and-seeds-management",
+    "komodo-de-fi-framework-v2-2-0-beta",
+    "custom-token-support-and-various-optimizations",
     "release-notes",
     "features",
-    "nb-backwards-compatibility-breaking-changes",
-    "new-contributors",
     "enhancements",
+    "nb-backwards-compatibility-breaking-changes",
+    "removals",
+    "api-changes",
     "bug-fixes",
-    "komodo-de-fi-framework-v2-0-0-beta",
-    "network-evolution-and-kmd-burn-enhancing-kmds-role-in-komodos-de-fi-framework",
+    "komodo-de-fi-framework-v2-1-0-beta",
+    "essential-new-features-trading-protocol-upgrade-hd-wallet-event-streaming-and-seeds-management",
     "release-notes-2",
+    "features-2",
     "nb-backwards-compatibility-breaking-changes-2",
+    "new-contributors",
+    "enhancements-2",
+    "bug-fixes-2",
+    "komodo-de-fi-framework-v2-0-0-beta",
+    "network-evolution-and-kmd-burn-enhancing-kmds-role-in-komodos-de-fi-framework",
+    "release-notes-3",
+    "nb-backwards-compatibility-breaking-changes-3",
     "komodo-de-fi-framework-v1-0-7-beta",
     "komodo-de-fi-framework-v1-0-6-beta",
     "atomic-dex-v1-0-5-beta",
@@ -3713,6 +3753,7 @@
     "example-not-allowing-weak-password",
     "example-using-gas-api",
     "example-wss-with-certificates",
+    "example-with-wallet-name-and-wallet-password",
     "example-for-hd-wallets",
     "coins-file-configuration",
     "optional-environment-variables",
@@ -3923,9 +3964,11 @@
     "nodes",
     "query-4",
     "respose",
-    "stats-nodes",
-    "query-5",
-    "response-4"
+    "coin-tables",
+    "kmd-block-headers-cache",
+    "kmd-tx-address",
+    "kmd-tx-cache",
+    "kmd-tx-history"
   ],
   "src/pages/komodo-defi-framework/tutorials/setup-komodefi-api-aws/index.mdx": [
     "how-to-setup-and-use-the-komodo-de-fi-framework-api-on-an-aws-ec-2-instance",

diff --git a/postman/collections/komodo_defi.postman_collection.json b/postman/collections/komodo_defi.postman_collection.json
@@ -5887,7 +5887,7 @@
 										"header": [],
 										"body": {
 											"mode": "raw",
-											"raw": "{\n    \"userpass\": \"{{userpass}}\",\n    \"mmrpc\": \"2.0\",\n    \"method\": \"enable_sia\",\n    \"params\": {\n        \"ticker\": \"TSIA\",\n        \"activation_params\": {\n            \"client_conf\": {\n                \"server_url\": \"https://sia-walletd.komodo.earth/\",\n                \"password\": \"dummy\"\n            }\n        }\n    }\n}\n",
+											"raw": "{\n    \"userpass\": \"{{userpass}}\",\n    \"mmrpc\": \"2.0\",\n    \"method\": \"enable_sia\",\n    \"params\": {\n        \"ticker\": \"TSIA\",\n        \"activation_params\": {\n            \"client_conf\": {\n                \"server_url\": \"https://api.siascan.com/anagami/wallet/\",\n                \"password\": \"dummy\"\n            }\n        }\n    }\n}\n",
 											"options": {
 												"raw": {
 													"language": "json"
@@ -5909,7 +5909,7 @@
 												"header": [],
 												"body": {
 													"mode": "raw",
-													"raw": "{\n    \"userpass\": \"{{userpass}}\",\n    \"mmrpc\": \"2.0\",\n    \"method\": \"enable_sia\",\n    \"params\": {\n        \"ticker\": \"TSIA\",\n        \"activation_params\": {\n            \"client_conf\": {\n                \"server_url\": \"https://sia-walletd.komodo.earth/\",\n                \"password\": \"dummy\"\n            }\n        }\n    }\n}\n",
+													"raw": "{\n    \"userpass\": \"{{userpass}}\",\n    \"mmrpc\": \"2.0\",\n    \"method\": \"enable_sia\",\n    \"params\": {\n        \"ticker\": \"TSIA\",\n        \"activation_params\": {\n            \"client_conf\": {\n                \"server_url\": \"https://api.siascan.com/anagami/wallet/\",\n                \"password\": \"dummy\"\n            }\n        }\n    }\n}\n",
 													"options": {
 														"raw": {
 															"language": "json"

diff --git a/preview-images/optimized/pre-komodo-defi-framework-api-1076540641.jpg b/preview-images/optimized/pre-komodo-defi-framework-api-1076540641.jpg
diff --git a/preview-images/optimized/pre-komodo-defi-framework-api-969879992.jpg b/preview-images/optimized/pre-komodo-defi-framework-api-969879992.jpg
diff --git a/...s/optimized/pre-komodo-defi-framework-api-legacy-coin_activation-2599479219.jpg b/...s/optimized/pre-komodo-defi-framework-api-legacy-coin_activation-2599479219.jpg
diff --git a/...s/optimized/pre-komodo-defi-framework-api-legacy-coin_activation-2998121958.jpg b/...s/optimized/pre-komodo-defi-framework-api-legacy-coin_activation-2998121958.jpg
diff --git a/...-images/original/pre-komodo-defi-framework-api-common_structures-activation.jpg b/...-images/original/pre-komodo-defi-framework-api-common_structures-activation.jpg
diff --git a/preview-images/original/pre-komodo-defi-framework-api-common_structures-nfts.jpg b/preview-images/original/pre-komodo-defi-framework-api-common_structures-nfts.jpg
diff --git a/...original/pre-komodo-defi-framework-api-common_structures-swaps-maker_events.jpg b/...original/pre-komodo-defi-framework-api-common_structures-swaps-maker_events.jpg
diff --git a/...original/pre-komodo-defi-framework-api-common_structures-swaps-taker_events.jpg b/...original/pre-komodo-defi-framework-api-common_structures-swaps-taker_events.jpg
diff --git a/preview-images/original/pre-komodo-defi-framework-api-common_structures-wallet.jpg b/preview-images/original/pre-komodo-defi-framework-api-common_structures-wallet.jpg
diff --git a/preview-images/original/pre-komodo-defi-framework-api-common_structures.jpg b/preview-images/original/pre-komodo-defi-framework-api-common_structures.jpg
diff --git a/preview-images/original/pre-komodo-defi-framework-api-legacy-coin_activation.jpg b/preview-images/original/pre-komodo-defi-framework-api-legacy-coin_activation.jpg
diff --git a/preview-images/original/pre-komodo-defi-framework-api.jpg b/preview-images/original/pre-komodo-defi-framework-api.jpg
diff --git a/src/data/sidebar.json b/src/data/sidebar.json
@@ -529,6 +529,10 @@
             "title": "get_public_key_hash",
             "href": "/komodo-defi-framework/api/v20/get_public_key_hash/"
           },
+          {
+            "title": "get_mnemonic",
+            "href": "/komodo-defi-framework/api/v20/get_mnemonic/"
+          },
           {
             "title": "get_wallet_names",
             "href": "/komodo-defi-framework/api/v20/get_wallet_names/"
@@ -609,6 +613,10 @@
             "title": "Overview",
             "href": "/komodo-defi-framework/api/v20-dev/non_fungible_tokens/"
           },
+          {
+            "title": "Enable NFT",
+            "href": "/komodo-defi-framework/api/v20-dev/non_fungible_tokens/enable_nft/"
+          },
           {
             "title": "Clear NFT Database Tables",
             "href": "/komodo-defi-framework/api/v20-dev/non_fungible_tokens/clear_nft_db/"

diff --git a/src/pages/komodo-defi-framework/api/common_structures/activation/index.mdx b/src/pages/komodo-defi-framework/api/common_structures/activation/index.mdx
@@ -210,6 +210,26 @@ The `TendermintNode` object includes the following items for a given coin or tok
   ```
 </CollapsibleSection>
 
+### SwapV2Contracts
+
+The `SwapV2Contracts` object includes the following items for a given coin or token:
+
+| Parameter                      | Type   | Description                                                                                                                       |
+| ------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------- |
+| maker\_swap\_v2\_contract      | string | Address for the maker's new V2 swap smart contract. Must be provided if "use\_trading\_proto\_v2"is true in mm2 configuration     |
+| taker\_swap\_v2\_contract      | string | Address for the taker's new V2 swap smart contract. Must be provided if "use\_trading\_proto\_v2"is true in mm2 configuration     |
+| nft\_maker\_swap\_v2\_contract | string | Address for the maker's new V2 NFT swap smart contract. Must be provided if "use\_trading\_proto\_v2"is true in mm2 configuration |
+
+<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
+  ```json
+  {
+        "maker_swap_v2_contract": "0x9130b257D37A52E52F21054c4DA3450c72f595CE",
+        "taker_swap_v2_contract": "0x9130b257D37A52E52F21054c4DA3450c72f595CE",
+        "nft_maker_swap_v2_contract": "0x9130b257D37A52E52F21054c4DA3450c72f595CE"
+  }
+  ```
+</CollapsibleSection>
+
 ### TokensRequest
 
 The `TokensRequest` object includes the following items for a given coin or token:

diff --git a/src/pages/komodo-defi-framework/api/common_structures/nfts/index.mdx b/src/pages/komodo-defi-framework/api/common_structures/nfts/index.mdx
@@ -5,6 +5,18 @@ export const description = "Starting with version beta-2.1.3434, the Komodo DeFi
 
 The following structures are used in the Komodo DeFi SDK for non-fungible tokens (NFTs).
 
+### NftInfoBasic
+
+The `NftInfoBasic` object includes the following items for a given token:
+
+| Parameter      | Type   | Description                                                           |
+| -------------- | ------ | --------------------------------------------------------------------- |
+| amount         | string | The amount of this NFT the user owns (used by `ERC1155`).             |
+| chain          | string | Chain name. One of `AVALANCHE`, `BSC`, `ETH`, `FANTOM`, or `POLYGON`. |
+| contract\_type | string | The type of NFT contract standard. One of `ERC721` or `ERC1155`.      |
+| token\_address | string | The address of the NFT contract.                                      |
+| token\_id      | string | The token ID of the NFT.                                              |
+
 ### NftInfo
 
 The `NftInfo` object includes the following items for a given token:
@@ -197,3 +209,26 @@ The `WithdrawNftData` object is used for withdrawals of NFTs on ERC721 and ERC11
   Due to this difference, the `amount` and `max` fields are only used the when
   the `type` value is `withdraw_erc1155`.
 </Note>
+
+### NftProvider
+
+The `NftProvider` object is used in the 'enable\_nft' RPC method. It defines the NFT providers that are avaialable and their configuration.
+
+| Parameter          | Type    | Description                                                                  |
+| ------------------ | ------- | ---------------------------------------------------------------------------- |
+| type               | string  | Specifies the type of the provider.                                          |
+| info               | object  | Additional information about the provider                                    |
+| info.url           | string  | URL of the provider's endpoint                                               |
+| info.komodo\_proxy | boolean | Optional. Indicates whether proxy authentication is enabled for the endpoint |
+
+<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
+  ```json
+  {
+      "type": "Moralis",
+      "info": {
+          "url": "https://moralis-proxy.komodo.earth",
+          "komodo_proxy": true
+      }
+  }
+  ```
+</CollapsibleSection>
diff --git a/src/pages/komodo-defi-framework/api/index.mdx b/src/pages/komodo-defi-framework/api/index.mdx
@@ -32,6 +32,7 @@ Below is a table of the currently available legacy, v2.0 and v2.0 (Dev) methods:
 |                                                                                                                                 | [enable\_bch\_with\_tokens](/komodo-defi-framework/api/v20/enable_bch_with_tokens/#enable-bch-with-tokens)                                            |                                                                                                                                   |
 |                                                                                                                                 | [enable\_erc20](/komodo-defi-framework/api/v20/enable_erc20/#enable-erc20)                                                                            |                                                                                                                                   |
 |                                                                                                                                 | [enable\_eth\_with\_tokens](/komodo-defi-framework/api/v20/enable_eth_with_tokens/#enable-eth-with-tokens)                                            |                                                                                                                                   |
+|                                                                                                                                 |                                                                                                                                                       | [enable\_nft](/komodo-defi-framework/api/v20-dev/non_fungible_tokens/enable_nft/#enable-nft)                                      |
 |                                                                                                                                 | [enable\_slp](/komodo-defi-framework/api/v20/enable_slp/#enable-slp)                                                                                  |                                                                                                                                   |
 |                                                                                                                                 | [enable\_tendermint\_token](/komodo-defi-framework/api/v20/enable_tendermint_token/#enable-tendermint-token)                                          |                                                                                                                                   |
 |                                                                                                                                 | [enable\_tendermint\_with\_assets](/komodo-defi-framework/api/v20/enable_tendermint_with_assets/#enable-tendermint-with-assets)                       |                                                                                                                                   |
@@ -45,6 +46,7 @@ Below is a table of the currently available legacy, v2.0 and v2.0 (Dev) methods:
 | [get\_gossip\_peer\_topics](/komodo-defi-framework/api/legacy/get_gossip_peer_topics/#get-gossip-peer-topics)                   |                                                                                                                                                       |                                                                                                                                   |
 | [get\_gossip\_topic\_peers](/komodo-defi-framework/api/legacy/get_gossip_topic_peers/#get-gossip-topic-peers)                   |                                                                                                                                                       |                                                                                                                                   |
 |                                                                                                                                 |                                                                                                                                                       | [get\_locked\_amount](/komodo-defi-framework/api/v20-dev/get_locked_amount/#get-locked-amount)                                    |
+|                                                                                                                                 | [get\_mnemonic](/komodo-defi-framework/api/v20/get_mnemonic/#get-mnemonic)                                                                            |                                                                                                                                   |
 | [get\_my\_peer\_id](/komodo-defi-framework/api/legacy/get_my_peer_id/#get-my-peer-id)                                           |                                                                                                                                                       |                                                                                                                                   |
 |                                                                                                                                 |                                                                                                                                                       | [get\_new\_address](/komodo-defi-framework/api/v20-dev/hd_address_management/#get-new-address)                                    |
 |                                                                                                                                 |                                                                                                                                                       | [get\_nft\_list](/komodo-defi-framework/api/v20-dev/non_fungible_tokens/get_nft_list/#get-a-list-of-nfts)                         |

diff --git a/...es/komodo-defi-framework/api/v20-dev/non_fungible_tokens/clear_nft_db/index.mdx b/...es/komodo-defi-framework/api/v20-dev/non_fungible_tokens/clear_nft_db/index.mdx
@@ -1,6 +1,6 @@
 export const title = "Komodo DeFi Framework Method: Non Fungible Tokens";
 export const description =
-  "This document describes the clear_nft_db method Komodo DeFi Framework  provides to clear NFT data from your local database";
+  "This document describes the clear_nft_db method Komodo DeFi Framework provides to clear NFT data from your local database";
 
 # Clear NFT Database {{label : 'clear_nft_db', tag : 'API-v2'}}
 
@@ -88,3 +88,17 @@ Returned when the `chains` parameter contains an unsupported network.
     "id": null
 }
 ```
+
+#### InvalidRequest
+
+Returned when neither the `chains` or `clear_all` parameters are present.
+
+```json
+{
+    "mmrpc":"2.0",
+    "error":"Invalid request: Nothing to clear was specified","error_path":"nft","error_trace":"nft:1512]",
+    "error_type":"InvalidRequest",
+    "error_data":"Nothing to clear was specified",
+    "id":null
+}
+```