@1inch/solidity-utils 4.0.0 → 4.1.0

package/dist/src/profileEVM.d.ts

@@ -2,14 +2,40 @@
 /// <reference types="node" />
 import { PathLike, promises as fs } from 'fs';
 import { JsonRpcProvider } from 'ethers';
+/**
+ * @category profileEVM
+ * @dev Default configuration options for the `gasspectEVM` function to analyze gas usage in EVM transactions.
+ * @property minOpGasCost The minimal gas cost of operations to be returned in the analysis. Defaults to 300, filtering out less costly operations for clarity.
+ * @property args Boolean indicating whether to return the arguments of each operation in the analysis. Defaults to `false`, omitting arguments for simplicity.
+ * @property res Boolean indicating whether to return the results of each operation in the analysis. Defaults to `false`, omitting results to focus on gas usage.
+ */
 export declare const gasspectOptionsDefault: {
     minOpGasCost: number;
     args: boolean;
     res: boolean;
 };
+/**
+ * @category profileEVM
+ * @notice Profiles EVM execution by counting occurrences of specified instructions in a transaction's execution trace.
+ * @param provider An Ethereum provider capable of sending custom RPC requests.
+ * @param txHash The hash of the transaction to profile.
+ * @param instruction An array of EVM instructions (opcodes) to count within the transaction's execution trace.
+ * @param optionalTraceFile An optional file path or handle where the full transaction trace will be saved.
+ * @return An array of numbers representing the counts of each instruction specified, in the order they were provided.
+ */
 export declare function profileEVM(provider: JsonRpcProvider | {
     send: (method: string, params: unknown[]) => Promise<any>;
 }, txHash: string, instruction: string[], optionalTraceFile?: PathLike | fs.FileHandle): Promise<number[]>;
+/**
+ * @category profileEVM
+ * @notice Performs gas analysis on EVM transactions, highlighting operations that exceed a specified gas cost.
+ * Analyzes gas usage by operations within a transaction, applying filters and formatting based on options.
+ * @param provider The Ethereum JSON RPC provider or any custom provider with a `send` method.
+ * @param txHash Transaction hash to analyze.
+ * @param gasspectOptions Analysis configuration, specifying filters and formatting for gas analysis. See `gasspectOptionsDefault` for default values.
+ * @param optionalTraceFile Optional path or handle to save the detailed transaction trace.
+ * @return A detailed string array of operations meeting the criteria set in `gasspectOptions`.
+ */
 export declare function gasspectEVM(provider: JsonRpcProvider | {
     send: (method: string, params: unknown[]) => Promise<any>;
 }, txHash: string, gasspectOptions?: Record<string, unknown>, optionalTraceFile?: PathLike | fs.FileHandle): Promise<string[]>;

package/dist/src/profileEVM.js

@@ -2,11 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.gasspectEVM = exports.profileEVM = exports.gasspectOptionsDefault = void 0;
 const fs_1 = require("fs");
+/**
+ * @category profileEVM
+ * @dev Default configuration options for the `gasspectEVM` function to analyze gas usage in EVM transactions.
+ * @property minOpGasCost The minimal gas cost of operations to be returned in the analysis. Defaults to 300, filtering out less costly operations for clarity.
+ * @property args Boolean indicating whether to return the arguments of each operation in the analysis. Defaults to `false`, omitting arguments for simplicity.
+ * @property res Boolean indicating whether to return the results of each operation in the analysis. Defaults to `false`, omitting results to focus on gas usage.
+ */
 exports.gasspectOptionsDefault = {
-    minOpGasCost: 300, // minimal gas cost of returned operations
-    args: false, // return operations arguments
-    res: false, // return operations results
+    minOpGasCost: 300,
+    args: false,
+    res: false,
 };
+/** @internal */
 function _normalizeOp(ops, i) {
     if (ops[i].op === 'STATICCALL') {
         ops[i].gasCost = ops[i].gasCost - ops[i + 1].gas;
@@ -68,6 +76,15 @@ function _normalizeOp(ops, i) {
         ops[i].res = ops[i + 1].stack[ops[i + 1].stack.length - 1];
     }
 }
+/**
+ * @category profileEVM
+ * @notice Profiles EVM execution by counting occurrences of specified instructions in a transaction's execution trace.
+ * @param provider An Ethereum provider capable of sending custom RPC requests.
+ * @param txHash The hash of the transaction to profile.
+ * @param instruction An array of EVM instructions (opcodes) to count within the transaction's execution trace.
+ * @param optionalTraceFile An optional file path or handle where the full transaction trace will be saved.
+ * @return An array of numbers representing the counts of each instruction specified, in the order they were provided.
+ */
 async function profileEVM(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 provider, txHash, instruction, optionalTraceFile) {
@@ -81,6 +98,16 @@ provider, txHash, instruction, optionalTraceFile) {
     });
 }
 exports.profileEVM = profileEVM;
