Config

Details about Mystiko configuration and related interfaces.

Data Structure

• MystikoConfig
• CircuitConfig
• ChainConfig
• BridgeConfig
• DepositContractConfig
• PoolContractConfig
• ContractConfig

Get

Get MystikoConfig.

import mystiko from '@mystikonetwork/node';

const mystikoConfig = mystiko.config?.get();

MystikoConfig data structure is as follows:

Property	Type	Description
version	string	Mystiko version.
chainConfigs	{[key: string]: ChainConfig;}	Chain configs map, key is chain id.
bridgeConfigs	{[key: number]: BridgeConfig;}	Bridge configs map, key is bridge type.
gitRevision	string	Git revision.
sequencerConfig	ClientOptions	Sequencer config.
packerConfig	PackerConfig	Packer config.
countryBlacklist	string[]	Country blacklist.
circuitConfigs	CircuitConfig[]	Circuit configs.

CircuitConfig

CircuitConfig data structure is as follows:

Property	Type	Description
name	string	Circuit name.
circuitType	CircuitType	Circuit type.
isDefault	boolean	Is default circuit.
programFile	string[]	Program files.
abiFile	string[]	ABI files.
provingKeyFile	string[]	Proving key files.
verifyingKeyFile	string[]	Verifying key files.

FindDefaultCircuit

Find default circuit config by circuit type.

import mystiko from '@mystikonetwork/node';
import { common } from '@mystikonetwork/protos';

const circuitConfig = mystiko.config?.findDefaultCircuit(common.v1.CircuitType.ROLLUP_1);

List of supported CircuitType:

CircuitType.ROLLUP_1;
CircuitType.ROLLUP_2;
CircuitType.ROLLUP_4;
CircuitType.ROLLUP_8;
CircuitType.ROLLUP_16;
CircuitType.ROLLUP_32;
CircuitType.ROLLUP_64;
CircuitType.ROLLUP_128;
CircuitType.ROLLUP_256;
CircuitType.ROLLUP_512;
CircuitType.ROLLUP_1024;

CircuitType.TRANSACTION1X0;
CircuitType.TRANSACTION1X1;
CircuitType.TRANSACTION1X2;
CircuitType.TRANSACTION2X0;
CircuitType.TRANSACTION2X1;
CircuitType.TRANSACTION2X2;

FindCircuit

Find circuit config by circuit name.

import mystiko from '@mystikonetwork/node';
import { common } from '@mystikonetwork/protos';

const circuitConfig = mystiko.config?.findCircuit('zokrates-1.0-rollup1');

ChainConfig

ChainConfig data structure is as follows:

Property	Type	Description
chainId	bigint	Chain id.
name	string	Chain name.
assetSymbol	string	Native asset symbol.
assetDecimals	number	Native asset decimals.
explorerUrl	string	Explorer URL.
explorerApiUrl	string	Explorer API URL.
explorerPrefix	string	Explorer prefix.
providerQuorumPercentage	number	Provider quorum percentage.
signerEndpoint	string	Signer endpoint.
eventDelayBlocks	bigint	Event delay blocks.
eventFilterSize	bigint	Event filter size.
sequencerFetchSize	bigint	Sequencer fetch size.
mainAssetConfig	AssetConfig	Main asset config.
providerType	ProviderType	Provider type.
transactionType	TransactionType	Transaction type.
assetConfigs	{[key: string]: AssetConfig;}	Asset configs map, key is asset contract address.
depositContractConfigs	{[key: string]: DepositContractConfig;}	Deposit contract configs map, key is deposit contract address.
poolContractConfigs	{[key: string]: PoolContractConfig;}	Pool contract configs map, key is pool contract address.
recommendedAmounts	string[]	Recommended amounts.
providerConfigs	ProviderConfig[]	Provider configs.
granularities	bigint[]	Granularities.

FindChain

Find chain config by chain id.

import mystiko from '@mystikonetwork/node';

const chainConfig = mystiko.config?.findChain(BigInt(97));

FindPeerChains

Find peer chains by chain id.

import mystiko from '@mystikonetwork/node';

const chainConfigs = mystiko.config?.findPeerChains(BigInt(11155111));

FindAssetSymbols

Find asset symbols by chain id and peer chain id.

import mystiko from '@mystikonetwork/node';

const assetSymbols = mystiko.config?.findAssetSymbols(BigInt(97), BigInt(11155111));

FindBridges

Find bridge type by chain id, peer chain id and asset symbol.

import mystiko from '@mystikonetwork/node';

const bridges = mystiko.config?.findBridges(BigInt(97), BigInt(11155111), 'MTT');

FindBridge

Find bridge config by bridge type.

import mystiko from '@mystikonetwork/node';

