On this page

latest contributor to this doc

Last Edit:

@smk762

Enable

API-v1enable

Enables a coin using the native daemon or RPC method. This is used for UTXO-based coins, ETH/ERC20, and other gas model chains.

ParameterTypeRequiredDefaultDescription
coinstring-The 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_decimalsinteger8For 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.
gas_station_policy.policystringMeanAverageFastFor ETH/ERC20 and other gas model chains. Defines the method of gas price calculation from the station response. Value can be gas-station-policy-enum.
mm2integer-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
tx_historyboolfalseIf 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 method
required_confirmationsinteger3Number of confirmations for the Komodo DeFi Framework API to wait during the transaction steps of an atomic swap.
requires_notarizationbooleanfalseIf true, coins protected by Komodo Platform's dPoW security will wait for a notarization before progressing to the next atomic swap transactions step.

ParameterTypeDescription
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_confirmationsnumberKomodo DeFi Framework API will wait for 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

Enable Method

POST
enable
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "enable",
  "coin": "LTC"
}