+/**
+ * @category profileEVM
+ * @notice Performs gas analysis on EVM transactions, highlighting operations that exceed a specified gas cost.
+ * Analyzes gas usage by operations within a transaction, applying filters and formatting based on options.
+ * @param provider The Ethereum JSON RPC provider or any custom provider with a `send` method.
+ * @param txHash Transaction hash to analyze.
+ * @param gasspectOptions Analysis configuration, specifying filters and formatting for gas analysis. See `gasspectOptionsDefault` for default values.
+ * @param optionalTraceFile Optional path or handle to save the detailed transaction trace.
+ * @return A detailed string array of operations meeting the criteria set in `gasspectOptions`.
+ */
 async function gasspectEVM(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 provider, txHash, gasspectOptions = {}, optionalTraceFile) {

package/dist/src/profileEVM.js.map

@@ -1 +1 @@
-{"version":3,"file":"profileEVM.js","sourceRoot":"","sources":["../../src/profileEVM.ts"],"names":[],"mappings":";;;AAAA,2BAA8C;AAGjC,QAAA,sBAAsB,GAAG;IAClC,YAAY,EAAE,GAAG,EAAE,0CAA0C;IAC7D,IAAI,EAAE,KAAK,EAAE,8BAA8B;IAC3C,GAAG,EAAE,KAAK,EAAE,4BAA4B;CAC3C,CAAC;AAcF,SAAS,YAAY,CAAC,GAAS,EAAE,CAAS;IACtC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,YAAY,EAAE,CAAC;QAC7B,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAEjD,IACI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;YACvB,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,kEAAkE,EAC9G,CAAC;YACC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,sBAAsB,CAAC;QACvC,CAAC;aAAM,IACH,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;YACvB,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,kEAAkE,EAC7G,CAAC;YACC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,aAAa,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QACpF,CAAC;aAAM,CAAC;YACJ,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG;gBACV,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC1D,IAAI;oBACA,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC;yBAChB,IAAI,CAAC,EAAE,CAAC;yBACR,MAAM,CACH,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EACjD,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACpD;aACZ,CAAC;YACF,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE,CAAC;gBACzB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;YACtB,CAAC;QACL,CAAC;IACL,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACjE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG;YACV,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1D,IAAI;gBACA,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC;qBAChB,IAAI,CAAC,EAAE,CAAC;qBACR,MAAM,CACH,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EACjD,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACpD;SACZ,CAAC;QACF,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACjD,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE3D,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE,CAAC;YACzB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;QACtB,CAAC;IACL,CAAC;IACD,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAC5D,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAChD,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QAC7D,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,EAAE,CAAC;YACzB,GAAG,CAAC,CAAC,CAAC,CAAC,IAAK,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE,CAAC;YACzB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;QACtB,CAAC;QACD,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;YAC1B,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;QACtB,CAAC;QAED,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC/D,CAAC;IACL,CAAC;IACD,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,aAAa,EAAE,CAAC;QAC9B,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3E,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC/D,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,UAAU;AAC5B,8DAA8D;AAC9D,QAAyF,EACzF,MAAc,EAAE,WAAqB,EACrC,iBAA4C;IAE5C,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtE,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAElC,IAAI,iBAAiB,EAAE,CAAC;QACpB,MAAM,aAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC7B,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACP,CAAC;AAjBD,gCAiBC;AAEM,KAAK,UAAU,WAAW;AAC7B,8DAA8D;AAC9D,QAAyF,EACzF,MAAc,EACd,kBAA2C,EAAE,EAC7C,iBAA4C;IAE5C,MAAM,OAAO,GAAG,EAAE,GAAG,8BAAsB,EAAE,GAAG,eAAe,EAAE,CAAC;IAElE,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtE,MAAM,GAAG,GAAS,KAAK,CAAC,UAAU,CAAC;IAEnC,MAAM,YAAY,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7B,KAAK,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;QAClC,EAAE,CAAC,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACjE,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAErB,IAAI,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;YACrC,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;YAC3C,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1B,CAAC;QAED,IAAI,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;YACrC,YAAY,CAAC,GAAG,EAAE,CAAC;QACvB,CAAC;IACL,CAAC;IAED,MAAM,MAAM,GAAG,GAAG;SACb,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC;SACjD,GAAG,CACA,CAAC,EAAE,EAAE,EAAE,CACH,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;QACzB,GAAG;QACH,EAAE,CAAC,EAAE;QACL,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,KAAK;QACL,EAAE,CAAC,OAAO,CACjB,CAAC;IAEN,IAAI,iBAAiB,EAAE,CAAC;QACpB,MAAM,aAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AA9CD,kCA8CC"}
+{"version":3,"file":"profileEVM.js","sourceRoot":"","sources":["../../src/profileEVM.ts"],"names":[],"mappings":";;;AAAA,2BAA8C;AAG9C;;;;;;GAMG;AACU,QAAA,sBAAsB,GAAG;IAClC,YAAY,EAAE,GAAG;IACjB,IAAI,EAAE,KAAK;IACX,GAAG,EAAE,KAAK;CACb,CAAC;AAcF,gBAAgB;AAChB,SAAS,YAAY,CAAC,GAAS,EAAE,CAAS;IACtC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,YAAY,EAAE,CAAC;QAC7B,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAEjD,IACI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;YACvB,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,kEAAkE,EAC9G,CAAC;YACC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,sBAAsB,CAAC;QACvC,CAAC;aAAM,IACH,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;YACvB,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,kEAAkE,EAC7G,CAAC;YACC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,aAAa,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QACpF,CAAC;aAAM,CAAC;YACJ,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG;gBACV,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC1D,IAAI;oBACA,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC;yBAChB,IAAI,CAAC,EAAE,CAAC;yBACR,MAAM,CACH,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EACjD,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACpD;aACZ,CAAC;YACF,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE,CAAC;gBACzB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;YACtB,CAAC;QACL,CAAC;IACL,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACjE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG;YACV,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1D,IAAI;gBACA,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC;qBAChB,IAAI,CAAC,EAAE,CAAC;qBACR,MAAM,CACH,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EACjD,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACpD;SACZ,CAAC;QACF,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACjD,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE3D,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE,CAAC;YACzB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;QACtB,CAAC;IACL,CAAC;IACD,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAC5D,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAChD,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QAC7D,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,EAAE,CAAC;YACzB,GAAG,CAAC,CAAC,CAAC,CAAC,IAAK,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE,CAAC;YACzB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;QACtB,CAAC;QACD,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;YAC1B,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;QACtB,CAAC;QAED,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC/D,CAAC;IACL,CAAC;IACD,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,aAAa,EAAE,CAAC;QAC9B,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3E,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC/D,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,UAAU;AAC5B,8DAA8D;AAC9D,QAAyF,EACzF,MAAc,EAAE,WAAqB,EACrC,iBAA4C;IAE5C,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtE,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAElC,IAAI,iBAAiB,EAAE,CAAC;QACpB,MAAM,aAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC7B,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACP,CAAC;AAjBD,gCAiBC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,WAAW;AAC7B,8DAA8D;AAC9D,QAAyF,EACzF,MAAc,EACd,kBAA2C,EAAE,EAC7C,iBAA4C;IAE5C,MAAM,OAAO,GAAG,EAAE,GAAG,8BAAsB,EAAE,GAAG,eAAe,EAAE,CAAC;IAElE,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtE,MAAM,GAAG,GAAS,KAAK,CAAC,UAAU,CAAC;IAEnC,MAAM,YAAY,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7B,KAAK,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;QAClC,EAAE,CAAC,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACjE,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAErB,IAAI,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;YACrC,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;YAC3C,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1B,CAAC;QAED,IAAI,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;YACrC,YAAY,CAAC,GAAG,EAAE,CAAC;QACvB,CAAC;IACL,CAAC;IAED,MAAM,MAAM,GAAG,GAAG;SACb,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC;SACjD,GAAG,CACA,CAAC,EAAE,EAAE,EAAE,CACH,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;QACzB,GAAG;QACH,EAAE,CAAC,EAAE;QACL,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,KAAK;QACL,EAAE,CAAC,OAAO,CACjB,CAAC;IAEN,IAAI,iBAAiB,EAAE,CAAC;QACpB,MAAM,aAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AA9CD,kCA8CC"}

package/dist/src/utils.d.ts

@@ -18,15 +18,62 @@ interface DeployContractOptions {
     log?: boolean;
     waitConfirmations?: number;
 }
+/**
+ * @category utils
+ * @notice Deploys a contract with optional Etherscan verification.
+ * @param contractName Name of the contract to deploy.
+ * @param constructorArgs Arguments for the contract's constructor.
+ * @param deployments Deployment facilitator object from Hardhat.
+ * @param deployer Address deploying the contract.
+ * @param deploymentName Optional custom name for deployment; defaults to contract name.
+ * @param skipVerify Skips Etherscan verification if true.
+ * @param skipIfAlreadyDeployed Avoids redeployment if contract already deployed.
+ * @param gasPrice, maxPriorityFeePerGas, maxFeePerGas Gas strategy options.
+ * @param log Toggles deployment logging.
+ * @param waitConfirmations Number of confirmations to wait based on network. Ussually it's need for waiting before Etherscan verification.
+ * @returns The deployed contract instance.
+ */
 export declare function deployAndGetContract({ contractName, constructorArgs, deployments, deployer, deploymentName, skipVerify, skipIfAlreadyDeployed, gasPrice, maxPriorityFeePerGas, maxFeePerGas, log, waitConfirmations, }: DeployContractOptions): Promise<Contract>;
+/**
+ * @category utils
+ * @notice Advances the blockchain time to a specific timestamp for testing purposes.
+ * @param seconds Target time in seconds or string format to increase to.
+ */
 export declare function timeIncreaseTo(seconds: number | string): Promise<void>;
+/**
+ * @category utils
+ * @notice Deploys a contract given a name and optional constructor parameters.
+ * @param name The contract name.
+ * @param parameters Constructor parameters for the contract.
+ * @returns The deployed contract instance.
+ */
 export declare function deployContract(name: string, parameters?: Array<BigNumberish>): Promise<BaseContract>;
+/**
+ * @category utils
+ * @notice Deploys a contract from bytecode, useful for testing and deployment of minimal proxies.
+ * @param abi Contract ABI.
+ * @param bytecode Contract bytecode.
+ * @param parameters Constructor parameters.
+ * @param signer Optional signer object.
+ * @returns The deployed contract instance.
+ */
 export declare function deployContractFromBytecode(abi: any[], bytecode: BytesLike, parameters?: Array<BigNumberish>, signer?: Signer): Promise<BaseContract>;
 type Token = {
     balanceOf: (address: string) => Promise<bigint>;
     getAddress: () => Promise<string>;
 };
 type TrackReceivedTokenAndTxResult = [bigint, ContractTransactionReceipt | TrackReceivedTokenAndTxResult];
+/**
+ * @category utils
+ * @notice Tracks token balance changes and transaction receipts for specified wallet addresses during test scenarios.
+ * It could be used recursively for multiple tokens via specific `txPromise` function.
+ * @param provider JSON RPC provider or custom provider object.
+ * @param token Token contract instance or ETH address constants.
+ * @param wallet Wallet address to track.
+ * @param txPromise Function returning a transaction promise.
+ * @param args Arguments for the transaction promise function.
+ * @returns Tuple of balance change and transaction receipt.
+ */
 export declare function trackReceivedTokenAndTx<T extends unknown[]>(provider: JsonRpcProvider | {
     getBalance: (address: string) => Promise<bigint>;
 }, token: Token | {
@@ -34,11 +81,43 @@ export declare function trackReceivedTokenAndTx<T extends unknown[]>(provider: J
 } | {
     address: typeof constants.EEE_ADDRESS;
 }, wallet: string, txPromise: (...args: T) => Promise<ContractTransactionResponse | TrackReceivedTokenAndTxResult>, ...args: T): Promise<TrackReceivedTokenAndTxResult>;
+/**
+ * @category utils
+ * @notice Corrects the ECDSA signature 'v' value according to Ethereum's standard.
+ * @param signature The original signature string.
+ * @returns The corrected signature string.
+ */
 export declare function fixSignature(signature: string): string;
+/**
+ * @category utils
+ * @notice Signs a message with a given signer and fixes the signature format.
+ * @param signer Signer object or wallet instance.
+ * @param messageHex The message to sign, in hex format.
+ * @returns The signed message string.
+ */
 export declare function signMessage(signer: Wallet | {
     signMessage: (messageHex: string | Uint8Array) => Promise<string>;
 }, messageHex?: string | Uint8Array): Promise<string>;
+/**
+ * @category utils
+ * @notice Counts the occurrences of specified EVM instructions in a transaction's execution trace.
+ * @param provider JSON RPC provider or custom provider object.
+ * @param txHash Transaction hash to analyze.
+ * @param instructions Array of EVM instructions (opcodes) to count.
+ * @returns Array of instruction counts.
+ */
 export declare function countInstructions(provider: JsonRpcProvider | {
     send: (method: string, params: unknown[]) => Promise<any>;
 }, txHash: string, instructions: string[]): Promise<number[]>;
+/**
+ * @category utils
+ * @notice Retrieves the current USD price of ETH or another specified native token.
+ * This helper function is designed for use in test environments to maintain stability against market fluctuations.
+ * It fetches the current price of ETH (or a specified native token for side chains) in USD from the Coinbase API to
+ * ensure that tests remain stable and unaffected by significant market price fluctuations when token price is
+ * important part of test.
+ * @param nativeTokenSymbol The symbol of the native token for which the price is being fetched, defaults to 'ETH'.
+ * @return The price of the specified native token in USD, scaled by 1e18 to preserve precision.
+ */
+export declare function getEthPrice(nativeTokenSymbol?: string): Promise<bigint>;
 export {};

package/dist/src/utils.js

@@ -1,11 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.countInstructions = exports.signMessage = exports.fixSignature = exports.trackReceivedTokenAndTx = exports.deployContractFromBytecode = exports.deployContract = exports.timeIncreaseTo = exports.deployAndGetContract = void 0;
+exports.getEthPrice = exports.countInstructions = exports.signMessage = exports.fixSignature = exports.trackReceivedTokenAndTx = exports.deployContractFromBytecode = exports.deployContract = exports.timeIncreaseTo = exports.deployAndGetContract = void 0;
 const tslib_1 = require("tslib");
 require("@nomicfoundation/hardhat-ethers"); // required to populate the HardhatRuntimeEnvironment with ethers
 const hardhat_1 = tslib_1.__importStar(require("hardhat"));
 const hardhat_network_helpers_1 = require("@nomicfoundation/hardhat-network-helpers");
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const prelude_1 = require("./prelude");
+/**
+ * @category utils
+ * @notice Deploys a contract with optional Etherscan verification.
+ * @param contractName Name of the contract to deploy.
+ * @param constructorArgs Arguments for the contract's constructor.
+ * @param deployments Deployment facilitator object from Hardhat.
+ * @param deployer Address deploying the contract.
+ * @param deploymentName Optional custom name for deployment; defaults to contract name.
+ * @param skipVerify Skips Etherscan verification if true.
+ * @param skipIfAlreadyDeployed Avoids redeployment if contract already deployed.
+ * @param gasPrice, maxPriorityFeePerGas, maxFeePerGas Gas strategy options.
+ * @param log Toggles deployment logging.
+ * @param waitConfirmations Number of confirmations to wait based on network. Ussually it's need for waiting before Etherscan verification.
+ * @returns The deployed contract instance.
+ */
 async function deployAndGetContract({ contractName, constructorArgs, deployments, deployer, deploymentName = contractName, skipVerify = false, skipIfAlreadyDeployed = true, gasPrice, maxPriorityFeePerGas, maxFeePerGas, log = true, waitConfirmations = prelude_1.constants.DEV_CHAINS.includes(hardhat_1.default.network.name) ? 1 : 6, }) {
     /**
      * Deploys contract and tries to verify it on Etherscan if requested.
@@ -38,12 +54,24 @@ async function deployAndGetContract({ contractName, constructorArgs, deployments
     return await hardhat_1.ethers.getContractAt(contractName, deployResult.address);
 }
 exports.deployAndGetContract = deployAndGetContract;
+/**
+ * @category utils
+ * @notice Advances the blockchain time to a specific timestamp for testing purposes.
+ * @param seconds Target time in seconds or string format to increase to.
+ */
 async function timeIncreaseTo(seconds) {
     const delay = 1000 - new Date().getMilliseconds();
     await new Promise((resolve) => setTimeout(resolve, delay));
     await hardhat_network_helpers_1.time.increaseTo(seconds);
 }
 exports.timeIncreaseTo = timeIncreaseTo;
+/**
+ * @category utils
+ * @notice Deploys a contract given a name and optional constructor parameters.
+ * @param name The contract name.
+ * @param parameters Constructor parameters for the contract.
+ * @returns The deployed contract instance.
+ */
 async function deployContract(name, parameters = []) {
     const ContractFactory = await hardhat_1.ethers.getContractFactory(name);
     const instance = await ContractFactory.deploy(...parameters);
@@ -51,6 +79,15 @@ async function deployContract(name, parameters = []) {
     return instance;
 }
 exports.deployContract = deployContract;
+/**
+ * @category utils
+ * @notice Deploys a contract from bytecode, useful for testing and deployment of minimal proxies.
+ * @param abi Contract ABI.
+ * @param bytecode Contract bytecode.
+ * @param parameters Constructor parameters.
+ * @param signer Optional signer object.
+ * @returns The deployed contract instance.
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 async function deployContractFromBytecode(abi, bytecode, parameters = [], signer) {
     const ContractFactory = await hardhat_1.ethers.getContractFactory(abi, bytecode, signer);
@@ -59,6 +96,17 @@ async function deployContractFromBytecode(abi, bytecode, parameters = [], signer
     return instance;
 }
 exports.deployContractFromBytecode = deployContractFromBytecode;
+/**
+ * @category utils
+ * @notice Tracks token balance changes and transaction receipts for specified wallet addresses during test scenarios.
+ * It could be used recursively for multiple tokens via specific `txPromise` function.
+ * @param provider JSON RPC provider or custom provider object.
+ * @param token Token contract instance or ETH address constants.
+ * @param wallet Wallet address to track.
+ * @param txPromise Function returning a transaction promise.
+ * @param args Arguments for the transaction promise function.
+ * @returns Tuple of balance change and transaction receipt.
+ */
 async function trackReceivedTokenAndTx(provider, token, wallet, txPromise, ...args) {
     const tokenAddress = 'address' in token ? token.address : await token.getAddress();
     const isETH = tokenAddress === prelude_1.constants.ZERO_ADDRESS || tokenAddress === prelude_1.constants.EEE_ADDRESS;
@@ -73,6 +121,12 @@ async function trackReceivedTokenAndTx(provider, token, wallet, txPromise, ...ar
     return [postBalance - preBalance + txFees, 'wait' in txResponse ? txReceipt : txResponse];
 }
 exports.trackReceivedTokenAndTx = trackReceivedTokenAndTx;
+/**
+ * @category utils
+ * @notice Corrects the ECDSA signature 'v' value according to Ethereum's standard.
+ * @param signature The original signature string.
+ * @returns The corrected signature string.
+ */
 function fixSignature(signature) {
     // in geth its always 27/28, in ganache its 0/1. Change to 27/28 to prevent
     // signature malleability if version is 0/1
@@ -85,10 +139,25 @@ function fixSignature(signature) {
     return signature.slice(0, 130) + vHex;
 }
 exports.fixSignature = fixSignature;
+/**
+ * @category utils
+ * @notice Signs a message with a given signer and fixes the signature format.
+ * @param signer Signer object or wallet instance.
+ * @param messageHex The message to sign, in hex format.
+ * @returns The signed message string.
+ */
 async function signMessage(signer, messageHex = '0x') {
     return fixSignature(await signer.signMessage(messageHex));
 }
 exports.signMessage = signMessage;
+/**
+ * @category utils
+ * @notice Counts the occurrences of specified EVM instructions in a transaction's execution trace.
+ * @param provider JSON RPC provider or custom provider object.
+ * @param txHash Transaction hash to analyze.
+ * @param instructions Array of EVM instructions (opcodes) to count.
+ * @returns Array of instruction counts.
+ */
 async function countInstructions(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 provider, txHash, instructions) {
@@ -99,4 +168,26 @@ provider, txHash, instructions) {
     });
 }
 exports.countInstructions = countInstructions;
+/**
+ * @category utils
+ * @notice Retrieves the current USD price of ETH or another specified native token.
+ * This helper function is designed for use in test environments to maintain stability against market fluctuations.
+ * It fetches the current price of ETH (or a specified native token for side chains) in USD from the Coinbase API to
+ * ensure that tests remain stable and unaffected by significant market price fluctuations when token price is
+ * important part of test.
+ * @param nativeTokenSymbol The symbol of the native token for which the price is being fetched, defaults to 'ETH'.
+ * @return The price of the specified native token in USD, scaled by 1e18 to preserve precision.
+ */
+async function getEthPrice(nativeTokenSymbol = 'ETH') {
+    const response = await (0, node_fetch_1.default)(`https://api.coinbase.com/v2/prices/${nativeTokenSymbol}-USD/spot`);
+    let amount = 0n;
+    try {
+        amount = BigInt(parseFloat((await response.json()).data.amount) * 1e18);
+    }
+    catch {
+        throw new Error('Failed to parse price from Coinbase API');
+    }
+    return amount;
+}
+exports.getEthPrice = getEthPrice;
 //# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;;AAAA,2CAAyC,CAAE,iEAAiE;AAC5G,2DAAsC;AACtC,sFAAgE;AAIhE,uCAAsC;AAkB/B,KAAK,UAAU,oBAAoB,CAAC,EACvC,YAAY,EACZ,eAAe,EACf,WAAW,EACX,QAAQ,EACR,cAAc,GAAG,YAAY,EAC7B,UAAU,GAAG,KAAK,EAClB,qBAAqB,GAAG,IAAI,EAC5B,QAAQ,EACR,oBAAoB,EACpB,YAAY,EACZ,GAAG,GAAG,IAAI,EACV,iBAAiB,GAAG,mBAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,iBAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvD;IACpB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;IAE/B,MAAM,aAAa,GAAkB;QACjC,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,YAAY;QACtB,qBAAqB;QACrB,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE;QAC9B,oBAAoB,EAAE,oBAAoB,EAAE,QAAQ,EAAE;QACtD,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE;QACtC,GAAG;QACH,iBAAiB;KACpB,CAAC;IACF,MAAM,YAAY,GAAiB,MAAM,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IAE/E,IAAI,CAAC,CAAC,UAAU,IAAI,mBAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,iBAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACnE,MAAM,iBAAG,CAAC,GAAG,CAAC,eAAe,EAAE;YAC3B,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,oBAAoB,EAAE,eAAe;SACxC,CAAC,CAAC;IACP,CAAC;SAAM,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,MAAM,gBAAM,CAAC,aAAa,CAAC,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;AAC1E,CAAC;AA5CD,oDA4CC;AAEM,KAAK,UAAU,cAAc,CAAC,OAAwB;IACzD,MAAM,KAAK,GAAG,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3D,MAAM,8BAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAJD,wCAIC;AAEM,KAAK,UAAU,cAAc,CAAC,IAAY,EAAE,aAAkC,EAAE;IACnF,MAAM,eAAe,GAAG,MAAM,gBAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC;IAC7D,MAAM,QAAQ,CAAC,iBAAiB,EAAE,CAAC;IACnC,OAAO,QAAQ,CAAC;AACpB,CAAC;AALD,wCAKC;AAED,8DAA8D;AACvD,KAAK,UAAU,0BAA0B,CAAC,GAAU,EAAE,QAAmB,EAAE,aAAkC,EAAE,EAAE,MAAe;IACnI,MAAM,eAAe,GAAG,MAAM,gBAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC/E,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC;IAC7D,MAAM,QAAQ,CAAC,iBAAiB,EAAE,CAAC;IACnC,OAAO,QAAQ,CAAC;AACpB,CAAC;AALD,gEAKC;AASM,KAAK,UAAU,uBAAuB,CACzC,QAAgF,EAChF,KAAqG,EACrG,MAAc,EACd,SAA+F,EAC/F,GAAG,IAAO;IAEV,MAAM,YAAY,GAAG,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;IACnF,MAAM,KAAK,GAAG,YAAY,KAAK,mBAAS,CAAC,YAAY,IAAI,YAAY,KAAK,mBAAS,CAAC,WAAW,CAAC;IAChG,MAAM,UAAU,GAAG,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAE3G,MAAM,UAAU,GAAW,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;IACpD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,MAAM,IAAI,UAAU,CAAC,CAAC,CAAC,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAA+B,CAAC;IAC/G,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,KAAK,SAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK;QAC1E,CAAC,CAAC,SAAU,CAAC,OAAO,GAAG,SAAU,CAAC,QAAQ;QAC1C,CAAC,CAAC,EAAE,CAAC;IACT,MAAM,WAAW,GAAW,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;IACrD,OAAO,CAAC,WAAW,GAAG,UAAU,GAAG,MAAM,EAAE,MAAM,IAAI,UAAU,CAAC,CAAC,CAAC,SAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;AAC/F,CAAC;AAnBD,0DAmBC;AAED,SAAgB,YAAY,CAAC,SAAiB;IAC1C,2EAA2E;IAC3E,2CAA2C;IAC3C,uFAAuF;IACvF,IAAI,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;IAChD,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QACT,CAAC,IAAI,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5B,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;AAC1C,CAAC;AAVD,oCAUC;AAEM,KAAK,UAAU,WAAW,CAC7B,MAAsF,EACtF,aAAkC,IAAI;IAEtC,OAAO,YAAY,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;AAC9D,CAAC;AALD,kCAKC;AAEM,KAAK,UAAU,iBAAiB;AACnC,8DAA8D;AAC9D,QAAyF,EACzF,MAAc,EACd,YAAsB;IAEtB,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtE,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAElC,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC9B,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACP,CAAC;AAbD,8CAaC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;;AAAA,2CAAyC,CAAE,iEAAiE;AAC5G,2DAAsC;AACtC,sFAAgE;AAChE,oEAA+B;AAI/B,uCAAsC;AAkBtC;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,oBAAoB,CAAC,EACvC,YAAY,EACZ,eAAe,EACf,WAAW,EACX,QAAQ,EACR,cAAc,GAAG,YAAY,EAC7B,UAAU,GAAG,KAAK,EAClB,qBAAqB,GAAG,IAAI,EAC5B,QAAQ,EACR,oBAAoB,EACpB,YAAY,EACZ,GAAG,GAAG,IAAI,EACV,iBAAiB,GAAG,mBAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,iBAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvD;IACpB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;IAE/B,MAAM,aAAa,GAAkB;QACjC,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,YAAY;QACtB,qBAAqB;QACrB,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE;QAC9B,oBAAoB,EAAE,oBAAoB,EAAE,QAAQ,EAAE;QACtD,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE;QACtC,GAAG;QACH,iBAAiB;KACpB,CAAC;IACF,MAAM,YAAY,GAAiB,MAAM,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IAE/E,IAAI,CAAC,CAAC,UAAU,IAAI,mBAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,iBAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACnE,MAAM,iBAAG,CAAC,GAAG,CAAC,eAAe,EAAE;YAC3B,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,oBAAoB,EAAE,eAAe;SACxC,CAAC,CAAC;IACP,CAAC;SAAM,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,MAAM,gBAAM,CAAC,aAAa,CAAC,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;AAC1E,CAAC;AA5CD,oDA4CC;AAED;;;;GAIG;AACI,KAAK,UAAU,cAAc,CAAC,OAAwB;IACzD,MAAM,KAAK,GAAG,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3D,MAAM,8BAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAJD,wCAIC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,cAAc,CAAC,IAAY,EAAE,aAAkC,EAAE;IACnF,MAAM,eAAe,GAAG,MAAM,gBAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC;IAC7D,MAAM,QAAQ,CAAC,iBAAiB,EAAE,CAAC;IACnC,OAAO,QAAQ,CAAC;AACpB,CAAC;AALD,wCAKC;AAED;;;;;;;;GAQG;AACH,8DAA8D;AACvD,KAAK,UAAU,0BAA0B,CAAC,GAAU,EAAE,QAAmB,EAAE,aAAkC,EAAE,EAAE,MAAe;IACnI,MAAM,eAAe,GAAG,MAAM,gBAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC/E,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC;IAC7D,MAAM,QAAQ,CAAC,iBAAiB,EAAE,CAAC;IACnC,OAAO,QAAQ,CAAC;AACpB,CAAC;AALD,gEAKC;AASD;;;;;;;;;;GAUG;AACI,KAAK,UAAU,uBAAuB,CACzC,QAAgF,EAChF,KAAqG,EACrG,MAAc,EACd,SAA+F,EAC/F,GAAG,IAAO;IAEV,MAAM,YAAY,GAAG,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;IACnF,MAAM,KAAK,GAAG,YAAY,KAAK,mBAAS,CAAC,YAAY,IAAI,YAAY,KAAK,mBAAS,CAAC,WAAW,CAAC;IAChG,MAAM,UAAU,GAAG,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAE3G,MAAM,UAAU,GAAW,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;IACpD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,MAAM,IAAI,UAAU,CAAC,CAAC,CAAC,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAA+B,CAAC;IAC/G,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,KAAK,SAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK;QAC1E,CAAC,CAAC,SAAU,CAAC,OAAO,GAAG,SAAU,CAAC,QAAQ;QAC1C,CAAC,CAAC,EAAE,CAAC;IACT,MAAM,WAAW,GAAW,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;IACrD,OAAO,CAAC,WAAW,GAAG,UAAU,GAAG,MAAM,EAAE,MAAM,IAAI,UAAU,CAAC,CAAC,CAAC,SAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;AAC/F,CAAC;AAnBD,0DAmBC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,SAAiB;IAC1C,2EAA2E;IAC3E,2CAA2C;IAC3C,uFAAuF;IACvF,IAAI,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;IAChD,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QACT,CAAC,IAAI,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5B,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;AAC1C,CAAC;AAVD,oCAUC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,WAAW,CAC7B,MAAsF,EACtF,aAAkC,IAAI;IAEtC,OAAO,YAAY,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;AAC9D,CAAC;AALD,kCAKC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,iBAAiB;AACnC,8DAA8D;AAC9D,QAAyF,EACzF,MAAc,EACd,YAAsB;IAEtB,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtE,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAElC,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC9B,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACP,CAAC;AAbD,8CAaC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,WAAW,CAAC,oBAA4B,KAAK;IAM/D,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAK,EAAC,sCAAsC,iBAAiB,WAAW,CAAC,CAAC;IACjG,IAAI,MAAM,GAAW,EAAE,CAAC;IACxB,IAAI,CAAC;QACD,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAuB,CAAA,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAChG,CAAC;IAAC,MAAM,CAAC;QACL,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAdD,kCAcC"}

package/dist/typechain-types/contracts/mixins/SelfdestructEthSender.d.ts

@@ -0,0 +1,29 @@
+import type { BaseContract, BytesLike, FunctionFragment, Result, Interface, AddressLike, ContractRunner, ContractMethod, Listener } from "ethers";
+import type { TypedContractEvent, TypedDeferredTopicFilter, TypedEventLog, TypedListener, TypedContractMethod } from "../../common";
+export interface SelfdestructEthSenderInterface extends Interface {
+    getFunction(nameOrSignature: "stopAndTransferBalance"): FunctionFragment;
+    encodeFunctionData(functionFragment: "stopAndTransferBalance", values: [AddressLike]): string;
+    decodeFunctionResult(functionFragment: "stopAndTransferBalance", data: BytesLike): Result;
+}
+export interface SelfdestructEthSender extends BaseContract {
+    connect(runner?: ContractRunner | null): SelfdestructEthSender;
+    waitForDeployment(): Promise<this>;
+    interface: SelfdestructEthSenderInterface;
+    queryFilter<TCEvent extends TypedContractEvent>(event: TCEvent, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TypedEventLog<TCEvent>>>;
+    queryFilter<TCEvent extends TypedContractEvent>(filter: TypedDeferredTopicFilter<TCEvent>, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TypedEventLog<TCEvent>>>;
+    on<TCEvent extends TypedContractEvent>(event: TCEvent, listener: TypedListener<TCEvent>): Promise<this>;
+    on<TCEvent extends TypedContractEvent>(filter: TypedDeferredTopicFilter<TCEvent>, listener: TypedListener<TCEvent>): Promise<this>;
+    once<TCEvent extends TypedContractEvent>(event: TCEvent, listener: TypedListener<TCEvent>): Promise<this>;
+    once<TCEvent extends TypedContractEvent>(filter: TypedDeferredTopicFilter<TCEvent>, listener: TypedListener<TCEvent>): Promise<this>;
+    listeners<TCEvent extends TypedContractEvent>(event: TCEvent): Promise<Array<TypedListener<TCEvent>>>;
+    listeners(eventName?: string): Promise<Array<Listener>>;
+    removeAllListeners<TCEvent extends TypedContractEvent>(event?: TCEvent): Promise<this>;
+    stopAndTransferBalance: TypedContractMethod<[
+        receiver: AddressLike
+    ], [
+        void
+    ], "nonpayable">;
+    getFunction<T extends ContractMethod = ContractMethod>(key: string | FunctionFragment): T;
+    getFunction(nameOrSignature: "stopAndTransferBalance"): TypedContractMethod<[receiver: AddressLike], [void], "nonpayable">;
+    filters: {};
+}

package/dist/typechain-types/contracts/mixins/SelfdestructEthSender.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SelfdestructEthSender.js.map

package/dist/typechain-types/contracts/mixins/SelfdestructEthSender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SelfdestructEthSender.js","sourceRoot":"","sources":["../../../../typechain-types/contracts/mixins/SelfdestructEthSender.ts"],"names":[],"mappings":""}

package/dist/typechain-types/contracts/mixins/index.d.ts

@@ -2,3 +2,4 @@ export type { BySig } from "./BySig";
 export type { EthReceiver } from "./EthReceiver";
 export type { OnlyWethReceiver } from "./OnlyWethReceiver";
 export type { PermitAndCall } from "./PermitAndCall";
+export type { SelfdestructEthSender } from "./SelfdestructEthSender";

package/dist/typechain-types/contracts/mocks/SelfdestructEthSenderMock.d.ts

@@ -0,0 +1,37 @@
+import type { BaseContract, BytesLike, FunctionFragment, Result, Interface, AddressLike, ContractRunner, ContractMethod, Listener } from "ethers";
+import type { TypedContractEvent, TypedDeferredTopicFilter, TypedEventLog, TypedListener, TypedContractMethod } from "../../common";
+export interface SelfdestructEthSenderMockInterface extends Interface {
+    getFunction(nameOrSignature: "stopAndTransferBalance" | "transferBalance"): FunctionFragment;
+    encodeFunctionData(functionFragment: "stopAndTransferBalance", values: [AddressLike]): string;
+    encodeFunctionData(functionFragment: "transferBalance", values: [AddressLike]): string;
+    decodeFunctionResult(functionFragment: "stopAndTransferBalance", data: BytesLike): Result;
+    decodeFunctionResult(functionFragment: "transferBalance", data: BytesLike): Result;
+}
+export interface SelfdestructEthSenderMock extends BaseContract {
+    connect(runner?: ContractRunner | null): SelfdestructEthSenderMock;
+    waitForDeployment(): Promise<this>;
+    interface: SelfdestructEthSenderMockInterface;
+    queryFilter<TCEvent extends TypedContractEvent>(event: TCEvent, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TypedEventLog<TCEvent>>>;
+    queryFilter<TCEvent extends TypedContractEvent>(filter: TypedDeferredTopicFilter<TCEvent>, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TypedEventLog<TCEvent>>>;
+    on<TCEvent extends TypedContractEvent>(event: TCEvent, listener: TypedListener<TCEvent>): Promise<this>;
+    on<TCEvent extends TypedContractEvent>(filter: TypedDeferredTopicFilter<TCEvent>, listener: TypedListener<TCEvent>): Promise<this>;
+    once<TCEvent extends TypedContractEvent>(event: TCEvent, listener: TypedListener<TCEvent>): Promise<this>;
+    once<TCEvent extends TypedContractEvent>(filter: TypedDeferredTopicFilter<TCEvent>, listener: TypedListener<TCEvent>): Promise<this>;
+    listeners<TCEvent extends TypedContractEvent>(event: TCEvent): Promise<Array<TypedListener<TCEvent>>>;
+    listeners(eventName?: string): Promise<Array<Listener>>;
+    removeAllListeners<TCEvent extends TypedContractEvent>(event?: TCEvent): Promise<this>;
+    stopAndTransferBalance: TypedContractMethod<[
+        receiver: AddressLike
+    ], [
+        void
+    ], "nonpayable">;
+    transferBalance: TypedContractMethod<[
+        receiver: AddressLike
+    ], [
+        void
+    ], "payable">;
+    getFunction<T extends ContractMethod = ContractMethod>(key: string | FunctionFragment): T;
+    getFunction(nameOrSignature: "stopAndTransferBalance"): TypedContractMethod<[receiver: AddressLike], [void], "nonpayable">;
+    getFunction(nameOrSignature: "transferBalance"): TypedContractMethod<[receiver: AddressLike], [void], "payable">;
+    filters: {};
+}

package/dist/typechain-types/contracts/mocks/SelfdestructEthSenderMock.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SelfdestructEthSenderMock.js.map

package/dist/typechain-types/contracts/mocks/SelfdestructEthSenderMock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SelfdestructEthSenderMock.js","sourceRoot":"","sources":["../../../../typechain-types/contracts/mocks/SelfdestructEthSenderMock.ts"],"names":[],"mappings":""}

package/dist/typechain-types/contracts/mocks/TokenCustomDecimalsMock.d.ts

@@ -1,7 +1,7 @@
 import type { BaseContract, BigNumberish, BytesLike, FunctionFragment, Result, Interface, EventFragment, AddressLike, ContractRunner, ContractMethod, Listener } from "ethers";
 import type { TypedContractEvent, TypedDeferredTopicFilter, TypedEventLog, TypedLogDescription, TypedListener, TypedContractMethod } from "../../common";
 export interface TokenCustomDecimalsMockInterface extends Interface {
-    getFunction(nameOrSignature: "DOMAIN_SEPARATOR" | "allowance" | "approve" | "balanceOf" | "burn" | "decimals" | "eip712Domain" | "getChainId" | "mint" | "name" | "nonces" | "owner" | "permit" | "renounceOwnership" | "symbol" | "totalSupply" | "transfer" | "transferFrom" | "transferOwnership"): FunctionFragment;
+    getFunction(nameOrSignature: "DOMAIN_SEPARATOR" | "allowance" | "approve" | "balanceOf" | "burn" | "decimals" | "eip712Domain" | "mint" | "name" | "nonces" | "owner" | "permit" | "renounceOwnership" | "symbol" | "totalSupply" | "transfer" | "transferFrom" | "transferOwnership"): FunctionFragment;
     getEvent(nameOrSignatureOrTopic: "Approval" | "EIP712DomainChanged" | "OwnershipTransferred" | "Transfer"): EventFragment;
     encodeFunctionData(functionFragment: "DOMAIN_SEPARATOR", values?: undefined): string;
     encodeFunctionData(functionFragment: "allowance", values: [AddressLike, AddressLike]): string;
@@ -10,7 +10,6 @@ export interface TokenCustomDecimalsMockInterface extends Interface {
     encodeFunctionData(functionFragment: "burn", values: [AddressLike, BigNumberish]): string;
     encodeFunctionData(functionFragment: "decimals", values?: undefined): string;
     encodeFunctionData(functionFragment: "eip712Domain", values?: undefined): string;
-    encodeFunctionData(functionFragment: "getChainId", values?: undefined): string;
     encodeFunctionData(functionFragment: "mint", values: [AddressLike, BigNumberish]): string;
     encodeFunctionData(functionFragment: "name", values?: undefined): string;
     encodeFunctionData(functionFragment: "nonces", values: [AddressLike]): string;
@@ -37,7 +36,6 @@ export interface TokenCustomDecimalsMockInterface extends Interface {
     decodeFunctionResult(functionFragment: "burn", data: BytesLike): Result;
     decodeFunctionResult(functionFragment: "decimals", data: BytesLike): Result;
     decodeFunctionResult(functionFragment: "eip712Domain", data: BytesLike): Result;
-    decodeFunctionResult(functionFragment: "getChainId", data: BytesLike): Result;
     decodeFunctionResult(functionFragment: "mint", data: BytesLike): Result;
     decodeFunctionResult(functionFragment: "name", data: BytesLike): Result;
     decodeFunctionResult(functionFragment: "nonces", data: BytesLike): Result;
@@ -160,7 +158,6 @@ export interface TokenCustomDecimalsMock extends BaseContract {
             extensions: bigint[];
         }
     ], "view">;
-    getChainId: TypedContractMethod<[], [bigint], "view">;
     mint: TypedContractMethod<[
         account: AddressLike,
         amount: BigNumberish
@@ -244,7 +241,6 @@ export interface TokenCustomDecimalsMock extends BaseContract {
             extensions: bigint[];
         }
     ], "view">;
-    getFunction(nameOrSignature: "getChainId"): TypedContractMethod<[], [bigint], "view">;
     getFunction(nameOrSignature: "mint"): TypedContractMethod<[
         account: AddressLike,
         amount: BigNumberish

package/dist/typechain-types/contracts/mocks/index.d.ts

@@ -1,3 +1,4 @@
 export type { ERC20PermitMock } from "./ERC20PermitMock";
+export type { SelfdestructEthSenderMock } from "./SelfdestructEthSenderMock";
 export type { TokenCustomDecimalsMock } from "./TokenCustomDecimalsMock";
 export type { TokenMock } from "./TokenMock";

package/dist/typechain-types/factories/@openzeppelin/contracts/utils/Address__factory.d.ts

@@ -14,7 +14,7 @@ export declare class Address__factory extends ContractFactory {
         deploymentTransaction(): ContractTransactionResponse;
     }>;
     connect(runner: ContractRunner | null): Address__factory;
-    static readonly bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea2646970667358221220f01c88cae3e92bb1046b6456af0802809927eb7f80c75abfba43fc0c0d20378d64736f6c63430008170033";
+    static readonly bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea26469706673582212208e7307ba8afd20d5d71304f49c621d138e49636a467449c5fbe6e494e0a86f9a64736f6c63430008190033";
     static readonly abi: readonly [{
         readonly inputs: readonly [{
             readonly internalType: "address";

package/dist/typechain-types/factories/@openzeppelin/contracts/utils/Address__factory.js

@@ -34,7 +34,7 @@ const _abi = [
         type: "error",
     },
 ];
-const _bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea2646970667358221220f01c88cae3e92bb1046b6456af0802809927eb7f80c75abfba43fc0c0d20378d64736f6c63430008170033";
+const _bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea26469706673582212208e7307ba8afd20d5d71304f49c621d138e49636a467449c5fbe6e494e0a86f9a64736f6c63430008190033";
 const isSuperArgs = (xs) => xs.length > 1;
 class Address__factory extends ethers_1.ContractFactory {
     constructor(...args) {

package/dist/typechain-types/factories/@openzeppelin/contracts/utils/ShortStrings__factory.d.ts

@@ -14,7 +14,7 @@ export declare class ShortStrings__factory extends ContractFactory {
         deploymentTransaction(): ContractTransactionResponse;
     }>;
     connect(runner: ContractRunner | null): ShortStrings__factory;
-    static readonly bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea2646970667358221220c2d578879d70eb5fc24f30e0f365c9851de7ae9990d18902cf38c9a0096e411964736f6c63430008170033";
+    static readonly bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea2646970667358221220edc9c8ade387899184a347cb5d95804053c11d77c8c4af806f33d996796ad0c364736f6c63430008190033";
     static readonly abi: readonly [{
         readonly inputs: readonly [];
         readonly name: "InvalidShortString";

package/dist/typechain-types/factories/@openzeppelin/contracts/utils/ShortStrings__factory.js

@@ -23,7 +23,7 @@ const _abi = [
         type: "error",
     },
 ];
-const _bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea2646970667358221220c2d578879d70eb5fc24f30e0f365c9851de7ae9990d18902cf38c9a0096e411964736f6c63430008170033";
+const _bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea2646970667358221220edc9c8ade387899184a347cb5d95804053c11d77c8c4af806f33d996796ad0c364736f6c63430008190033";
 const isSuperArgs = (xs) => xs.length > 1;
 class ShortStrings__factory extends ethers_1.ContractFactory {
     constructor(...args) {

package/dist/typechain-types/factories/@openzeppelin/contracts/utils/Strings__factory.d.ts

@@ -14,7 +14,7 @@ export declare class Strings__factory extends ContractFactory {
         deploymentTransaction(): ContractTransactionResponse;
     }>;
     connect(runner: ContractRunner | null): Strings__factory;
-    static readonly bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea264697066735822122022ac4017e0e6acab4084fc8500e4e9832331ac0ca8659956e3dda366ca5f9cf364736f6c63430008170033";
+    static readonly bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea26469706673582212208a4888671b973c8e7f68b4156e53a550899403092d55adcf9c7a9644aaf02f5a64736f6c63430008190033";
     static readonly abi: readonly [{
         readonly inputs: readonly [{
             readonly internalType: "uint256";

package/dist/typechain-types/factories/@openzeppelin/contracts/utils/Strings__factory.js

@@ -23,7 +23,7 @@ const _abi = [
         type: "error",
     },
 ];
-const _bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea264697066735822122022ac4017e0e6acab4084fc8500e4e9832331ac0ca8659956e3dda366ca5f9cf364736f6c63430008170033";
+const _bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea26469706673582212208a4888671b973c8e7f68b4156e53a550899403092d55adcf9c7a9644aaf02f5a64736f6c63430008190033";
 const isSuperArgs = (xs) => xs.length > 1;
 class Strings__factory extends ethers_1.ContractFactory {
     constructor(...args) {

package/dist/typechain-types/factories/@openzeppelin/contracts/utils/cryptography/ECDSA__factory.d.ts

@@ -14,7 +14,7 @@ export declare class ECDSA__factory extends ContractFactory {
         deploymentTransaction(): ContractTransactionResponse;
     }>;
     connect(runner: ContractRunner | null): ECDSA__factory;
-    static readonly bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea26469706673582212200353ab825b829549bcea7657b9d5dbbdecefeaf01d5c2998060c30ba252b6f8a64736f6c63430008170033";
+    static readonly bytecode = "0x6080806040523460175760399081601c823930815050f35b5f80fdfe5f80fdfea264697066735822122037b0b9583aebde19d8cdbcb64a7c90da36adfdb28a42301e3fbb7fdbc0d18afe64736f6c63430008190033";
     static readonly abi: readonly [{
         readonly inputs: readonly [];
         readonly name: "ECDSAInvalidSignature";