const bridgeConfig = mystiko.config?.findBridge(common.v1.BridgeType.TBRIDGE);

List of supported BridgeType:

BridgeType.LOOP;
BridgeType.POLY;
BridgeType.TBRIDGE;
BridgeType.CELER;
BridgeType.LAYER_ZERO;
BridgeType.AXELAR;
BridgeType.WORMHOLE;

BridgeConfig data structure is as follows:

Property	Type	Description
name	string	Bridge name.
bridgeType	BridgeType	Bridge type.
explorerUrl	string	Explorer URL.
explorerPrefix	string	Explorer prefix.
apiUrl	string	API URL.
apiPrefix	string	API prefix.

DepositContractConfig

DepositContractConfig data structure is as follows:

Property	Type	Description
version	number	Deposit Contract Version.
name	string	Contract name.
address	string	Contract address.
startBlock	bigint	Start block.
disabled	boolean	Is disabled.
minAmount	string	Minimum amount.
maxAmount	string	Maximum amount.
poolContractConfig	PoolContractConfig	Pool contract config.
bridgeType	BridgeType	Bridge type.
contractType	ContractType	Contract type.
minBridgeFee	string	Minimum bridge fee.
minExecutorFee	string	Minimum executor fee.
serviceFee	number	Service fee.
serviceFeeDivider	number	Service fee divider.
bridgeFeeAssetConfig	AssetConfig	Bridge fee asset config.
executorFeeAssetConfig	AssetConfig	Executor fee asset config.
peerChainId	bigint	Peer chain id.
peerContractAddress	string	Peer contract address.

FindDepositContract

Find deposit contract config by chain id, peer chain id, asset symbol and bridge type.

import mystiko from '@mystikonetwork/node';

const depositContractConfig = mystiko.config?.findDepositContract(
    BigInt(11155111),
    BigInt(97),
    'MTT',
    common.v1.BridgeType.TBRIDGE,
);

FindDepositContractByAddress

Find deposit contract config by chain id and deposit contract address.

import mystiko from '@mystikonetwork/node';

const depositContractConfig = mystiko.config?.findDepositContractByAddress(
    BigInt(11155111),
    '0x643DD956aC516808538BF979b8440AbcebC3bcdA',
);

PoolContractConfig

PoolContractConfig data structure is as follows:

Property	Type	Description
version	number	Pool Contract Version.
name	string	Contract name.
address	string	Contract address.
startBlock	bigint	Start block.
poolName	string	Pool name.
minRollupFee	string	Minimum rollup fee.
contractType	ContractType	Contract type.
bridgeType	BridgeType	Bridge type.
assetConfig	AssetConfig	Asset config.
circuitConfigs	CircuitConfig[]	Circuit configs.
circuits	string[]	Circuits.

FindPoolContract

Find pool contract config by chain id, asset symbol, bridge type and version.

import mystiko from '@mystikonetwork/node';

const poolContractConfig = mystiko.config?.findPoolContract(BigInt(11155111), 'MTT', common.v1.BridgeType.TBRIDGE, 6);

FindPoolContracts

Find pool contracts by chain id, asset symbol and bridge type.

import mystiko from '@mystikonetwork/node';

const poolContractConfig = mystiko.config?.findPoolContracts(BigInt(11155111), 'MTT', common.v1.BridgeType.TBRIDGE);

FindPoolContractByAddress

Find pool contract config by chain id and pool contract address.

import mystiko from '@mystikonetwork/node';

const poolContractConfig = mystiko.config?.findPoolContractByAddress(
    BigInt(11155111),
    '0xAE77941b3bd4d2293E13A9a69E64A0ACFf5bBC55',
);

FindContractByAddress

Find contract config by chain id and contract address.

import mystiko from '@mystikonetwork/node';

const contractConfig = mystiko.config?.findContractByAddress(
    BigInt(11155111),
    '0xAE77941b3bd4d2293E13A9a69E64A0ACFf5bBC55',
);

ContractConfig data structure is as follows:

Property	Type	Description
version	number	Contract version.
name	string	Contract name.
address	string	Contract address.
startBlock	bigint	Start block.
disabled	boolean	Is disabled.
minRollupFee	string	Minimum rollup fee.
assetConfig	AssetConfig	Asset config.
bridgeType	BridgeType	Bridge type.
contractType	ContractType	Contract type.

List of supported ContractType:

ContractType.DEPOSIT;
ContractType.POOL;

GetTransactionUrl

Get transaction url by chain id and transaction hash.

import mystiko from '@mystikonetwork/node';

const txWithUrl = mystiko.config?.getTransactionUrl(BigInt(11155111), '0x1803ef0489ec2bda0abb7f564fa795959c0d1f4db7651236e34f879b317c074a');