@skalenetwork/ima-js/src/contracts/mainnet/DepositBoxERC20.ts

Simple TS/JS library to interact with SKALE IMA

/**
 * @license
 * SKALE ima-js
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

/**
 * @file DepositBoxERC20.ts
 * @copyright SKALE Labs 2022-Present
 */

import { type TransactionResponse, type BigNumberish } from 'ethers';

import { DepositBox } from './DepositBox';
import * as transactions from '../../transactions';
import type TxOpts from '../../TxOpts';

export class DepositBoxERC20 extends DepositBox {
    async approve (
        tokenName: string,
        amount: BigNumberish,
        opts: TxOpts
    ): Promise<TransactionResponse> {
        const tokenContract = this.tokens[tokenName];
        const txData = await tokenContract.approve.populateTransaction(this.address, amount);
        return await transactions.send(this.provider, txData, opts, this.txName('approve'));
    }

    async deposit (
        chainName: string,
        tokenName: string,
        amount: bigint,
        opts: TxOpts
    ): Promise<TransactionResponse> {
        const tokenContract = this.tokens[tokenName];
        const tokenContractAddress = await tokenContract.getAddress();

        const txData = await this.contract.depositERC20.populateTransaction(
            chainName,
            tokenContractAddress,
            amount
        );
        return await transactions.send(this.provider, txData, opts, this.txName('depositERC20'));
    }

    async getTokenMappingsLength (chainName: string): Promise<number> {
        return await this.contract.getSchainToAllERC20Length(chainName);
    }

    async getTokenMappings (
        chainName: string,
        from: number,
        to: number
    ): Promise<string[]> {
        return await this.contract.getSchainToAllERC20(
            chainName,
            from,
            to
        );
    }

    async isTokenAdded (chainName: string, erc20OnMainnet: string): Promise<boolean> {
        return await this.contract.getSchainToERC20(chainName, erc20OnMainnet);
    }

    async addTokenByOwner (
        chainName: string,
        erc20OnMainnet: string,
        opts: TxOpts
    ): Promise<TransactionResponse> {
        const txData = await this.contract.addERC20TokenByOwner.populateTransaction(
            chainName,
            erc20OnMainnet
        );
        return await transactions.send(
            this.provider,
            txData,
            opts,
            this.txName('addERC20TokenByOwner')
        );
    }
}