Chore/oft approve e2e (#884)

Author: slavastartsev

sdk/src/gateway/abi.ts

@@ -243,6 +243,19 @@ export const layerZeroOftAbi = [
         ],
         stateMutability: 'payable',
     },
+    {
+        inputs: [],
+        name: 'approvalRequired',
+        outputs: [
+            {
+                internalType: 'bool',
+                name: '',
+                type: 'bool',
+            },
+        ],
+        stateMutability: 'pure',
+        type: 'function',
+    },
 ] as const;
 
 export const quoterV2Abi = [

sdk/src/gateway/layerzero.ts

@@ -758,13 +758,17 @@ export class LayerZeroGatewayClient extends GatewayApiClient {
                 };
 
                 try {
-                    // ETH -> %any_chain%
-                    if (data.sourceEid === 30101) {
-                        const wbtcMainnetAddress = getTokenAddress(mainnet.id, 'wbtc');
+                    const approvalRequired = await publicClient.readContract({
+                        account: walletClient.account,
+                        address: oftAddress,
+                        abi: layerZeroOftAbi,
+                        functionName: 'approvalRequired',
+                    });
 
+                    if (approvalRequired) {
                         const allowance = await publicClient.readContract({
                             account: walletClient.account,
-                            address: wbtcMainnetAddress,
+                            address: oftAddress,
                             abi: erc20Abi,
                             functionName: 'allowance',
                             args: [params.fromUserAddress as Address, oftAddress],
@@ -773,7 +777,7 @@ export class LayerZeroGatewayClient extends GatewayApiClient {
                         if (allowance < sendParam.amountLD) {
                             const { request } = await publicClient.simulateContract({
                                 account: walletClient.account,
-                                address: wbtcMainnetAddress,
+                                address: oftAddress,
                                 abi: erc20Abi,
                                 functionName: 'approve',
                                 args: [oftAddress, maxUint256],

sdk/test/layerzero.test.ts

@@ -7,8 +7,11 @@ import {
     erc20Abi,
     http,
     PublicClient,
+    SimulateContractReturnType,
+    TransactionReceipt,
     Transport,
     zeroAddress,
+    zeroHash,
 } from 'viem';
 import {
     bob,
@@ -25,7 +28,13 @@ import {
     optimism,
     sei,
 } from 'viem/chains';
-import { BitcoinSigner, GetQuoteParams, LayerZeroMessageWallet } from '../src/gateway/types';
+import {
+    BitcoinSigner,
+    ExecuteQuoteParams,
+    GatewayOrderType,
+    GetQuoteParams,
+    LayerZeroMessageWallet,
+} from '../src/gateway/types';
 import * as btc from '@scure/btc-signer';
 import { base64 } from '@scure/base';
 import { mnemonicToSeedSync } from 'bip39';
@@ -566,6 +575,155 @@ describe('LayerZero Tests', () => {
             ).rejects.toThrow('WBTC OFT not found for chain: 40184');
         });
     });
+
+    it('should execute approve if approval required', async () => {
+        const client = new LayerZeroGatewayClient();
+
+        const mockQuote: ExecuteQuoteParams = {
+            type: GatewayOrderType.CrossChainSwap,
+            finalOutputSats: 100000,
+            finalFeeSats: 0,
+            params: {
+                fromChain: 'ethereum',
+                fromToken: '0x0555E30da8f98308EdB960aa94C0Db47230d2B9c',
+                toChain: 'bob',
+                toToken: '0x0555E30da8f98308EdB960aa94C0Db47230d2B9c',
+                fromUserAddress: '0x5AC6f7ee4D571872333845e8Abc0bDef200B4Df6',
+                toUserAddress: '0x5AC6f7ee4D571872333845e8Abc0bDef200B4Df6',
+                amount: '100000',
+                feeRate: 1,
+            },
+            data: {
+                oftAddress: '0x0555e30da8f98308edb960aa94c0db47230d2b9c',
+                destinationEid: 30279,
+                sourceEid: 30101,
+                feeBreakdown: {
+                    nativeFee: BigInt('245222054031895'),
+                    lzTokenFee: BigInt('0'),
+                },
+            },
+        };
+
+        const publicClient = createPublicClient({
+            chain: mainnet,
+            transport: http(),
+        });
+
+        const publicClientReadContractSpy = vi
+            .spyOn(publicClient, 'readContract')
+            .mockImplementationOnce(() => Promise.resolve(true))
+            .mockImplementationOnce(() => Promise.resolve(10n));
+
+        const publicClientWaitForTransactionReceiptSpy = vi
+            .spyOn(publicClient, 'waitForTransactionReceipt')
+            .mockImplementation(() => {
+                const txReceipt: TransactionReceipt = {} as TransactionReceipt;
+                return Promise.resolve(txReceipt);
+            });
+
+        const publicClientSimulateContractSpy = vi.spyOn(publicClient, 'simulateContract').mockImplementation(() => {
+            const simulateContractReturnType: Awaited<ReturnType<typeof publicClient.simulateContract>> = {} as Awaited<
+                ReturnType<typeof publicClient.simulateContract>
+            >;
+            return Promise.resolve(simulateContractReturnType);
+        });
+
+        const walletClient = createWalletClient({
+            chain: mainnet,
+            transport: http(),
+            account: privateKeyToAccount(process.env.PRIVATE_KEY as Hex),
+        });
+
+        const walletClientWriteContractSpy = vi.spyOn(walletClient, 'writeContract').mockImplementation(() => {
+            const writeContractReturnType = {} as Awaited<ReturnType<typeof walletClient.writeContract>>;
+            return Promise.resolve(writeContractReturnType);
+        });
+
+        const txHash = await client.executeQuote({
+            quote: mockQuote,
+            walletClient,
+            publicClient: publicClient as PublicClient<Transport>,
+        });
+
+        expect(txHash).toBeDefined();
+        expect(publicClientReadContractSpy).toHaveBeenCalledTimes(2);
+        expect(publicClientWaitForTransactionReceiptSpy).toHaveBeenCalledTimes(2);
+        expect(publicClientSimulateContractSpy).toHaveBeenCalledTimes(2);
+        expect(walletClientWriteContractSpy).toHaveBeenCalledTimes(2);
+    }, 120000);
+
+    it('should skip approve step', async () => {
+        const client = new LayerZeroGatewayClient();
+
+        const mockQuote: ExecuteQuoteParams = {
+            type: GatewayOrderType.CrossChainSwap,
+            finalOutputSats: 100000,
+            finalFeeSats: 0,
+            params: {
+                fromChain: 'bsc',
+                fromToken: '0x0555E30da8f98308EdB960aa94C0Db47230d2B9c',
+                toChain: 'bob',
+                toToken: '0x0555E30da8f98308EdB960aa94C0Db47230d2B9c',
+                fromUserAddress: '0x5AC6f7ee4D571872333845e8Abc0bDef200B4Df6',
+                toUserAddress: '0x5AC6f7ee4D571872333845e8Abc0bDef200B4Df6',
+                amount: '100000',
+                feeRate: 1,
+            },
+            data: {
+                oftAddress: '0x0555e30da8f98308edb960aa94c0db47230d2b9c',
+                destinationEid: 30279,
+                sourceEid: 30102,
+                feeBreakdown: {
+                    nativeFee: BigInt('245222054031895'),
+                    lzTokenFee: BigInt('0'),
+                },
+            },
+        };
+
+        const publicClient = createPublicClient({
+            chain: bsc,
+            transport: http(),
+        });
+
+        const publicClientReadContractSpy = vi.spyOn(publicClient, 'readContract');
+
+        const publicClientWaitForTransactionReceiptSpy = vi
+            .spyOn(publicClient, 'waitForTransactionReceipt')
+            .mockImplementation(() => {
+                const txReceipt: TransactionReceipt = {} as TransactionReceipt;
+                return Promise.resolve(txReceipt);
+            });
+
+        const publicClientSimulateContractSpy = vi.spyOn(publicClient, 'simulateContract').mockImplementation(() => {
+            const simulateContractReturnType: Awaited<ReturnType<typeof publicClient.simulateContract>> = {} as Awaited<
+                ReturnType<typeof publicClient.simulateContract>
+            >;
+            return Promise.resolve(simulateContractReturnType);
+        });
+
+        const walletClient = createWalletClient({
+            chain: bsc,
+            transport: http(),
+            account: privateKeyToAccount(process.env.PRIVATE_KEY as Hex),
+        });
+
+        const walletClientWriteContractSpy = vi.spyOn(walletClient, 'writeContract').mockImplementation(() => {
+            const writeContractReturnType = {} as Awaited<ReturnType<typeof walletClient.writeContract>>;
+            return Promise.resolve(writeContractReturnType);
+        });
+
+        const txHash = await client.executeQuote({
+            quote: mockQuote,
+            walletClient,
+            publicClient: publicClient as PublicClient<Transport>,
+        });
+
+        expect(txHash).toBeDefined();
+        expect(publicClientReadContractSpy).toHaveBeenCalledTimes(0);
+        expect(publicClientWaitForTransactionReceiptSpy).toHaveBeenCalledTimes(1);
+        expect(publicClientSimulateContractSpy).toHaveBeenCalledTimes(1);
+        expect(walletClientWriteContractSpy).toHaveBeenCalledTimes(1);
+    }, 120000);
 });
 
 /**
@@ -633,7 +791,7 @@ class ScureBitcoinSigner implements BitcoinSigner {
 class TestLayerZeroGatewayClient extends (await import('../src/gateway/layerzero')).LayerZeroGatewayClient {
     _publicClient: any;
     constructor(chainId: number, l0Client: any, publicClient: any) {
-        super(chainId);
+        super();
         // @ts-ignore
         this.l0Client = l0Client;
         this._publicClient = publicClient;