2598371834

Build Type

github

Committed by GitHub

Commit Message

Merge 3e173b5ae into 71eebf429

Pull Request Pull Request #123: Add support for Klaytn, SFI

Run Details

25 of 38 branches covered (65.79%)

Branch coverage included in aggregate %.

8 of 93 new or added lines in 9 files covered. (8.6%)

4942 existing lines in 20 files now uncovered.

1431 of 6477 relevant lines covered (22.09%)

0.43 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.05

/src/common/gasoptions.ts

import {chainSupportsEIP1559} from "@chainid";
import {BigNumber, BigNumberish} from "@ethersproject/bignumber";
import type {PopulatedTransaction} from "@ethersproject/contracts";

import {parseUnits} from "@ethersproject/units";

/**
 * This interface allows for passing custom options for transaction gas fees.
 * Note: all values must be passed as GWei.
 *
 * @see {@link https://eips.ethereum.org/EIPS/eip-1559|EIP-1559} for more information regarding EIP-1559.
 *
 * @param {BigNumber} gasPrice For chains which don't support EIP-1559,
 * `gasPrice` controls the price in GWei per unit of gas used by a transaction.
 * @param {BigNumber} gasLimit Maximum number of gas units a transaction is allowed to use.
 * @param {BigNumber} maxFeePerGas For chains which do support EIP-1559,
 * `maxFeePerGas` controls the maximum fee in GWei which a sender is willing to pay per unit of gas used by a transaction.
 * @param {BigNumber} maxPriorityFeePerGas For chains which do support EIP-1559,
 * `maxPriorityFeePerGas` controls the fee in GWei which a sender is willing to pay block miners or validators to have their
 * transaction included in an upcoming block. Defaults to 1.5 GWei.
 */
export interface GasOptions {
    gasPrice?:             BigNumber;
    gasLimit?:             BigNumber;
    maxFeePerGas?:         BigNumber;
    maxPriorityFeePerGas?: BigNumber;
}

/**
 * This interface partially implements the Overrides interface which can be passed to
 * Ethers.js Transaction functions.
 *
 * @param {BigNumberish | Promise<BigNumberish>} gasPrice For chains which don't support EIP-1559,
 * `gasPrice` controls the price in GWei per unit of gas used by a transaction.
 * @param {BigNumberish | Promise<BigNumberish>} gasLimit Maximum number of gas units a transaction is allowed to use.
 * @param {BigNumberish | Promise<BigNumberish>} maxFeePerGas For chains which do support EIP-1559,
 * `maxFeePerGas` controls the maximum fee in GWei which a sender is willing to pay per unit of gas used by a transaction.
 * @param {BigNumberish | Promise<BigNumberish>} maxPriorityFeePerGas For chains which do support EIP-1559,
 * `maxPriorityFeePerGas` controls the fee in GWei which a sender is willing to pay block miners or validators to have their
 * transaction included in an upcoming block. Defaults to 1.5 GWei.
 */
export interface TransactionGasOverrides {
    gasLimit?:             BigNumberish | Promise<BigNumberish>;
    gasPrice?:             BigNumberish | Promise<BigNumberish>;
    maxFeePerGas?:         BigNumberish | Promise<BigNumberish>;
    maxPriorityFeePerGas?: BigNumberish | Promise<BigNumberish>;
}

/* c8 ignore next */
export function makeGwei(n: string): BigNumber { return parseUnits(n, "gwei") }

/**
 * populateGasOptions adds gas limit, fee, and/or price options as provided in the `gasOptions` parameter to a built,
 * but as of yet unsent {@link PopulatedTransaction} object.
 *
 * @param {PopulatedTransaction} txn Ethers.js {@link PopulatedTransaction} object to add gas params to.
 * @param {GasOptions} gasOptions Gas limit/fee/price options for {@link PopulatedTransaction} objects.
 * @param {number} chainId Chain ID of the network which `txn` will be sent on, used for determining EIP-1559 support.
 * @param {boolean} ignoreLimit Optional. If set to `true`, the `gasLimit` field of `gasOptions` is entirely ignored.
 *
 * @return {PopulatedTransaction} Transaction object as passed as a param, but with any of `gasPrice`, `gasLimit`,
 * `maxFeePerGas`, and `maxPriorityFeePerGas` respectively set to values provided in `gasOptions`.
 */
