Electrum
API-v1electrum
Activates a coin using the Electrum method. This is used for UTXO-based coins and QTUM/QRC20 tokens.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| coin | string | ✓ | - | Ticker of coin to activate |
| servers | list of objects | ✓ | - | A list of standard ActivationServers objects. |
| 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 |
| min_connected | integer | ✗ | 1 | Minimum number of electrum servers to maintain an active connection to. |
| max_connected | integer | ✗ | - | Maximum number of electrum servers to maintain an active connection to. If not set, defaults to all servers in activation request. |
| required_confirmations | integer | ✗ | 3 | Number of confirmations for the Komodo DeFi Framework API to wait during the transaction steps of an atomic swap. |
| requires_notarization | boolean | ✗ | false | If true, coins protected by Komodo Platform's dPoW security will wait for a notarization before progressing to the next atomic swap transactions step. |
| swap_contract_address | string | ✗ | - | QRC20 only. Address of etomic swap smart contract |
| fallback_swap_contract | string | ✗ | - | QRC20 only. Address of backup etomic swap smart contract |
| utxo_merge_params | object | ✗ | - | A standard UtxoMergeParams object. Used to reduce a wallet's UTXO count in cases where it is causing significantly slower RPC responses. |
| Parameter | Type | Description |
|---|---|---|
| address | string | The address of the user's coin wallet, based on the user's passphrase |
| balance | string (numeric) | The amount of coin the user holds in their wallet; does not include unspendable_balance |
| unspendable_balance | string (numeric) | The coin balance that is unspendable at the moment (e.g. if the address has immature UTXOs) |
| coin | string | The ticker of the enabled coin |
| required_confirmations | number | The number of transaction confirmations for which the Komodo DeFi Framework API must wait during the atomic swap process |
| mature_confirmations | number (optional) | The number of coinbase transaction confirmations required to become mature; UTXO coins only |
| requires_notarization | bool | Whether the node must wait for a notarization of the selected coin that is performing the atomic swap transactions; applicable only for coins using Komodo dPoW |
| result | string | The result of the request; this value either indicates success, or an error, or another type of failure |
Electrum Method
POST
electrum{
"coin": "LTC",
"method": "electrum",
"servers": [
{
"url": "electrum1.cipig.net:10063",
"protocol": "TCP"
},
{
"url": "electrum2.cipig.net:20063",
"protocol": "SSL",
"disable_cert_verification": true
},
{
"url": "electrum3.cipig.net:20063",
"protocol": "SSL",
"ws_url": "electrum3.cipig.net:30063"
}
],
"min_connected": 1,
"max_connected": 2,
"userpass": "RPC_UserP@SSW0RD"
}