@metamask/transaction-controller 36.1.0 → 37.1.0

package/dist/{types/utils/gas.d.ts → utils/gas.d.cts}

@@ -1,7 +1,7 @@
 /// <reference types="debug" />
-import type EthQuery from '@metamask/eth-query';
-import type { Hex } from '@metamask/utils';
-import type { TransactionMeta, TransactionParams } from '../types';
+import type EthQuery from "@metamask/eth-query";
+import type { Hex } from "@metamask/utils";
+import type { TransactionMeta, TransactionParams } from "../types.cjs";
 export type UpdateGasRequest = {
     ethQuery: EthQuery;
     isCustomNetwork: boolean;
@@ -25,4 +25,4 @@ export declare function estimateGas(txParams: TransactionParams, ethQuery: EthQu
     } | undefined;
 }>;
 export declare function addGasBuffer(estimatedGas: string, blockGasLimit: string, multiplier: number): `0x${string}`;
-//# sourceMappingURL=gas.d.ts.map
+//# sourceMappingURL=gas.d.cts.map

package/dist/utils/gas.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gas.d.cts","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":";AAQA,OAAO,KAAK,QAAQ,4BAA4B;AAChD,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAK3C,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,qBAAiB;AAEnE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,GAAG,CAAC;IACb,MAAM,EAAE,eAAe,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,GAAG,0BAA2C,CAAC;AAE5D,eAAO,MAAM,SAAS,WAAW,CAAC;AAClC,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAE1C,wBAAsB,SAAS,CAAC,OAAO,EAAE,gBAAgB,iBAkBxD;AAED,wBAAsB,WAAW,CAC/B,QAAQ,EAAE,iBAAiB,EAC3B,QAAQ,EAAE,QAAQ;;;;;;;;;;;GAwCnB;AAED,wBAAgB,YAAY,CAC1B,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,iBAqBnB"}

package/dist/utils/gas.d.mts

@@ -0,0 +1,28 @@
+/// <reference types="debug" />
+import type EthQuery from "@metamask/eth-query";
+import type { Hex } from "@metamask/utils";
+import type { TransactionMeta, TransactionParams } from "../types.mjs";
+export type UpdateGasRequest = {
+    ethQuery: EthQuery;
+    isCustomNetwork: boolean;
+    chainId: Hex;
+    txMeta: TransactionMeta;
+};
+export declare const log: import("debug").Debugger;
+export declare const FIXED_GAS = "0x5208";
+export declare const DEFAULT_GAS_MULTIPLIER = 1.5;
+export declare function updateGas(request: UpdateGasRequest): Promise<void>;
+export declare function estimateGas(txParams: TransactionParams, ethQuery: EthQuery): Promise<{
+    blockGasLimit: string;
+    estimatedGas: string;
+    simulationFails: {
+        reason: any;
+        errorKey: any;
+        debug: {
+            blockNumber: string;
+            blockGasLimit: string;
+        };
+    } | undefined;
+}>;
+export declare function addGasBuffer(estimatedGas: string, blockGasLimit: string, multiplier: number): `0x${string}`;
+//# sourceMappingURL=gas.d.mts.map

package/dist/utils/gas.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gas.d.mts","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":";AAQA,OAAO,KAAK,QAAQ,4BAA4B;AAChD,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAK3C,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,qBAAiB;AAEnE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,GAAG,CAAC;IACb,MAAM,EAAE,eAAe,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,GAAG,0BAA2C,CAAC;AAE5D,eAAO,MAAM,SAAS,WAAW,CAAC;AAClC,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAE1C,wBAAsB,SAAS,CAAC,OAAO,EAAE,gBAAgB,iBAkBxD;AAED,wBAAsB,WAAW,CAC/B,QAAQ,EAAE,iBAAiB,EAC3B,QAAQ,EAAE,QAAQ;;;;;;;;;;;GAwCnB;AAED,wBAAgB,YAAY,CAC1B,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,iBAqBnB"}

package/dist/utils/gas.mjs

@@ -1,20 +1,106 @@
-import {
-  DEFAULT_GAS_MULTIPLIER,
-  FIXED_GAS,
-  addGasBuffer,
-  estimateGas,
-  log,
-  updateGas
-} from "../chunk-5G6OHAXI.mjs";
-import "../chunk-O6ZZVIFH.mjs";
-import "../chunk-UQQWZT6C.mjs";
-import "../chunk-XUI43LEZ.mjs";
-export {
-  DEFAULT_GAS_MULTIPLIER,
-  FIXED_GAS,
-  addGasBuffer,
-  estimateGas,
-  log,
-  updateGas
-};
+/* eslint-disable jsdoc/require-jsdoc */
+import { BNToHex, fractionBN, hexToBN, query } from "@metamask/controller-utils";
+import { add0x, createModuleLogger } from "@metamask/utils";
+import { GAS_BUFFER_CHAIN_OVERRIDES } from "../constants.mjs";
+import { projectLogger } from "../logger.mjs";
+export const log = createModuleLogger(projectLogger, 'gas');
+export const FIXED_GAS = '0x5208';
+export const DEFAULT_GAS_MULTIPLIER = 1.5;
+export async function updateGas(request) {
+    const { txMeta } = request;
+    const initialParams = { ...txMeta.txParams };
+    const [gas, simulationFails] = await getGas(request);
+    txMeta.txParams.gas = gas;
+    txMeta.simulationFails = simulationFails;
+    if (!initialParams.gas) {
+        txMeta.originalGasEstimate = txMeta.txParams.gas;
+    }
+    if (!txMeta.defaultGasEstimates) {
+        txMeta.defaultGasEstimates = {};
+    }
+    txMeta.defaultGasEstimates.gas = txMeta.txParams.gas;
+}
+export async function estimateGas(txParams, ethQuery) {
+    const request = { ...txParams };
+    const { data, value } = request;
+    const { gasLimit: gasLimitHex, number: blockNumber } = await getLatestBlock(ethQuery);
+    const gasLimitBN = hexToBN(gasLimitHex);
+    request.data = data ? add0x(data) : data;
+    request.gas = BNToHex(fractionBN(gasLimitBN, 19, 20));
+    request.value = value || '0x0';
+    let estimatedGas = request.gas;
+    let simulationFails;
+    try {
+        estimatedGas = await query(ethQuery, 'estimateGas', [request]);
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    }
+    catch (error) {
+        simulationFails = {
+            reason: error.message,
+            errorKey: error.errorKey,
+            debug: {
+                blockNumber,
+                blockGasLimit: gasLimitHex,
+            },
+        };
+        log('Estimation failed', { ...simulationFails, fallback: estimateGas });
+    }
+    return {
+        blockGasLimit: gasLimitHex,
+        estimatedGas,
+        simulationFails,
+    };
+}
+export function addGasBuffer(estimatedGas, blockGasLimit, multiplier) {
+    const estimatedGasBN = hexToBN(estimatedGas);
+    const maxGasBN = hexToBN(blockGasLimit).muln(0.9);
+    const paddedGasBN = estimatedGasBN.muln(multiplier);
+    if (estimatedGasBN.gt(maxGasBN)) {
+        const estimatedGasHex = add0x(estimatedGas);
+        log('Using estimated value', estimatedGasHex);
+        return estimatedGasHex;
+    }
+    if (paddedGasBN.lt(maxGasBN)) {
+        const paddedHex = add0x(BNToHex(paddedGasBN));
+        log('Using padded estimate', paddedHex, multiplier);
+        return paddedHex;
+    }
+    const maxHex = add0x(BNToHex(maxGasBN));
+    log('Using 90% of block gas limit', maxHex);
+    return maxHex;
+}
+async function getGas(request) {
+    const { isCustomNetwork, chainId, txMeta } = request;
+    if (txMeta.txParams.gas) {
+        log('Using value from request', txMeta.txParams.gas);
+        return [txMeta.txParams.gas];
+    }
+    if (await requiresFixedGas(request)) {
+        log('Using fixed value', FIXED_GAS);
+        return [FIXED_GAS];
+    }
+    const { blockGasLimit, estimatedGas, simulationFails } = await estimateGas(txMeta.txParams, request.ethQuery);
+    if (isCustomNetwork) {
+        log('Using original estimate as custom network');
+        return [estimatedGas, simulationFails];
+    }
+    const bufferMultiplier = GAS_BUFFER_CHAIN_OVERRIDES[chainId] ?? DEFAULT_GAS_MULTIPLIER;
+    const bufferedGas = addGasBuffer(estimatedGas, blockGasLimit, bufferMultiplier);
+    return [bufferedGas, simulationFails];
+}
+async function requiresFixedGas({ ethQuery, txMeta, isCustomNetwork, }) {
+    const { txParams: { to, data }, } = txMeta;
+    if (isCustomNetwork || !to || data) {
+        return false;
+    }
+    const code = await getCode(ethQuery, to);
+    return !code || code === '0x';
+}
+async function getCode(ethQuery, address) {
+    return await query(ethQuery, 'getCode', [address]);
+}
+async function getLatestBlock(ethQuery) {
+    return await query(ethQuery, 'getBlockByNumber', ['latest', false]);
+}
 //# sourceMappingURL=gas.mjs.map

