The ActivationParams object defines additional parameters used for activation. These params may vary depending on the coin type.
Parameter
Type
Description
required_confirmations
integer
Optional. Confirmations to wait for steps in swap. Defaults to value in the coins file if not set.
requires_notarization
boolean
Optional, defaults to false. For dPoW protected coins, a true value will wait for transactions to be notarised when doing swaps. Overrides value if set in coins file.
mode
object
QTUM, UTXO & ZHTLC coins only. A standard ActivationMode object.
zcash_params_path
string
ZHTLC coins only. Path to folder containing Zcash parameters. Optional, defaults to standard location as defined in this guide
scan_blocks_per_iteration
integer
ZHTLC coins only. Sets the number of scanned blocks per iteration during BuildingWalletDb state. Optional, default value is 1000.
scan_interval_ms
integer
ZHTLC coins only. Sets the interval in milliseconds between iterations of BuildingWalletDb state. Optional, default value is 0.
tx_history
boolean
Optional. Enable transaction history scanning. When active, the Komodo DeFi Framework API will collect transaction history data for local storage, and allow use of the my_tx_history (v2) method.
min_addresses_number
integer
Optional, HD wallets only. Number of addresses to generate. If not specified, addresses will be generated up to path_to_address::address_index.
scan_policy
string
Optional, HD wallets only. Whether or not to scan for new addresses. Select from do_not_scan, scan_if_new_wallet or scan. Defaults to scan_if_new_wallet. Note that scan will result in multple requests to the Komodo DeFi API and may take some time to complete.
gap_limit
integer
Optional, HD wallets only. The max number of empty addresses in a row. Transactions sent to an address outside the gap_limit, will not be identified when scanning. Defaults to 20.
Optional, defaults to true. If false, coin and token balances will not be returned in the response, and the response will be returned more quickly.
For ZHTLC coins, older wallets need to set the sync_params field to a date before its
first transaction to see all balance and history. This may take a long time on the first
activation, but subsequent activations will be much faster.
Using a smaller scan_blocks_per_iteration and larger scan_interval_ms,
will reduce the average CPU load during ZHTLC coin activation (at the cost of a
longer activation time). These optional fields are recommended when developing
for iOS, where a high CPU load may kill the activation process. Android &
desktop operating systems do not appear to have any problems with high CPU
load during ZHTLC coin activation.
QTUM, BCH & UTXO coins only. A list of standard ActivationServers objects.
sync_params
integer or string
ZHTLC coins only. Optional, defaults to two days ago. Defines where to start scanning blockchain data upon initial activation. Options: "earliest" (the coin's sapling_activation_height), height (a specific block height) or date (a unix timestamp).
The AddressDerivationPath object defines the account / change / address_index of the derivation path used for your wallet. Using different values for account_id or address_id parameters will result in a different address and private key for each combination. The chain parameter is used to specify if the change from a transaction. Set to External for addresses that are intended to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used to return the leftover change from a transaction.
Parameter
Type
Description
account_id
integer
Optional, defaults to 0. Used as a layer of separation or hierarchy.
chain
string
Optional. Accepted values are External (0) and Internal (1). Defaults to External.
address_id
integer
Optional, defaults to 0. Used as a layer of separation or hierarchy.
The UtxoMergeParams object defines how often and at which thresholds to merge UTXOs. This is useful for wallets which have been used for a long time, and have many small UTXOs from mining activity.
Parameter
Type
Description
merge_at
integer
Mamimum UTXO count before merge loop is initiated.
check_every
integer
How frequently (in blocks) the wallet UTXO count is evaluated.
max_merge_at_once
integer
The maximum nouber of UTXOs to inlude as inputs for a merge transaction. Note that more input UTXOs means a larger transaction and greater fees, and that each blockchain has a limit to the maximum size of a transaction.
