SOV-3922: fix typedData functionality for smart router (#907)

* wip: reworking permits

* wip: reworking permits

* feat: reworking permits on smart router

* chore: add changeset

* chore: update readme

* chore: remove console log

Author: creed-victor

.changeset/modern-boxes-enjoy.md

@@ -0,0 +1,5 @@
+---
+'@sovryn/sdk': patch
+---
+
+SOV-3922: move typedData / permits to smart router

apps/frontend/src/app/3_organisms/TransactionStepDialog/TransactionStepDialog.types.ts

@@ -50,6 +50,9 @@ export enum TransactionType {
   signTypedData = 'signTypedData',
   signTransaction = 'signTransaction',
   signTransactionData = 'signTransactionData',
+  /**
+   * @deprecated Use `signTypedData` instead.
+   */
   signPermit = 'signPermit',
 }
 
@@ -64,9 +67,12 @@ export type SignTypedDataRequest = {
   signer: JsonRpcSigner;
   domain: TypedDataDomain;
   types: Record<string, Array<TypedDataField>>;
-  value: Record<string, any>;
+  values: Record<string, any>;
 };
 
+/**
+ * @deprecated Use TypedDataTransactionRequest instead
+ */
 export type SignPermitRequest = {
   type: TransactionType.signPermit;
   signer: JsonRpcSigner;
@@ -115,5 +121,5 @@ export enum TransactionReceiptStatus {
 export type TransactionReceipt = {
   status: TransactionReceiptStatus;
   request: TransactionRequest;
-  response?: string | PermitTransactionResponse;
+  response?: string;
 };

apps/frontend/src/app/3_organisms/TransactionStepDialog/components/TransactionSteps/TransactionSteps.tsx

@@ -22,7 +22,6 @@ import { translations } from '../../../../../locales/i18n';
 import { findNativeAsset } from '../../../../../utils/asset';
 import { sleep } from '../../../../../utils/helpers';
 import { fromWei, toWei } from '../../../../../utils/math';
-import { signERC2612Permit } from '../../../../../utils/permit/permit';
 import {
   Transaction,
   TransactionReceiptStatus,
@@ -32,7 +31,6 @@ import {
 } from '../../TransactionStepDialog.types';
 import {
   isMessageSignatureRequest,
-  isPermitRequest,
   isSignTransactionDataRequest,
   isTransactionRequest,
   isTypedDataRequest,
@@ -267,37 +265,30 @@ export const TransactionSteps: FC<TransactionStepsProps> = ({
           const signature = await request.signer._signTypedData(
             request.domain,
             request.types,
-            request.value,
+            request.values,
           );
 
-          transactions[i].onChangeStatus?.(StatusType.success);
-          transactions[i].onComplete?.(signature);
-
-          updateReceipt(i, {
-            status: TransactionReceiptStatus.success,
-            request,
-            response: signature,
-          });
-
-          await handleUpdates();
-        } else if (isPermitRequest(request)) {
-          const response = await signERC2612Permit(
-            request.signer,
-            request.token,
-            request.owner,
-            request.spender,
-            request.value,
-            request.deadline,
-            request.nonce,
+          const verifiedAddress = ethers.utils.verifyTypedData(
+            request.domain,
+            request.types,
+            request.values,
+            signature,
           );
 
+          if (
+            verifiedAddress.toLowerCase() !==
+            (await request.signer.getAddress()).toLowerCase()
+          ) {
+            throw new Error('Failed to verify signature. ');
+          }
+
           transactions[i].onChangeStatus?.(StatusType.success);
-          transactions[i].onComplete?.(response);
+          transactions[i].onComplete?.(signature);
 
           updateReceipt(i, {
             status: TransactionReceiptStatus.success,
             request,
-            response,
+            response: signature,
           });
 
           await handleUpdates();

apps/frontend/src/app/3_organisms/TransactionStepDialog/helpers.ts

@@ -1,6 +1,5 @@
 import {
   SignMessageRequest,
-  SignPermitRequest,
   SignTransactionDataRequest,
   SignTransactionRequest,
   SignTypedDataRequest,
@@ -27,7 +26,3 @@ export const isSignTransactionDataRequest = (
   request: TransactionRequest,
 ): request is SignTransactionDataRequest =>
   request.type === TransactionType.signTransactionData;
-
-export const isPermitRequest = (
-  request: TransactionRequest,
-): request is SignPermitRequest => request.type === TransactionType.signPermit;

apps/frontend/src/app/5_pages/ConvertPage/ConvertPage.constants.ts

@@ -16,6 +16,7 @@ export const SWAP_ROUTES = [
   smartRoutes.myntFixedRateRoute,
   smartRoutes.mocIntegrationSwapRoute,
   smartRoutes.ambientRoute,
+  smartRoutes.zeroRedemptionSwapRoute,
 ];
 
 export const SMART_ROUTER_RSK = new SmartRouter(

apps/frontend/src/app/5_pages/ConvertPage/hooks/useHandleConversion.ts

@@ -1,12 +1,10 @@
-import { PERMIT2_ADDRESS, PermitTransferFrom } from '@uniswap/permit2-sdk';
-
 import { useCallback } from 'react';
 
 import { BigNumber, ethers } from 'ethers';
 import { t } from 'i18next';
 
 import { getAssetData, getProtocolContract } from '@sovryn/contracts';
-import { PermitTransactionResponse, SwapRoute } from '@sovryn/sdk';
+import { SwapRoute } from '@sovryn/sdk';
 
 import {
   Transaction,
@@ -19,18 +17,13 @@ import { useTransactionContext } from '../../../../contexts/TransactionContext';
 import { useAccount } from '../../../../hooks/useAccount';
 import { useCurrentChain } from '../../../../hooks/useChainStore';
 import { translations } from '../../../../locales/i18n';
-import { COMMON_SYMBOLS } from '../../../../utils/asset';
 import {
   DEFAULT_SIGNATURE,
   EMPTY_PERMIT_TRANSFER_FROM,
-  getPermitTransferFrom,
   permitHandler,
   prepareApproveTransaction,
-  preparePermit2Transaction,
-  preparePermitTransaction,
-  UNSIGNED_PERMIT,
+  prepareTypedDataTransaction,
 } from '../../../../utils/transactions';
-import { getRouteContract } from '../ConvertPage.utils';
 
 export const useHandleConversion = (
   sourceToken: string,
@@ -138,91 +131,49 @@ export const useHandleConversion = (
       return;
     }
 
-    const requiresPermit2 =
-      !!route && ['ZeroRedemption', 'MocIntegration'].includes(route.name);
-
     const [sourceTokenDetails, destinationTokenDetails] = await Promise.all([
       getAssetData(sourceToken, currentChainId),
       getAssetData(destinationToken, currentChainId),
     ]);
 
-    const approveTxData = await route.approve(
-      sourceTokenDetails.address,
-      destinationTokenDetails.address,
-      weiAmount,
-      account,
-    );
-
     const transactions: Transaction[] = [];
 
-    if (requiresPermit2) {
-      const approveTx = await prepareApproveTransaction({
-        token: COMMON_SYMBOLS.DLLR,
-        spender: PERMIT2_ADDRESS,
-        amount: weiAmount,
-        signer,
-        approveMaximumAmount: true,
-      });
-
-      if (approveTx) {
-        transactions.push(approveTx);
-      }
-    }
-
-    if (
-      !requiresPermit2 &&
-      approveTxData &&
-      approveTxData.to &&
-      approveTxData.data
-    ) {
-      transactions.push({
-        title: t(translations.convertPage.txDialog.approve, {
-          asset: getTokenDisplayName(sourceToken),
-        }),
-        request: {
-          type: TransactionType.signTransactionData,
-          signer: signer,
-          to: approveTxData.to,
-          data: approveTxData.data,
-          gasLimit: approveTxData.gasLimit ?? GAS_LIMIT.APPROVE,
-        },
-        onComplete,
-      });
-    }
-
     const permitTxData = await route.permit(
       sourceTokenDetails.address,
       destinationTokenDetails.address,
       weiAmount,
       account,
     );
 
-    if (!requiresPermit2 && permitTxData) {
+    if (permitTxData) {
       transactions.push(
-        await preparePermitTransaction({
-          token: sourceTokenDetails.symbol,
-          signer,
-          spender: permitTxData.spender,
-          value: permitTxData.value?.toString(),
-          deadline: permitTxData.deadline,
-          nonce: permitTxData.nonce,
-        }),
+        await prepareTypedDataTransaction(permitTxData, signer),
       );
     }
 
-    let permitTransferFrom: PermitTransferFrom;
-
-    if (requiresPermit2) {
-      const contract = await getRouteContract(route, signer);
-
-      permitTransferFrom = await getPermitTransferFrom(
-        contract.address,
-        weiAmount.toString(),
+    if (!permitTxData || permitTxData.approvalRequired) {
+      const approveTxData = await route.approve(
+        sourceTokenDetails.address,
+        destinationTokenDetails.address,
+        weiAmount,
+        account,
       );
 
-      transactions.push(
-        await preparePermit2Transaction(permitTransferFrom, signer),
-      );
+      if (approveTxData) {
+        transactions.push({
+          title: t(translations.convertPage.txDialog.approve, {
+            asset: getTokenDisplayName(sourceToken),
+          }),
+          request: {
+            type: TransactionType.signTransactionData,
+            signer: signer,
+            to: approveTxData.to!,
+            data: approveTxData.data!,
+            gasLimit: approveTxData.gasLimit ?? GAS_LIMIT.APPROVE,
+          },
+          onComplete,
+        });
+      }
     }
 
     const txData = await route.swap(
@@ -231,59 +182,45 @@ export const useHandleConversion = (
       weiAmount,
       account,
       {
-        permit: permitTxData ? UNSIGNED_PERMIT : undefined,
-        permitTransferFrom: requiresPermit2
-          ? EMPTY_PERMIT_TRANSFER_FROM
-          : undefined,
-        signature: DEFAULT_SIGNATURE,
+        typedDataValue: permitTxData
+          ? permitTxData.typedData.values
+          : EMPTY_PERMIT_TRANSFER_FROM,
+        typedDataSignature: DEFAULT_SIGNATURE,
         slippage: Number(slippageTolerance) * 100,
       },
     );
 
-    if (txData && txData.to && txData.data) {
+    if (txData) {
       transactions.push({
         title: t(translations.convertPage.txDialog.convert, {
           asset: getTokenDisplayName(sourceToken),
         }),
         request: {
           type: TransactionType.signTransactionData,
           signer: signer,
-          to: txData.to,
-          data: txData.data,
+          to: txData.to!,
+          data: txData.data!,
           value: txData.value,
           gasLimit: txData?.gasLimit ?? GAS_LIMIT.CONVERT,
           gasPrice: txData?.gasPrice?.toString(),
         },
         onComplete,
         updateHandler: permitHandler(async (req, res) => {
           if (isSignTransactionDataRequest(req)) {
-            if (!requiresPermit2 && !!permitTxData) {
+            if (!!permitTxData) {
               const { data } = await route.swap(
                 sourceTokenDetails.address,
                 destinationTokenDetails.address,
                 weiAmount,
                 account,
                 {
-                  permit: res as PermitTransactionResponse,
+                  typedDataValue: permitTxData.typedData.values,
+                  typedDataSignature: res as string,
                   slippage: Number(slippageTolerance) * 100,
                 },
               );
               req.data = data!;
             }
-
-            if (requiresPermit2 && !!permitTransferFrom) {
-              const { data } = await route.swap(
-                sourceTokenDetails.address,
-                destinationTokenDetails.address,
-                weiAmount,
-                account,
-                {
-                  permitTransferFrom,
-                  signature: typeof res === 'string' ? res : '',
-                },
-              );
-              req.data = data!;
-            }
           }
           return req;
         }),

apps/frontend/src/utils/graphql/bob/generated.tsx

@@ -1,6 +1,5 @@
 import { gql } from '@apollo/client';
 import * as Apollo from '@apollo/client';
-
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
 export type Exact<T extends { [key: string]: unknown }> = {

apps/frontend/src/utils/graphql/mynt/generated.tsx

@@ -1,6 +1,5 @@
 import { gql } from '@apollo/client';
 import * as Apollo from '@apollo/client';
-
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
 export type Exact<T extends { [key: string]: unknown }> = {

apps/frontend/src/utils/graphql/rsk/generated.tsx

@@ -1,6 +1,5 @@
 import { gql } from '@apollo/client';
 import * as Apollo from '@apollo/client';
-
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
 export type Exact<T extends { [key: string]: unknown }> = {

apps/frontend/src/utils/graphql/zero/generated.tsx

@@ -1,6 +1,5 @@
 import { gql } from '@apollo/client';
 import * as Apollo from '@apollo/client';
-
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
 export type Exact<T extends { [key: string]: unknown }> = {