@skalenetwork/ima-js/src/transactions.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 transactions.ts
 * @copyright SKALE Labs 2021-Present
 */

import {
    ethers, type Signer, Wallet, type Provider, type TransactionRequest,
    type TransactionResponse, type BrowserProvider
} from 'ethers';
import { Logger, type ILogObj } from 'tslog';

import * as constants from './constants';
import type TxOpts from './TxOpts';

const log = new Logger<ILogObj>();

export async function send (
    provider: Provider,
    transaction: TransactionRequest,
    opts: TxOpts,
    name: string,
    wait: boolean = true
): Promise<TransactionResponse> {
    transaction.value = opts.value ?? transaction.value;
    transaction.from = opts.address ?? transaction.from;

    const gasLimit = opts.customGasLimit ?? await provider.estimateGas(transaction);
    transaction.gasLimit = gasLimit;
    log.info('💡 ' + name + ' gasLimit: ' + gasLimit);

    const signer = await getSigner(provider, opts);

    log.info(`⏩ ${name} sending - from: ${transaction.from}, to: ${transaction.to as string}, value: ${transaction.value as string}`);
    const txResponse = await signer.sendTransaction(transaction);
    log.info(`⏳ ${name} mining - tx: ${txResponse.hash}, nonce: ${txResponse.nonce}, gasLimit: ${txResponse.gasLimit}`);
    if (wait) await provider.waitForTransaction(txResponse.hash);
    // todo: handle failed tx!
    log.info('✅ ' + name + ' mined - tx: ' + txResponse.hash);
    return txResponse;
}

async function getSigner (provider: Provider, opts: TxOpts): Promise<Signer> {
    let signer: Signer;
    if (opts.privateKey !== undefined && typeof opts.privateKey === 'string' && opts.privateKey.length > 0) {
        signer = new Wallet(opts.privateKey, provider);
    } else if (
        (provider as BrowserProvider).provider !== undefined
    ) {
        signer = await (provider as BrowserProvider).getSigner();
    } else {
        throw new Error('Invalid provider type, can not send transaction');
    }
    return signer;
}

export async function sendETH (
    provider: Provider,
    address: string,
    value: string,
    opts: TxOpts,
    wait: boolean = true
): Promise<TransactionResponse> {
    // TODO: add dry run!
    log.info('⏩ ' + ' sending ETH - from: ' + ', to: ' + address + ', value: ' + value);
    const signer = await getSigner(provider, opts);
    const txResponse = await signer.sendTransaction({
        to: address,
        value: ethers.parseEther(value)
    });
    log.info(`⏳ sending ETH - tx: ${txResponse.hash}, nonce: ${txResponse.nonce}, gasLimit: ${txResponse.gasLimit}`);
    if (wait) await txResponse.wait(constants.DEFAULT_CONFIRMATIONS_NUM);
    log.info('✅ ' + ' ETH sent - tx: ' + txResponse.hash);
    return txResponse;
}