Add Relay strategy

Author: matthewwalsh0

packages/transaction-controller/package.json

@@ -79,6 +79,7 @@
     "@metamask/gas-fee-controller": "^24.1.0",
     "@metamask/network-controller": "^24.2.1",
     "@metamask/remote-feature-flag-controller": "^1.8.0",
+    "@ts-bridge/cli": "^0.6.1",
     "@types/bn.js": "^5.1.5",
     "@types/jest": "^27.4.1",
     "@types/node": "^16.18.54",

packages/transaction-controller/src/helpers/PendingTransactionTracker.ts

@@ -382,7 +382,12 @@ export class PendingTransactionTracker {
   }
 
   async #checkTransaction(txMeta: TransactionMeta) {
-    const { hash, id } = txMeta;
+    const { hash, id, isIntentComplete } = txMeta;
+
+    if (isIntentComplete) {
+      await this.#onTransactionConfirmed(txMeta);
+      return;
+    }
 
     if (!hash && (await this.#beforeCheckPendingTransaction(txMeta))) {
       const error = new Error(
@@ -450,10 +455,10 @@ export class PendingTransactionTracker {
 
   async #onTransactionConfirmed(
     txMeta: TransactionMeta,
-    receipt: SuccessfulTransactionReceipt,
+    receipt?: SuccessfulTransactionReceipt,
   ) {
     const { id } = txMeta;
-    const { blockHash } = receipt;
+    const { blockHash } = receipt ?? {};
 
     this.#log('Transaction confirmed', id);
 
@@ -463,19 +468,23 @@ export class PendingTransactionTracker {
       return;
     }
 
-    const { baseFeePerGas, timestamp: blockTimestamp } =
-      await this.#getBlockByHash(blockHash, false);
-
     const updatedTxMeta = cloneDeep(txMeta);
-    updatedTxMeta.baseFeePerGas = baseFeePerGas;
-    updatedTxMeta.blockTimestamp = blockTimestamp;
+
+    if (receipt && blockHash) {
+      const { baseFeePerGas, timestamp: blockTimestamp } =
+        await this.#getBlockByHash(blockHash, false);
+
+      updatedTxMeta.baseFeePerGas = baseFeePerGas;
+      updatedTxMeta.blockTimestamp = blockTimestamp;
+      updatedTxMeta.txParams = {
+        ...updatedTxMeta.txParams,
+        gasUsed: receipt.gasUsed,
+      };
+      updatedTxMeta.txReceipt = receipt;
+      updatedTxMeta.verifiedOnBlockchain = true;
+    }
+
     updatedTxMeta.status = TransactionStatus.confirmed;
-    updatedTxMeta.txParams = {
-      ...updatedTxMeta.txParams,
-      gasUsed: receipt.gasUsed,
-    };
-    updatedTxMeta.txReceipt = receipt;
-    updatedTxMeta.verifiedOnBlockchain = true;
 
     this.#updateTransaction(
       updatedTxMeta,

packages/transaction-controller/src/types.ts

@@ -268,6 +268,9 @@ export type TransactionMeta = {
   /** Whether MetaMask will be compensated for the gas fee by the transaction. */
   isGasFeeIncluded?: boolean;
 
+  /** Whether the intent of the transaction was achieved via an alternate route or chain. */
+  isIntentComplete?: boolean;
+
   /**
    * Whether the transaction is an incoming token transfer.
    */

packages/transaction-pay-controller/src/TransactionPayController.test.ts

@@ -67,15 +67,15 @@ describe('TransactionPayController', () => {
   });
 
   describe('getStrategy Action', () => {
-    it('returns bridge if no callback', async () => {
+    it('returns relay if no callback', async () => {
       createController();
 
       expect(
         await messenger.call(
           'TransactionPayController:getStrategy',
           TRANSACTION_META_MOCK,
         ),
-      ).toBe(TransactionPayStrategy.Bridge);
+      ).toBe(TransactionPayStrategy.Relay);
     });
 
     it('returns callback value if provided', async () => {

packages/transaction-pay-controller/src/TransactionPayController.ts

@@ -123,7 +123,7 @@ export class TransactionPayController extends BaseController<
   #registerActionHandlers() {
     this.messagingSystem.registerActionHandler(
       'TransactionPayController:getStrategy',
-      this.#getStrategy ?? (async () => TransactionPayStrategy.Bridge),
+      this.#getStrategy ?? (async () => TransactionPayStrategy.Relay),
     );
   }
 }

packages/transaction-pay-controller/src/constants.ts

@@ -2,5 +2,6 @@ export const CONTROLLER_NAME = 'TransactionPayController';
 
 export enum TransactionPayStrategy {
   Bridge = 'bridge',
+  Relay = 'relay',
   Test = 'test',
 }

packages/transaction-pay-controller/src/helpers/TransactionPayPublishHook.test.ts

@@ -5,11 +5,11 @@ import type { TransactionMeta } from '@metamask/transaction-controller';
 import type { TransactionControllerUnapprovedTransactionAddedEvent } from '@metamask/transaction-controller';
 
 import { TransactionPayPublishHook } from './TransactionPayPublishHook';
-import type { TransactionPayPublishHookMessenger } from './TransactionPayPublishHook';
 import { TransactionPayStrategy } from '../constants';
 import { TestStrategy } from '../strategy/test/TestStrategy';
 import type {
   TransactionPayControllerGetStateAction,
+  TransactionPayPublishHookMessenger,
   TransactionPayQuote,
 } from '../types';
 
@@ -100,12 +100,6 @@ describe('TransactionPayPublishHook', () => {
     expect(executeMock).not.toHaveBeenCalled();
   });
 
-  it('returns empty result', async () => {
-    const result = await runHook();
-
-    expect(result).toStrictEqual({ transactionHash: undefined });
-  });
-
   it('throws errors from submit', async () => {
     executeMock.mockRejectedValue(new Error('Test error'));
 

packages/transaction-pay-controller/src/helpers/TransactionPayPublishHook.ts

@@ -1,7 +1,3 @@
-import type { Messenger } from '@metamask/base-controller';
-import type { BridgeStatusControllerStateChangeEvent } from '@metamask/bridge-status-controller';
-import type { BridgeStatusControllerActions } from '@metamask/bridge-status-controller';
-import type { TransactionControllerUnapprovedTransactionAddedEvent } from '@metamask/transaction-controller';
 import type { PublishHook } from '@metamask/transaction-controller';
 import type { TransactionMeta } from '@metamask/transaction-controller';
 import type { PublishHookResult } from '@metamask/transaction-controller';
@@ -10,8 +6,7 @@ import { createModuleLogger } from '@metamask/utils';
 
 import { projectLogger } from '../logger';
 import type {
-  TransactionPayControllerGetStateAction,
-  TransactionPayControllerGetStrategyAction,
+  TransactionPayPublishHookMessenger,
   TransactionPayQuote,
 } from '../types';
 import { getStrategy } from '../utils/strategy';
@@ -22,14 +17,6 @@ const EMPTY_RESULT = {
   transactionHash: undefined,
 };
 
-export type TransactionPayPublishHookMessenger = Messenger<
-  | BridgeStatusControllerActions
-  | TransactionPayControllerGetStateAction
-  | TransactionPayControllerGetStrategyAction,
-  | BridgeStatusControllerStateChangeEvent
-  | TransactionControllerUnapprovedTransactionAddedEvent
->;
-
 export class TransactionPayPublishHook {
   readonly #isSmartTransaction: (chainId: Hex) => boolean;
 
@@ -83,13 +70,11 @@ export class TransactionPayPublishHook {
 
     const strategy = await getStrategy(this.#messenger, transactionMeta);
 
-    await strategy.execute({
+    return await strategy.execute({
       isSmartTransaction: this.#isSmartTransaction,
       quotes,
       messenger: this.#messenger,
       transaction: transactionMeta,
     });
-
-    return EMPTY_RESULT;
   }
 }

packages/transaction-pay-controller/src/index.ts

@@ -4,10 +4,10 @@ export type {
   TransactionPayControllerState,
   TransactionPayControllerStateChangeEvent,
   TransactionPaymentToken,
+  TransactionPayPublishHookMessenger,
   TransactionPayQuote,
   TransactionPayTotals,
   TransactionToken,
 } from './types';
 export { TransactionPayController } from './TransactionPayController';
-export type { TransactionPayPublishHookMessenger } from './helpers/TransactionPayPublishHook';
 export { TransactionPayPublishHook } from './helpers/TransactionPayPublishHook';

packages/transaction-pay-controller/src/strategy/bridge/BridgeStrategy.ts

@@ -28,5 +28,7 @@ export class BridgeStrategy implements PayStrategy<QuoteResponse> {
       quotes,
       updateTransaction: noop,
     });
+
+    return { transactionHash: undefined };
   }
 }