fix(bridge): increase gas for Gnosis bridge hook (#448)

* chore: increase gas for Gnosis bridge hook to 150k

* chore: increase extra gas for hook to 200k and for proxy to 400k

* chore: remove logs - bump version

* chore: improve test coverage and bump version

* Update package.json

---------

Co-authored-by: Alexandr Kazachenko <[email protected]>

Author: cowdan

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/cow-sdk",
-  "version": "6.3.1",
+  "version": "6.3.2",
   "license": "(MIT OR Apache-2.0)",
   "files": [
     "/dist"

src/bridging/PROVIDER_README.md

@@ -381,14 +381,15 @@ import { getGasLimitEstimationForHook } from '../utils/getGasLimitEstimationForH
 
 export class YourBridgeProvider implements BridgeProvider<YourBridgeQuoteResult> {
   async getGasLimitEstimationForHook(
-    request: Omit<QuoteBridgeRequest, 'amount'> & { extraGas?: number },
+    request: Omit<QuoteBridgeRequest, 'amount'> & { extraGas?: number; extraGasProxyCreation?: number },
   ): Promise<number> {
     // Use utility function or implement custom gas estimation
     return getGasLimitEstimationForHook(
-      this.cowShedSdk,
-      request as QuoteBridgeRequest, // cast needed due to omit
-      this.getRpcProvider(request.sellTokenChainId),
-      request.extraGas, // to add extra gas to the hook.
+      cowshed: this.cowShedSdk,
+      request: request as QuoteBridgeRequest, // cast needed due to omit
+      provider: this.getRpcProvider(request.sellTokenChainId),
+      extraGas: request.extraGas, // to add extra gas to the hook
+      extraGasProxyCreation: request.extraGasProxyCreation // to add extra gas to the hook and deploy proxy account
     )
   }
 

src/bridging/const.ts

@@ -3,7 +3,8 @@ import { RAW_FILES_PATH } from '../common/consts/path'
 export const RAW_PROVIDERS_FILES_PATH = `${RAW_FILES_PATH}/src/bridging/providers`
 // Based on https://dashboard.tenderly.co/shoom/project/simulator/a5e29dac-d0f2-407f-9e3d-d1b916da595b
 export const DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION = 240_000
-export const DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION = 100_000
+export const DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION = 200_000
 // Based on https://dashboard.tenderly.co/shoom/project/tx/0x2971aee9aa7237d24b254da8ccd4345ff77410c8829c8e825e9a02cb2cece5e6/gas-usage
 export const COW_SHED_PROXY_CREATION_GAS = 360_000
+export const DEFAULT_EXTRA_GAS_PROXY_CREATION = 400_000
 export const HOOK_DAPP_BRIDGE_PROVIDER_PREFIX = 'cow-sdk://bridging/providers'

src/bridging/providers/across/AcrossBridgeProvider.ts

@@ -145,7 +145,11 @@ export class AcrossBridgeProvider implements BridgeProvider<AcrossQuoteResult> {
   }
 
   async getGasLimitEstimationForHook(request: QuoteBridgeRequest): Promise<number> {
-    return getGasLimitEstimationForHook(this.cowShedSdk, request, this.getRpcProvider(request.sellTokenChainId))
+    return getGasLimitEstimationForHook({
+      cowShedSdk: this.cowShedSdk,
+      request,
+      provider: this.getRpcProvider(request.sellTokenChainId),
+    })
   }
 
   async getSignedHook(

src/bridging/providers/bungee/BungeeApi.ts

@@ -508,7 +508,7 @@ function isValidBungeeEventsResponse(response: unknown): response is BungeeEvent
       'fromChainId' in e &&
       'isCowswapTrade' in e &&
       'orderId' in e &&
-      'recipient' in e &&
+      // 'recipient' in e &&
       'sender' in e &&
       'srcTxStatus' in e &&
       'destTxStatus' in e

src/bridging/providers/bungee/BungeeBridgeProvider.test.ts

@@ -2,7 +2,12 @@ import { latest as latestAppData } from '@cowprotocol/app-data'
 import { OrderKind } from '@cowprotocol/contracts'
 import { JsonRpcProvider } from '@ethersproject/providers'
 import { SupportedChainId, TargetChainId } from '../../../chains'
-import { DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION, DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION } from '../../const'
+import {
+  COW_SHED_PROXY_CREATION_GAS,
+  DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION,
+  DEFAULT_EXTRA_GAS_PROXY_CREATION,
+  DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION,
+} from '../../const'
 import { BridgeStatus, QuoteBridgeRequest } from '../../types'
 import { BungeeApi } from './BungeeApi'
 import {
@@ -33,6 +38,8 @@ class BungeeBridgeProviderTest extends BungeeBridgeProvider {
   }
 }
 
+const mockGetCode = jest.fn()
+
 describe('BungeeBridgeProvider', () => {
   let provider: BungeeBridgeProviderTest
 
@@ -41,7 +48,7 @@ describe('BungeeBridgeProvider', () => {
       apiOptions: {},
       getRpcProvider() {
         return {
-          getCode: jest.fn().mockResolvedValue('0x1234567890'),
+          getCode: mockGetCode,
         } as unknown as JsonRpcProvider
       },
     }
@@ -396,7 +403,9 @@ describe('BungeeBridgeProvider', () => {
   })
 
   describe('getGasLimitEstimationForHook', () => {
-    it('should return default gas limit estimation for non-Mainnet to Gnosis', async () => {
+    it('should return default gas limit estimation for Mainnet to Polygon', async () => {
+      mockGetCode.mockResolvedValue('0x1234567890')
+
       const request: QuoteBridgeRequest = {
         kind: OrderKind.SELL,
         sellTokenAddress: '0x123',
@@ -417,7 +426,32 @@ describe('BungeeBridgeProvider', () => {
       expect(gasLimit).toEqual(DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION)
     })
 
+    it('should return default gas limit estimation for Mainnet to Polygon and deploy proxy account', async () => {
+      mockGetCode.mockResolvedValue(undefined)
+
+      const request: QuoteBridgeRequest = {
+        kind: OrderKind.SELL,
+        sellTokenAddress: '0x123',
+        sellTokenChainId: SupportedChainId.MAINNET,
+        buyTokenChainId: SupportedChainId.POLYGON,
+        amount: 1000000000000000000n,
+        receiver: '0x789',
+        account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef', // need to find cowshed account address
+        sellTokenDecimals: 18,
+        buyTokenAddress: '0x456',
+        buyTokenDecimals: 6,
+        appCode: '0x123',
+        signer: '0xa43ccc40ff785560dab6cb0f13b399d050073e8a54114621362f69444e1421ca',
+      }
+
+      const gasLimit = await provider.getGasLimitEstimationForHook(request)
+
+      expect(gasLimit).toEqual(DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION + COW_SHED_PROXY_CREATION_GAS)
+    })
+
     it('should return default gas limit estimation for Mainnet to Gnosis', async () => {
+      mockGetCode.mockResolvedValue('0x1234567890')
+
       const request: QuoteBridgeRequest = {
         kind: OrderKind.SELL,
         sellTokenAddress: '0x123',
@@ -437,5 +471,30 @@ describe('BungeeBridgeProvider', () => {
 
       expect(gasLimit).toEqual(DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION + DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION)
     })
+
+    it('should return default gas limit estimation for Mainnet to Gnosis and deploy proxy account', async () => {
+      mockGetCode.mockResolvedValue('0x')
+
+      const request: QuoteBridgeRequest = {
+        kind: OrderKind.SELL,
+        sellTokenAddress: '0x123',
+        sellTokenChainId: SupportedChainId.MAINNET,
+        buyTokenChainId: SupportedChainId.GNOSIS_CHAIN,
+        amount: 1000000000000000000n,
+        receiver: '0x789',
+        account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef', // need to find cowshed account address
+        sellTokenDecimals: 18,
+        buyTokenAddress: '0x456',
+        buyTokenDecimals: 6,
+        appCode: '0x123',
+        signer: '0xa43ccc40ff785560dab6cb0f13b399d050073e8a54114621362f69444e1421ca',
+      }
+
+      const gasLimit = await provider.getGasLimitEstimationForHook(request)
+
+      expect(gasLimit).toEqual(
+        DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION + COW_SHED_PROXY_CREATION_GAS + DEFAULT_EXTRA_GAS_PROXY_CREATION,
+      )
+    })
   })
 })

src/bridging/providers/bungee/BungeeBridgeProvider.ts

@@ -13,7 +13,11 @@ import {
   GetProviderBuyTokens,
   QuoteBridgeRequest,
 } from '../../types'
-import { DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION, RAW_PROVIDERS_FILES_PATH } from '../../const'
+import {
+  DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION,
+  DEFAULT_EXTRA_GAS_PROXY_CREATION,
+  RAW_PROVIDERS_FILES_PATH,
+} from '../../const'
 import { ChainId, ChainInfo, SupportedChainId } from '../../../chains'
 import { EvmCall, TokenInfo } from '../../../common'
 import { mainnet } from '../../../chains/details/mainnet'
@@ -150,14 +154,17 @@ export class BungeeBridgeProvider implements BridgeProvider<BungeeQuoteResult> {
   }
 
   async getGasLimitEstimationForHook(request: QuoteBridgeRequest): Promise<number> {
-    const extraGas = this.isExtraGasRequired(request) ? DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION : undefined
+    const isExtraGasRequired = this.isExtraGasRequired(request)
+    const extraGas = isExtraGasRequired ? DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION : undefined
+    const extraGasProxyCreation = isExtraGasRequired ? DEFAULT_EXTRA_GAS_PROXY_CREATION : undefined
 
-    return getGasLimitEstimationForHook(
-      this.cowShedSdk,
+    return getGasLimitEstimationForHook({
+      cowShedSdk: this.cowShedSdk,
       request,
-      this.getRpcProvider(request.sellTokenChainId),
+      provider: this.getRpcProvider(request.sellTokenChainId),
       extraGas,
-    )
+      extraGasProxyCreation,
+    })
   }
 
   async getSignedHook(
@@ -204,7 +211,7 @@ export class BungeeBridgeProvider implements BridgeProvider<BungeeQuoteResult> {
     _txHash: string,
   ): Promise<{ params: BridgingDepositParams; status: BridgeStatusResult } | null> {
     const events = await this.api.getEvents({ orderId })
-    const event = events[0]
+    const event = events?.[0]
 
     if (!event) return null
 

src/bridging/providers/bungee/getBridgingStatusFromEvents.ts

@@ -37,6 +37,7 @@ export async function getBridgingStatusFromEvents(
         console.error('BungeeBridgeProvider get across status error', e)
       }
     }
+
     // if not across or across API fails, waiting for dest tx, return in_progress
     return { status: BridgeStatus.IN_PROGRESS, depositTxHash: event.srcTransactionHash }
   }

src/bridging/providers/utils/getGasLimitEstimationForHook.ts

@@ -3,24 +3,27 @@ import type { JsonRpcProvider } from '@ethersproject/providers'
 import { COW_SHED_PROXY_CREATION_GAS, DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION } from '../../const'
 import { CowShedSdk } from '../../../cow-shed'
 
-export async function getGasLimitEstimationForHook(
-  cowShedSdk: CowShedSdk,
-  request: QuoteBridgeRequest,
-  provider: JsonRpcProvider,
-  extraGas?: number,
-): Promise<number> {
+export async function getGasLimitEstimationForHook({
+  cowShedSdk,
+  request,
+  provider,
+  extraGas,
+  extraGasProxyCreation,
+}: {
+  cowShedSdk: CowShedSdk
+  request: QuoteBridgeRequest
+  provider: JsonRpcProvider
+  extraGas?: number
+  extraGasProxyCreation?: number
+}): Promise<number> {
   const proxyAddress = cowShedSdk.getCowShedAccount(request.sellTokenChainId, request.owner || request.account)
   const proxyCode = await provider.getCode(proxyAddress)
 
   // Proxy is not deployed
   if (!proxyCode || proxyCode === '0x') {
-    return DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION + COW_SHED_PROXY_CREATION_GAS
+    const baseGas = DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION + COW_SHED_PROXY_CREATION_GAS
+    return baseGas + (extraGasProxyCreation && extraGasProxyCreation > 0 ? extraGasProxyCreation : 0)
   }
 
-  // Some bridges require extra gas to be added to the hook.
-  if (extraGas && extraGas > 0) {
-    return DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION + extraGas
-  }
-
-  return DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION
+  return DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION + (extraGas && extraGas > 0 ? extraGas : 0)
 }

src/bridging/types.ts

@@ -209,10 +209,13 @@ export interface BridgeProvider<Q extends BridgeQuoteResult> {
    * 2. The final amount could affect hook gas costs
    *
    * By estimating gas costs independently, we can resolve this dependency cycle.
-   * For some providers, the `extraGas` flag adds a 100,000 gas‐unit buffer to the hook
-   * (see DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION).
+   * For some providers, the `extraGas` parameter adds additional gas‐unit buffer to the hook
+   * and `extraGasProxyCreation` parameter adds additional gas‐unit buffer for the proxy creation
+   * (see DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION and DEFAULT_EXTRA_GAS_PROXY_CREATION).
    */
-  getGasLimitEstimationForHook(request: Omit<QuoteBridgeRequest, 'amount'> & { extraGas?: number }): Promise<number>
+  getGasLimitEstimationForHook(
+    request: Omit<QuoteBridgeRequest, 'amount'> & { extraGas?: number; extraGasProxyCreation?: number },
+  ): Promise<number>
 
   /**
    * Get a pre-authorized hook for initiating a bridge.