Skip to content

Commit

Permalink
corrections to json
Browse files Browse the repository at this point in the history
  • Loading branch information
@gcharang
gcharang committed Jul 8, 2024
1 parent 5d201e2 commit ebe33e9
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 34 deletions.
2 changes: 1 addition & 1 deletion src/pages/komodo-defi-framework/api/legacy/coin_activation/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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). <b>Use at your own risk</b> |
Expand Down
1 change: 0 additions & 1 deletion ...es/komodo-defi-framework/api/v20-dev/non_fungible_tokens/get_nft_list/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

<CodeGroup title="Get a list of NFTs" tag="POST" label="get_nft_list" mm2MethodDecorate="true">
Expand Down
16 changes: 8 additions & 8 deletions ...o-defi-framework/api/v20-dev/non_fungible_tokens/refresh_nft_metadata/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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). |

<Note>
If there are no errors, this request will return an empty response.
Expand Down
15 changes: 8 additions & 7 deletions ...ages/komodo-defi-framework/api/v20-dev/non_fungible_tokens/update_nft/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

<Note>
If there are no errors, this request will return an empty response.
Expand All @@ -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
}
}
```
</CodeGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/komodo-defi-framework/api/v20-dev/task_enable_qtum/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down
2 changes: 1 addition & 1 deletion src/pages/komodo-defi-framework/api/v20-dev/task_enable_utxo/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down
4 changes: 2 additions & 2 deletions src/pages/komodo-defi-framework/api/v20-dev/zhtlc_coins/activation/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export const description =
},
{
"url": "zombie.dragonhound.info:20033",
"protocol":"SSL",
"protocol": "SSL",
"ws_url": "zombie.dragonhound.info:30058"
}
],
Expand Down Expand Up @@ -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"
}
],
Expand Down
20 changes: 11 additions & 9 deletions src/pages/komodo-defi-framework/api/v20/enable_bch_with_tokens/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
| | | |

<Note>
- 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.
</Note>

### Response Parameters
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -181,9 +183,9 @@ The Komodo DeFi Framework supports Bitcoin Cash SLP tokens. Using this method, y
```
</CodeGroup>

<CollapsibleSection expandedText="Hide Response" collapsedText="Show Response">
#### Response
#### Response

<CollapsibleSection expandedText="Hide Response" collapsedText="Show Response">
```json
{
"mmrpc": "2.0",
Expand Down

0 comments on commit ebe33e9

Please sign in to comment.