@metamask-previews/transaction-controller 10.0.0-preview.d5e3b8e → 10.0.0-preview.dbee2e4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask-previews/transaction-controller",
3
- "version": "10.0.0-preview.d5e3b8e",
3
+ "version": "10.0.0-preview.dbee2e4",
4
4
  "description": "Stores transactions alongside their periodically updated statuses and manages interactions such as approval and cancellation",
5
5
  "keywords": [
6
6
  "MetaMask",
@@ -40,8 +40,6 @@
40
40
  "eth-method-registry": "1.1.0",
41
41
  "eth-rpc-errors": "^4.0.2",
42
42
  "ethereumjs-util": "^7.0.10",
43
- "fast-json-patch": "^3.1.1",
44
- "lodash": "^4.17.21",
45
43
  "nonce-tracker": "^1.1.0",
46
44
  "uuid": "^8.3.2"
47
45
  },
package/dist/history.d.ts DELETED
@@ -1,15 +0,0 @@
1
- import type { TransactionMeta } from './types';
2
- /**
3
- * Add initial history snapshot to the provided transactionMeta history.
4
- *
5
- * @param transactionMeta - TransactionMeta to add initial history snapshot to.
6
- */
7
- export declare function addInitialHistorySnapshot(transactionMeta: TransactionMeta): void;
8
- /**
9
- * Compares and adds history entry to the provided transactionMeta history.
10
- *
11
- * @param transactionMeta - TransactionMeta to add history entry to.
12
- * @param note - Note to add to history entry.
13
- */
14
- export declare function updateTransactionHistory(transactionMeta: TransactionMeta, note: string): void;
15
- //# sourceMappingURL=history.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"history.d.ts","sourceRoot":"","sources":["../src/history.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAGV,eAAe,EAChB,MAAM,SAAS,CAAC;AAEjB;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,eAAe,EAAE,eAAe,QAGzE;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,EAChC,IAAI,EAAE,MAAM,GACX,IAAI,CAWN"}
package/dist/history.js DELETED
@@ -1,75 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.updateTransactionHistory = exports.addInitialHistorySnapshot = void 0;
7
- const fast_json_patch_1 = __importDefault(require("fast-json-patch"));
8
- const lodash_1 = require("lodash");
9
- /**
10
- * Add initial history snapshot to the provided transactionMeta history.
11
- *
12
- * @param transactionMeta - TransactionMeta to add initial history snapshot to.
13
- */
14
- function addInitialHistorySnapshot(transactionMeta) {
15
- const snapshot = snapshotFromTransactionMeta(transactionMeta);
16
- transactionMeta.history = [snapshot];
17
- }
18
- exports.addInitialHistorySnapshot = addInitialHistorySnapshot;
19
- /**
20
- * Compares and adds history entry to the provided transactionMeta history.
21
- *
22
- * @param transactionMeta - TransactionMeta to add history entry to.
23
- * @param note - Note to add to history entry.
24
- */
25
- function updateTransactionHistory(transactionMeta, note) {
26
- var _a;
27
- const currentState = snapshotFromTransactionMeta(transactionMeta);
28
- const previousState = replayHistory(transactionMeta.history);
29
- const historyEntry = generateHistoryEntry(previousState, currentState, note);
30
- if (historyEntry.length) {
31
- (_a = transactionMeta === null || transactionMeta === void 0 ? void 0 : transactionMeta.history) === null || _a === void 0 ? void 0 : _a.push(historyEntry);
32
- }
33
- }
34
- exports.updateTransactionHistory = updateTransactionHistory;
35
- /**
36
- * Generates a history entry from the previous and new transaction metadata.
37
- *
38
- * @param previousState - The previous transaction metadata.
39
- * @param currentState - The new transaction metadata.
40
- * @param note - A note for the transaction metada update.
41
- * @returns An array of history operation.
42
- */
43
- function generateHistoryEntry(previousState, currentState, note) {
44
- const historyOperationsEntry = fast_json_patch_1.default.compare(previousState, currentState);
45
- // Add a note to the first operation, since it breaks if we append it to the entry
46
- if (historyOperationsEntry[0]) {
47
- if (note) {
48
- historyOperationsEntry[0].note = note;
49
- }
50
- historyOperationsEntry[0].timestamp = Date.now();
51
- }
52
- return historyOperationsEntry;
53
- }
54
- /**
55
- * Recovers previous transactionMeta from passed history array.
56
- *
57
- * @param transactionHistory - The transaction metadata to replay.
58
- * @returns The transaction metadata.
59
- */
60
- function replayHistory(transactionHistory) {
61
- const shortHistory = (0, lodash_1.cloneDeep)(transactionHistory);
62
- return shortHistory.reduce((val, entry) => fast_json_patch_1.default.applyPatch(val, entry).newDocument);
63
- }
64
- /**
65
- * Clone the transaction meta data without the history property.
66
- *
67
- * @param transactionMeta - The transaction metadata to snapshot.
68
- * @returns A deep clone of transaction metadata without history property.
69
- */
70
- function snapshotFromTransactionMeta(transactionMeta) {
71
- const snapshot = Object.assign({}, transactionMeta);
72
- delete snapshot.history;
73
- return (0, lodash_1.cloneDeep)(snapshot);
74
- }
75
- //# sourceMappingURL=history.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"history.js","sourceRoot":"","sources":["../src/history.ts"],"names":[],"mappings":";;;;;;AAAA,sEAAyC;AACzC,mCAAmC;AAQnC;;;;GAIG;AACH,SAAgB,yBAAyB,CAAC,eAAgC;IACxE,MAAM,QAAQ,GAAG,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAC9D,eAAe,CAAC,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC;AAHD,8DAGC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CACtC,eAAgC,EAChC,IAAY;;IAEZ,MAAM,YAAY,GAAG,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,aAAa,CACjC,eAAe,CAAC,OAA6B,CAC9C,CAAC;IAEF,MAAM,YAAY,GAAG,oBAAoB,CAAC,aAAa,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAE7E,IAAI,YAAY,CAAC,MAAM,EAAE;QACvB,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,0CAAE,IAAI,CAAC,YAAY,CAAC,CAAC;KAC9C;AACH,CAAC;AAdD,4DAcC;AAED;;;;;;;GAOG;AACH,SAAS,oBAAoB,CAC3B,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,CACxB,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,qBAAQ,eAAe,CAAE,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 } from 'lodash';\n\nimport type {\n TransactionHistory,\n TransactionHistoryEntry,\n TransactionMeta,\n} from './types';\n\n/**\n * Add initial history snapshot to the provided transactionMeta history.\n *\n * @param transactionMeta - TransactionMeta to add initial history snapshot to.\n */\nexport function addInitialHistorySnapshot(transactionMeta: TransactionMeta) {\n const snapshot = snapshotFromTransactionMeta(transactionMeta);\n transactionMeta.history = [snapshot];\n}\n\n/**\n * Compares and adds history entry to the provided transactionMeta history.\n *\n * @param transactionMeta - TransactionMeta to add history entry to.\n * @param note - Note to add to history entry.\n */\nexport function updateTransactionHistory(\n transactionMeta: TransactionMeta,\n note: string,\n): void {\n const currentState = snapshotFromTransactionMeta(transactionMeta);\n const previousState = replayHistory(\n transactionMeta.history as TransactionHistory,\n );\n\n const historyEntry = generateHistoryEntry(previousState, currentState, note);\n\n if (historyEntry.length) {\n transactionMeta?.history?.push(historyEntry);\n }\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 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 (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/logger.d.ts DELETED
@@ -1,6 +0,0 @@
1
- /// <reference types="debug" />
2
- import { createModuleLogger } from '@metamask/utils';
3
- export declare const projectLogger: import("debug").Debugger;
4
- export declare const incomingTransactionsLogger: import("debug").Debugger;
5
- export { createModuleLogger };
6
- //# sourceMappingURL=logger.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";AAAA,OAAO,EAAuB,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE1E,eAAO,MAAM,aAAa,0BAAgD,CAAC;AAE3E,eAAO,MAAM,0BAA0B,0BAGtC,CAAC;AAEF,OAAO,EAAE,kBAAkB,EAAE,CAAC"}
package/dist/logger.js DELETED
@@ -1,8 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.createModuleLogger = exports.incomingTransactionsLogger = exports.projectLogger = void 0;
4
- const utils_1 = require("@metamask/utils");
5
- Object.defineProperty(exports, "createModuleLogger", { enumerable: true, get: function () { return utils_1.createModuleLogger; } });
6
- exports.projectLogger = (0, utils_1.createProjectLogger)('transaction-controller');
7
- exports.incomingTransactionsLogger = (0, utils_1.createModuleLogger)(exports.projectLogger, 'incoming-transactions');
8
- //# sourceMappingURL=logger.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;AAAA,2CAA0E;AASjE,mGATqB,0BAAkB,OASrB;AAPd,QAAA,aAAa,GAAG,IAAA,2BAAmB,EAAC,wBAAwB,CAAC,CAAC;AAE9D,QAAA,0BAA0B,GAAG,IAAA,0BAAkB,EAC1D,qBAAa,EACb,uBAAuB,CACxB,CAAC","sourcesContent":["import { createProjectLogger, createModuleLogger } from '@metamask/utils';\n\nexport const projectLogger = createProjectLogger('transaction-controller');\n\nexport const incomingTransactionsLogger = createModuleLogger(\n projectLogger,\n 'incoming-transactions',\n);\n\nexport { createModuleLogger };\n"]}