Komodo DeFi API configuration#

Komodo DeFi-API configuration parameters, along with additional runtime flags, and per-process environment variables are listed in the source code, and can be viewed by running the ./kdf --help.

MM2.json#

When running the Komodo DeFi API via commandline with the kdf binary, some basic configuration parameters need to be defined in either an MM2.json file, or at runtime.

Configuration Parameters#

Example (allowing weak password):#

{
  "gui": "DEVDOCS_CLI",
  "netid": 8762,
  "seednodes": ["seed01.kmdefi.net", "seed02.kmdefi.net"],
  "rpc_password": "ENTER_UNIQUE_PASSWORD",
  "passphrase": "ENTER_UNIQUE_SEED_PHRASE_DONT_USE_THIS_CHANGE_IT_OR_FUNDS_NOT_SAFU",
  "allow_weak_password": true,
  "dbdir": "/path/to/DB/folder"
}

Example (not allowing weak password):#

{
  "gui": "DEVDOCS_CLI",
  "netid": 8762,
  "seednodes": ["seed01.kmdefi.net", "seed02.kmdefi.net"],
  "rpc_password": "Ent3r_Un1Qu3_Pa$$w0rd",
  "passphrase": "ENTER_UNIQUE_SEED_PHRASE_DONT_USE_THIS_CHANGE_IT_OR_FUNDS_NOT_SAFU",
  "allow_weak_password": false,
  "dbdir": "/path/to/DB/folder"
}

Example (using gas api):#

{
  "gui": "DEVDOCS_CLI",
  "netid": 8762,
  "seednodes": ["seed01.kmdefi.net", "seed02.kmdefi.net"],
  "rpc_password": "Ent3r_Un1Qu3_Pa$$w0rd",
  "passphrase": "ENTER_UNIQUE_SEED_PHRASE_DONT_USE_THIS_CHANGE_IT_OR_FUNDS_NOT_SAFU",
  "gas_api": {
    "provider": "infura",
    "url": https://your-provider-url.com
  }
}

Example (WSS with certificates):#

{
  "gui": "DEVDOCS_CLI",
  "netid": 8762,
  "seednodes": ["seed01.kmdefi.net", "seed02.kmdefi.net"],
  "rpc_password": "Ent3r_Un1Qu3_Pa$$w0rd",
  "passphrase": "ENTER_UNIQUE_SEED_PHRASE_DONT_USE_THIS_CHANGE_IT_OR_FUNDS_NOT_SAFU",
  "wss_certs": {
    "server_priv_key": "/path/to/privkey.pem",
    "certificate": "/path/to/fullchain.pem"
  }

}

Example with wallet_name and wallet_password#

{
  "gui": "DEVDOCS_CLI",
  "netid": 8762,
  "seednodes": ["seed01.kmdefi.net", "seed02.kmdefi.net"],
  "rpc_password": "Ent3r_Un1Qu3_Pa$$w0rd",
  "wallet_name": "Gringotts Retirement Fund",
  "wallet_password": "Q^wJZg~Ck3.tPW~asnM-WrL"
}

Example with 1inch_api#

{
  "gui": "DEVDOCS_CLI",
  "netid": 8762,
  "seednodes": ["seed01.kmdefi.net", "seed02.kmdefi.net"],
  "rpc_password": "Ent3r_Un1Qu3_Pa$$w0rd",
  "1inch_api": "https://api.1inch.dev"
}

Example with event streaming enabled#

{
  "gui": "DEVDOCS_CLI",
  "netid": 8762,
  "rpc_password": "Ent3r_Un1Qu3_Pa$$w0rd"
  "event_streaming_configuration": {
      "access_control_allow_origin": "*",
      "worker_path": "index.js"
  }
}

Example for HD Wallets:#

If you are using HD wallets, you will need to set enable_hd to true in to your MM2.json file.

{
  "gui": "DEVDOCS_CLI",
  "netid": 8762,
  "seednodes": ["seed01.kmdefi.net", "seed02.kmdefi.net"],
  "rpc_password": "Ent3r_Un1Qu3_Pa$$w0rd",
  "passphrase": "ENTER_UNIQUE_SEED_PHRASE_DONT_USE_THIS_CHANGE_IT_OR_FUNDS_NOT_SAFU",
  "allow_weak_password": false,
  "dbdir": "/path/to/DB/folder",
  "enable_hd": true
}

Examples for Seed nodes:#

For bootstrap nodes:

• set is_bootstrap_node to true.
• the seednodes list paramater is not required.
• the i_am_seed paramater must be set to true.
• the disable_p2p paramater must be set to false.

{
  "gui": "DEVDOCS_CLI",
  "netid": 8762,
  "seednodes": ["seed01.kmdefi.net", "seed02.kmdefi.net"],
  "is_bootstrap_node": true,
  "i_am_seed": true,
  "disable_p2p": false
}

For a normal seed node:

• set is_bootstrap_node to false.
• the seednodes list paramater is required.
• the i_am_seed paramater must be set to true.
• the disable_p2p paramater must be set to false.

{
  "gui": "DEVDOCS_CLI",
  "netid": 8762,
  "seednodes": ["seed01.kmdefi.net", "seed02.kmdefi.net"],
  "is_bootstrap_node": false,
  "i_am_seed": true,
  "disable_p2p": false
}

Some warning or errors may appear in logs on launch if these parameters are not set correctly.

• WARN P2P is disabled. Features that require a P2P network (like swaps, peer health checks, etc.) will not work.
• P2P initializing error: 'Precheck failed: 'Seed nodes cannot disable P2P.'
• P2P initializing error: 'Precheck failed: 'Bootstrap node must also be a seed node.'
• Precheck failed: 'Non-bootstrap node must have seed nodes configured to connect.'

Coins file configuration#

You can download and use this file as a starting point for your own coins file. It contains all of the coins that are currently supported by the Komodo DeFi API, and is maintained by the Komodo Platform team. The structure for adding additional coins can vary, please refer to the listing guide or contact the KomodoPlatform team for assistance.

Optional environment variables:#

What now?#

Check out the rest of the Komodo DeFi API documentation for examples of how to:

• Enable coins
• Place orders
• View the orderbook
• Check your balance
• Configure bot trading!

If you have any questions or feedback, join us on the Komodo Platform Discord Server and tell us about your experience!