latest contributor to this doc

Last Edit: @gcharang ,

Coin Activation

There are two methods of coin activation:

  • enable - Connects to a native daemon, or a url which handles RPCs for Platform coins (e.g. ETH, MATIC, FTM, BNB, ONE)
  • electrum - Connects to an electrum server for UTXO based coins and QTUM/QRC20 tokens.

A coin can only be activated once per session, and must be activated before it can be used in trading or wallet functions.

The KomoDeFi API requires an mm2 parameter to be set for each coin. This can be added to the enable/electrum command, or defined in your coins file.

The value of the mm2 parameter informs the software as to whether the coin is expected to be compatible for atomic swaps.

  • 0 = non-compatible
  • 1 = compatible

Many examples of activation commands are available at kmd.stats.io

If you are running a UTXO based coin daemon locally and the blockchain is synchronised, you can connect the local daemon to the KomoDeFi API by using the enable method, though some additional configuration is required. The KomoDeFi API requires the following options to be added to the native chain's .conf file.

logevents=1
txindex=1
addressindex=1

The KomoDeFi API node's coin address needs to be imported manually into the coin daemon using the importaddress method.

Activating coins in 'lite mode' means you don't need to have a native coin daemon installed, or keep a local blockchain synchronised. In this mode, the KomoDeFi API communicates with an external node to perform transactions and query the blockchain. UTXO based coins and QTUM/QRC20 tokens communicate via electrum servers, while other platform coins communicate via JSON RPC urls.

KomoDeFi is a true cross chain, cross protocol Decentralized Exchange (DEX), allowing for trades between coins and tokens across many platforms and ecosystems, such as:

Electrum mode is only available for UTXO based coins and QTUM/QRC20 tokens.

