Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Node/Server URLs update #272

Merged
merged 32 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
9a491a5
Update index.mdx
harsenyan3 Jul 3, 2024
27fcf35
Update index.mdx
harsenyan3 Jul 3, 2024
2aa09b7
Update index.mdx
harsenyan3 Jul 3, 2024
7274ed5
Update index.mdx
harsenyan3 Jul 3, 2024
2e12273
Update index.mdx
harsenyan3 Jul 3, 2024
0c4fe3d
Update index.mdx
harsenyan3 Jul 3, 2024
4b20f02
Update index.mdx
harsenyan3 Jul 3, 2024
ec4db6e
Update index.mdx
harsenyan3 Jul 3, 2024
e654252
Update index.mdx
harsenyan3 Jul 3, 2024
695df63
Update index.mdx
harsenyan3 Jul 4, 2024
ee17d74
Update index.mdx
harsenyan3 Jul 4, 2024
9726773
Update index.mdx
harsenyan3 Jul 4, 2024
b5b06fc
Update index.mdx
harsenyan3 Jul 4, 2024
f868c06
Update index.mdx
harsenyan3 Jul 4, 2024
cba0694
Update index.mdx
harsenyan3 Jul 4, 2024
fd6fd6e
Update index.mdx
harsenyan3 Jul 4, 2024
2a97134
Update index.mdx
harsenyan3 Jul 4, 2024
cbdb06a
Update index.mdx
harsenyan3 Jul 4, 2024
6d7fa69
Update index.mdx
harsenyan3 Jul 4, 2024
89e36c8
Update index.mdx
harsenyan3 Jul 4, 2024
44e14bc
Update index.mdx
harsenyan3 Jul 4, 2024
7ab17f5
Update index.mdx
harsenyan3 Jul 4, 2024
36df2d7
Update index.mdx
harsenyan3 Jul 4, 2024
f74e7bd
Update index.mdx
harsenyan3 Jul 4, 2024
27dfdd0
Update index.mdx
harsenyan3 Jul 4, 2024
65e41f7
Update index.mdx
harsenyan3 Jul 4, 2024
b993afe
Update index.mdx
harsenyan3 Jul 4, 2024
1cdc920
Update index.mdx
gcharang Jul 8, 2024
aabea5e
Update index.mdx
gcharang Jul 8, 2024
b0bfcd4
Update index.mdx
gcharang Jul 8, 2024
af2dc02
Update index.mdx
harsenyan3 Jul 8, 2024
ca1eeb1
Update index.mdx
gcharang Jul 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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) |
| 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 Expand Up @@ -331,9 +331,9 @@ Komodo DeFi Framework is a true cross chain, cross protocol Decentralized Exchan
"coin": "ETH",
"method": "enable",
"urls": [
"http://eth1.cipig.net:8555",
"http://eth2.cipig.net:8555",
"http://eth3.cipig.net:8555"
"http://eth1.cipig.net:18555",
"http://eth2.cipig.net:18555",
"http://eth3.cipig.net:18555"
],
"swap_contract_address": "0x24ABE4c71FC658C91313b6552cd40cD808b3Ea80",
"fallback_swap_contract": "0x8500AFc0bc5214728082163326C2FF0C73f4a871",
Expand Down Expand Up @@ -367,9 +367,9 @@ Komodo DeFi Framework is a true cross chain, cross protocol Decentralized Exchan
"userpass": "RPC_UserP@SSW0RD",
"method": "enable",
"urls": [
"http://eth1.cipig.net:8555",
"http://eth2.cipig.net:8555",
"http://eth3.cipig.net:8555"
"http://eth1.cipig.net:18555",
"http://eth2.cipig.net:18555",
"http://eth3.cipig.net:18555"
],
"swap_contract_address": "0x24ABE4c71FC658C91313b6552cd40cD808b3Ea80",
"fallback_swap_contract": "0x8500AFc0bc5214728082163326C2FF0C73f4a871",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ Returns a list of the NFTs owned by the user, shown in descending order of the `
| Parameter | Type | Description |
| --------- | --------------- | -------------------------------------------------------------------------------------------------- |
| nfts | list of objects | A list of standard [NftInfo](/komodo-defi-framework/api/common_structures/nfts/#nft-info) objects. |
| total | integer | The total number of NFTs in your wallet matching the request filters. |
| 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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ This method refreshes metadata of one NFT and metadata of related transactions w
| Parameter | Type | Description |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| chain | string | Chains which holds the NFT you would like to updated metadata for. |
| url | string | URL link to the Moralis API proxy base url ([https://moralis-proxy.komodo.earth](https://moralis-proxy.komodo.earth)) or equivalent. |
| 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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +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`. |
| url | string | URL link to the [Moralis API proxy base url](https://moralis-proxy.komodo.earth) or equivalent. |
| 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 @@ -37,17 +38,16 @@ These coins can be activated using the [enable\_eth\_with\_tokens](/komodo-defi-
<CodeGroup title="Update NFT" tag="POST" label="update_nft" mm2MethodDecorate="true">
```json
{
"userpass": "RPC_UserP@SSW0RD",
"userpass": "RPC_UserP@SSWORD",
"method": "update_nft",
"mmrpc": "2.0",
"params": {
"chains": [
"BSC",
"chains": [
"POLYGON"
],
"url": "https://moralis-proxy.komodo.earth",
"url_antispam": "https://nft.antispam.dragonhound.info"
}
"url_antispam": "https://nft.antispam.dragonhound.info",
"proxy_auth": false
}
```
</CodeGroup>
Expand Down
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 |
| ...servers | list | A list of electrum server URLs (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
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 |
| ...servers | list | A list of electrum server URLs (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
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ export const description =
"electrum_servers": [
{
"url": "zombie.dragonhound.info:10033"
},
{
"url": "zombie.dragonhound.info:20033",
"protocol":"SSL",
"ws_url": "zombie.dragonhound.info:30058"
}
],
"light_wallet_d_servers": [
Expand Down Expand Up @@ -112,6 +117,11 @@ The Z coin lightwallet client only supports blocks that are post-sapling. The sa
"electrum_servers": [
{
"url": "zombie.dragonhound.info:10033"
},
{
"url": "zombie.dragonhound.info:20033",
"protocol":"SSL",
"ws_url": "zombie.dragonhound.info:30058"
}
],
"light_wallet_d_servers": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The Komodo DeFi Framework supports Bitcoin Cash SLP tokens. Using this method, y
| ------------------------ | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ticker | string | Ticker of the platform protocol coin. Options: `BCH` or `tBCH` |
| bchd\_urls | array of strings | A list of BCHD gRPC API server URLs, used for validation of SLP token transactions. It's recommended to add as many servers as possible. The URLs list can be found at [https://bchd.fountainhead.cash/](https://bchd.fountainhead.cash/). |
| mode | object | A standard [ActivationMode](/komodo-defi-framework/api/common_structures/activation/#activation-mode) object. |
| mode | object | A standard [ActivationMode](/komodo-defi-framework/api/common_structures/activation/#activation-mode) object.* |
| tx\_history | boolean | If `true`, spawns a background loop to store the local cache of address(es) transactions. Defaults to `false`. |
| slp\_tokens\_requests | array of objects | A list of standard [TokensRequest](/komodo-defi-framework/api/common_structures/activation/#tokens-request) objects. |
| address\_format | object | Optional. Overwrites the address format from coins file, if set. A standard [AddressFormat](/komodo-defi-framework/api/common_structures/#address-format) object. |
Expand All @@ -21,6 +21,9 @@ 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. |
<DevComment>
harsenyan3 marked this conversation as resolved.
Show resolved Hide resolved
*Go to: https://github.com/KomodoPlatform/coins/tree/master/electrums for full list of nodes/servers.
</DevComment>

### Response Parameters

Expand Down Expand Up @@ -48,14 +51,19 @@ The Komodo DeFi Framework supports Bitcoin Cash SLP tokens. Using this method, y
"ticker": "BCH",
"allow_slp_unsafe_conf": false,
"bchd_urls": [
"https://bchd.imaginary.cash:8335/"
"https://bchd.dragonhound.info"
],
"mode": {
"rpc": "Electrum",
"rpc_data": {
"servers": [
{
"url": "electrum1.cipig.net:10055"
"url": "bch.imaginary.cash:50002"
"protocol": "SSL",
},
{
"url": "cashnode.bch.ninja:50002",
"protocol": "SSL",
},
{
"url": "electrum3.cipig.net:20055",
Expand Down Expand Up @@ -139,14 +147,19 @@ The Komodo DeFi Framework supports Bitcoin Cash SLP tokens. Using this method, y
"ticker": "BCH",
"allow_slp_unsafe_conf": false,
"bchd_urls": [
"https://bchd.imaginary.cash:8335/"
"https://bchd.dragonhound.info"
],
"mode": {
"rpc": "Electrum",
"rpc_data": {
"servers": [
{
"url": "electrum1.cipig.net:10055"
"url": "bch.imaginary.cash:50002"
"protocol": "SSL",
},
{
"url": "cashnode.bch.ninja:50002",
"protocol": "SSL",
},
{
"url": "electrum3.cipig.net:20055",
Expand Down
Loading