On this page

latest contributor to this doc

Last Edit:

@gcharang

enable_tendermint_with_assets

Use this method to activate Tendermint coins (COSMOS/IRIS/OSMOSIS) and IBC assets in a single command.

ParameterTypeDescription
tickerstringTicker of the platform protocol coin. Options: ATOM, IRIS, OSMOSIS
mm2integerRequired 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
tokens_paramsarray of objectsA list of standard TokensRequest objects.
rpc_urlsarray of stringsv2.1.0 and earlier only. A list of RPC urls for Tendermint full node servers.
nodesarray of objectsv2.2.0+ only. A list of TendermintNode objects.
priv_key_policystringOptional, defaults to ContextPrivKey. value can be ContextPrivKey,Trezor when Komodo DeFi Framework is built for native platforms. value can be ContextPrivKey, Trezor, Metamask when the Komodo DeFi Framework is built targeting wasm
tx_historybooleanOptional, defaults to false. If 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_confirmationsintegerOptional, defaults to 3. When the platform coin is involved, the number of confirmations for the Komodo DeFi Framework API to wait during the transaction steps of an atomic swap
requires_notarizationbooleanOptional, 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.
get_balancesbooleanOptional, defaults to true. If false, coin and token balances will not be returned in the response, and the response will be returned more quickly.

ParameterTypeDescription
current_blockintegerBlock height of the coin being activated
tickerstringTicker of the platform protocol coin, as input in the request.
addressstringAn address for the activated coin
balanceobjectOnly returned when get_balances is true. A standard BalanceInfos object.
tokens_balancesarray of objectsOnly returned when get_balances is true. A list of standard AddressInfo objects, one for each token.
tokens_tickersarrayOnly returned when get_balances is false. A list of each token which was activated.

The rpc_urls parameter will be replaced with the nodes parameter in the kdf version 2.2.0 release. Instead of a list of url strings, the nodes parameter will be a list of TendermintNode objects.

POST
enable_tendermint_with_assets
{
  "method": "enable_tendermint_with_assets",
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "params": {
    "ticker": "IRIS",
    "tokens_params": [
      {
        "ticker": "ATOM-IBC_IRIS"
      }
    ],
    "rpc_urls": [
      "https://iris.komodo.earth/",
      "https://rpc.irishub-1.irisnet.org"
    ]
  }
}

POST
enable_tendermint_with_assets
{
  "method": "enable_tendermint_with_assets",
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "params": {
    "ticker": "IRIS",
    "tokens_params": [
      {
        "ticker": "ATOM-IBC_IRIS"
      }
    ],
    "rpc_urls": [
      "https://iris.komodo.earth/",
      "https://rpc.irishub-1.irisnet.org"
    ],
    "tx_history": true,
    "get_balances": false
  }
}

POST
enable_tendermint_with_assets
{
  "method": "enable_tendermint_with_assets",
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "params": {
    "ticker": "IRIS",
    "tokens_params": [
      {
        "ticker": "ATOM-IBC_IRIS"
      }
    ],
    "nodes": [
      {
        "url": "https://iris-rpc.alpha.komodo.earth/",
        "api_url": "https://iris-api.alpha.komodo.earth/",
        "grpc_url": "https://iris-grpc.alpha.komodo.earth/",
        "ws_url": "wss://iris-rpc.alpha.komodo.earth/websocket"
      },
      {
        "url": "https://rpc.irishub-1.irisnet.org",
        "komodo_auth": false
      }
    ]
  }
}