@metamask/transaction-controller 35.0.1 → 35.1.0

package/CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [35.1.0]
+
+### Added
+
+- Add `DISPLAYED_TRANSACTION_HISTORY_PATHS` constant, representing the transaction history paths that may be used for display ([#4555](https://github.com/MetaMask/core/pull/4555))
+  - This was exported so that it might be used to ensure display logic and internal history logic remains in-sync.
+  - Any paths listed here will have their timestamps preserved. Unlisted paths may be compressed by the controller to minimize history size, losing the timestamp.
+- Add `MAX_TRANSACTION_HISTORY_LENGTH` constant, representing the expected maximum size of the `history` property for a given transaction ([#4555](https://github.com/MetaMask/core/pull/4555))
+  - Note that this is not strictly enforced, the length may exceed this number of all entries are "displayed" entries, but we expect this to be extremely improbable in practice.
+
+### Fixed
+
+- Prevent transaction history from growing endlessly in size ([#4555](https://github.com/MetaMask/core/pull/4555))
+
 ## [35.0.1]
 
 ### Changed
@@ -934,7 +948,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@35.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@35.1.0...HEAD
+[35.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@35.0.1...@metamask/transaction-controller@35.1.0
 [35.0.1]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@35.0.0...@metamask/transaction-controller@35.0.1
 [35.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@34.0.0...@metamask/transaction-controller@35.0.0
 [34.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@33.0.1...@metamask/transaction-controller@34.0.0

package/dist/TransactionController.js

@@ -4,7 +4,7 @@
 
 
 
-var _chunkPHSSZPCUjs = require('./chunk-PHSSZPCU.js');
+var _chunkQKS2F7VGjs = require('./chunk-QKS2F7VG.js');
 require('./chunk-PRUNMTRD.js');
 require('./chunk-NNCUD3QF.js');
 require('./chunk-KT6UAKBB.js');
@@ -13,7 +13,7 @@ require('./chunk-RXIUMVA5.js');
 require('./chunk-ULD4JC3Q.js');
 require('./chunk-7LXE4KHV.js');
 require('./chunk-V72C4MCR.js');
-require('./chunk-QP75SWIQ.js');
+require('./chunk-TIE3CPF7.js');
 require('./chunk-NYKRCWBG.js');
 require('./chunk-WR5F34OW.js');
 require('./chunk-YVCX6Z75.js');
@@ -41,5 +41,5 @@ require('./chunk-Z4BLTVTB.js');
 
 
 
-exports.ApprovalState = _chunkPHSSZPCUjs.ApprovalState; exports.CANCEL_RATE = _chunkPHSSZPCUjs.CANCEL_RATE; exports.HARDFORK = _chunkPHSSZPCUjs.HARDFORK; exports.SPEED_UP_RATE = _chunkPHSSZPCUjs.SPEED_UP_RATE; exports.TransactionController = _chunkPHSSZPCUjs.TransactionController;
+exports.ApprovalState = _chunkQKS2F7VGjs.ApprovalState; exports.CANCEL_RATE = _chunkQKS2F7VGjs.CANCEL_RATE; exports.HARDFORK = _chunkQKS2F7VGjs.HARDFORK; exports.SPEED_UP_RATE = _chunkQKS2F7VGjs.SPEED_UP_RATE; exports.TransactionController = _chunkQKS2F7VGjs.TransactionController;
 //# sourceMappingURL=TransactionController.js.map

package/dist/TransactionController.mjs

@@ -4,7 +4,7 @@ import {
   HARDFORK,
   SPEED_UP_RATE,
   TransactionController
-} from "./chunk-J2OIT7FN.mjs";
+} from "./chunk-5JWPMHSZ.mjs";
 import "./chunk-6DDVVUJC.mjs";
 import "./chunk-3AVRGHUO.mjs";
 import "./chunk-K4KOSAGM.mjs";
@@ -13,7 +13,7 @@ import "./chunk-5ZEJT5SN.mjs";
 import "./chunk-6B5BEO3R.mjs";
 import "./chunk-FRKQ3Z2L.mjs";
 import "./chunk-5G6OHAXI.mjs";
-import "./chunk-XGRAHX6T.mjs";
+import "./chunk-SMC5Q6ZH.mjs";
 import "./chunk-VEVVBHP3.mjs";
 import "./chunk-Z4GV3YQQ.mjs";
 import "./chunk-FG74Z3F5.mjs";

package/dist/{chunk-J2OIT7FN.mjs → chunk-5JWPMHSZ.mjs}

@@ -26,7 +26,7 @@ import {
 import {
   addInitialHistorySnapshot,
   updateTransactionHistory
-} from "./chunk-XGRAHX6T.mjs";
+} from "./chunk-SMC5Q6ZH.mjs";
 import {
   OptimismLayer1GasFeeFlow
 } from "./chunk-VEVVBHP3.mjs";
@@ -2563,4 +2563,4 @@ export {
   ApprovalState,
   TransactionController
 };
-//# sourceMappingURL=chunk-J2OIT7FN.mjs.map
+//# sourceMappingURL=chunk-5JWPMHSZ.mjs.map

package/dist/{chunk-PHSSZPCU.js → chunk-QKS2F7VG.js}

@@ -26,7 +26,7 @@ var _chunkV72C4MCRjs = require('./chunk-V72C4MCR.js');
 
 
 
-var _chunkQP75SWIQjs = require('./chunk-QP75SWIQ.js');
+var _chunkTIE3CPF7js = require('./chunk-TIE3CPF7.js');
 
 
 var _chunkNYKRCWBGjs = require('./chunk-NYKRCWBG.js');
@@ -514,7 +514,7 @@ var TransactionController = class extends _basecontroller.BaseController {
         addedTransactionMeta.sendFlowHistory = sendFlowHistory ?? [];
       }
       if (!this.isHistoryDisabled) {
-        addedTransactionMeta = _chunkQP75SWIQjs.addInitialHistorySnapshot.call(void 0, addedTransactionMeta);
+        addedTransactionMeta = _chunkTIE3CPF7js.addInitialHistorySnapshot.call(void 0, addedTransactionMeta);
       }
       addedTransactionMeta = _chunkQH2H4W3Njs.updateSwapsTransaction.call(void 0, 
         addedTransactionMeta,
@@ -1998,7 +1998,7 @@ var TransactionController = class extends _basecontroller.BaseController {
       confirmedTxs,
       pendingTxs
     );
-    const newTransactionMeta = (transactionMeta.history ?? []).length === 0 && !this.isHistoryDisabled ? _chunkQP75SWIQjs.addInitialHistorySnapshot.call(void 0, transactionMeta) : transactionMeta;
+    const newTransactionMeta = (transactionMeta.history ?? []).length === 0 && !this.isHistoryDisabled ? _chunkTIE3CPF7js.addInitialHistorySnapshot.call(void 0, transactionMeta) : transactionMeta;
     this.update((state) => {
       state.transactions = this.trimTransactionsForState([
         ...state.transactions,
@@ -2406,7 +2406,7 @@ updateTransactionInternal_fn = function({
     updatedTransactionParams = _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _checkIfTransactionParamsUpdated, checkIfTransactionParamsUpdated_fn).call(this, transactionMeta2);
     const shouldSkipHistory = this.isHistoryDisabled || skipHistory;
     if (!shouldSkipHistory) {
-      transactionMeta2 = _chunkQP75SWIQjs.updateTransactionHistory.call(void 0, 
+      transactionMeta2 = _chunkTIE3CPF7js.updateTransactionHistory.call(void 0, 
         transactionMeta2,
         note ?? "Transaction updated"
       );
@@ -2563,4 +2563,4 @@ getSelectedAccount_fn = function() {
 
 
 exports.HARDFORK = HARDFORK; exports.CANCEL_RATE = CANCEL_RATE; exports.SPEED_UP_RATE = SPEED_UP_RATE; exports.ApprovalState = ApprovalState; exports.TransactionController = TransactionController;
-//# sourceMappingURL=chunk-PHSSZPCU.js.map
+//# sourceMappingURL=chunk-QKS2F7VG.js.map

package/dist/chunk-SMC5Q6ZH.mjs

@@ -0,0 +1,120 @@
+// src/utils/history.ts
+import jsonDiffer from "fast-json-patch";
+import { cloneDeep, merge } from "lodash";
+var MAX_TRANSACTION_HISTORY_LENGTH = 100;
+var DISPLAYED_TRANSACTION_HISTORY_PATHS = [
+  "/status",
+  "/txParams/gasPrice",
+  "/txParams/gas",
+  "/estimatedBaseFee",
+  "/blockTimestamp"
+];
+function addInitialHistorySnapshot(transactionMeta) {
+  const snapshot = snapshotFromTransactionMeta(transactionMeta);
+  return merge({}, transactionMeta, { history: [snapshot] });
+}
+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;
+  }
+  let updatedHistory = [
+    ...transactionMeta.history,
+    newHistoryEntry
+  ];
+  if (updatedHistory.length > MAX_TRANSACTION_HISTORY_LENGTH) {
+    updatedHistory = compressTransactionHistory(updatedHistory);
+  }
+  return merge({}, transactionMeta, {
+    history: updatedHistory
+  });
+}
+function compressTransactionHistory(transactionHistory) {
+  const initialEntry = transactionHistory[0];
+  const historyEntries = transactionHistory.slice(
+    1
+  );
+  const firstNonDisplayedEntryIndex = historyEntries.findIndex(
+    (historyEntry) => {
+      return !historyEntry.some(
+        ({ path }) => DISPLAYED_TRANSACTION_HISTORY_PATHS.includes(path)
+      );
+    }
+  );
+  if (firstNonDisplayedEntryIndex === -1) {
+    return transactionHistory;
+  }
+  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];
+}
+function generateHistoryEntry(previousState, currentState, note) {
+  const historyOperationsEntry = jsonDiffer.compare(
+    previousState,
+    currentState
+  );
+  if (historyOperationsEntry[0]) {
+    if (note) {
+      historyOperationsEntry[0].note = note;
+    }
+    historyOperationsEntry[0].timestamp = Date.now();
+  }
+  return historyOperationsEntry;
+}
+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
+  );
+}
+function snapshotFromTransactionMeta(transactionMeta) {
+  const snapshot = { ...transactionMeta };
+  delete snapshot.history;
+  return cloneDeep(snapshot);
+}
+
+export {
+  MAX_TRANSACTION_HISTORY_LENGTH,
+  DISPLAYED_TRANSACTION_HISTORY_PATHS,
+  addInitialHistorySnapshot,
+  updateTransactionHistory
+};
+//# sourceMappingURL=chunk-SMC5Q6ZH.mjs.map

package/dist/chunk-SMC5Q6ZH.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils/history.ts"],"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"],"mappings":";AAAA,OAAO,gBAAgB;AACvB,SAAS,WAAW,aAAa;AAW1B,IAAM,iCAAiC;AAMvC,IAAM,sCAAsC;AAAA,EACjD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AASO,SAAS,0BACd,iBACiB;AACjB,QAAM,WAAW,4BAA4B,eAAe;AAC5D,SAAO,MAAM,CAAC,GAAG,iBAAiB,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC;AAC3D;AAWO,SAAS,yBACd,iBACA,MACiB;AACjB,MAAI,CAAC,gBAAgB,SAAS;AAC5B,WAAO;AAAA,EACT;AAEA,QAAM,eAAe,4BAA4B,eAAe;AAChE,QAAM,gBAAgB,cAAc,gBAAgB,OAAO;AAC3D,QAAM,kBAAkB;AAAA,IACtB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,MAAI,gBAAgB,WAAW,GAAG;AAChC,WAAO;AAAA,EACT;AAKA,MAAI,iBAAiB;AAAA,IACnB,GAAG,gBAAgB;AAAA,IACnB;AAAA,EACF;AAEA,MAAI,eAAe,SAAS,gCAAgC;AAC1D,qBAAiB,2BAA2B,cAAc;AAAA,EAC5D;AAEA,SAAO,MAAM,CAAC,GAAG,iBAAiB;AAAA,IAChC,SAAS;AAAA,EACX,CAAC;AACH;AASA,SAAS,2BACP,oBACoB;AACpB,QAAM,eAAe,mBAAmB,CAAC;AAIzC,QAAM,iBAAiB,mBAAmB;AAAA,IACxC;AAAA,EACF;AAEA,QAAM,8BAA8B,eAAe;AAAA,IACjD,CAAC,iBAAiB;AAChB,aAAO,CAAC,aAAa;AAAA,QAAK,CAAC,EAAE,KAAK,MAChC,oCAAoC,SAAS,IAAI;AAAA,MACnD;AAAA,IACF;AAAA,EACF;AAKA,MAAI,gCAAgC,IAAI;AACtC,WAAO;AAAA,EACT;AAKA,QAAM;AAAA;AAAA;AAAA;AAAA,IAIJ,gCAAgC,eAAe,SAAS,IACpD,8BAA8B,IAC9B,8BAA8B;AAAA;AACpC,QAAM,oBAAoB,KAAK;AAAA,IAC7B;AAAA,IACA;AAAA,EACF;AACA,QAAM,oBAAoB,eAAe,iBAAiB;AAC1D,QAAM,qBAAqB,eAAe,oBAAoB,CAAC;AAE/D,QAAM,mBAAmB,cAAc;AAAA,IACrC;AAAA,IACA,GAAG,eAAe,MAAM,GAAG,iBAAiB;AAAA,EAC9C,CAAC;AACD,QAAM,kBAAkB,cAAc;AAAA,IACpC;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACD,QAAM,qBAAqB;AAAA,IACzB;AAAA,IACA;AAAA,IACA,GAAG,OAAO,kBAAkB,CAAC,EAAE,IAAI,CAAC,KAAK;AAAA,MACvC,mBAAmB,CAAC,EAAE;AAAA,IACxB,CAAC;AAAA,EACH;AAEA,iBAAe,OAAO,mBAAmB,GAAG,kBAAkB;AAC9D,SAAO,CAAC,cAAc,GAAG,cAAc;AACzC;AAUA,SAAS,qBAGP,eACA,cACA,MACyB;AACzB,QAAM,yBAAyB,WAAW;AAAA,IACxC;AAAA,IACA;AAAA,EACF;AAEA,MAAI,uBAAuB,CAAC,GAAG;AAC7B,QAAI,MAAM;AACR,6BAAuB,CAAC,EAAE,OAAO;AAAA,IACnC;AACA,2BAAuB,CAAC,EAAE,YAAY,KAAK,IAAI;AAAA,EACjD;AACA,SAAO;AACT;AAQA,SAAS,cACP,oBACiB;AACjB,QAAM,eAAe,UAAU,kBAAkB;AACjD,SAAO,aAAa;AAAA;AAAA;AAAA,IAGlB,CAAC,KAAK,UAAe,WAAW,WAAW,KAAK,KAAK,EAAE;AAAA,EACzD;AACF;AAQA,SAAS,4BACP,iBACiB;AACjB,QAAM,WAAW,EAAE,GAAG,gBAAgB;AACtC,SAAO,SAAS;AAChB,SAAO,UAAU,QAAQ;AAC3B;","names":[]}

package/dist/chunk-TIE3CPF7.js

@@ -0,0 +1,120 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }// src/utils/history.ts
+var _fastjsonpatch = require('fast-json-patch'); var _fastjsonpatch2 = _interopRequireDefault(_fastjsonpatch);
+var _lodash = require('lodash');
+var MAX_TRANSACTION_HISTORY_LENGTH = 100;
+var DISPLAYED_TRANSACTION_HISTORY_PATHS = [
+  "/status",
+  "/txParams/gasPrice",
+  "/txParams/gas",
+  "/estimatedBaseFee",
+  "/blockTimestamp"
+];
+function addInitialHistorySnapshot(transactionMeta) {
+  const snapshot = snapshotFromTransactionMeta(transactionMeta);
+  return _lodash.merge.call(void 0, {}, transactionMeta, { history: [snapshot] });
+}
+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;
+  }
+  let updatedHistory = [
+    ...transactionMeta.history,
+    newHistoryEntry
+  ];
+  if (updatedHistory.length > MAX_TRANSACTION_HISTORY_LENGTH) {
+    updatedHistory = compressTransactionHistory(updatedHistory);
+  }
+  return _lodash.merge.call(void 0, {}, transactionMeta, {
+    history: updatedHistory
+  });
+}
+function compressTransactionHistory(transactionHistory) {
+  const initialEntry = transactionHistory[0];
+  const historyEntries = transactionHistory.slice(
+    1
+  );
+  const firstNonDisplayedEntryIndex = historyEntries.findIndex(
+    (historyEntry) => {
+      return !historyEntry.some(
+        ({ path }) => DISPLAYED_TRANSACTION_HISTORY_PATHS.includes(path)
+      );
+    }
+  );
+  if (firstNonDisplayedEntryIndex === -1) {
+    return transactionHistory;
+  }
+  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];
+}
+function generateHistoryEntry(previousState, currentState, note) {
+  const historyOperationsEntry = _fastjsonpatch2.default.compare(
+    previousState,
+    currentState
+  );
+  if (historyOperationsEntry[0]) {
+    if (note) {
+      historyOperationsEntry[0].note = note;
+    }
+    historyOperationsEntry[0].timestamp = Date.now();
+  }
+  return historyOperationsEntry;
+}
+function replayHistory(transactionHistory) {
+  const shortHistory = _lodash.cloneDeep.call(void 0, transactionHistory);
+  return shortHistory.reduce(
+    // TODO: Replace `any` with type
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (val, entry) => _fastjsonpatch2.default.applyPatch(val, entry).newDocument
+  );
+}
+function snapshotFromTransactionMeta(transactionMeta) {
+  const snapshot = { ...transactionMeta };
+  delete snapshot.history;
+  return _lodash.cloneDeep.call(void 0, snapshot);
+}
+
+
+
+
+
+
+exports.MAX_TRANSACTION_HISTORY_LENGTH = MAX_TRANSACTION_HISTORY_LENGTH; exports.DISPLAYED_TRANSACTION_HISTORY_PATHS = DISPLAYED_TRANSACTION_HISTORY_PATHS; exports.addInitialHistorySnapshot = addInitialHistorySnapshot; exports.updateTransactionHistory = updateTransactionHistory;
+//# sourceMappingURL=chunk-TIE3CPF7.js.map

package/dist/chunk-TIE3CPF7.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils/history.ts"],"names":[],"mappings":";AAAA,OAAO,gBAAgB;AACvB,SAAS,WAAW,aAAa;AAW1B,IAAM,iCAAiC;AAMvC,IAAM,sCAAsC;AAAA,EACjD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AASO,SAAS,0BACd,iBACiB;AACjB,QAAM,WAAW,4BAA4B,eAAe;AAC5D,SAAO,MAAM,CAAC,GAAG,iBAAiB,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC;AAC3D;AAWO,SAAS,yBACd,iBACA,MACiB;AACjB,MAAI,CAAC,gBAAgB,SAAS;AAC5B,WAAO;AAAA,EACT;AAEA,QAAM,eAAe,4BAA4B,eAAe;AAChE,QAAM,gBAAgB,cAAc,gBAAgB,OAAO;AAC3D,QAAM,kBAAkB;AAAA,IACtB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,MAAI,gBAAgB,WAAW,GAAG;AAChC,WAAO;AAAA,EACT;AAKA,MAAI,iBAAiB;AAAA,IACnB,GAAG,gBAAgB;AAAA,IACnB;AAAA,EACF;AAEA,MAAI,eAAe,SAAS,gCAAgC;AAC1D,qBAAiB,2BAA2B,cAAc;AAAA,EAC5D;AAEA,SAAO,MAAM,CAAC,GAAG,iBAAiB;AAAA,IAChC,SAAS;AAAA,EACX,CAAC;AACH;AASA,SAAS,2BACP,oBACoB;AACpB,QAAM,eAAe,mBAAmB,CAAC;AAIzC,QAAM,iBAAiB,mBAAmB;AAAA,IACxC;AAAA,EACF;AAEA,QAAM,8BAA8B,eAAe;AAAA,IACjD,CAAC,iBAAiB;AAChB,aAAO,CAAC,aAAa;AAAA,QAAK,CAAC,EAAE,KAAK,MAChC,oCAAoC,SAAS,IAAI;AAAA,MACnD;AAAA,IACF;AAAA,EACF;AAKA,MAAI,gCAAgC,IAAI;AACtC,WAAO;AAAA,EACT;AAKA,QAAM;AAAA;AAAA;AAAA;AAAA,IAIJ,gCAAgC,eAAe,SAAS,IACpD,8BAA8B,IAC9B,8BAA8B;AAAA;AACpC,QAAM,oBAAoB,KAAK;AAAA,IAC7B;AAAA,IACA;AAAA,EACF;AACA,QAAM,oBAAoB,eAAe,iBAAiB;AAC1D,QAAM,qBAAqB,eAAe,oBAAoB,CAAC;AAE/D,QAAM,mBAAmB,cAAc;AAAA,IACrC;AAAA,IACA,GAAG,eAAe,MAAM,GAAG,iBAAiB;AAAA,EAC9C,CAAC;AACD,QAAM,kBAAkB,cAAc;AAAA,IACpC;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACD,QAAM,qBAAqB;AAAA,IACzB;AAAA,IACA;AAAA,IACA,GAAG,OAAO,kBAAkB,CAAC,EAAE,IAAI,CAAC,KAAK;AAAA,MACvC,mBAAmB,CAAC,EAAE;AAAA,IACxB,CAAC;AAAA,EACH;AAEA,iBAAe,OAAO,mBAAmB,GAAG,kBAAkB;AAC9D,SAAO,CAAC,cAAc,GAAG,cAAc;AACzC;AAUA,SAAS,qBAGP,eACA,cACA,MACyB;AACzB,QAAM,yBAAyB,WAAW;AAAA,IACxC;AAAA,IACA;AAAA,EACF;AAEA,MAAI,uBAAuB,CAAC,GAAG;AAC7B,QAAI,MAAM;AACR,6BAAuB,CAAC,EAAE,OAAO;AAAA,IACnC;AACA,2BAAuB,CAAC,EAAE,YAAY,KAAK,IAAI;AAAA,EACjD;AACA,SAAO;AACT;AAQA,SAAS,cACP,oBACiB;AACjB,QAAM,eAAe,UAAU,kBAAkB;AACjD,SAAO,aAAa;AAAA;AAAA;AAAA,IAGlB,CAAC,KAAK,UAAe,WAAW,WAAW,KAAK,KAAK,EAAE;AAAA,EACzD;AACF;AAQA,SAAS,4BACP,iBACiB;AACjB,QAAM,WAAW,EAAE,GAAG,gBAAgB;AACtC,SAAO,SAAS;AAChB,SAAO,UAAU,QAAQ;AAC3B","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/index.js

@@ -2,7 +2,7 @@
 
 
 
-var _chunkPHSSZPCUjs = require('./chunk-PHSSZPCU.js');
+var _chunkQKS2F7VGjs = require('./chunk-QKS2F7VG.js');
 require('./chunk-PRUNMTRD.js');
 require('./chunk-NNCUD3QF.js');
 require('./chunk-KT6UAKBB.js');
@@ -13,7 +13,10 @@ require('./chunk-RXIUMVA5.js');
 require('./chunk-ULD4JC3Q.js');
 require('./chunk-7LXE4KHV.js');
 require('./chunk-V72C4MCR.js');
-require('./chunk-QP75SWIQ.js');
+
+
+
+var _chunkTIE3CPF7js = require('./chunk-TIE3CPF7.js');
 require('./chunk-NYKRCWBG.js');
 require('./chunk-WR5F34OW.js');
 require('./chunk-YVCX6Z75.js');
@@ -67,5 +70,7 @@ require('./chunk-Z4BLTVTB.js');
 
 
 
-exports.CANCEL_RATE = _chunkPHSSZPCUjs.CANCEL_RATE; exports.GasFeeEstimateLevel = _chunkAYTU4HU5js.GasFeeEstimateLevel; exports.GasFeeEstimateType = _chunkAYTU4HU5js.GasFeeEstimateType; exports.HARDFORK = _chunkPHSSZPCUjs.HARDFORK; exports.SimulationErrorCode = _chunkAYTU4HU5js.SimulationErrorCode; exports.SimulationTokenStandard = _chunkAYTU4HU5js.SimulationTokenStandard; exports.TransactionController = _chunkPHSSZPCUjs.TransactionController; exports.TransactionEnvelopeType = _chunkAYTU4HU5js.TransactionEnvelopeType; exports.TransactionStatus = _chunkAYTU4HU5js.TransactionStatus; exports.TransactionType = _chunkAYTU4HU5js.TransactionType; exports.UserFeeLevel = _chunkAYTU4HU5js.UserFeeLevel; exports.WalletDevice = _chunkAYTU4HU5js.WalletDevice; exports.determineTransactionType = _chunkSD6CWFDFjs.determineTransactionType; exports.isEIP1559Transaction = _chunkOZ6UB42Cjs.isEIP1559Transaction; exports.mergeGasFeeEstimates = _chunk76FONEDAjs.mergeGasFeeEstimates; exports.normalizeTransactionParams = _chunkOZ6UB42Cjs.normalizeTransactionParams;
+
+
+exports.CANCEL_RATE = _chunkQKS2F7VGjs.CANCEL_RATE; exports.DISPLAYED_TRANSACTION_HISTORY_PATHS = _chunkTIE3CPF7js.DISPLAYED_TRANSACTION_HISTORY_PATHS; exports.GasFeeEstimateLevel = _chunkAYTU4HU5js.GasFeeEstimateLevel; exports.GasFeeEstimateType = _chunkAYTU4HU5js.GasFeeEstimateType; exports.HARDFORK = _chunkQKS2F7VGjs.HARDFORK; exports.MAX_TRANSACTION_HISTORY_LENGTH = _chunkTIE3CPF7js.MAX_TRANSACTION_HISTORY_LENGTH; exports.SimulationErrorCode = _chunkAYTU4HU5js.SimulationErrorCode; exports.SimulationTokenStandard = _chunkAYTU4HU5js.SimulationTokenStandard; exports.TransactionController = _chunkQKS2F7VGjs.TransactionController; exports.TransactionEnvelopeType = _chunkAYTU4HU5js.TransactionEnvelopeType; exports.TransactionStatus = _chunkAYTU4HU5js.TransactionStatus; exports.TransactionType = _chunkAYTU4HU5js.TransactionType; exports.UserFeeLevel = _chunkAYTU4HU5js.UserFeeLevel; exports.WalletDevice = _chunkAYTU4HU5js.WalletDevice; exports.determineTransactionType = _chunkSD6CWFDFjs.determineTransactionType; exports.isEIP1559Transaction = _chunkOZ6UB42Cjs.isEIP1559Transaction; exports.mergeGasFeeEstimates = _chunk76FONEDAjs.mergeGasFeeEstimates; exports.normalizeTransactionParams = _chunkOZ6UB42Cjs.normalizeTransactionParams;
 //# sourceMappingURL=index.js.map

package/dist/index.mjs

@@ -2,7 +2,7 @@ import {
   CANCEL_RATE,
   HARDFORK,
   TransactionController
-} from "./chunk-J2OIT7FN.mjs";
+} from "./chunk-5JWPMHSZ.mjs";
 import "./chunk-6DDVVUJC.mjs";
 import "./chunk-3AVRGHUO.mjs";
 import "./chunk-K4KOSAGM.mjs";
@@ -13,7 +13,10 @@ import "./chunk-5ZEJT5SN.mjs";
 import "./chunk-6B5BEO3R.mjs";
 import "./chunk-FRKQ3Z2L.mjs";
 import "./chunk-5G6OHAXI.mjs";
-import "./chunk-XGRAHX6T.mjs";
+import {
+  DISPLAYED_TRANSACTION_HISTORY_PATHS,
+  MAX_TRANSACTION_HISTORY_LENGTH
+} from "./chunk-SMC5Q6ZH.mjs";
 import "./chunk-VEVVBHP3.mjs";
 import "./chunk-Z4GV3YQQ.mjs";
 import "./chunk-FG74Z3F5.mjs";
@@ -52,9 +55,11 @@ import {
 import "./chunk-XUI43LEZ.mjs";
 export {
   CANCEL_RATE,
+  DISPLAYED_TRANSACTION_HISTORY_PATHS,
   GasFeeEstimateLevel,
   GasFeeEstimateType,
   HARDFORK,
+  MAX_TRANSACTION_HISTORY_LENGTH,
   SimulationErrorCode,
   SimulationTokenStandard,
   TransactionController,