package/dist/utils/gas.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"gas.mjs","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":"AAAA,wCAAwC;AAExC,OAAO,EACL,OAAO,EACP,UAAU,EACV,OAAO,EACP,KAAK,EACN,mCAAmC;AAGpC,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,wBAAwB;AAE5D,OAAO,EAAE,0BAA0B,EAAE,yBAAqB;AAC1D,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAU1C,MAAM,CAAC,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;AAE5D,MAAM,CAAC,MAAM,SAAS,GAAG,QAAQ,CAAC;AAClC,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAE1C,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAyB;IACvD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC3B,MAAM,aAAa,GAAG,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IAE7C,MAAM,CAAC,GAAG,EAAE,eAAe,CAAC,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;IAErD,MAAM,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,CAAC;IAC1B,MAAM,CAAC,eAAe,GAAG,eAAe,CAAC;IAEzC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;QACtB,MAAM,CAAC,mBAAmB,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;KAClD;IAED,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE;QAC/B,MAAM,CAAC,mBAAmB,GAAG,EAAE,CAAC;KACjC;IAED,MAAM,CAAC,mBAAmB,CAAC,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;AACvD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,QAA2B,EAC3B,QAAkB;IAElB,MAAM,OAAO,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;IAChC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAEhC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,cAAc,CACzE,QAAQ,CACT,CAAC;IAEF,MAAM,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAExC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACtD,OAAO,CAAC,KAAK,GAAG,KAAK,IAAI,KAAK,CAAC;IAE/B,IAAI,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IAC/B,IAAI,eAAe,CAAC;IAEpB,IAAI;QACF,YAAY,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE,aAAa,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAC/D,gCAAgC;QAChC,8DAA8D;KAC/D;IAAC,OAAO,KAAU,EAAE;QACnB,eAAe,GAAG;YAChB,MAAM,EAAE,KAAK,CAAC,OAAO;YACrB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,KAAK,EAAE;gBACL,WAAW;gBACX,aAAa,EAAE,WAAW;aAC3B;SACF,CAAC;QAEF,GAAG,CAAC,mBAAmB,EAAE,EAAE,GAAG,eAAe,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;KACzE;IAED,OAAO;QACL,aAAa,EAAE,WAAW;QAC1B,YAAY;QACZ,eAAe;KAChB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,YAAoB,EACpB,aAAqB,EACrB,UAAkB;IAElB,MAAM,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAEpD,IAAI,cAAc,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE;QAC/B,MAAM,eAAe,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5C,GAAG,CAAC,uBAAuB,EAAE,eAAe,CAAC,CAAC;QAC9C,OAAO,eAAe,CAAC;KACxB;IAED,IAAI,WAAW,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE;QAC5B,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;QAC9C,GAAG,CAAC,uBAAuB,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QACpD,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxC,GAAG,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IAC5C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,MAAM,CACnB,OAAyB;IAEzB,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAErD,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE;QACvB,GAAG,CAAC,0BAA0B,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;KAC9B;IAED,IAAI,MAAM,gBAAgB,CAAC,OAAO,CAAC,EAAE;QACnC,GAAG,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;QACpC,OAAO,CAAC,SAAS,CAAC,CAAC;KACpB;IAED,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,eAAe,EAAE,GAAG,MAAM,WAAW,CACxE,MAAM,CAAC,QAAQ,EACf,OAAO,CAAC,QAAQ,CACjB,CAAC;IAEF,IAAI,eAAe,EAAE;QACnB,GAAG,CAAC,2CAA2C,CAAC,CAAC;QACjD,OAAO,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;KACxC;IAED,MAAM,gBAAgB,GACpB,0BAA0B,CACxB,OAAkD,CACnD,IAAI,sBAAsB,CAAC;IAE9B,MAAM,WAAW,GAAG,YAAY,CAC9B,YAAY,EACZ,aAAa,EACb,gBAAgB,CACjB,CAAC;IAEF,OAAO,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;AACxC,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,EAC9B,QAAQ,EACR,MAAM,EACN,eAAe,GACE;IACjB,MAAM,EACJ,QAAQ,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GACvB,GAAG,MAAM,CAAC;IAEX,IAAI,eAAe,IAAI,CAAC,EAAE,IAAI,IAAI,EAAE;QAClC,OAAO,KAAK,CAAC;KACd;IAED,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAEzC,OAAO,CAAC,IAAI,IAAI,IAAI,KAAK,IAAI,CAAC;AAChC,CAAC;AAED,KAAK,UAAU,OAAO,CACpB,QAAkB,EAClB,OAAe;IAEf,OAAO,MAAM,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,KAAK,UAAU,cAAc,CAC3B,QAAkB;IAElB,OAAO,MAAM,KAAK,CAAC,QAAQ,EAAE,kBAAkB,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AACtE,CAAC","sourcesContent":["/* eslint-disable jsdoc/require-jsdoc */\n\nimport {\n  BNToHex,\n  fractionBN,\n  hexToBN,\n  query,\n} from '@metamask/controller-utils';\nimport type EthQuery from '@metamask/eth-query';\nimport type { Hex } from '@metamask/utils';\nimport { add0x, createModuleLogger } from '@metamask/utils';\n\nimport { GAS_BUFFER_CHAIN_OVERRIDES } from '../constants';\nimport { projectLogger } from '../logger';\nimport type { TransactionMeta, TransactionParams } from '../types';\n\nexport type UpdateGasRequest = {\n  ethQuery: EthQuery;\n  isCustomNetwork: boolean;\n  chainId: Hex;\n  txMeta: TransactionMeta;\n};\n\nexport const log = createModuleLogger(projectLogger, 'gas');\n\nexport const FIXED_GAS = '0x5208';\nexport const DEFAULT_GAS_MULTIPLIER = 1.5;\n\nexport async function updateGas(request: UpdateGasRequest) {\n  const { txMeta } = request;\n  const initialParams = { ...txMeta.txParams };\n\n  const [gas, simulationFails] = await getGas(request);\n\n  txMeta.txParams.gas = gas;\n  txMeta.simulationFails = simulationFails;\n\n  if (!initialParams.gas) {\n    txMeta.originalGasEstimate = txMeta.txParams.gas;\n  }\n\n  if (!txMeta.defaultGasEstimates) {\n    txMeta.defaultGasEstimates = {};\n  }\n\n  txMeta.defaultGasEstimates.gas = txMeta.txParams.gas;\n}\n\nexport async function estimateGas(\n  txParams: TransactionParams,\n  ethQuery: EthQuery,\n) {\n  const request = { ...txParams };\n  const { data, value } = request;\n\n  const { gasLimit: gasLimitHex, number: blockNumber } = await getLatestBlock(\n    ethQuery,\n  );\n\n  const gasLimitBN = hexToBN(gasLimitHex);\n\n  request.data = data ? add0x(data) : data;\n  request.gas = BNToHex(fractionBN(gasLimitBN, 19, 20));\n  request.value = value || '0x0';\n\n  let estimatedGas = request.gas;\n  let simulationFails;\n\n  try {\n    estimatedGas = await query(ethQuery, 'estimateGas', [request]);\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  } catch (error: any) {\n    simulationFails = {\n      reason: error.message,\n      errorKey: error.errorKey,\n      debug: {\n        blockNumber,\n        blockGasLimit: gasLimitHex,\n      },\n    };\n\n    log('Estimation failed', { ...simulationFails, fallback: estimateGas });\n  }\n\n  return {\n    blockGasLimit: gasLimitHex,\n    estimatedGas,\n    simulationFails,\n  };\n}\n\nexport function addGasBuffer(\n  estimatedGas: string,\n  blockGasLimit: string,\n  multiplier: number,\n) {\n  const estimatedGasBN = hexToBN(estimatedGas);\n  const maxGasBN = hexToBN(blockGasLimit).muln(0.9);\n  const paddedGasBN = estimatedGasBN.muln(multiplier);\n\n  if (estimatedGasBN.gt(maxGasBN)) {\n    const estimatedGasHex = add0x(estimatedGas);\n    log('Using estimated value', estimatedGasHex);\n    return estimatedGasHex;\n  }\n\n  if (paddedGasBN.lt(maxGasBN)) {\n    const paddedHex = add0x(BNToHex(paddedGasBN));\n    log('Using padded estimate', paddedHex, multiplier);\n    return paddedHex;\n  }\n\n  const maxHex = add0x(BNToHex(maxGasBN));\n  log('Using 90% of block gas limit', maxHex);\n  return maxHex;\n}\n\nasync function getGas(\n  request: UpdateGasRequest,\n): Promise<[string, TransactionMeta['simulationFails']?]> {\n  const { isCustomNetwork, chainId, txMeta } = request;\n\n  if (txMeta.txParams.gas) {\n    log('Using value from request', txMeta.txParams.gas);\n    return [txMeta.txParams.gas];\n  }\n\n  if (await requiresFixedGas(request)) {\n    log('Using fixed value', FIXED_GAS);\n    return [FIXED_GAS];\n  }\n\n  const { blockGasLimit, estimatedGas, simulationFails } = await estimateGas(\n    txMeta.txParams,\n    request.ethQuery,\n  );\n\n  if (isCustomNetwork) {\n    log('Using original estimate as custom network');\n    return [estimatedGas, simulationFails];\n  }\n\n  const bufferMultiplier =\n    GAS_BUFFER_CHAIN_OVERRIDES[\n      chainId as keyof typeof GAS_BUFFER_CHAIN_OVERRIDES\n    ] ?? DEFAULT_GAS_MULTIPLIER;\n\n  const bufferedGas = addGasBuffer(\n    estimatedGas,\n    blockGasLimit,\n    bufferMultiplier,\n  );\n\n  return [bufferedGas, simulationFails];\n}\n\nasync function requiresFixedGas({\n  ethQuery,\n  txMeta,\n  isCustomNetwork,\n}: UpdateGasRequest): Promise<boolean> {\n  const {\n    txParams: { to, data },\n  } = txMeta;\n\n  if (isCustomNetwork || !to || data) {\n    return false;\n  }\n\n  const code = await getCode(ethQuery, to);\n\n  return !code || code === '0x';\n}\n\nasync function getCode(\n  ethQuery: EthQuery,\n  address: string,\n): Promise<string | undefined> {\n  return await query(ethQuery, 'getCode', [address]);\n}\n\nasync function getLatestBlock(\n  ethQuery: EthQuery,\n): Promise<{ gasLimit: string; number: string }> {\n  return await query(ethQuery, 'getBlockByNumber', ['latest', false]);\n}\n"]}