export function populateGasOptions(
    txn:                  PopulatedTransaction,
    gasOptions:  GasOptions,
    chainId:     number,
    ignoreLimit: boolean = false
): PopulatedTransaction {
    if (!chainSupportsEIP1559(chainId)) {
        if (gasOptions?.gasPrice) {
            txn.gasPrice = gasOptions.gasPrice;
        }
    } else {
        if (gasOptions?.maxFeePerGas) {
            txn.maxFeePerGas = gasOptions.maxFeePerGas;
        }

        if (gasOptions?.maxPriorityFeePerGas) {
            txn.maxPriorityFeePerGas = gasOptions.maxPriorityFeePerGas;
        }
    }

    if (!ignoreLimit) {
        if (gasOptions?.gasLimit) {
            txn.gasLimit = gasOptions.gasLimit;
        }
    }

    return txn
}

/* c8 ignore start */
export function makeTransactionGasOverrides(
    gasOptions:  GasOptions,
    chainId:     number,
    ignoreLimit: boolean = false
): TransactionGasOverrides {
    let overrides: TransactionGasOverrides = {};

    if (!chainSupportsEIP1559(chainId)) {
        if (gasOptions?.gasPrice) {
            overrides.gasPrice = gasOptions.gasPrice;
        }
    } else {
        if (gasOptions?.maxFeePerGas) {
            overrides.maxFeePerGas = gasOptions.maxFeePerGas;
        }

        if (gasOptions?.maxPriorityFeePerGas) {
            overrides.maxPriorityFeePerGas = gasOptions.maxPriorityFeePerGas;
        }
    }

    if (!ignoreLimit) {
        if (gasOptions?.gasLimit) {
            overrides.gasLimit = gasOptions.gasLimit;
        }
    }

    return overrides
}
/* c8 ignore stop */

