feat(transaction-pay-controller): support polymarket deposit-wallet

packages/transaction-pay-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add Polymarket deposit-wallet support to the Relay strategy for `predictWithdraw` transactions, routed via the `isPolymarketDepositWallet` flag on `TransactionConfig` ([#8754](https://github.com/MetaMask/core/pull/8754))
+
 ## [22.4.0]
 
 ### Added

packages/transaction-pay-controller/src/TransactionPayController-method-action-types.ts

@@ -81,6 +81,30 @@ export type TransactionPayControllerGetStrategyAction = {
   handler: TransactionPayController['getStrategy'];
 };
 
+/**
+ * Derives the Polymarket deposit-wallet address for an EOA via the
+ * client-supplied callback.
+ *
+ * @param args - The arguments forwarded to {@link PolymarketCallbacks.getDepositWalletAddress}.
+ * @returns A promise resolving to the deposit-wallet address.
+ */
+export type TransactionPayControllerPolymarketGetDepositWalletAddressAction = {
+  type: `TransactionPayController:polymarketGetDepositWalletAddress`;
+  handler: TransactionPayController['polymarketGetDepositWalletAddress'];
+};
+
+/**
+ * Signs and broadcasts a Polymarket deposit-wallet batch via the
+ * client-supplied callback.
+ *
+ * @param args - The arguments forwarded to {@link PolymarketCallbacks.submitDepositWalletBatch}.
+ * @returns A promise resolving to the relayer-issued source hash.
+ */
+export type TransactionPayControllerPolymarketSubmitDepositWalletBatchAction = {
+  type: `TransactionPayController:polymarketSubmitDepositWalletBatch`;
+  handler: TransactionPayController['polymarketSubmitDepositWalletBatch'];
+};
+
 /**
  * Union of all TransactionPayController action types.
  */
@@ -89,4 +113,6 @@ export type TransactionPayControllerMethodActions =
   | TransactionPayControllerUpdatePaymentTokenAction
   | TransactionPayControllerUpdateFiatPaymentAction
   | TransactionPayControllerGetDelegationTransactionAction
-  | TransactionPayControllerGetStrategyAction;
+  | TransactionPayControllerGetStrategyAction
+  | TransactionPayControllerPolymarketGetDepositWalletAddressAction
+  | TransactionPayControllerPolymarketSubmitDepositWalletBatchAction;

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

@@ -457,6 +457,94 @@ describe('TransactionPayController', () => {
     });
   });
 
+  describe('polymarket callbacks', () => {
+    const EOA_MOCK = '0x1111111111111111111111111111111111111111' as Hex;
+    const DEPOSIT_WALLET_MOCK =
+      '0x2222222222222222222222222222222222222222' as Hex;
+    const SOURCE_HASH_MOCK: Hex = `0x${'aa'.repeat(32)}`;
+
+    it('delegates polymarketGetDepositWalletAddress to the callback', async () => {
+      const getDepositWalletAddressMock = jest
+        .fn()
+        .mockResolvedValue(DEPOSIT_WALLET_MOCK);
+
+      new TransactionPayController({
+        getDelegationTransaction: jest.fn(),
+        messenger,
+        polymarket: {
+          getDepositWalletAddress: getDepositWalletAddressMock,
+          submitDepositWalletBatch: jest.fn(),
+        },
+      });
+
+      const result = await messenger.call(
+        'TransactionPayController:polymarketGetDepositWalletAddress',
+        { eoa: EOA_MOCK },
+      );
+
+      expect(getDepositWalletAddressMock).toHaveBeenCalledWith({
+        eoa: EOA_MOCK,
+      });
+      expect(result).toBe(DEPOSIT_WALLET_MOCK);
+    });
+
+    it('delegates polymarketSubmitDepositWalletBatch to the callback', async () => {
+      const submitDepositWalletBatchMock = jest
+        .fn()
+        .mockResolvedValue({ sourceHash: SOURCE_HASH_MOCK });
+
+      new TransactionPayController({
+        getDelegationTransaction: jest.fn(),
+        messenger,
+        polymarket: {
+          getDepositWalletAddress: jest.fn(),
+          submitDepositWalletBatch: submitDepositWalletBatchMock,
+        },
+      });
+
+      const params = {
+        eoa: EOA_MOCK,
+        depositWallet: DEPOSIT_WALLET_MOCK,
+        calls: [],
+      };
+      const result = await messenger.call(
+        'TransactionPayController:polymarketSubmitDepositWalletBatch',
+        params,
+      );
+
+      expect(submitDepositWalletBatchMock).toHaveBeenCalledWith(params);
+      expect(result).toStrictEqual({ sourceHash: SOURCE_HASH_MOCK });
+    });
+
+    it('throws if polymarketGetDepositWalletAddress is invoked without callbacks supplied', () => {
+      new TransactionPayController({
+        getDelegationTransaction: jest.fn(),
+        messenger,
+      });
+
+      expect(() =>
+        messenger.call(
+          'TransactionPayController:polymarketGetDepositWalletAddress',
+          { eoa: EOA_MOCK },
+        ),
+      ).toThrow('Polymarket callbacks missing');
+    });
+
+    it('throws if polymarketSubmitDepositWalletBatch is invoked without callbacks supplied', () => {
+      new TransactionPayController({
+        getDelegationTransaction: jest.fn(),
+        messenger,
+      });
+
+      expect(() =>
+        messenger.call(
+          'TransactionPayController:polymarketSubmitDepositWalletBatch',
+          { eoa: EOA_MOCK, depositWallet: DEPOSIT_WALLET_MOCK, calls: [] },
+        ),
+      ).toThrow('Polymarket callbacks missing');
+    });
+  });
+
   describe('getStrategy Action', () => {
     it('returns relay if no callback', async () => {
       createController();

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

@@ -15,6 +15,7 @@ import { QuoteRefresher } from './helpers/QuoteRefresher';
 import { deriveFiatAssetForFiatPayment } from './strategy/fiat/utils';
 import type {
   GetDelegationTransactionCallback,
+  PolymarketCallbacks,
   TransactionConfigCallback,
   TransactionData,
   TransactionPayControllerMessenger,
@@ -36,6 +37,8 @@ import {
 const MESSENGER_EXPOSED_METHODS = [
   'getDelegationTransaction',
   'getStrategy',
+  'polymarketGetDepositWalletAddress',
+  'polymarketSubmitDepositWalletBatch',
   'setTransactionConfig',
   'updateFiatPayment',
   'updatePaymentToken',
@@ -69,11 +72,14 @@ export class TransactionPayController extends BaseController<
     transaction: TransactionMeta,
   ) => TransactionPayStrategy[];
 
+  readonly #polymarket?: PolymarketCallbacks;
+
   constructor({
     getDelegationTransaction,
     getStrategy,
     getStrategies,
     messenger,
+    polymarket,
     state,
   }: TransactionPayControllerOptions) {
     super({
@@ -86,6 +92,7 @@ export class TransactionPayController extends BaseController<
     this.#getDelegationTransaction = getDelegationTransaction;
     this.#getStrategy = getStrategy;
     this.#getStrategies = getStrategies;
+    this.#polymarket = polymarket;
 
     this.messenger.registerMethodActionHandlers(
       this,
@@ -130,6 +137,7 @@ export class TransactionPayController extends BaseController<
         isMaxAmount: transactionData.isMaxAmount,
         isPostQuote: transactionData.isPostQuote,
         isHyperliquidSource: transactionData.isHyperliquidSource,
+        isPolymarketDepositWallet: transactionData.isPolymarketDepositWallet,
         refundTo: transactionData.refundTo,
         accountOverride: transactionData.accountOverride,
       };
@@ -142,6 +150,8 @@ export class TransactionPayController extends BaseController<
       transactionData.isMaxAmount = config.isMaxAmount;
       transactionData.isPostQuote = config.isPostQuote;
       transactionData.isHyperliquidSource = config.isHyperliquidSource;
+      transactionData.isPolymarketDepositWallet =
+        config.isPolymarketDepositWallet;
       transactionData.refundTo = config.refundTo;
 
       if (
@@ -219,6 +229,39 @@ export class TransactionPayController extends BaseController<
     return this.#getStrategiesWithFallback(transaction)[0];
   }
 
+  /**
+   * Derives the Polymarket deposit-wallet address for an EOA via the
+   * client-supplied callback.
+   *
+   * @param args - The arguments forwarded to {@link PolymarketCallbacks.getDepositWalletAddress}.
+   * @returns A promise resolving to the deposit-wallet address.
+   */
+  polymarketGetDepositWalletAddress(
+    ...args: Parameters<PolymarketCallbacks['getDepositWalletAddress']>
+  ): ReturnType<PolymarketCallbacks['getDepositWalletAddress']> {
+    return this.#requirePolymarket().getDepositWalletAddress(...args);
+  }
+
+  /**
+   * Signs and broadcasts a Polymarket deposit-wallet batch via the
+   * client-supplied callback.
+   *
+   * @param args - The arguments forwarded to {@link PolymarketCallbacks.submitDepositWalletBatch}.
+   * @returns A promise resolving to the relayer-issued source hash.
+   */
+  polymarketSubmitDepositWalletBatch(
+    ...args: Parameters<PolymarketCallbacks['submitDepositWalletBatch']>
+  ): ReturnType<PolymarketCallbacks['submitDepositWalletBatch']> {
+    return this.#requirePolymarket().submitDepositWalletBatch(...args);
+  }
+
+  #requirePolymarket(): PolymarketCallbacks {
+    if (!this.#polymarket) {
+      throw new Error('TransactionPayController: Polymarket callbacks missing');
+    }
+    return this.#polymarket;
+  }
+
   #removeTransactionData(transactionId: string): void {
     this.update((state) => {
       delete state.transactionData[transactionId];
@@ -328,6 +371,8 @@ export class TransactionPayController extends BaseController<
   #getStrategiesWithFallback(
     transaction: TransactionMeta,
   ): TransactionPayStrategy[] {
+    const transactionData = this.state.transactionData[transaction.id];
+
     const strategyCandidates: unknown[] =
       this.#getStrategies?.(transaction) ??
       (this.#getStrategy ? [this.#getStrategy(transaction)] : []);
@@ -341,7 +386,6 @@ export class TransactionPayController extends BaseController<
       return validStrategies;
     }
 
-    const transactionData = this.state.transactionData[transaction.id];
     const paymentToken = transactionData?.paymentToken;
 
     return getStrategyOrder(

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

@@ -10,6 +10,7 @@ export type {
   TransactionPayControllerMessenger,
   TransactionPayControllerOptions,
   TransactionPayControllerState,
+  PolymarketCallbacks,
   TransactionPayControllerStateChangeEvent,
   TransactionPaymentToken,
   TransactionPayQuote,
@@ -22,6 +23,8 @@ export type {
 export type {
   TransactionPayControllerGetDelegationTransactionAction,
   TransactionPayControllerGetStrategyAction,
+  TransactionPayControllerPolymarketGetDepositWalletAddressAction,
+  TransactionPayControllerPolymarketSubmitDepositWalletBatchAction,
   TransactionPayControllerSetTransactionConfigAction,
   TransactionPayControllerUpdatePaymentTokenAction,
   TransactionPayControllerUpdateFiatPaymentAction,

packages/transaction-pay-controller/src/strategy/relay/polymarket/calldata.ts

@@ -0,0 +1,42 @@
+import { Interface } from '@ethersproject/abi';
+import type { Hex } from '@metamask/utils';
+
+const iface = new Interface([
+  'function approve(address spender, uint256 amount)',
+  'function unwrap(address asset, address recipient, uint256 amount)',
+  'function wrap(address asset, address recipient, uint256 amount)',
+  'function transfer(address recipient, uint256 amount)',
+]);
+
+export function encodeApprove(spender: Hex, amount: bigint): Hex {
+  return iface.encodeFunctionData('approve', [spender, amount]) as Hex;
+}
+
+export function encodeUnwrap({
+  asset,
+  recipient,
+  amount,
+}: {
+  asset: Hex;
+  recipient: Hex;
+  amount: bigint;
+}): Hex {
+  return iface.encodeFunctionData('unwrap', [asset, recipient, amount]) as Hex;
+}
+
+export function encodeWrap({
+  asset,
+  recipient,
+  amount,
+}: {
+  asset: Hex;
+  recipient: Hex;
+  amount: bigint;
+}): Hex {
+  return iface.encodeFunctionData('wrap', [asset, recipient, amount]) as Hex;
+}
+
+export function extractErc20TransferRecipient(data: Hex): Hex {
+  const [recipient] = iface.decodeFunctionData('transfer', data);
+  return recipient as Hex;
+}

packages/transaction-pay-controller/src/strategy/relay/polymarket/constants.ts

@@ -0,0 +1,13 @@
+import type { Hex } from '@metamask/utils';
+
+export const POLYMARKET_COLLATERAL_OFFRAMP_POLYGON =
+  '0x2957922Eb93258b93368531d39fAcCA3B4dC5854' as Hex;
+
+export const POLYMARKET_COLLATERAL_ONRAMP_POLYGON =
+  '0x93070a847efEf7F70739046A929D47a521F5B8ee' as Hex;
+
+export const SWEEP_BALANCE_RETRY_ATTEMPTS = 5;
+
+export const SWEEP_BALANCE_RETRY_DELAY_MS = 1000;
+
+export const SWEEP_RELAYER_SETTLE_DELAY_MS = 3000;