package/dist/utils/history.cjs

@@ -0,0 +1,164 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateTransactionHistory = exports.addInitialHistorySnapshot = exports.DISPLAYED_TRANSACTION_HISTORY_PATHS = exports.MAX_TRANSACTION_HISTORY_LENGTH = void 0;
+const fast_json_patch_1 = __importDefault(require("fast-json-patch"));
+const lodash_1 = require("lodash");
+/**
+ * The maximum allowed length of the `transaction.history` property.
+ */
+exports.MAX_TRANSACTION_HISTORY_LENGTH = 100;
+/**
+ * A list of trarnsaction history paths that may be used for display. These entries will not be
+ * compressed.
+ */
+exports.DISPLAYED_TRANSACTION_HISTORY_PATHS = [
+    '/status',
+    '/txParams/gasPrice',
+    '/txParams/gas',
+    '/estimatedBaseFee',
+    '/blockTimestamp',
+];
+/**
+ * Build a new version of the provided transaction with an initial history
+ * entry, which is just a snapshot of the transaction.
+ *
+ * @param transactionMeta - TransactionMeta to add initial history snapshot to.
+ * @returns A copy of `transactionMeta` with a new `history` property.
+ */
+function addInitialHistorySnapshot(transactionMeta) {
+    const snapshot = snapshotFromTransactionMeta(transactionMeta);
+    return (0, lodash_1.merge)({}, transactionMeta, { history: [snapshot] });
+}
+exports.addInitialHistorySnapshot = addInitialHistorySnapshot;
+/**
+ * Builds a new version of the transaction with a new history entry if
+ * it has a `history` property, or just returns the transaction.
+ *
+ * @param transactionMeta - TransactionMeta to add history entry to.
+ * @param note - Note to add to history entry.
+ * @returns A copy of `transactionMeta` with a new `history` entry if it has an
+ * existing non-empty `history` array.
+ */
+function updateTransactionHistory(transactionMeta, note) {
+    if (!transactionMeta.history) {
+        return transactionMeta;
+    }
+    const currentState = snapshotFromTransactionMeta(transactionMeta);
+    const previousState = replayHistory(transactionMeta.history);
+    const newHistoryEntry = generateHistoryEntry(previousState, currentState, note);
+    if (newHistoryEntry.length === 0) {
+        return transactionMeta;
+    }
+    // Casts required here because this list has two separate types of entries:
+    // TransactionMeta and TransactionHistoryEntry. The only TransactionMeta is the first
+    // entry, but TypeScript loses that type information when `slice` is called for some reason.
+    let updatedHistory = [
+        ...transactionMeta.history,
+        newHistoryEntry,
+    ];
+    if (updatedHistory.length > exports.MAX_TRANSACTION_HISTORY_LENGTH) {
+        updatedHistory = compressTransactionHistory(updatedHistory);
+    }
+    return (0, lodash_1.merge)({}, transactionMeta, {
+        history: updatedHistory,
+    });
+}
+exports.updateTransactionHistory = updateTransactionHistory;
+/**
+ * Compress the transaction history, if it is possible to do so without compressing entries used
+ * for display. History entries are merged together to make room for a single new entry.
+ *
+ * @param transactionHistory - The transaction history to compress.
+ * @returns A compressed transaction history.
+ */
+function compressTransactionHistory(transactionHistory) {
+    const initialEntry = transactionHistory[0];
+    // Casts required here because this list has two separate types of entries:
+    // TransactionMeta and TransactionHistoryEntry. The only TransactionMeta is the first
+    // entry, but TypeScript loses that type information when `slice` is called for some reason.
+    const historyEntries = transactionHistory.slice(1);
+    const firstNonDisplayedEntryIndex = historyEntries.findIndex((historyEntry) => {
+        return !historyEntry.some(({ path }) => exports.DISPLAYED_TRANSACTION_HISTORY_PATHS.includes(path));
+    });
+    // If no non-displayed entry is found, let history exceed max size.
+    // TODO: Move data used for display to another property, so that we can more reliably limit
+    // history size or remove it altogether.
+    if (firstNonDisplayedEntryIndex === -1) {
+        return transactionHistory;
+    }
+    // If a non-displayed entry is found that we can remove, merge it with another entry.
+    // The entry we're merging with might be a "displayed" entry, but that's OK, merging more changes
+    // in does not break our display logic.
+    const mergeTargetEntryIndex = 
+    // Merge with previous entry if there is no next entry.
+    // We default to merging with next because the next entry might also be non-displayed, so it
+    // might be removed in a future trim, saving more space.
+    firstNonDisplayedEntryIndex === historyEntries.length - 1
+        ? firstNonDisplayedEntryIndex - 1
+        : firstNonDisplayedEntryIndex + 1;
+    const firstIndexToMerge = Math.min(firstNonDisplayedEntryIndex, mergeTargetEntryIndex);
+    const firstEntryToMerge = historyEntries[firstIndexToMerge];
+    const secondEntryToMerge = historyEntries[firstIndexToMerge + 1];
+    const beforeMergeState = replayHistory([
+        initialEntry,
+        ...historyEntries.slice(0, firstIndexToMerge),
+    ]);
+    const afterMergeState = replayHistory([
+        beforeMergeState,
+        firstEntryToMerge,
+        secondEntryToMerge,
+    ]);
+    const mergedHistoryEntry = generateHistoryEntry(beforeMergeState, afterMergeState, `${String(firstEntryToMerge[0].note)}, ${String(secondEntryToMerge[0].note)}`);
+    historyEntries.splice(firstIndexToMerge, 2, mergedHistoryEntry);
+    return [initialEntry, ...historyEntries];
+}
+/**
+ * Generates a history entry from the previous and new transaction metadata.
+ *
+ * @param previousState - The previous transaction metadata.
+ * @param currentState - The new transaction metadata.
+ * @param note - A note for the transaction metada update.
+ * @returns An array of history operation.
+ */
+function generateHistoryEntry(
+// TODO: Replace `any` with type
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+previousState, currentState, note) {
+    const historyOperationsEntry = fast_json_patch_1.default.compare(previousState, currentState);
+    // Add a note to the first operation, since it breaks if we append it to the entry
+    if (historyOperationsEntry[0]) {
+        if (note) {
+            historyOperationsEntry[0].note = note;
+        }
+        historyOperationsEntry[0].timestamp = Date.now();
+    }
+    return historyOperationsEntry;
+}
+/**
+ * Recovers previous transactionMeta from passed history array.
+ *
+ * @param transactionHistory - The transaction metadata to replay.
+ * @returns The transaction metadata.
+ */
+function replayHistory(transactionHistory) {
+    const shortHistory = (0, lodash_1.cloneDeep)(transactionHistory);
+    return shortHistory.reduce(
+    // TODO: Replace `any` with type
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (val, entry) => fast_json_patch_1.default.applyPatch(val, entry).newDocument);
+}
+/**
+ * Clone the transaction meta data without the history property.
+ *
+ * @param transactionMeta - The transaction metadata to snapshot.
+ * @returns A deep clone of transaction metadata without history property.
+ */
+function snapshotFromTransactionMeta(transactionMeta) {
+    const snapshot = { ...transactionMeta };
+    delete snapshot.history;
+    return (0, lodash_1.cloneDeep)(snapshot);
+}
+//# sourceMappingURL=history.cjs.map