1	import {chainSupportsEIP1559} from "@chainid";	2✔
2	import {BigNumber, BigNumberish} from "@ethersproject/bignumber";	2✔
3	import type {PopulatedTransaction} from "@ethersproject/contracts";	2✔
4		2✔
5	import {parseUnits} from "@ethersproject/units";	2✔
6		2✔
7	/**	2✔
8	* This interface allows for passing custom options for transaction gas fees.	2✔
9	* Note: all values must be passed as GWei.	2✔
10	*	2✔
11	* @see {@link https://eips.ethereum.org/EIPS/eip-1559\|EIP-1559} for more information regarding EIP-1559.	2✔
12	*	2✔
13	* @param {BigNumber} gasPrice For chains which don't support EIP-1559,	2✔
14	* `gasPrice` controls the price in GWei per unit of gas used by a transaction.	2✔
15	* @param {BigNumber} gasLimit Maximum number of gas units a transaction is allowed to use.	2✔
16	* @param {BigNumber} maxFeePerGas For chains which do support EIP-1559,	2✔
17	* `maxFeePerGas` controls the maximum fee in GWei which a sender is willing to pay per unit of gas used by a transaction.	2✔
18	* @param {BigNumber} maxPriorityFeePerGas For chains which do support EIP-1559,	2✔
19	* `maxPriorityFeePerGas` controls the fee in GWei which a sender is willing to pay block miners or validators to have their	2✔
20	* transaction included in an upcoming block. Defaults to 1.5 GWei.	2✔
21	*/	2✔
22	export interface GasOptions {	2✔
23	gasPrice?: BigNumber;	2✔
24	gasLimit?: BigNumber;	2✔
25	maxFeePerGas?: BigNumber;	2✔
26	maxPriorityFeePerGas?: BigNumber;	2✔
27	}	2✔
28		2✔
29	/**	2✔
30	* This interface partially implements the Overrides interface which can be passed to	2✔
31	* Ethers.js Transaction functions.	2✔
32	*	2✔
33	* @param {BigNumberish \| Promise<BigNumberish>} gasPrice For chains which don't support EIP-1559,	2✔
34	* `gasPrice` controls the price in GWei per unit of gas used by a transaction.	2✔
35	* @param {BigNumberish \| Promise<BigNumberish>} gasLimit Maximum number of gas units a transaction is allowed to use.	2✔
36	* @param {BigNumberish \| Promise<BigNumberish>} maxFeePerGas For chains which do support EIP-1559,	2✔
37	* `maxFeePerGas` controls the maximum fee in GWei which a sender is willing to pay per unit of gas used by a transaction.	2✔
38	* @param {BigNumberish \| Promise<BigNumberish>} maxPriorityFeePerGas For chains which do support EIP-1559,	2✔
39	* `maxPriorityFeePerGas` controls the fee in GWei which a sender is willing to pay block miners or validators to have their	2✔
40	* transaction included in an upcoming block. Defaults to 1.5 GWei.	2✔
41	*/	2✔
42	export interface TransactionGasOverrides {	2✔
43	gasLimit?: BigNumberish \| Promise<BigNumberish>;	2✔
44	gasPrice?: BigNumberish \| Promise<BigNumberish>;	2✔
45	maxFeePerGas?: BigNumberish \| Promise<BigNumberish>;	2✔
46	maxPriorityFeePerGas?: BigNumberish \| Promise<BigNumberish>;	2✔
47	}	2✔
48		2✔
49	/* c8 ignore next */	2✔
50	export function makeGwei(n: string): BigNumber { return parseUnits(n, "gwei") }	2✔
51		2✔
52	/**	2✔
53	* populateGasOptions adds gas limit, fee, and/or price options as provided in the `gasOptions` parameter to a built,	2✔
54	* but as of yet unsent {@link PopulatedTransaction} object.	2✔
55	*	2✔
56	* @param {PopulatedTransaction} txn Ethers.js {@link PopulatedTransaction} object to add gas params to.	2✔
57	* @param {GasOptions} gasOptions Gas limit/fee/price options for {@link PopulatedTransaction} objects.	2✔
58	* @param {number} chainId Chain ID of the network which `txn` will be sent on, used for determining EIP-1559 support.	2✔
59	* @param {boolean} ignoreLimit Optional. If set to `true`, the `gasLimit` field of `gasOptions` is entirely ignored.	2✔
60	*	2✔
61	* @return {PopulatedTransaction} Transaction object as passed as a param, but with any of `gasPrice`, `gasLimit`,	2✔
62	* `maxFeePerGas`, and `maxPriorityFeePerGas` respectively set to values provided in `gasOptions`.	2✔
63	*/	2✔
64	export function populateGasOptions(	2✔
UNCOV 65	txn: PopulatedTransaction,	×
UNCOV 66	gasOptions: GasOptions,	×
UNCOV 67	chainId: number,	×
UNCOV 68	ignoreLimit: boolean = false	×
UNCOV 69	): PopulatedTransaction {	×
UNCOV 70	if (!chainSupportsEIP1559(chainId)) {	×
UNCOV 71	if (gasOptions?.gasPrice) {	×
UNCOV 72	txn.gasPrice = gasOptions.gasPrice;	×
UNCOV 73	}	×
UNCOV 74	} else {	×
UNCOV 75	if (gasOptions?.maxFeePerGas) {	×
UNCOV 76	txn.maxFeePerGas = gasOptions.maxFeePerGas;	×
UNCOV 77	}	×
UNCOV 78		×
UNCOV 79	if (gasOptions?.maxPriorityFeePerGas) {	×
UNCOV 80	txn.maxPriorityFeePerGas = gasOptions.maxPriorityFeePerGas;	×
UNCOV 81	}	×
UNCOV 82	}	×
UNCOV 83		×
UNCOV 84	if (!ignoreLimit) {	×
UNCOV 85	if (gasOptions?.gasLimit) {	×
UNCOV 86	txn.gasLimit = gasOptions.gasLimit;	×
UNCOV 87	}	×
UNCOV 88	}	×
UNCOV 89		×
UNCOV 90	return txn	×
UNCOV 91	}	×
92		2✔
93	/* c8 ignore start */	2✔
94	export function makeTransactionGasOverrides(	2✔
95	gasOptions: GasOptions,	2✔
96	chainId: number,	2✔
97	ignoreLimit: boolean = false	2✔
98	): TransactionGasOverrides {	2✔
99	let overrides: TransactionGasOverrides = {};	2✔
100		2✔
101	if (!chainSupportsEIP1559(chainId)) {	2✔
102	if (gasOptions?.gasPrice) {	2✔
103	overrides.gasPrice = gasOptions.gasPrice;	2✔
104	}	2✔
105	} else {	2✔
106	if (gasOptions?.maxFeePerGas) {	2✔
107	overrides.maxFeePerGas = gasOptions.maxFeePerGas;	2✔
108	}	2✔
109		2✔
110	if (gasOptions?.maxPriorityFeePerGas) {	2✔
111	overrides.maxPriorityFeePerGas = gasOptions.maxPriorityFeePerGas;	2✔
112	}	2✔
113	}	2✔
114		2✔
115	if (!ignoreLimit) {	2✔
116	if (gasOptions?.gasLimit) {	2✔
117	overrides.gasLimit = gasOptions.gasLimit;	2✔
118	}	2✔
119	}	2✔
120		2✔
121	return overrides	2✔
122	}	2✔
123	/* c8 ignore stop */	2✔

synapsecns / sdk / 2598371834

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous