feat: add sign actions for swaps typedData

Author: juangm

packages/client/src/ethers.ts

@@ -4,8 +4,10 @@ import {
   ValidationError,
 } from '@aave/core-next';
 import type {
+  CancelSwapTypedData,
   InsufficientBalanceError,
   PermitTypedDataResponse,
+  SwapByIntentTypedData,
   TransactionRequest,
 } from '@aave/graphql-next';
 import {
@@ -20,6 +22,7 @@ import type { Signer, TransactionResponse } from 'ethers';
 import type {
   ExecutionPlanHandler,
   PermitHandler,
+  SwapSignatureHandler,
   TransactionExecutionResult,
 } from './types';
 
@@ -100,3 +103,19 @@ export function signERC20PermitWith(signer: Signer): PermitHandler {
     }));
   };
 }
+
+/**
+ * Signs swap typed data using the provided ethers signer.
+ */
+export function signSwapTypedDataWith(signer: Signer): SwapSignatureHandler {
+  return (result: SwapByIntentTypedData | CancelSwapTypedData) => {
+    const message = JSON.parse(result.message);
+    return ResultAsync.fromPromise(
+      signer.signTypedData(result.domain, result.types, message),
+      (err) => SigningError.from(err),
+    ).map((signature) => ({
+      deadline: message.deadline,
+      value: signatureFrom(signature),
+    }));
+  };
+}

packages/client/src/privy.ts

@@ -4,8 +4,10 @@ import {
   ValidationError,
 } from '@aave/core-next';
 import type {
+  CancelSwapTypedData,
   InsufficientBalanceError,
   PermitTypedDataResponse,
+  SwapByIntentTypedData,
   TransactionRequest,
 } from '@aave/graphql-next';
 import {
@@ -22,6 +24,7 @@ import { waitForTransactionReceipt } from 'viem/actions';
 import type {
   ExecutionPlanHandler,
   PermitHandler,
+  SwapSignatureHandler,
   TransactionExecutionResult,
 } from './types';
 import { supportedChains, transactionError } from './viem';
@@ -135,3 +138,30 @@ export function signERC20PermitWith(
     }));
   };
 }
+
+/**
+ * Signs swap typed data using the provided Privy client.
+ */
+export function signSwapTypedDataWith(
+  privy: PrivyClient,
+  walletId: string,
+): SwapSignatureHandler {
+  return (result: SwapByIntentTypedData | CancelSwapTypedData) => {
+    const message = JSON.parse(result.message);
+    return ResultAsync.fromPromise(
+      privy.walletApi.ethereum.signTypedData({
+        walletId,
+        typedData: {
+          domain: result.domain,
+          types: result.types,
+          message,
+          primaryType: result.primaryType,
+        },
+      }),
+      (err) => SigningError.from(err),
+    ).map((response) => ({
+      deadline: message.deadline,
+      value: signatureFrom(response.signature),
+    }));
+  };
+}

packages/client/src/thirdweb.ts

@@ -4,8 +4,10 @@ import {
   ValidationError,
 } from '@aave/core-next';
 import type {
+  CancelSwapTypedData,
   InsufficientBalanceError,
   PermitTypedDataResponse,
+  SwapByIntentTypedData,
   TransactionRequest,
 } from '@aave/graphql-next';
 import {
@@ -26,6 +28,7 @@ import {
 import type {
   ExecutionPlanHandler,
   PermitHandler,
+  SwapSignatureHandler,
   TransactionExecutionResult,
 } from './types';
 
@@ -139,3 +142,39 @@ export function signERC20PermitWith(client: ThirdwebClient): PermitHandler {
     }));
   };
 }
+
+/**
+ * Signs swap typed data using the provided Thirdweb client.
+ */
+export function signSwapTypedDataWith(
+  client: ThirdwebClient,
+): SwapSignatureHandler {
+  return (result: SwapByIntentTypedData | CancelSwapTypedData) => {
+    const message = JSON.parse(result.message);
+
+    const signTypedDataPromise = async (): Promise<Signature> => {
+      const wallet = Engine.serverWallet({
+        client,
+        chain: defineChain({ id: result.domain.chainId }),
+        address: message.user,
+      });
+
+      const signature = await wallet.signTypedData({
+        // silence the rest of the type inference
+        types: result.types as Record<string, unknown>,
+        domain: result.domain,
+        primaryType: result.primaryType,
+        message,
+      });
+
+      return signatureFrom(signature);
+    };
+
+    return ResultAsync.fromPromise(signTypedDataPromise(), (err) =>
+      SigningError.from(err),
+    ).map((value) => ({
+      deadline: message.deadline,
+      value,
+    }));
+  };
+}

packages/client/src/types.ts

@@ -44,10 +44,6 @@ export type PermitHandler = (
   result: PermitTypedDataResponse,
 ) => ResultAsync<ERC712Signature, SigningError>;
 
-export type SwapByIntentHandler = (
-  result: SwapByIntentTypedData,
-) => ResultAsync<ERC712Signature, SigningError>;
-
-export type SwapCancelHandler = (
-  result: CancelSwapTypedData,
+export type SwapSignatureHandler = (
+  result: CancelSwapTypedData | SwapByIntentTypedData,
 ) => ResultAsync<ERC712Signature, SigningError>;

packages/client/src/viem.ts

@@ -41,8 +41,7 @@ import { mainnet } from 'viem/chains';
 import type {
   ExecutionPlanHandler,
   PermitHandler,
-  SwapByIntentHandler,
-  SwapCancelHandler,
+  SwapSignatureHandler,
   TransactionExecutionResult,
 } from './types';
 
@@ -179,37 +178,12 @@ export function signERC20PermitWith(walletClient: WalletClient): PermitHandler {
 }
 
 /**
- * Signs a swap by intent using the provided wallet client.
+ * Signs swap typed data using the provided wallet client.
  */
-export function signSwapByIntentWith(
+export function signSwapTypedDataWith(
   walletClient: WalletClient,
-): SwapByIntentHandler {
-  return (result: SwapByIntentTypedData) => {
-    invariant(walletClient.account, 'Wallet account is required');
-
-    return ResultAsync.fromPromise(
-      signTypedData(walletClient, {
-        account: walletClient.account,
-        domain: result.domain as TypedDataDomain,
-        types: result.types as TypedData,
-        primaryType: result.primaryType,
-        message: JSON.parse(result.message),
-      }),
-      (err) => SigningError.from(err),
-    ).map((hex) => ({
-      deadline: JSON.parse(result.message).deadline,
-      value: signatureFrom(hex),
-    }));
-  };
-}
-
-/**
- * Signs a swap cancellation using the provided wallet client.
- */
-export function signSwapCancelWith(
-  walletClient: WalletClient,
-): SwapCancelHandler {
-  return (result: CancelSwapTypedData) => {
+): SwapSignatureHandler {
+  return (result: SwapByIntentTypedData | CancelSwapTypedData) => {
     invariant(walletClient.account, 'Wallet account is required');
 
     return ResultAsync.fromPromise(

packages/react/src/viem.ts

@@ -3,8 +3,7 @@ import { permitTypedData } from '@aave/client-next/actions';
 import {
   sendTransactionAndWait,
   signERC20PermitWith,
-  signSwapByIntentWith,
-  signSwapCancelWith,
+  signSwapTypedDataWith,
 } from '@aave/client-next/viem';
 import type {
   CancelSwapTypedData,
@@ -94,62 +93,30 @@ export function useERC20Permit(
 export type SignSwapError = SigningError | UnexpectedError;
 
 /**
- * A hook that provides a way to sign swap by intent using a viem WalletClient instance.
+ * A hook that provides a way to sign swap typed data using a viem WalletClient instance.
  *
  * ```ts
  * const { data: wallet } = useWalletClient(); // wagmi hook
- * const [signSwapByIntent, { loading, error, data }] = useSignSwapByIntentWith(wallet);
+ * const [signSwapTypedData, { loading, error, data }] = useSignSwapTypedDataWith(wallet);
  *
  * const run = async () => {
- *   const result = await signSwapByIntent(swapByIntentTypedData);
+ *   const result = await signSwapTypedData(swapTypedData);
  *
  *   if (result.isErr()) {
  *     console.error(result.error);
  *     return;
  *   }
  *
- *   console.log('Swap by intent signed:', result.value);
+ *   console.log('Swap typed data signed:', result.value);
  * };
  * ```
  */
-export function useSignSwapByIntentWith(
+export function useSignSwapTypedDataWith(
   walletClient: WalletClient | undefined,
 ): UseAsyncTask<SwapByIntentTypedData, ERC712Signature, SignSwapError> {
   return useAsyncTask((typedData: SwapByIntentTypedData) => {
-    invariant(walletClient, 'Expected a WalletClient to sign swap by intent');
+    invariant(walletClient, 'Expected a WalletClient to sign swap typed data');
 
-    return signSwapByIntentWith(walletClient)(typedData);
-  });
-}
-
-/**
- * A hook that provides a way to sign swap cancellation using a viem WalletClient instance.
- *
- * ```ts
- * const { data: wallet } = useWalletClient(); // wagmi hook
- * const [signSwapCancel, { loading, error, data }] = useSignSwapCancelWith(wallet);
- *
- * const run = async () => {
- *   const result = await signSwapCancel(cancelSwapTypedData);
- *
- *   if (result.isErr()) {
- *     console.error(result.error);
- *     return;
- *   }
- *
- *   console.log('Swap cancellation signed:', result.value);
- * };
- * ```
- */
-export function useSignSwapCancelWith(
-  walletClient: WalletClient | undefined,
-): UseAsyncTask<CancelSwapTypedData, ERC712Signature, SignSwapError> {
-  return useAsyncTask((typedData: CancelSwapTypedData) => {
-    invariant(
-      walletClient,
-      'Expected a WalletClient to sign swap cancellation',
-    );
-
-    return signSwapCancelWith(walletClient)(typedData);
+    return signSwapTypedDataWith(walletClient)(typedData);
   });
 }