mcps-sdk-js/dist/src/modules/bank.d.ts

MCPS JavaScript SDK

import { Client } from '../client';
import * as types from '../types';
import { SdkError } from '../errors';
/**
 * This module is mainly used to transfer coins between accounts,
 * query account balances, and provide common offline transaction signing and broadcasting methods.
 * In addition, the available units of tokens in the cosmos system are defined using [coin-type].
 *
 * @category Modules
 * @since v0.17
 */
export declare class Bank {
    /** @hidden */
    private client;
    /** @hidden */
    constructor(client: Client);
    /**
     * Query account info from blockchain
     * @param address Bech32 address
     * @returns
     * @since v0.17
     */
    queryAccount(address: string): Promise<types.Account>;
    /**
     * Send coins
     * @param to Recipient bech32 address
     * @param amount Coins to be sent
     * @param baseTx { types.BaseTx }
     * @returns
     * @since v0.17
     */
    send(to: string, amount: types.Coin[], baseTx: types.BaseTx): Promise<types.TxResult>;
    batch_send(to: string[], amount: types.Coin[], baseTx: types.BaseTx): Promise<types.TxResult>;
    /**
     * multiSend coins
     * @param to Recipient bech32 address
     * @param amount Coins to be sent
     * @param baseTx { types.BaseTx }
     * @returns
     * @since v0.17
     */
    multiSend(to: string, amount: types.Coin[], baseTx: types.BaseTx): Promise<types.TxResult>;
    /**
     * Balance queries the balance of a single coin for a single account.
     * @param address is the address to query balances for.
     * @param denom is the coin denom to query balances for.
     */
    queryBalance(address: string, denom: string): Promise<object>;
    /**
     * AllBalances queries the balance of all coins for a single account.
     * @param address is the address to query balances for.
     */
    queryAllBalances(address: string): Promise<object>;
    /**
     * TotalSupply queries the total supply of all coins.
     */
    queryTotalSupply(): Promise<object>;
    /**
     * SupplyOf queries the supply of a single coin.
     * @param denom is the coin denom to query balances for.
     */
    querySupplyOf(denom: string): Promise<object>;
    /**
     * Params queries the parameters of x/bank module.
     */
    queryParams(): Promise<object>;
    /**
     * Subscribe Send Txs
     * @param conditions Query conditions for the subscription
     * @param callback A function to receive notifications
     * @returns
     * @since v0.17
     */
    subscribeSendTx(conditions: {
        from?: string;
        to?: string;
    }, callback: (error?: SdkError, data?: types.EventDataMsgSend) => void): types.EventSubscription;
}