package/dist/utils/history.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"history.cjs","sourceRoot":"","sources":["../../src/utils/history.ts"],"names":[],"mappings":";;;;;;AAAA,sEAAyC;AACzC,mCAA0C;AAQ1C;;GAEG;AACU,QAAA,8BAA8B,GAAG,GAAG,CAAC;AAElD;;;GAGG;AACU,QAAA,mCAAmC,GAAG;IACjD,SAAS;IACT,oBAAoB;IACpB,eAAe;IACf,mBAAmB;IACnB,iBAAiB;CAClB,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,yBAAyB,CACvC,eAAgC;IAEhC,MAAM,QAAQ,GAAG,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAC9D,OAAO,IAAA,cAAK,EAAC,EAAE,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AAC7D,CAAC;AALD,8DAKC;AAED;;;;;;;;GAQG;AACH,SAAgB,wBAAwB,CACtC,eAAgC,EAChC,IAAY;IAEZ,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE;QAC5B,OAAO,eAAe,CAAC;KACxB;IAED,MAAM,YAAY,GAAG,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,aAAa,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,eAAe,GAAG,oBAAoB,CAC1C,aAAa,EACb,YAAY,EACZ,IAAI,CACL,CAAC;IAEF,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE;QAChC,OAAO,eAAe,CAAC;KACxB;IAED,2EAA2E;IAC3E,qFAAqF;IACrF,4FAA4F;IAC5F,IAAI,cAAc,GAAG;QACnB,GAAG,eAAe,CAAC,OAAO;QAC1B,eAAe;KACM,CAAC;IAExB,IAAI,cAAc,CAAC,MAAM,GAAG,sCAA8B,EAAE;QAC1D,cAAc,GAAG,0BAA0B,CAAC,cAAc,CAAC,CAAC;KAC7D;IAED,OAAO,IAAA,cAAK,EAAC,EAAE,EAAE,eAAe,EAAE;QAChC,OAAO,EAAE,cAAc;KACxB,CAAC,CAAC;AACL,CAAC;AAnCD,4DAmCC;AAED;;;;;;GAMG;AACH,SAAS,0BAA0B,CACjC,kBAAsC;IAEtC,MAAM,YAAY,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAC3C,2EAA2E;IAC3E,qFAAqF;IACrF,4FAA4F;IAC5F,MAAM,cAAc,GAAG,kBAAkB,CAAC,KAAK,CAC7C,CAAC,CAC2B,CAAC;IAE/B,MAAM,2BAA2B,GAAG,cAAc,CAAC,SAAS,CAC1D,CAAC,YAAY,EAAE,EAAE;QACf,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CACrC,2CAAmC,CAAC,QAAQ,CAAC,IAAI,CAAC,CACnD,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,mEAAmE;IACnE,2FAA2F;IAC3F,wCAAwC;IACxC,IAAI,2BAA2B,KAAK,CAAC,CAAC,EAAE;QACtC,OAAO,kBAAkB,CAAC;KAC3B;IAED,qFAAqF;IACrF,iGAAiG;IACjG,uCAAuC;IACvC,MAAM,qBAAqB;IACzB,uDAAuD;IACvD,4FAA4F;IAC5F,wDAAwD;IACxD,2BAA2B,KAAK,cAAc,CAAC,MAAM,GAAG,CAAC;QACvD,CAAC,CAAC,2BAA2B,GAAG,CAAC;QACjC,CAAC,CAAC,2BAA2B,GAAG,CAAC,CAAC;IACtC,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAChC,2BAA2B,EAC3B,qBAAqB,CACtB,CAAC;IACF,MAAM,iBAAiB,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;IAC5D,MAAM,kBAAkB,GAAG,cAAc,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC;IAEjE,MAAM,gBAAgB,GAAG,aAAa,CAAC;QACrC,YAAY;QACZ,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,iBAAiB,CAAC;KAC9C,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,aAAa,CAAC;QACpC,gBAAgB;QAChB,iBAAiB;QACjB,kBAAkB;KACnB,CAAC,CAAC;IACH,MAAM,kBAAkB,GAAG,oBAAoB,CAC7C,gBAAgB,EAChB,eAAe,EACf,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,MAAM,CAC7C,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,CAC3B,EAAE,CACJ,CAAC;IAEF,cAAc,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAChE,OAAO,CAAC,YAAY,EAAE,GAAG,cAAc,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,oBAAoB;AAC3B,gCAAgC;AAChC,8DAA8D;AAC9D,aAAkB,EAClB,YAA6B,EAC7B,IAAY;IAEZ,MAAM,sBAAsB,GAAG,yBAAU,CAAC,OAAO,CAC/C,aAAa,EACb,YAAY,CACc,CAAC;IAC7B,kFAAkF;IAClF,IAAI,sBAAsB,CAAC,CAAC,CAAC,EAAE;QAC7B,IAAI,IAAI,EAAE;YACR,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC;SACvC;QACD,sBAAsB,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;KAClD;IACD,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CACpB,kBAAsC;IAEtC,MAAM,YAAY,GAAG,IAAA,kBAAS,EAAC,kBAAkB,CAAC,CAAC;IACnD,OAAO,YAAY,CAAC,MAAM;IACxB,gCAAgC;IAChC,8DAA8D;IAC9D,CAAC,GAAG,EAAE,KAAU,EAAE,EAAE,CAAC,yBAAU,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,WAAW,CAChD,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,SAAS,2BAA2B,CAClC,eAAgC;IAEhC,MAAM,QAAQ,GAAG,EAAE,GAAG,eAAe,EAAE,CAAC;IACxC,OAAO,QAAQ,CAAC,OAAO,CAAC;IACxB,OAAO,IAAA,kBAAS,EAAC,QAAQ,CAAC,CAAC;AAC7B,CAAC","sourcesContent":["import jsonDiffer from 'fast-json-patch';\nimport { cloneDeep, merge } from 'lodash';\n\nimport type {\n  TransactionHistory,\n  TransactionHistoryEntry,\n  TransactionMeta,\n} from '../types';\n\n/**\n * The maximum allowed length of the `transaction.history` property.\n */\nexport const MAX_TRANSACTION_HISTORY_LENGTH = 100;\n\n/**\n * A list of trarnsaction history paths that may be used for display. These entries will not be\n * compressed.\n */\nexport const DISPLAYED_TRANSACTION_HISTORY_PATHS = [\n  '/status',\n  '/txParams/gasPrice',\n  '/txParams/gas',\n  '/estimatedBaseFee',\n  '/blockTimestamp',\n];\n\n/**\n * Build a new version of the provided transaction with an initial history\n * entry, which is just a snapshot of the transaction.\n *\n * @param transactionMeta - TransactionMeta to add initial history snapshot to.\n * @returns A copy of `transactionMeta` with a new `history` property.\n */\nexport function addInitialHistorySnapshot(\n  transactionMeta: TransactionMeta,\n): TransactionMeta {\n  const snapshot = snapshotFromTransactionMeta(transactionMeta);\n  return merge({}, transactionMeta, { history: [snapshot] });\n}\n\n/**\n * Builds a new version of the transaction with a new history entry if\n * it has a `history` property, or just returns the transaction.\n *\n * @param transactionMeta - TransactionMeta to add history entry to.\n * @param note - Note to add to history entry.\n * @returns A copy of `transactionMeta` with a new `history` entry if it has an\n * existing non-empty `history` array.\n */\nexport function updateTransactionHistory(\n  transactionMeta: TransactionMeta,\n  note: string,\n): TransactionMeta {\n  if (!transactionMeta.history) {\n    return transactionMeta;\n  }\n\n  const currentState = snapshotFromTransactionMeta(transactionMeta);\n  const previousState = replayHistory(transactionMeta.history);\n  const newHistoryEntry = generateHistoryEntry(\n    previousState,\n    currentState,\n    note,\n  );\n\n  if (newHistoryEntry.length === 0) {\n    return transactionMeta;\n  }\n\n  // Casts required here because this list has two separate types of entries:\n  // TransactionMeta and TransactionHistoryEntry. The only TransactionMeta is the first\n  // entry, but TypeScript loses that type information when `slice` is called for some reason.\n  let updatedHistory = [\n    ...transactionMeta.history,\n    newHistoryEntry,\n  ] as TransactionHistory;\n\n  if (updatedHistory.length > MAX_TRANSACTION_HISTORY_LENGTH) {\n    updatedHistory = compressTransactionHistory(updatedHistory);\n  }\n\n  return merge({}, transactionMeta, {\n    history: updatedHistory,\n  });\n}\n\n/**\n * Compress the transaction history, if it is possible to do so without compressing entries used\n * for display. History entries are merged together to make room for a single new entry.\n *\n * @param transactionHistory - The transaction history to compress.\n * @returns A compressed transaction history.\n */\nfunction compressTransactionHistory(\n  transactionHistory: TransactionHistory,\n): TransactionHistory {\n  const initialEntry = transactionHistory[0];\n  // Casts required here because this list has two separate types of entries:\n  // TransactionMeta and TransactionHistoryEntry. The only TransactionMeta is the first\n  // entry, but TypeScript loses that type information when `slice` is called for some reason.\n  const historyEntries = transactionHistory.slice(\n    1,\n  ) as TransactionHistoryEntry[];\n\n  const firstNonDisplayedEntryIndex = historyEntries.findIndex(\n    (historyEntry) => {\n      return !historyEntry.some(({ path }) =>\n        DISPLAYED_TRANSACTION_HISTORY_PATHS.includes(path),\n      );\n    },\n  );\n\n  // If no non-displayed entry is found, let history exceed max size.\n  // TODO: Move data used for display to another property, so that we can more reliably limit\n  // history size or remove it altogether.\n  if (firstNonDisplayedEntryIndex === -1) {\n    return transactionHistory;\n  }\n\n  // If a non-displayed entry is found that we can remove, merge it with another entry.\n  // The entry we're merging with might be a \"displayed\" entry, but that's OK, merging more changes\n  // in does not break our display logic.\n  const mergeTargetEntryIndex =\n    // Merge with previous entry if there is no next entry.\n    // We default to merging with next because the next entry might also be non-displayed, so it\n    // might be removed in a future trim, saving more space.\n    firstNonDisplayedEntryIndex === historyEntries.length - 1\n      ? firstNonDisplayedEntryIndex - 1\n      : firstNonDisplayedEntryIndex + 1;\n  const firstIndexToMerge = Math.min(\n    firstNonDisplayedEntryIndex,\n    mergeTargetEntryIndex,\n  );\n  const firstEntryToMerge = historyEntries[firstIndexToMerge];\n  const secondEntryToMerge = historyEntries[firstIndexToMerge + 1];\n\n  const beforeMergeState = replayHistory([\n    initialEntry,\n    ...historyEntries.slice(0, firstIndexToMerge),\n  ]);\n  const afterMergeState = replayHistory([\n    beforeMergeState,\n    firstEntryToMerge,\n    secondEntryToMerge,\n  ]);\n  const mergedHistoryEntry = generateHistoryEntry(\n    beforeMergeState,\n    afterMergeState,\n    `${String(firstEntryToMerge[0].note)}, ${String(\n      secondEntryToMerge[0].note,\n    )}`,\n  );\n\n  historyEntries.splice(firstIndexToMerge, 2, mergedHistoryEntry);\n  return [initialEntry, ...historyEntries];\n}\n\n/**\n * Generates a history entry from the previous and new transaction metadata.\n *\n * @param previousState - The previous transaction metadata.\n * @param currentState - The new transaction metadata.\n * @param note - A note for the transaction metada update.\n * @returns An array of history operation.\n */\nfunction generateHistoryEntry(\n  // TODO: Replace `any` with type\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  previousState: any,\n  currentState: TransactionMeta,\n  note: string,\n): TransactionHistoryEntry {\n  const historyOperationsEntry = jsonDiffer.compare(\n    previousState,\n    currentState,\n  ) as TransactionHistoryEntry;\n  // Add a note to the first operation, since it breaks if we append it to the entry\n  if (historyOperationsEntry[0]) {\n    if (note) {\n      historyOperationsEntry[0].note = note;\n    }\n    historyOperationsEntry[0].timestamp = Date.now();\n  }\n  return historyOperationsEntry;\n}\n\n/**\n * Recovers previous transactionMeta from passed history array.\n *\n * @param transactionHistory - The transaction metadata to replay.\n * @returns The transaction metadata.\n */\nfunction replayHistory(\n  transactionHistory: TransactionHistory,\n): TransactionMeta {\n  const shortHistory = cloneDeep(transactionHistory);\n  return shortHistory.reduce(\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    (val, entry: any) => jsonDiffer.applyPatch(val, entry).newDocument,\n  ) as TransactionMeta;\n}\n\n/**\n * Clone the transaction meta data without the history property.\n *\n * @param transactionMeta - The transaction metadata to snapshot.\n * @returns A deep clone of transaction metadata without history property.\n */\nfunction snapshotFromTransactionMeta(\n  transactionMeta: TransactionMeta,\n): TransactionMeta {\n  const snapshot = { ...transactionMeta };\n  delete snapshot.history;\n  return cloneDeep(snapshot);\n}\n"]}

