@skalenetwork/ima-js
Version:
Simple TS/JS library to interact with SKALE IMA
86 lines (85 loc) • 4.6 kB
JavaScript
/**
* @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 } from 'ethers';
import { TokenManager } from './TokenManager';
import * as constants from '../../constants';
import * as transactions from '../../transactions';
export class TokenManagerERC20 extends TokenManager {
tokenMappingLenghtSlot = constants.TOKEN_MANAGER_ERC20_MAPPING_LENGTH_SLOT;
async addTokenByOwner(originChainName, erc20OnMainnet, erc20OnSchain, opts) {
const txData = await this.contract.addERC20TokenByOwner.populateTransaction(originChainName, erc20OnMainnet, erc20OnSchain);
return await transactions.send(this.provider, txData, opts, this.txName('addERC20TokenByOwner'));
}
async getTokenCloneAddress(originTokenAddress, originChainName = constants.MAINNET_CHAIN_NAME) {
return await this.contract.clonesErc20(ethers.solidityPackedKeccak256(['string'], [originChainName]), originTokenAddress);
}
async approve(tokenName, amount, address, opts) {
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, amount, opts) {
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, amount, opts) {
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, opts) {
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, opts) {
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, amount, opts) {
const txData = await this.contract.exitToMainERC20.populateTransaction(mainnetTokenAddress, amount);
return await transactions.send(this.provider, txData, opts, this.txName('exitToMainERC20'));
}
async transferToSchain(targetSchainName, mainnetTokenAddress, amount, opts) {
const txData = await this.contract.transferToSchainERC20.populateTransaction(targetSchainName, mainnetTokenAddress, amount);
return await transactions.send(this.provider, txData, opts, this.txName('transferToSchainERC20'));
}
}