Deposit

Mystiko Deposit Related APIs.

quote

Retrieve quote information for a deposit.

import mystiko from '@mystikonetwork/browser';
import { BridgeType } from '@mystikonetwork/config';

const depositQuote = await mystiko.deposits?.quote({
    srcChainId: 11155111,
    dstChainId: 97,
    assetSymbol: 'MTT',
    bridge: BridgeType.TBRIDGE,
});

DepositQuoteOptions:

Parameter	Required	Description
srcChainId	true	Source chain id.
dstChainId	true	Asset symbol.
assetSymbol	true	Asset symbol.
bridge	true	Bridge type.

DepositQuote data structure is as follows:

Property	Type	Description
minAmount	number	Minimum amount.
maxAmount	number	Maximum amount.
minRollupFeeAmount	number	Minimum rollup fee amount.
rollupFeeAssetSymbol	string	Rollup fee asset symbol.
minBridgeFeeAmount	number	Minimum bridge fee amount.
bridgeFeeAssetSymbol	string	Bridge fee asset symbol.
minExecutorFeeAmount	number	Minimum executor fee amount.
executorFeeAssetSymbol	string	Executor fee asset symbol.
recommendedAmounts	number[]	Recommended amounts.
isScreeningEnabled	bool	Is screening enabled.

summary

Retrieve summary information for a deposit.

import mystiko from '@mystikonetwork/browser';

const depositSummary = await mystiko.deposits?.summary({
    srcChainId: 11155111,
    dstChainId: 97,
    assetSymbol: 'MTT',
    bridge: BridgeType.TBRIDGE,
    amount: 10,
    rollupFee: 1,
    bridgeFee: 0.01,
    executorFee: 0.1,
    shieldedAddress: account.shieldedAddress,
});

create

Create a Deposit request.

import mystiko from '@mystikonetwork/browser';

const deposit = await mystiko.deposits?.create({
    srcChainId: 11155111,
    dstChainId: 97,
    assetSymbol: 'MTT',
    bridge: BridgeType.TBRIDGE,
    amount: 10,
    rollupFee: 1,
    bridgeFee: 0.01,
    executorFee: 0.1,
    shieldedAddress: account.shieldedAddress,
    signer: privatKeySigner
});

find

Query deposit data using Filter.

import mystiko from '@mystikonetwork/browser';

const deposits = await mystiko.deposits?.find({ selector: { chainId: 97 } });

findOne

Find a single Deposit record using Filter.

import mystiko from '@mystikonetwork/browser';

const deposits = await mystiko.deposits?.findOne('depositId');

count

Query the count of data that matches Filter.

import mystiko from '@mystikonetwork/browser';

const counter = await mystiko.deposits?.count({ selector: { chainId: 11155111 } });
const total = await mystiko.deposits?.count();

update

Update a Deposit record.

import mystiko from '@mystikonetwork/browser';

const newDeposit = await mystiko.deposits?.update('depositId', {transactionHash: '0x....'});

fixStatus

Fix a Deposit status.

import mystiko from '@mystikonetwork/browser';

const newDeposit = await mystiko.deposits?.fixStatus('depositId');