package/dist/{types/utils/history.d.ts → utils/history.d.cts}

@@ -1,4 +1,4 @@
-import type { TransactionMeta } from '../types';
+import type { TransactionMeta } from "../types.cjs";
 /**
  * The maximum allowed length of the `transaction.history` property.
  */
@@ -26,4 +26,4 @@ export declare function addInitialHistorySnapshot(transactionMeta: TransactionMe
  * existing non-empty `history` array.
  */
 export declare function updateTransactionHistory(transactionMeta: TransactionMeta, note: string): TransactionMeta;
-//# sourceMappingURL=history.d.ts.map
+//# sourceMappingURL=history.d.cts.map

package/dist/utils/history.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"history.d.cts","sourceRoot":"","sources":["../../src/utils/history.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAGV,eAAe,EAChB,qBAAiB;AAElB;;GAEG;AACH,eAAO,MAAM,8BAA8B,MAAM,CAAC;AAElD;;;GAGG;AACH,eAAO,MAAM,mCAAmC,UAM/C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,eAAe,EAAE,eAAe,GAC/B,eAAe,CAGjB;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,EAChC,IAAI,EAAE,MAAM,GACX,eAAe,CAgCjB"}

package/dist/utils/history.d.mts

@@ -0,0 +1,29 @@
+import type { TransactionMeta } from "../types.mjs";
+/**
+ * The maximum allowed length of the `transaction.history` property.
+ */
+export declare const MAX_TRANSACTION_HISTORY_LENGTH = 100;
+/**
+ * A list of trarnsaction history paths that may be used for display. These entries will not be
+ * compressed.
+ */
+export declare const DISPLAYED_TRANSACTION_HISTORY_PATHS: string[];
+/**
+ * Build a new version of the provided transaction with an initial history
+ * entry, which is just a snapshot of the transaction.
+ *
+ * @param transactionMeta - TransactionMeta to add initial history snapshot to.
+ * @returns A copy of `transactionMeta` with a new `history` property.
+ */
+export declare function addInitialHistorySnapshot(transactionMeta: TransactionMeta): TransactionMeta;
+/**
+ * Builds a new version of the transaction with a new history entry if
+ * it has a `history` property, or just returns the transaction.
+ *
+ * @param transactionMeta - TransactionMeta to add history entry to.
+ * @param note - Note to add to history entry.
+ * @returns A copy of `transactionMeta` with a new `history` entry if it has an
+ * existing non-empty `history` array.
+ */
+export declare function updateTransactionHistory(transactionMeta: TransactionMeta, note: string): TransactionMeta;
+//# sourceMappingURL=history.d.mts.map

package/dist/utils/history.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"history.d.mts","sourceRoot":"","sources":["../../src/utils/history.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAGV,eAAe,EAChB,qBAAiB;AAElB;;GAEG;AACH,eAAO,MAAM,8BAA8B,MAAM,CAAC;AAElD;;;GAGG;AACH,eAAO,MAAM,mCAAmC,UAM/C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,eAAe,EAAE,eAAe,GAC/B,eAAe,CAGjB;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,EAChC,IAAI,EAAE,MAAM,GACX,eAAe,CAgCjB"}

package/dist/utils/history.mjs

@@ -1,14 +1,164 @@
-import {
-  DISPLAYED_TRANSACTION_HISTORY_PATHS,
-  MAX_TRANSACTION_HISTORY_LENGTH,
-  addInitialHistorySnapshot,
-  updateTransactionHistory
-} from "../chunk-SMC5Q6ZH.mjs";
-import "../chunk-XUI43LEZ.mjs";
-export {
-  DISPLAYED_TRANSACTION_HISTORY_PATHS,
-  MAX_TRANSACTION_HISTORY_LENGTH,
-  addInitialHistorySnapshot,
-  updateTransactionHistory
-};
+function $importDefault(module) {
+    if (module?.__esModule) {
+        return module.default;
+    }
+    return module;
+}
+import $jsonDiffer from "fast-json-patch";
+const jsonDiffer = $importDefault($jsonDiffer);
+import $lodash from "lodash";
+const { cloneDeep, merge } = $lodash;
+/**
+ * The maximum allowed length of the `transaction.history` property.
+ */
+export const MAX_TRANSACTION_HISTORY_LENGTH = 100;
+/**
+ * A list of trarnsaction history paths that may be used for display. These entries will not be
+ * compressed.
+ */
+export const DISPLAYED_TRANSACTION_HISTORY_PATHS = [
+    '/status',
+    '/txParams/gasPrice',
+    '/txParams/gas',
+    '/estimatedBaseFee',
+    '/blockTimestamp',
+];
+/**
+ * Build a new version of the provided transaction with an initial history
+ * entry, which is just a snapshot of the transaction.
+ *
+ * @param transactionMeta - TransactionMeta to add initial history snapshot to.
+ * @returns A copy of `transactionMeta` with a new `history` property.
+ */
+export function addInitialHistorySnapshot(transactionMeta) {
+    const snapshot = snapshotFromTransactionMeta(transactionMeta);
+    return merge({}, transactionMeta, { history: [snapshot] });
+}
+/**
+ * Builds a new version of the transaction with a new history entry if
+ * it has a `history` property, or just returns the transaction.
+ *
+ * @param transactionMeta - TransactionMeta to add history entry to.
+ * @param note - Note to add to history entry.
+ * @returns A copy of `transactionMeta` with a new `history` entry if it has an
+ * existing non-empty `history` array.
+ */
+export function updateTransactionHistory(transactionMeta, note) {
+    if (!transactionMeta.history) {
+        return transactionMeta;
+    }
+    const currentState = snapshotFromTransactionMeta(transactionMeta);
+    const previousState = replayHistory(transactionMeta.history);
+    const newHistoryEntry = generateHistoryEntry(previousState, currentState, note);
+    if (newHistoryEntry.length === 0) {
+        return transactionMeta;
+    }
+    // Casts required here because this list has two separate types of entries:
+    // TransactionMeta and TransactionHistoryEntry. The only TransactionMeta is the first
+    // entry, but TypeScript loses that type information when `slice` is called for some reason.
+    let updatedHistory = [
+        ...transactionMeta.history,
+        newHistoryEntry,
+    ];
+    if (updatedHistory.length > MAX_TRANSACTION_HISTORY_LENGTH) {
+        updatedHistory = compressTransactionHistory(updatedHistory);
+    }
+    return merge({}, transactionMeta, {
+        history: updatedHistory,
+    });
+}
+/**
+ * Compress the transaction history, if it is possible to do so without compressing entries used
+ * for display. History entries are merged together to make room for a single new entry.
+ *
+ * @param transactionHistory - The transaction history to compress.
+ * @returns A compressed transaction history.
+ */
+function compressTransactionHistory(transactionHistory) {
+    const initialEntry = transactionHistory[0];
+    // Casts required here because this list has two separate types of entries:
+    // TransactionMeta and TransactionHistoryEntry. The only TransactionMeta is the first
+    // entry, but TypeScript loses that type information when `slice` is called for some reason.
+    const historyEntries = transactionHistory.slice(1);
+    const firstNonDisplayedEntryIndex = historyEntries.findIndex((historyEntry) => {
+        return !historyEntry.some(({ path }) => DISPLAYED_TRANSACTION_HISTORY_PATHS.includes(path));
+    });
+    // If no non-displayed entry is found, let history exceed max size.
+    // TODO: Move data used for display to another property, so that we can more reliably limit
+    // history size or remove it altogether.
+    if (firstNonDisplayedEntryIndex === -1) {
+        return transactionHistory;
+    }
+    // If a non-displayed entry is found that we can remove, merge it with another entry.
+    // The entry we're merging with might be a "displayed" entry, but that's OK, merging more changes
+    // in does not break our display logic.
+    const mergeTargetEntryIndex = 
+    // Merge with previous entry if there is no next entry.
+    // We default to merging with next because the next entry might also be non-displayed, so it
+    // might be removed in a future trim, saving more space.
+    firstNonDisplayedEntryIndex === historyEntries.length - 1
+        ? firstNonDisplayedEntryIndex - 1
+        : firstNonDisplayedEntryIndex + 1;
+    const firstIndexToMerge = Math.min(firstNonDisplayedEntryIndex, mergeTargetEntryIndex);
+    const firstEntryToMerge = historyEntries[firstIndexToMerge];
+    const secondEntryToMerge = historyEntries[firstIndexToMerge + 1];
+    const beforeMergeState = replayHistory([
+        initialEntry,
+        ...historyEntries.slice(0, firstIndexToMerge),
+    ]);
+    const afterMergeState = replayHistory([
+        beforeMergeState,
+        firstEntryToMerge,
+        secondEntryToMerge,
+    ]);
+    const mergedHistoryEntry = generateHistoryEntry(beforeMergeState, afterMergeState, `${String(firstEntryToMerge[0].note)}, ${String(secondEntryToMerge[0].note)}`);
+    historyEntries.splice(firstIndexToMerge, 2, mergedHistoryEntry);
+    return [initialEntry, ...historyEntries];
+}
+/**
+ * Generates a history entry from the previous and new transaction metadata.
+ *
+ * @param previousState - The previous transaction metadata.
+ * @param currentState - The new transaction metadata.
+ * @param note - A note for the transaction metada update.
+ * @returns An array of history operation.
+ */
+function generateHistoryEntry(
+// TODO: Replace `any` with type
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+previousState, currentState, note) {
+    const historyOperationsEntry = jsonDiffer.compare(previousState, currentState);
+    // Add a note to the first operation, since it breaks if we append it to the entry
+    if (historyOperationsEntry[0]) {
+        if (note) {
+            historyOperationsEntry[0].note = note;
+        }
+        historyOperationsEntry[0].timestamp = Date.now();
+    }
+    return historyOperationsEntry;
+}
+/**
+ * Recovers previous transactionMeta from passed history array.
+ *
+ * @param transactionHistory - The transaction metadata to replay.
+ * @returns The transaction metadata.
+ */
+function replayHistory(transactionHistory) {
+    const shortHistory = cloneDeep(transactionHistory);
+    return shortHistory.reduce(
+    // TODO: Replace `any` with type
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (val, entry) => jsonDiffer.applyPatch(val, entry).newDocument);
+}
+/**
+ * Clone the transaction meta data without the history property.
+ *
+ * @param transactionMeta - The transaction metadata to snapshot.
+ * @returns A deep clone of transaction metadata without history property.
+ */
+function snapshotFromTransactionMeta(transactionMeta) {
+    const snapshot = { ...transactionMeta };
+    delete snapshot.history;
+    return cloneDeep(snapshot);
+}
 //# sourceMappingURL=history.mjs.map

package/dist/utils/history.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"history.mjs","sourceRoot":"","sources":["../../src/utils/history.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,WAAU,wBAAwB;;;;AASzC;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,GAAG,CAAC;AAElD;;;GAGG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG;IACjD,SAAS;IACT,oBAAoB;IACpB,eAAe;IACf,mBAAmB;IACnB,iBAAiB;CAClB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,yBAAyB,CACvC,eAAgC;IAEhC,MAAM,QAAQ,GAAG,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAC9D,OAAO,KAAK,CAAC,EAAE,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,wBAAwB,CACtC,eAAgC,EAChC,IAAY;IAEZ,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE;QAC5B,OAAO,eAAe,CAAC;KACxB;IAED,MAAM,YAAY,GAAG,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,aAAa,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,eAAe,GAAG,oBAAoB,CAC1C,aAAa,EACb,YAAY,EACZ,IAAI,CACL,CAAC;IAEF,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE;QAChC,OAAO,eAAe,CAAC;KACxB;IAED,2EAA2E;IAC3E,qFAAqF;IACrF,4FAA4F;IAC5F,IAAI,cAAc,GAAG;QACnB,GAAG,eAAe,CAAC,OAAO;QAC1B,eAAe;KACM,CAAC;IAExB,IAAI,cAAc,CAAC,MAAM,GAAG,8BAA8B,EAAE;QAC1D,cAAc,GAAG,0BAA0B,CAAC,cAAc,CAAC,CAAC;KAC7D;IAED,OAAO,KAAK,CAAC,EAAE,EAAE,eAAe,EAAE;QAChC,OAAO,EAAE,cAAc;KACxB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,0BAA0B,CACjC,kBAAsC;IAEtC,MAAM,YAAY,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAC3C,2EAA2E;IAC3E,qFAAqF;IACrF,4FAA4F;IAC5F,MAAM,cAAc,GAAG,kBAAkB,CAAC,KAAK,CAC7C,CAAC,CAC2B,CAAC;IAE/B,MAAM,2BAA2B,GAAG,cAAc,CAAC,SAAS,CAC1D,CAAC,YAAY,EAAE,EAAE;QACf,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CACrC,mCAAmC,CAAC,QAAQ,CAAC,IAAI,CAAC,CACnD,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,mEAAmE;IACnE,2FAA2F;IAC3F,wCAAwC;IACxC,IAAI,2BAA2B,KAAK,CAAC,CAAC,EAAE;QACtC,OAAO,kBAAkB,CAAC;KAC3B;IAED,qFAAqF;IACrF,iGAAiG;IACjG,uCAAuC;IACvC,MAAM,qBAAqB;IACzB,uDAAuD;IACvD,4FAA4F;IAC5F,wDAAwD;IACxD,2BAA2B,KAAK,cAAc,CAAC,MAAM,GAAG,CAAC;QACvD,CAAC,CAAC,2BAA2B,GAAG,CAAC;QACjC,CAAC,CAAC,2BAA2B,GAAG,CAAC,CAAC;IACtC,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAChC,2BAA2B,EAC3B,qBAAqB,CACtB,CAAC;IACF,MAAM,iBAAiB,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;IAC5D,MAAM,kBAAkB,GAAG,cAAc,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC;IAEjE,MAAM,gBAAgB,GAAG,aAAa,CAAC;QACrC,YAAY;QACZ,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,iBAAiB,CAAC;KAC9C,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,aAAa,CAAC;QACpC,gBAAgB;QAChB,iBAAiB;QACjB,kBAAkB;KACnB,CAAC,CAAC;IACH,MAAM,kBAAkB,GAAG,oBAAoB,CAC7C,gBAAgB,EAChB,eAAe,EACf,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,MAAM,CAC7C,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,CAC3B,EAAE,CACJ,CAAC;IAEF,cAAc,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAChE,OAAO,CAAC,YAAY,EAAE,GAAG,cAAc,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,oBAAoB;AAC3B,gCAAgC;AAChC,8DAA8D;AAC9D,aAAkB,EAClB,YAA6B,EAC7B,IAAY;IAEZ,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,CAC/C,aAAa,EACb,YAAY,CACc,CAAC;IAC7B,kFAAkF;IAClF,IAAI,sBAAsB,CAAC,CAAC,CAAC,EAAE;QAC7B,IAAI,IAAI,EAAE;YACR,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC;SACvC;QACD,sBAAsB,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;KAClD;IACD,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CACpB,kBAAsC;IAEtC,MAAM,YAAY,GAAG,SAAS,CAAC,kBAAkB,CAAC,CAAC;IACnD,OAAO,YAAY,CAAC,MAAM;IACxB,gCAAgC;IAChC,8DAA8D;IAC9D,CAAC,GAAG,EAAE,KAAU,EAAE,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,WAAW,CAChD,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,SAAS,2BAA2B,CAClC,eAAgC;IAEhC,MAAM,QAAQ,GAAG,EAAE,GAAG,eAAe,EAAE,CAAC;IACxC,OAAO,QAAQ,CAAC,OAAO,CAAC;IACxB,OAAO,SAAS,CAAC,QAAQ,CAAC,CAAC;AAC7B,CAAC","sourcesContent":["import jsonDiffer from 'fast-json-patch';\nimport { cloneDeep, merge } from 'lodash';\n\nimport type {\n  TransactionHistory,\n  TransactionHistoryEntry,\n  TransactionMeta,\n} from '../types';\n\n/**\n * The maximum allowed length of the `transaction.history` property.\n */\nexport const MAX_TRANSACTION_HISTORY_LENGTH = 100;\n\n/**\n * A list of trarnsaction history paths that may be used for display. These entries will not be\n * compressed.\n */\nexport const DISPLAYED_TRANSACTION_HISTORY_PATHS = [\n  '/status',\n  '/txParams/gasPrice',\n  '/txParams/gas',\n  '/estimatedBaseFee',\n  '/blockTimestamp',\n];\n\n/**\n * Build a new version of the provided transaction with an initial history\n * entry, which is just a snapshot of the transaction.\n *\n * @param transactionMeta - TransactionMeta to add initial history snapshot to.\n * @returns A copy of `transactionMeta` with a new `history` property.\n */\nexport function addInitialHistorySnapshot(\n  transactionMeta: TransactionMeta,\n): TransactionMeta {\n  const snapshot = snapshotFromTransactionMeta(transactionMeta);\n  return merge({}, transactionMeta, { history: [snapshot] });\n}\n\n/**\n * Builds a new version of the transaction with a new history entry if\n * it has a `history` property, or just returns the transaction.\n *\n * @param transactionMeta - TransactionMeta to add history entry to.\n * @param note - Note to add to history entry.\n * @returns A copy of `transactionMeta` with a new `history` entry if it has an\n * existing non-empty `history` array.\n */\nexport function updateTransactionHistory(\n  transactionMeta: TransactionMeta,\n  note: string,\n): TransactionMeta {\n  if (!transactionMeta.history) {\n    return transactionMeta;\n  }\n\n  const currentState = snapshotFromTransactionMeta(transactionMeta);\n  const previousState = replayHistory(transactionMeta.history);\n  const newHistoryEntry = generateHistoryEntry(\n    previousState,\n    currentState,\n    note,\n  );\n\n  if (newHistoryEntry.length === 0) {\n    return transactionMeta;\n  }\n\n  // Casts required here because this list has two separate types of entries:\n  // TransactionMeta and TransactionHistoryEntry. The only TransactionMeta is the first\n  // entry, but TypeScript loses that type information when `slice` is called for some reason.\n  let updatedHistory = [\n    ...transactionMeta.history,\n    newHistoryEntry,\n  ] as TransactionHistory;\n\n  if (updatedHistory.length > MAX_TRANSACTION_HISTORY_LENGTH) {\n    updatedHistory = compressTransactionHistory(updatedHistory);\n  }\n\n  return merge({}, transactionMeta, {\n    history: updatedHistory,\n  });\n}\n\n/**\n * Compress the transaction history, if it is possible to do so without compressing entries used\n * for display. History entries are merged together to make room for a single new entry.\n *\n * @param transactionHistory - The transaction history to compress.\n * @returns A compressed transaction history.\n */\nfunction compressTransactionHistory(\n  transactionHistory: TransactionHistory,\n): TransactionHistory {\n  const initialEntry = transactionHistory[0];\n  // Casts required here because this list has two separate types of entries:\n  // TransactionMeta and TransactionHistoryEntry. The only TransactionMeta is the first\n  // entry, but TypeScript loses that type information when `slice` is called for some reason.\n  const historyEntries = transactionHistory.slice(\n    1,\n  ) as TransactionHistoryEntry[];\n\n  const firstNonDisplayedEntryIndex = historyEntries.findIndex(\n    (historyEntry) => {\n      return !historyEntry.some(({ path }) =>\n        DISPLAYED_TRANSACTION_HISTORY_PATHS.includes(path),\n      );\n    },\n  );\n\n  // If no non-displayed entry is found, let history exceed max size.\n  // TODO: Move data used for display to another property, so that we can more reliably limit\n  // history size or remove it altogether.\n  if (firstNonDisplayedEntryIndex === -1) {\n    return transactionHistory;\n  }\n\n  // If a non-displayed entry is found that we can remove, merge it with another entry.\n  // The entry we're merging with might be a \"displayed\" entry, but that's OK, merging more changes\n  // in does not break our display logic.\n  const mergeTargetEntryIndex =\n    // Merge with previous entry if there is no next entry.\n    // We default to merging with next because the next entry might also be non-displayed, so it\n    // might be removed in a future trim, saving more space.\n    firstNonDisplayedEntryIndex === historyEntries.length - 1\n      ? firstNonDisplayedEntryIndex - 1\n      : firstNonDisplayedEntryIndex + 1;\n  const firstIndexToMerge = Math.min(\n    firstNonDisplayedEntryIndex,\n    mergeTargetEntryIndex,\n  );\n  const firstEntryToMerge = historyEntries[firstIndexToMerge];\n  const secondEntryToMerge = historyEntries[firstIndexToMerge + 1];\n\n  const beforeMergeState = replayHistory([\n    initialEntry,\n    ...historyEntries.slice(0, firstIndexToMerge),\n  ]);\n  const afterMergeState = replayHistory([\n    beforeMergeState,\n    firstEntryToMerge,\n    secondEntryToMerge,\n  ]);\n  const mergedHistoryEntry = generateHistoryEntry(\n    beforeMergeState,\n    afterMergeState,\n    `${String(firstEntryToMerge[0].note)}, ${String(\n      secondEntryToMerge[0].note,\n    )}`,\n  );\n\n  historyEntries.splice(firstIndexToMerge, 2, mergedHistoryEntry);\n  return [initialEntry, ...historyEntries];\n}\n\n/**\n * Generates a history entry from the previous and new transaction metadata.\n *\n * @param previousState - The previous transaction metadata.\n * @param currentState - The new transaction metadata.\n * @param note - A note for the transaction metada update.\n * @returns An array of history operation.\n */\nfunction generateHistoryEntry(\n  // TODO: Replace `any` with type\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  previousState: any,\n  currentState: TransactionMeta,\n  note: string,\n): TransactionHistoryEntry {\n  const historyOperationsEntry = jsonDiffer.compare(\n    previousState,\n    currentState,\n  ) as TransactionHistoryEntry;\n  // Add a note to the first operation, since it breaks if we append it to the entry\n  if (historyOperationsEntry[0]) {\n    if (note) {\n      historyOperationsEntry[0].note = note;\n    }\n    historyOperationsEntry[0].timestamp = Date.now();\n  }\n  return historyOperationsEntry;\n}\n\n/**\n * Recovers previous transactionMeta from passed history array.\n *\n * @param transactionHistory - The transaction metadata to replay.\n * @returns The transaction metadata.\n */\nfunction replayHistory(\n  transactionHistory: TransactionHistory,\n): TransactionMeta {\n  const shortHistory = cloneDeep(transactionHistory);\n  return shortHistory.reduce(\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    (val, entry: any) => jsonDiffer.applyPatch(val, entry).newDocument,\n  ) as TransactionMeta;\n}\n\n/**\n * Clone the transaction meta data without the history property.\n *\n * @param transactionMeta - The transaction metadata to snapshot.\n * @returns A deep clone of transaction metadata without history property.\n */\nfunction snapshotFromTransactionMeta(\n  transactionMeta: TransactionMeta,\n): TransactionMeta {\n  const snapshot = { ...transactionMeta };\n  delete snapshot.history;\n  return cloneDeep(snapshot);\n}\n"]}