Refactor: Rename transactionHash to hash

Author: vinistevam

packages/transaction-controller/jest.config.js

@@ -19,7 +19,7 @@ module.exports = merge(baseConfig, {
     global: {
       branches: 83.91,
       functions: 92.68,
-      lines: 95.35,
+      lines: 95.34,
       statements: 95.46,
     },
   },

packages/transaction-controller/src/EtherscanRemoteTransactionSource.test.ts

@@ -102,7 +102,7 @@ const EXPECTED_NORMALISED_TRANSACTION_BASE = {
     to: ETHERSCAN_TRANSACTION_SUCCESS_MOCK.to,
     value: '0xb1a2bc2ec50000',
   },
-  transactionHash: ETHERSCAN_TRANSACTION_SUCCESS_MOCK.hash,
+  hash: ETHERSCAN_TRANSACTION_SUCCESS_MOCK.hash,
   verifiedOnBlockchain: false,
 };
 

packages/transaction-controller/src/EtherscanRemoteTransactionSource.ts

@@ -154,7 +154,7 @@ export class EtherscanRemoteTransactionSource
         to: txMeta.to,
         value: BNToHex(new BN(txMeta.value)),
       },
-      transactionHash: txMeta.hash,
+      hash: txMeta.hash,
       verifiedOnBlockchain: false,
     };
   }

packages/transaction-controller/src/IncomingTransactionHelper.test.ts