StructureTypeDescription
coinstringTicker of coin to activate
serversarray of objectsList of Electrum servers
servers.urlstringElectrum server URL
servers.protocolstring (optional, defaults to TCP)Transport protocol used by KomoDeFi API to connect to the electrum server (TCP or SSL)
servers.disable_cert_verificationbool (optional, defaults to false.)If true, this disables server SSL/TLS certificate verification (e.g. to use self-signed certificate). Use at your own risk
mm2integerRequired if not set in coins file. Informs the KomoDeFi API whether or not the coin is expected to function. Accepted values are 0 or 1
tx_historyboolIf true the KomoDeFi API will preload trasaction history as a background process. Must be set to true to use the my_tx_history method
required_confirmationsinteger (optional, defaults to 3)Number of confirmations for the KomoDeFi API to wait during the transaction steps of an atomic swap.
requires_notarizationboolean (optional, defaults to 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_addressstring (required for QRC20 only)address of etomic swap smart contract
fallback_swap_contractstring (required for QRC20 only)address of backup etomic swap smart contract
utxo_merge_paramsobject (optional)If set, will consolidate excessive UTXOs (e.g. from mining)
utxo_merge_params.merge_atintegerNumber of UTXOs in wallet required before merging
utxo_merge_params.check_everyintegerHow often to check the UTXO count, in seconds. Ideally should be at least 3x the coins block time.
utxo_merge_params.max_merge_at_onceintegerMaximum number of UTXOs to merge in each consolidation transaction. Should be less that merge_at value, but will fail if so high the transaction becomes too large. Suggested maximum is 250.

StructureTypeDescription
addressstringthe address of the user's coin wallet, based on the user's passphrase
balancestring (numeric)the amount of coin the user holds in their wallet; does not include unspendable_balance
unspendable_balancestring (numeric)the coin balance that is unspendable at the moment (e.g. if the address has immature UTXOs)
coinstringthe ticker of the enabled coin
required_confirmationsnumberthe number of transaction confirmations for which the KomoDeFi API must wait during the atomic swap process
mature_confirmationsnumber (optional)the number of coinbase transaction confirmations required to become mature; UTXO coins only
requires_notarizationboolwhether 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
resultstringthe result of the request; this value either indicates success, or an error, or another type of failure

legacyelectrum

Electrum Method

POST
electrum
{
  "coin": "LTC",
  "method": "electrum",
  "servers": [
    {
      "url": "electrum1.cipig.net:10063"
    },
    {
      "url": "electrum2.cipig.net:10063"
    },
    {
      "url": "electrum3.cipig.net:10063"
    }
  ],
  "userpass": "testpsw"
}
legacyelectrum

Electrum Method

POST
electrum
{
  "coin": "KMD",
  "method": "electrum",
  "servers": [
    {
      "url": "electrum1.cipig.net:10001"
    },
    {
      "url": "electrum2.cipig.net:10001"
    },
    {
      "url": "electrum3.cipig.net:10001"
    }
  ],
  "required_confirmations": 10,
  "requires_notarization": true,
  "mm2": 1,
  "userpass": "testpsw"
}
legacyelectrum

Electrum Method

POST
electrum
{
  "coin": "QTUM",
  "method": "electrum",
  "servers": [
    {
      "url": "electrum1.cipig.net:10050"
    },
    {
      "url": "electrum2.cipig.net:10050"
    },
    {
      "url": "electrum3.cipig.net:10050"
    }
  ],
  "swap_contract_address": "0x2f754733acd6d753731c00fee32cb484551cc15d",
  "userpass": "testpsw"
}

StructureTypeDescription
coinstringthe name of the coin the user desires to enable
urlsarray of strings (required for ETH/ERC20 and other gas model chains)urls of Ethereum RPC nodes to which the user desires to connect
swap_contract_addressstring (required for QRC20 only)address of etomic swap smart contract
fallback_swap_contractstring (required for QRC20 only)address of backup etomic swap smart contract
gas_station_decimalsinteger (optional for ETH/ERC20 and other gas model chains)Defines the decimals used to denominate the gas station response to gwei units. For example, the ETH gas station uses 8 decimals, which means that "average": 860 is equal to 86 gwei. While the Matic gas station uses 9 decimals, so 860 would mean 860 gwei exactly. Defaults to 8
gas_station_policy.policystring (optional for ETH/ERC20 and other gas model chains)Defines the method of gas price calculation from the station response. "MeanAverageFast" will use the mean between average and fast fields. "Average" will return a simple average value. Defaults to "MeanAverageFast".
mm2integerRequired if not set in coins file. Informs the KomoDeFi API whether or not the coin is expected to function. Accepted values are 0 or 1
tx_historyboolIf true the KomoDeFi API will preload transaction history as a background process. Must be set to true to use the my_tx_history method
required_confirmationsinteger (optional, defaults to 3)Number of confirmations for the KomoDeFi API to wait during the transaction steps of an atomic swap.
requires_notarizationboolean (optional, defaults to 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.

StructureTypeDescription
addressstringthe address of the user's coin wallet, based on the user's passphrase
balancestring (numeric)the amount of coin the user holds in their wallet; does not include unspendable_balance
unspendable_balancestring (numeric)the coin balance that is unspendable at the moment (e.g. if the address has immature UTXOs)
coinstringthe ticker of enabled coin
required_confirmationsnumberKomoDeFi API will wait for the this number of coin's transaction confirmations during the swap
requires_notarizationboolwhether the node must wait for a notarization of the selected coin that is performing the atomic swap transactions
mature_confirmationsnumber (optional)the number of coinbase transaction confirmations required to become mature; UTXO coins only
resultstringthe result of the request; this value either indicates success, or an error or other type of failure

legacyenable

Enable Method

POST
enable
{
  "userpass": "testpsw",
  "method": "enable",
  "coin": "TKL"
}

POST
enable
{
  "userpass": "testpsw",
  "method": "enable",
  "coin": "TKL",
  "mm2": 1,
  "required_confirmations": 10,
  "requires_notarization": true
}

POST
enable
{
  "coin": "ETH",
  "method": "enable",
  "urls": [
    "http://eth1.cipig.net:8555",
    "http://eth2.cipig.net:8555",
    "http://eth3.cipig.net:8555"
  ],
  "swap_contract_address": "0x24ABE4c71FC658C91313b6552cd40cD808b3Ea80",
  "fallback_swap_contract": "0x8500AFc0bc5214728082163326C2FF0C73f4a871",
  "userpass": "testpsw"
}
legacyenable

Enable Method

POST
enable
{
  "coin": "ETH",
  "userpass": "testpsw",
  "method": "enable",
  "urls": [
    "http://eth1.cipig.net:8555",
    "http://eth2.cipig.net:8555",
    "http://eth3.cipig.net:8555"
  ],
  "swap_contract_address": "0x24ABE4c71FC658C91313b6552cd40cD808b3Ea80",
  "fallback_swap_contract": "0x8500AFc0bc5214728082163326C2FF0C73f4a871",
  "gas_station_url": "https://ethgasstation.info/json/ethgasAPI.json",
  "gas_station_decimals": 8,
  "gas_station_policy": {
    "policy": "MeanAverageFast"
  }
}
legacyenable

Enable Method

POST
enable
{
  "coin": "NZDS-PLG20",
  "method": "enable",
  "swap_contract_address": "0x9130b257D37A52E52F21054c4DA3450c72f595CE",
  "fallback_swap_contract": "0x9130b257D37A52E52F21054c4DA3450c72f595CE",
  "urls": [
    "https://polygon-rpc.com"
  ],
  "userpass": "testpsw"
}
legacyenable

Enable Method

POST
enable
{
  "coin": "BUSD-BEP20",
  "method": "enable",
  "swap_contract_address": "0xeDc5b89Fe1f0382F9E4316069971D90a0951DB31",
  "fallback_swap_contract": "0xeDc5b89Fe1f0382F9E4316069971D90a0951DB31",
  "urls": [
    "http://bsc1.cipig.net:8655",
    "http://bsc2.cipig.net:8655",
    "http://bsc3.cipig.net:8655"
  ],
  "userpass": "testpsw"
}

For enabling Z coins, refer to the Z coin tasks in the v2.0 Dev API.

To see more examples for other platforms like Fantom, Avalanche & Harmony, you can search the KomoDeFi API Coin Activation Commands List or build a single batch command to enable a set of selected coins via the Batch Coin Activation Form

We welcome volunteers to test new coins for KomoDeFi API compatibility! Follow the Submitting Coin Test Results guide for more information, or drop into the Komodo Platform Discord Server for a chat if you need some help.