@skalenetwork/ima-js/src/contracts/schain/TokenManagerERC20.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 TokenManagerERC20.ts
 * @copyright SKALE Labs 2022-Present
 */

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

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

export class TokenManagerERC20 extends TokenManager {
    tokenMappingLenghtSlot = constants.TOKEN_MANAGER_ERC20_MAPPING_LENGTH_SLOT;

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

    async getTokenCloneAddress (
        originTokenAddress: string,
        originChainName: string = constants.MAINNET_CHAIN_NAME
    ): Promise<string> {
        return await this.contract.clonesErc20(
            ethers.solidityPackedKeccak256(['string'], [originChainName]),
            originTokenAddress
        );
    }

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

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

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

    /**
     * Funds an exit for the given token by sending a transaction.
     * @param tokenName - The name of the token for which the exit is to be funded.
     * @param opts - Transaction options including the value to be sent as part of the transaction.
     * @returns Promise<any> - The Promise that resolves to the transaction receipt.
     * @remarks
     * This is a payable transaction and the value should be passed in the opts object.
     * This function can be executed only for supported tokens.
     */
    async fundExit (tokenName: string, opts: TxOpts): Promise<any> {
        const tokenContract = this.tokens[tokenName];
        const txData = await tokenContract.fundExit.populateTransaction();
        return await transactions.send(this.provider, txData, opts, this.txName('fundExit'));
    }

    /**
     * Reverses a previously funded exit for the given token by sending a transaction.
     * @param tokenName - The name of the token for which the exit is to be undone.
     * @param opts - Transaction options.
     * @returns Promise<any> - The Promise that resolves to the transaction receipt.
     * @remarks
     * This function can be executed only for supported tokens.
     */
    async undoExit (tokenName: string, opts: TxOpts): Promise<any> {
        const tokenContract = this.tokens[tokenName];
        const txData = await tokenContract.undoExit.populateTransaction();
        return await transactions.send(this.provider, txData, opts, this.txName('undoExit'));
    }

    async withdraw (
        mainnetTokenAddress: string,
        amount: bigint,
        opts: TxOpts
    ): Promise<TransactionResponse> {
        const txData = await this.contract.exitToMainERC20.populateTransaction(
            mainnetTokenAddress,
            amount
        );
        return await transactions.send(this.provider, txData, opts, this.txName('exitToMainERC20'));
    }

    async transferToSchain (
        targetSchainName: string,
        mainnetTokenAddress: string,
        amount: BigNumberish,
        opts: TxOpts
    ): Promise<TransactionResponse> {
        const txData = await this.contract.transferToSchainERC20.populateTransaction(
            targetSchainName,
            mainnetTokenAddress,
            amount
        );
        return await transactions.send(
            this.provider,
            txData,
            opts,
            this.txName('transferToSchainERC20')
        );
    }
}