Skip to content
Merged
Show file tree
Hide file tree
Changes from 34 commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
7feaf8b
rm obsolete methods
Apr 24, 2025
10e9f63
add `estimator_type` param to `get_eth_estimated_fee_per_gas`
Apr 24, 2025
167507e
rm references to obsolete gas estimation methods
Apr 24, 2025
08a132a
updates kdf postman collection
Apr 24, 2025
98cbe67
adds `task::enable_utxo::cancel`
Apr 24, 2025
aac914d
rm extraneous table row
Apr 24, 2025
b6077cc
adds `task::enable_bch::init`, `task::enable_bch::status`, `task::ena…
Apr 24, 2025
1d9c7cd
linting
Apr 24, 2025
4add2c8
adds `enable_tendermint` tasks
Apr 24, 2025
ebe3910
update postman collection
Apr 24, 2025
8b4450c
remove obsolete streaming config
Apr 29, 2025
fa93486
adds kdf streaming methods (network, heartbeat, balance)
Apr 29, 2025
15e1e1f
adds kdf streaming methods to postman collection (balance, network, h…
Apr 29, 2025
90bc1f0
adds `stream::fee_estimator::enable` to postman collection
Apr 30, 2025
13c57d6
update network_enable `always_send` param
Apr 30, 2025
37f2bc2
adds `stream::fee_estimator::enable`
Apr 30, 2025
c10cf2a
adds `stream::swap_status::enable` to postman collection
Apr 30, 2025
4522ea7
adds `stream::swap_status::enable` doc
Apr 30, 2025
de81f72
adds `stream::order_status::enable` to postman collection
Apr 30, 2025
1ebe8ef
adds `stream::order_status::enable` doc
Apr 30, 2025
ecf4ae7
adds `stream::orderbook::enable` to postman collection
Apr 30, 2025
da3fd16
adds `stream::orderbook::enable` doc
Apr 30, 2025
337be63
adds `stream::tx_history::enable` to postman collection
Apr 30, 2025
4378c3f
adds `stream::tx_history::enable` doc
Apr 30, 2025
3383c4d
balanceInfo -> BalanceInfo
May 1, 2025
6b17567
use common objects for task managed resp param tables
May 1, 2025
6c4837b
adds missing task managed activation methods to postman collection
May 1, 2025
85f7008
linting / fix broken links
May 2, 2025
0bbc206
move some common structures
May 2, 2025
f062c67
move common structurez
May 2, 2025
6bec594
alphabetic order for common structures > activation
May 2, 2025
13c8331
alphabetic order for common structures > orders
May 2, 2025
6583371
alphabetic order for common structures > wallet
May 2, 2025
dc1ebaa
linting
May 2, 2025
c127376
standardize task method urls
May 5, 2025
c004988
add note about single client `client_id` default
May 5, 2025
77befa0
grass or gas?
May 5, 2025
8ca44db
remove default for non-optional gas_estimator param
May 5, 2025
1def440
use consistent task_id values in examples
May 5, 2025
cbf6731
use localhost url for streaming
May 5, 2025
3c1b6fe
wont -> won't
May 5, 2025
aef5fb3
base fliped rel and no-one noticed.
May 5, 2025
bd009b7
adds `StreamingFeeConfig` common structure
May 5, 2025
88490a5
fix spelling error
May 5, 2025
218898c
use common structure for activation status resp
May 5, 2025
a61beeb
EvmNode -> CoinNode
May 5, 2025
76e29d2
rm extraneous link
May 5, 2025
698f01b
add stream data examples
May 5, 2025
7d3b9a0
Merge branch 'dev' into add/kdf/streaming-methods
May 5, 2025
5bd9934
fix address output
May 7, 2025
de7dee3
Merge branch 'dev' into add/kdf/streaming-methods
May 7, 2025
bdf9aa8
linting
May 7, 2025
af8e7a7
adds missing image import
May 7, 2025
b1e691f
add missing img import
May 7, 2025
8037302
fix parse issue on doc var
May 7, 2025
4bfc7a5
Merge branch 'dev' into add/kdf/streaming-methods
Jun 3, 2025
b675ee9
Merge branch 'dev' into add/kdf/streaming-methods
Jun 4, 2025
45d3ab5
Merge branch 'dev' into add/kdf/streaming-methods
Jun 5, 2025
02a3e4d
Merge branch 'dev' into add/kdf/streaming-methods
Jun 13, 2025
4b95698
linting
Jun 13, 2025
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
395 changes: 276 additions & 119 deletions filepathSlugs.json

Large diffs are not rendered by default.

13,914 changes: 9,775 additions & 4,139 deletions postman/collections/komodo_defi.postman_collection.json

Large diffs are not rendered by default.

65 changes: 57 additions & 8 deletions src/data/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -406,10 +406,22 @@
"title": "Overview",
"href": "/komodo-defi-framework/api/v20/coin_activation/task_managed/"
},
{
"title": "Task: Enable BCH",
"href": "/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_bch/"
},
{
"title": "Task: Enable ETH",
"href": "/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_eth/"
},
{
"title": "Task: Enable QTUM",
"href": "/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_qtum/"
},
{
"title": "Task: Enable Tendermint",
"href": "/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_tendermint/"
},
{
"title": "Task: Enable UTXO",
"href": "/komodo-defi-framework/api/v20/coin_activation/task_managed/task_enable_utxo/"
Expand Down Expand Up @@ -438,14 +450,6 @@
{
"title": "set_swap_transaction_fee_policy",
"href": "/komodo-defi-framework/api/v20/wallet/fee_management/set_swap_transaction_fee_policy/"
},
{
"title": "start_eth_fee_estimator",
"href": "/komodo-defi-framework/api/v20/wallet/fee_management/start_eth_fee_estimator/"
},
{
"title": "stop_eth_fee_estimator",
"href": "/komodo-defi-framework/api/v20/wallet/fee_management/stop_eth_fee_estimator/"
}
]
},
Expand Down Expand Up @@ -475,6 +479,51 @@
}
]
},
{
"title": "Streaming",
"links": [
{
"title": "Overview",
"href": "/komodo-defi-framework/api/v20/streaming/"
},
{
"title": "Enable Balance",
"href": "/komodo-defi-framework/api/v20/streaming/balance_enable/"
},
{
"title": "Enable Fee Estimator",
"href": "/komodo-defi-framework/api/v20/streaming/fee_estimator/"
},
{
"title": "Enable Heartbeat",
"href": "/komodo-defi-framework/api/v20/streaming/heartbeat_enable/"
},
{
"title": "Enable Network",
"href": "/komodo-defi-framework/api/v20/streaming/network_enable/"
},
{
"title": "Enable Orderbook",
"href": "/komodo-defi-framework/api/v20/streaming/orderbook_enable/"
},
{
"title": "Enable Order Status",
"href": "/komodo-defi-framework/api/v20/streaming/order_status_enable/"
},
{
"title": "Enable Swap Status",
"href": "/komodo-defi-framework/api/v20/streaming/swap_status_enable/"
},
{
"title": "Enable Transaction History",
"href": "/komodo-defi-framework/api/v20/streaming/tx_history_enable/"
},
{
"title": "Disable",
"href": "/komodo-defi-framework/api/v20/streaming/disable/"
}
]
},
{
"title": "Swaps & Orders",
"links": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,43 @@ export const description = "The Komodo DeFi SDK uses a variety of activation met

# Activation Structures

### ActivationMode

<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
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](/komodo-defi-framework/api/common_structures/activation/#activation-rpc-data) object. |

```json
{
"mode": {
"rpc": "Electrum",
"rpc_data": {
...
}
},
}
```
</CollapsibleSection>

### 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 | list of objects | ZHTLC only. A list of standard [ActivationServers](/komodo-defi-framework/api/common_structures/activation/#activation-servers) objects. |
| electrum | list of objects | QTUM, BCH & UTXO coins only. A list of standard [ActivationServers](/komodo-defi-framework/api/common_structures/activation/#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). |

<DevComment>
`electrum` and `electrum_servers` are both used for the same purpose. This should be consolidated in the API.
</DevComment>

### ActivationParams

The `ActivationParams` object defines additional parameters used for activation. These params may vary depending on the coin type.
Expand All @@ -20,6 +57,11 @@ The `ActivationParams` object defines additional parameters used for activation.
| 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, UTXO & ZHTLC coins only. A standard [ActivationMode](/komodo-defi-framework/api/common_structures/activation/#activation-mode) object. |

<DevComment>
Is priv\_key\_policy still a thing?
Defaults to `ContextPrivKey`. Set as `Trezor` to activate in Trezor mode.
</DevComment>

<Note>
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
Expand All @@ -32,30 +74,6 @@ The `ActivationParams` object defines additional parameters used for activation.
load during ZHTLC coin activation.
</Note>

### 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](/komodo-defi-framework/api/common_structures/activation/#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 | list of objects | ZHTLC only. A list of standard [ActivationServers](/komodo-defi-framework/api/common_structures/activation/#activation-servers) objects. |
| electrum | list of objects | QTUM, BCH & UTXO coins only. A list of standard [ActivationServers](/komodo-defi-framework/api/common_structures/activation/#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). |

<DevComment>
`electrum` and `electrum_servers` are both used for the same purpose. This should be consolidated in the API.
</DevComment>

### ActivationServers

Contains information electrum servers for coins being used in `Electrum` or `Light` mode.
Expand Down Expand Up @@ -144,63 +162,11 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig

The `EvmNode` object includes the following items for a given coin or token:

| Parameter | Type | Description |
| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------- |
| url | string | URL of an RPC node |
| komodo\_auth | boolean | Optional, defaults to `false`. Must be set to `true` to access RPC nodes run officially by the Komodo Platform team |

#### v2.1.0 (current release)

<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
```json
{
"url": "http://eth1.cipig.net:8555",
"komodo_proxy": false
}
```
</CollapsibleSection>

<Note>
Prior to the v2.2.0 release, the `gui_auth` field was used to access RPC nodes run officially by the Komodo Platform team. This field was replaced with the `komodo_proxy` field in the v2.2.0 release.
</Note>

#### v2.2.0+

<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
```json
{
"url": "https://nucleus-rpc.alpha.komodo.earth",
"komodo_proxy": true
}
```
</CollapsibleSection>

### TendermintNode

The `TendermintNode` object includes the following items for a given coin or token:

| Parameter | Type | Description |
| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| url | string | URL of an RPC node |
| komodo\_auth | boolean | Optional, defaults to `false`. Must be set to `true` to access RPC nodes run behind [komodo-defi-proxy](https://github.com/KomodoPlatform/komodo-defi-proxy) |

#### v2.1.0 (current release)

<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
```json
{
"url": "http://eth1.cipig.net:8555",
"komodo_proxy": false
}
```
</CollapsibleSection>

<Note>
Prior to the v2.2.0 release, the `gui_auth` field was used to access RPC nodes run officially by the Komodo Platform team. This field was replaced with the `komodo_proxy` field in the v2.2.0 release.
</Note>

#### v2.2.0+

<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
```json
{
Expand Down
Loading