@@ -48,15 +48,15 @@ const TRANSACTION_MOCK: TransactionMeta = {
   status: TransactionStatus.submitted,
   time: 0,
   transaction: { to: '0x1', gasUsed: '0x1' },
-  transactionHash: '0x1',
+  hash: '0x1',
 } as unknown as TransactionMeta;
 
 const TRANSACTION_MOCK_2: TransactionMeta = {
   blockNumber: '234',
   chainId: '0x1',
   time: 1,
   transaction: { to: '0x1' },
-  transactionHash: '0x2',
+  hash: '0x2',
 } as unknown as TransactionMeta;
 
 const createRemoteTransactionSourceMock = (

packages/transaction-controller/src/IncomingTransactionHelper.ts

@@ -178,10 +178,7 @@ export class IncomingTransactionHelper {
     localTxs: TransactionMeta[],
   ): TransactionMeta[] {
     return remoteTxs.filter(
-      (tx) =>
-        !localTxs.some(
-          ({ transactionHash }) => transactionHash === tx.transactionHash,
-        ),
+      (tx) => !localTxs.some(({ hash }) => hash === tx.hash),
     );
   }
 
@@ -192,7 +189,7 @@ export class IncomingTransactionHelper {
     return remoteTxs.filter((remoteTx) =>
       localTxs.some(
         (localTx) =>
-          remoteTx.transactionHash === localTx.transactionHash &&
+          remoteTx.hash === localTx.hash &&
           this.#isTransactionOutdated(remoteTx, localTx),
       ),
     );

packages/transaction-controller/src/TransactionController.test.ts

@@ -84,12 +84,10 @@ jest.mock('@metamask/eth-query', () =>
       },
       getTransactionByHash: (_hash: string, callback: any) => {
         const txs: any = [
-          { transactionHash: '1337', blockNumber: '0x1' },
-          { transactionHash: '1338', blockNumber: null },
+          { hash: '1337', blockNumber: '0x1' },
+          { hash: '1338', blockNumber: null },
         ];
-        const tx: any = txs.find(
-          (element: any) => element.transactionHash === _hash,
-        );
+        const tx: any = txs.find((element: any) => element.hash === _hash);
         callback(undefined, tx);
       },
       getTransactionCount: (_from: any, _to: any, callback: any) => {
@@ -101,22 +99,20 @@ jest.mock('@metamask/eth-query', () =>
       getTransactionReceipt: (_hash: any, callback: any) => {
         const txs: any = [
           {
-            transactionHash: '1337',
+            hash: '1337',
             gasUsed: '0x5208',
             status: '0x1',
             transactionIndex: 1337,
             blockHash: '1337',
           },
           {
-            transactionHash: '1111',
+            hash: '1111',
             gasUsed: '0x1108',
             status: '0x0',
             transactionIndex: 1111,
           },
         ];
-        const tx: any = txs.find(
-          (element: any) => element.transactionHash === _hash,
-        );
+        const tx: any = txs.find((element: any) => element.hash === _hash);
         callback(undefined, tx);
       },
       getBlockByHash: (_blockHash: any, callback: any) => {
@@ -401,7 +397,7 @@ const TRANSACTION_META_MOCK = {
   transaction: {
     from: ACCOUNT_MOCK,
   },
-  transactionHash: '0x1',
+  hash: '0x1',
   time: 123456789,
 } as TransactionMeta;
 
@@ -410,7 +406,7 @@ const TRANSACTION_META_2_MOCK = {
   transaction: {
     from: '0x3',
   },
-  transactionHash: '0x2',
+  hash: '0x2',
   time: 987654321,
 } as TransactionMeta;
 
@@ -1174,7 +1170,7 @@ describe('TransactionController', () => {
         id: 'foo',
         networkID: '5',
         status: TransactionStatus.submitted,
-        transactionHash: '1337',
+        hash: '1337',
       } as any);
 
       controller.wipeTransactions();
@@ -1255,7 +1251,7 @@ describe('TransactionController', () => {
         networkID: '5',
         chainId: toHex(5),
         status: TransactionStatus.submitted,
-        transactionHash: '1337',
+        hash: '1337',
       } as any);
 
       controller.state.transactions.push({} as any);
@@ -1280,7 +1276,7 @@ describe('TransactionController', () => {
         id: 'foo',
         networkID: '5',
         status: TransactionStatus.submitted,
-        transactionHash: '1337',
+        hash: '1337',
       } as any);
 
       controller.state.transactions.push({} as any);
@@ -1303,7 +1299,7 @@ describe('TransactionController', () => {
         id: 'foo',
         networkID: '5',
         status: TransactionStatus.submitted,
-        transactionHash: '1338',
+        hash: '1338',
       } as any);
 
       await controller.queryTransactionStatuses();
@@ -1321,7 +1317,7 @@ describe('TransactionController', () => {
         networkID: '5',
         chainId: toHex(5),
         status: TransactionStatus.confirmed,
-        transactionHash: '1337',
+        hash: '1337',
         verifiedOnBlockchain: false,
         transaction: {
           gasUsed: undefined,
@@ -1527,14 +1523,14 @@ describe('TransactionController', () => {
         id: 'mocked',
         networkID: '5',
         status: TransactionStatus.unapproved,
-        transactionHash: '1337',
+        hash: '1337',
       };
       const controller = newController();
       controller.state.transactions.push(transaction as any);
       controller.state.transactions.push({
         ...transaction,
         id: 'mocked1',
-        transactionHash: '1338',
+        hash: '1338',
       } as any);
 
       controller.initApprovals();

packages/transaction-controller/src/TransactionController.ts

@@ -670,14 +670,14 @@ export class TransactionController extends BaseController<
       transactionMeta.transaction.from,
     );
     const rawTransaction = bufferToHex(signedTx.serialize());
-    const transactionHash = await query(this.ethQuery, 'sendRawTransaction', [
+    const hash = await query(this.ethQuery, 'sendRawTransaction', [
       rawTransaction,
     ]);
     const baseTransactionMeta = {
       ...transactionMeta,
       id: random(),
       time: Date.now(),
-      transactionHash,
+      hash,
     };
     const newTransactionMeta =
       newMaxFeePerGas && newMaxPriorityFeePerGas
@@ -945,7 +945,7 @@ export class TransactionController extends BaseController<
 
       case TransactionStatus.submitted:
         resultCallbacks?.success();
-        return finalMeta.transactionHash as string;
+        return finalMeta.hash as string;
 
       default:
         const internalError = ethErrors.rpc.internal(
@@ -1036,10 +1036,10 @@ export class TransactionController extends BaseController<
 
       transactionMeta.rawTransaction = rawTransaction;
       this.updateTransaction(transactionMeta);
-      const transactionHash = await query(this.ethQuery, 'sendRawTransaction', [
+      const hash = await query(this.ethQuery, 'sendRawTransaction', [
         rawTransaction,
       ]);
-      transactionMeta.transactionHash = transactionHash;
+      transactionMeta.hash = hash;
       transactionMeta.status = TransactionStatus.submitted;
       this.updateTransaction(transactionMeta);
       this.hub.emit(`${transactionMeta.id}:finished`, transactionMeta);
@@ -1155,11 +1155,11 @@ export class TransactionController extends BaseController<
   private async blockchainTransactionStateReconciler(
     meta: TransactionMeta,
   ): Promise<[TransactionMeta, boolean]> {
-    const { status, transactionHash } = meta;
+    const { status, hash } = meta;
     switch (status) {
       case TransactionStatus.confirmed:
         const txReceipt = await query(this.ethQuery, 'getTransactionReceipt', [
-          transactionHash,
+          hash,
         ]);
 
         if (!txReceipt) {
@@ -1189,12 +1189,12 @@ export class TransactionController extends BaseController<
         return [meta, true];
       case TransactionStatus.submitted:
         const txObj = await query(this.ethQuery, 'getTransactionByHash', [
-          transactionHash,
+          hash,
         ]);
 
         if (!txObj) {
           const receiptShowsFailedStatus =
-            await this.checkTxReceiptStatusIsFailed(transactionHash);
+            await this.checkTxReceiptStatusIsFailed(hash);
 
           // Case the txObj is evaluated as false, a second check will
           // determine if the tx failed or it is pending or confirmed
@@ -1351,8 +1351,7 @@ export class TransactionController extends BaseController<
       ...added,
       ...currentTransactions.map((originalTransaction) => {
         const updatedTransaction = updated.find(
-          ({ transactionHash }) =>
-            transactionHash === originalTransaction.transactionHash,
+          ({ hash }) => hash === originalTransaction.hash,
         );
 
         return updatedTransaction ?? originalTransaction;

packages/transaction-controller/src/types.ts

@@ -44,7 +44,12 @@ type TransactionMetaBase = {
   deviceConfirmedOn?: WalletDevice;
 
   /**
-   * Generated UUID associated with this transaction.
+   * Hash of a successful transaction.
+   */
+  hash?: string;
+
+  /**
+   * Transaction ID.
    */
   id: string;
 
@@ -83,11 +88,6 @@ type TransactionMetaBase = {
    */
   transaction: Transaction;
 
-  /**
-   * Hash of a successful transaction.
-   */
-  transactionHash?: string;
-
   /**
    * Additional transfer information.
    */