Add unit tests

Author: matthewwalsh0

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

@@ -1,6 +1,7 @@
 export type {
   TransactionPayControllerActions,
   TransactionPayControllerEvents,
+  TransactionPayControllerGetDelegationTransactionAction,
   TransactionPayControllerGetStateAction,
   TransactionPayControllerGetStrategyAction,
   TransactionPayControllerMessenger,

packages/transaction-pay-controller/src/strategy/relay/relay-quotes.test.ts

@@ -13,7 +13,10 @@ import { getRelayQuotes } from './relay-quotes';
 import type { RelayQuote } from './types';
 import { NATIVE_TOKEN_ADDRESS } from '../../constants';
 import { getMessengerMock } from '../../tests/messenger-mock';
-import type { QuoteRequest } from '../../types';
+import type {
+  GetDelegationTransactionCallback,
+  QuoteRequest,
+} from '../../types';
 import { calculateGasCost, calculateTransactionGasCost } from '../../utils/gas';
 import { getNativeToken, getTokenFiatRate } from '../../utils/token';
 
@@ -26,14 +29,14 @@ jest.mock('@metamask/controller-utils', () => ({
 }));
 
 const QUOTE_REQUEST_MOCK: QuoteRequest = {
-  from: '0x123',
+  from: '0x1234567890123456789012345678901234567891',
   sourceBalanceRaw: '10000000000000000000',
   sourceChainId: '0x1',
   sourceTokenAddress: '0xabc',
   sourceTokenAmount: '1000000000000000000',
   targetAmountMinimum: '123',
   targetChainId: '0x2',
-  targetTokenAddress: '0xdef',
+  targetTokenAddress: '0x1234567890123456789012345678901234567890',
 };
 
 const QUOTE_MOCK = {
@@ -81,6 +84,19 @@ const QUOTE_MOCK = {
 
 const TRANSACTION_META_MOCK = { txParams: {} } as TransactionMeta;
 
+const DELEGATION_RESULT_MOCK = {
+  authorizationList: [
+    {
+      chainId: '0x1' as Hex,
+      nonce: '0x2' as Hex,
+      yParity: '0x1' as Hex,
+    },
+  ],
+  data: '0x111' as Hex,
+  to: '0x222' as Hex,
+  value: '0x333' as Hex,
+} as Awaited<ReturnType<GetDelegationTransactionCallback>>;
+
 describe('Relay Quotes Utils', () => {
   const successfulFetchMock = jest.mocked(successfulFetch);
   const getTokenFiatRateMock = jest.mocked(getTokenFiatRate);
@@ -91,8 +107,11 @@ describe('Relay Quotes Utils', () => {
     calculateTransactionGasCost,
   );
 
-  const { messenger, getRemoteFeatureFlagControllerStateMock } =
-    getMessengerMock();
+  const {
+    messenger,
+    getDelegationTransactionMock,
+    getRemoteFeatureFlagControllerStateMock,
+  } = getMessengerMock();
 
   beforeEach(() => {
     jest.resetAllMocks();
@@ -116,6 +135,8 @@ describe('Relay Quotes Utils', () => {
       cacheTimestamp: 0,
       remoteFeatureFlags: {},
     });
+
+    getDelegationTransactionMock.mockResolvedValue(DELEGATION_RESULT_MOCK);
   });
 
   describe('getRelayQuotes', () => {
@@ -165,6 +186,52 @@ describe('Relay Quotes Utils', () => {
       );
     });
 
+    it('includes transactions in request', async () => {
+      successfulFetchMock.mockResolvedValue({
+        json: async () => QUOTE_MOCK,
+      } as never);
+
+      await getRelayQuotes({
+        messenger,
+        requests: [QUOTE_REQUEST_MOCK],
+        transaction: {
+          ...TRANSACTION_META_MOCK,
+          txParams: {
+            data: '0xabc' as Hex,
+          },
+        } as TransactionMeta,
+      });
+
+      const body = JSON.parse(
+        successfulFetchMock.mock.calls[0][1]?.body as string,
+      );
+
+      expect(body).toStrictEqual(
+        expect.objectContaining({
+          authorizationList: [
+            {
+              chainId: 1,
+              nonce: 2,
+              yParity: 1,
+            },
+          ],
+          tradeType: 'EXACT_OUTPUT',
+          txs: [
+            {
+              to: QUOTE_REQUEST_MOCK.targetTokenAddress,
+              data: '0xa9059cbb0000000000000000000000001234567890123456789012345678901234567891000000000000000000000000000000000000000000000000000000000000007b',
+              value: '0x0',
+            },
+            {
+              to: DELEGATION_RESULT_MOCK.to,
+              data: DELEGATION_RESULT_MOCK.data,
+              value: DELEGATION_RESULT_MOCK.value,
+            },
+          ],
+        }),
+      );
+    });
+
     it('sends request to url from feature flag', async () => {
       successfulFetchMock.mockResolvedValue({
         json: async () => QUOTE_MOCK,

packages/transaction-pay-controller/src/strategy/relay/relay-quotes.ts

@@ -122,6 +122,8 @@ async function processTransactions(
   messenger: TransactionPayControllerMessenger,
 ) {
   const { data, value } = transaction.txParams;
+
+  /* istanbul ignore next */
   const hasNoParams = (!data || data === '0x') && (!value || value === '0x0');
 
   const skipDelegation =

packages/transaction-pay-controller/src/strategy/relay/relay-submit.test.ts

@@ -245,6 +245,14 @@ describe('Relay Submit Utils', () => {
       );
     });
 
+    it('does not wait for relay status if same chain', async () => {
+      request.quotes[0].original.details.currencyOut.currency.chainId = 1;
+
+      await submitRelayQuotes(request);
+
+      expect(successfulFetchMock).toHaveBeenCalledTimes(0);
+    });
+
     it('throws if transaction fails to confirm', async () => {
       waitForTransactionConfirmedMock.mockRejectedValue(
         new Error('Transaction failed'),
@@ -297,6 +305,18 @@ describe('Relay Submit Utils', () => {
       expect(result.transactionHash).toBe(TRANSACTION_HASH_MOCK);
     });
 
+    it('returns fallback hash if none included', async () => {
+      successfulFetchMock.mockResolvedValue({
+        json: async () => ({
+          ...STATUS_RESPONSE_MOCK,
+          txHashes: [],
+        }),
+      } as Response);
+
+      const result = await submitRelayQuotes(request);
+      expect(result.transactionHash).toBe('0x0');
+    });
+
     it('adds required transaction IDs', async () => {
       await submitRelayQuotes(request);
 

packages/transaction-pay-controller/src/strategy/relay/relay-submit.ts

@@ -29,7 +29,7 @@ import {
   waitForTransactionConfirmed,
 } from '../../utils/transaction';
 
-const FALLBCAK_HASH = '0x0' as Hex;
+const FALLBACK_HASH = '0x0' as Hex;
 
 const log = createModuleLogger(projectLogger, 'relay-strategy');
 
@@ -127,7 +127,7 @@ async function waitForRelayCompletion(quote: RelayQuote): Promise<Hex> {
     quote.details.currencyOut.currency.chainId
   ) {
     log('Skipping polling as same chain');
-    return FALLBCAK_HASH;
+    return FALLBACK_HASH;
   }
 
   const { endpoint, method } = quote.steps
@@ -144,7 +144,7 @@ async function waitForRelayCompletion(quote: RelayQuote): Promise<Hex> {
 
     if (status.status === 'success') {
       const targetHash = status.txHashes?.slice(-1)[0] as Hex;
-      return targetHash ?? FALLBCAK_HASH;
+      return targetHash ?? FALLBACK_HASH;
     }
 
     if (['failure', 'refund', 'fallback'].includes(status.status)) {

packages/transaction-pay-controller/src/tests/messenger-mock.ts

@@ -21,7 +21,10 @@ import type { TransactionControllerUpdateTransactionAction } from '@metamask/tra
 
 import type { TransactionPayControllerMessenger } from '..';
 import type { BridgeStatusControllerSubmitTxAction } from '../../../bridge-status-controller/src/types';
-import type { TransactionPayControllerGetStrategyAction } from '../types';
+import type {
+  TransactionPayControllerGetDelegationTransactionAction,
+  TransactionPayControllerGetStrategyAction,
+} from '../types';
 import { type TransactionPayControllerGetStateAction } from '../types';
 
 type AllActions = MessengerActions<TransactionPayControllerMessenger>;
@@ -104,6 +107,10 @@ export function getMessengerMock({
     NetworkControllerGetNetworkClientByIdAction['handler']
   > = jest.fn();
 
+  const getDelegationTransactionMock: jest.MockedFn<
+    TransactionPayControllerGetDelegationTransactionAction['handler']
+  > = jest.fn();
+
   const messenger: RootMessenger = new Messenger({
     namespace: MOCK_ANY_NAMESPACE,
   });
@@ -198,6 +205,11 @@ export function getMessengerMock({
       'NetworkController:getNetworkClientById',
       getNetworkClientByIdMock,
     );
+
+    messenger.registerActionHandler(
+      'TransactionPayController:getDelegationTransaction',
+      getDelegationTransactionMock,
+    );
   }
 
   const publish = messenger.publish.bind(messenger);
@@ -211,6 +223,7 @@ export function getMessengerMock({
     getBridgeStatusControllerStateMock,
     getControllerStateMock,
     getCurrencyRateControllerStateMock,
+    getDelegationTransactionMock,
     getGasFeeControllerStateMock,
     getNetworkClientByIdMock,
     getRemoteFeatureFlagControllerStateMock,