feat: add Gnosis bridge to BungeeApi (#418)

* feat: add Gnosis bridget to BungeeApi

* chore: fix Gnosis bridge name and add specs

* chore: add Bungee transaction spec

* chore: add Gnosis bridge full transaction test

* chore: add getWallet test, update `BungeeTxDataBytesIndices`

* chore: update tests

* chore: address coderabbit CR comments

* chore: remove console.log

* chore: update version

* chore: improve `getWallet` test coverage

* feat: method `getBuyTokens` of `BridgingSdk` returns if route is available

* chore: bump version

* feat: increase gas for hook if mainnet to gnosis bridge

* chore: bump version

* chore: bump version

* chore: update `getGasLimitEstimationForHook` documentation

* chore: address coderabbit comments

* chore: address PR comments

* Update package.json

Co-authored-by: Leandro <[email protected]>

* chore: update description

---------

Co-authored-by: Leandro <[email protected]>

Author: cowdan

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/cow-sdk",
-  "version": "6.2.0",
+  "version": "6.3.0-RC.0",
   "license": "(MIT OR Apache-2.0)",
   "files": [
     "/dist"
@@ -24,6 +24,7 @@
     "test": "jest",
     "test:coverage": "jest --coverage --json --outputFile=jest.results.json && cat ./coverage/lcov.info | coveralls",
     "test:coverage:html": "jest --silent=false --coverage --coverageReporters html",
+    "test:bungeeGnosisBridge": "yarn test --testPathPattern=BungeeGnosisBridge",
     "codegen": "npm run swagger:codegen && npm run typechain:codegen",
     "prepare": "npm run build",
     "prepublishOnly": "npm test && npm run lint",

src/bridging/BridgingSdk/BridgingSdk.ts

@@ -6,9 +6,10 @@ import {
   BuyTokensParams,
   CrossChainOrder,
   CrossChainQuoteAndPost,
+  GetProviderBuyTokens,
   QuoteBridgeRequest,
 } from '../types'
-import { ALL_SUPPORTED_CHAINS, CowEnv, TokenInfo, enableLogging } from '../../common'
+import { ALL_SUPPORTED_CHAINS, CowEnv, enableLogging } from '../../common'
 import { ChainInfo, SupportedChainId } from '../../chains'
 import { getQuoteWithoutBridge } from './getQuoteWithoutBridge'
 import { getQuoteWithBridge } from './getQuoteWithBridge'
@@ -120,7 +121,7 @@ export class BridgingSdk {
 
    * @param params
    */
-  async getBuyTokens(params: BuyTokensParams): Promise<TokenInfo[]> {
+  async getBuyTokens(params: BuyTokensParams): Promise<GetProviderBuyTokens> {
     return this.provider.getBuyTokens(params)
   }
 

src/bridging/BridgingSdk/mock/bridgeRequestMocks.ts

@@ -1,7 +1,7 @@
 import { SupportedChainId } from '../../../chains'
 import { parseUnits } from '@ethersproject/units'
 
-import { BridgeCallDetails, BridgeQuoteResult, QuoteBridgeRequest } from '../../types'
+import { BridgeCallDetails, BridgeQuoteResult, BuyTokensParams, QuoteBridgeRequest } from '../../types'
 import { OrderKind } from '@cowprotocol/contracts'
 import {
   BuyTokenDestination,
@@ -234,3 +234,8 @@ export const orderTypedData: OrderTypedData = {
   types: {},
   message: orderToSign,
 }
+
+export const buyTokensParams: BuyTokensParams = {
+  sellChainId: SupportedChainId.MAINNET,
+  buyChainId: SupportedChainId.GNOSIS_CHAIN,
+}

src/bridging/PROVIDER_README.md

@@ -3,7 +3,7 @@
 This guide explains how to develop a new bridge provider for the `CoW Protocol` `BridgingSDK`.
 Bridge providers integrate third-party bridging protocols into the `CoW ecosystem`, enabling cross-chain token swaps.
 
->You can see existing providers code in [`src/bridging/providers`](./providers) directory.
+> You can see existing providers code in [`src/bridging/providers`](./providers) directory.
 
 ## Table of Contents
 
@@ -92,37 +92,31 @@ interface BridgeProvider<Q extends BridgeQuoteResult> {
 
 ### Required Methods
 
-| Method | Purpose | Required |
-|--------|---------|----------|
-| `getNetworks()` | Get supported destination chains | ✅ |
-| `getBuyTokens()` | Get supported tokens for a chain | ✅ |
-| `getIntermediateTokens()` | Get bridgeable tokens on source chain | ✅ |
-| `getQuote()` | Generate bridge quote | ✅ |
-| `getUnsignedBridgeCall()` | Create unsigned bridge transaction | ✅ |
-| `getGasLimitEstimationForHook()` | Estimate gas for hook execution | ✅ |
-| `getSignedHook()` | Generate pre-authorized hook | ✅ |
-| `getStatus()` | Check bridge transaction status | ✅ |
-| `getBridgingParams()` | Extract bridge params from settlement | ✅ |
-| `getExplorerUrl()` | Get bridge explorer URL | ✅ |
-| `decodeBridgeHook()` | Decode hook data | Optional* |
-| `getCancelBridgingTx()` | Create cancel transaction | Optional* |
-| `getRefundBridgingTx()` | Create refund transaction | Optional* |
-
-*Can throw "Not implemented" error if unsupported
+| Method                           | Purpose                               | Required   |
+| -------------------------------- | ------------------------------------- | ---------- |
+| `getNetworks()`                  | Get supported destination chains      | ✅         |
+| `getBuyTokens()`                 | Get supported tokens for a chain      | ✅         |
+| `getIntermediateTokens()`        | Get bridgeable tokens on source chain | ✅         |
+| `getQuote()`                     | Generate bridge quote                 | ✅         |
+| `getUnsignedBridgeCall()`        | Create unsigned bridge transaction    | ✅         |
+| `getGasLimitEstimationForHook()` | Estimate gas for hook execution       | ✅         |
+| `getSignedHook()`                | Generate pre-authorized hook          | ✅         |
+| `getStatus()`                    | Check bridge transaction status       | ✅         |
+| `getBridgingParams()`            | Extract bridge params from settlement | ✅         |
+| `getExplorerUrl()`               | Get bridge explorer URL               | ✅         |
+| `decodeBridgeHook()`             | Decode hook data                      | Optional\* |
+| `getCancelBridgingTx()`          | Create cancel transaction             | Optional\* |
+| `getRefundBridgingTx()`          | Create refund transaction             | Optional\* |
+
+\*Can throw "Not implemented" error if unsupported
 
 ## Implementation Guide
 
 ### Step 1: Basic Provider Class
 
 ```typescript
-import {
-  BridgeProvider,
-  BridgeProviderInfo,
-  BridgeQuoteResult
-} from '../../types'
-import {
-  SupportedChainId, mainnet, polygon, arbitrumOne, optimism, ChainInfo
-} from '../../../chains'
+import { BridgeProvider, BridgeProviderInfo, BridgeQuoteResult } from '../../types'
+import { SupportedChainId, mainnet, polygon, arbitrumOne, optimism, ChainInfo } from '../../../chains'
 import { CowShedSdk } from '../../../cow-shed'
 import { JsonRpcProvider } from '@ethersproject/providers'
 import { HOOK_DAPP_BRIDGE_PROVIDER_PREFIX } from '../../const'
@@ -134,7 +128,7 @@ export const YOUR_BRIDGE_SUPPORTED_NETWORKS = [
   mainnet,
   polygon,
   arbitrumOne,
-  optimism
+  optimism,
   // Add your supported chains
   // If there are no needed chains, add them to `src/chains`
 ]
@@ -187,7 +181,7 @@ export class YourBridgeProvider implements BridgeProvider<YourBridgeQuoteResult>
         sellTokenAddress: params.sellTokenAddress,
       })
 
-      return tokens.map(token => ({
+      return tokens.map((token) => ({
         chainId: token.chainId,
         address: token.address,
         name: token.name,
@@ -204,14 +198,11 @@ export class YourBridgeProvider implements BridgeProvider<YourBridgeQuoteResult>
   async getIntermediateTokens(request: QuoteBridgeRequest): Promise<TokenInfo[]> {
     // Validate order kind
     if (request.kind !== OrderKind.SELL) {
-      throw new BridgeProviderQuoteError(
-        BridgeQuoteErrors.ONLY_SELL_ORDER_SUPPORTED,
-        {kind: request.kind}
-      )
+      throw new BridgeProviderQuoteError(BridgeQuoteErrors.ONLY_SELL_ORDER_SUPPORTED, { kind: request.kind })
     }
 
     // Get tokens on source chain that can bridge to target token
-    const {sellTokenChainId, buyTokenChainId, buyTokenAddress} = request
+    const { sellTokenChainId, buyTokenChainId, buyTokenAddress } = request
 
     const intermediateTokens = await this.api.getIntermediateTokens({
       fromChainId: sellTokenChainId,
@@ -238,15 +229,12 @@ export class YourBridgeProvider implements BridgeProvider<YourBridgeQuoteResult>
       amount,
       receiver,
       account,
-      owner
+      owner,
     } = request
 
     // Get CoW Shed account for the owner
     const ownerAddress = owner ?? account
-    const cowShedAccount = this.cowShedSdk.getCowShedAccount(
-      sellTokenChainId,
-      ownerAddress
-    )
+    const cowShedAccount = this.cowShedSdk.getCowShedAccount(sellTokenChainId, ownerAddress)
 
     // Request quote from external bridge
     const externalQuote = await this.api.getQuote({
@@ -266,23 +254,14 @@ export class YourBridgeProvider implements BridgeProvider<YourBridgeQuoteResult>
     return this.convertToBridgeQuote(externalQuote, request)
   }
 
-  private async validateQuote(
-    externalQuote: YourBridgeQuote,
-    request: QuoteBridgeRequest
-  ): Promise<void> {
+  private async validateQuote(externalQuote: YourBridgeQuote, request: QuoteBridgeRequest): Promise<void> {
     // Add validation logic
     if (!externalQuote.isValid) {
-      throw new BridgeProviderQuoteError(
-        BridgeQuoteErrors.NO_ROUTES_FOUND,
-        {quote: externalQuote}
-      )
+      throw new BridgeProviderQuoteError(BridgeQuoteErrors.NO_ROUTES_FOUND, { quote: externalQuote })
     }
   }
 
-  private convertToBridgeQuote(
-    externalQuote: YourBridgeQuote,
-    request: QuoteBridgeRequest
-  ): YourBridgeQuoteResult {
+  private convertToBridgeQuote(externalQuote: YourBridgeQuote, request: QuoteBridgeRequest): YourBridgeQuoteResult {
     return {
       isSell: true,
       amountsAndCosts: {
@@ -328,17 +307,15 @@ export class YourBridgeProvider implements BridgeProvider<YourBridgeQuoteResult>
 
 > It very depends on your smart-contract implementation.
 > Basically, the smart-contract should:
+>
 > 1. Approve sell token spending from `CoW Shed proxy`
 > 2. Transfer funds from `CoW Shed proxy` to your deposit smart-contract
 >
 > See `createBungeeDepositCall` as an example
 
 ```typescript
 export class YourBridgeProvider implements BridgeProvider<YourBridgeQuoteResult> {
-  async getUnsignedBridgeCall(
-    request: QuoteBridgeRequest,
-    quote: YourBridgeQuoteResult
-  ): Promise<EvmCall> {
+  async getUnsignedBridgeCall(request: QuoteBridgeRequest, quote: YourBridgeQuoteResult): Promise<EvmCall> {
     // Create the bridge transaction that will be executed by CoW Shed
     return createYourBridgeCall({
       request,
@@ -356,7 +333,10 @@ import { EvmCall } from '../../../common'
 import { YourBridgeQuoteResult } from '../types'
 import { YOUR_BRIDGE_CONTRACTS, YOUR_BRIDGE_ABI } from '../const'
 
-export async function createYourBridgeCall({ request, quote }: {
+export async function createYourBridgeCall({
+  request,
+  quote,
+}: {
   request: QuoteBridgeRequest
   quote: YourBridgeQuoteResult
 }): Promise<EvmCall> {
@@ -401,13 +381,14 @@ import { getGasLimitEstimationForHook } from '../utils/getGasLimitEstimationForH
 
 export class YourBridgeProvider implements BridgeProvider<YourBridgeQuoteResult> {
   async getGasLimitEstimationForHook(
-    request: Omit<QuoteBridgeRequest, 'amount'>
+    request: Omit<QuoteBridgeRequest, 'amount'> & { extraGas?: 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)
+      this.getRpcProvider(request.sellTokenChainId),
+      request.extraGas, // to add extra gas to the hook.
     )
   }
 
@@ -421,21 +402,23 @@ export class YourBridgeProvider implements BridgeProvider<YourBridgeQuoteResult>
   ): Promise<BridgeHook> {
     // Sign the multicall using CoW Shed SDK
     const { signedMulticall, cowShedAccount, gasLimit } = await this.cowShedSdk.signCalls({
-      calls: [{
-        target: unsignedCall.to,
-        value: unsignedCall.value,
-        callData: unsignedCall.data,
-        allowFailure: false,
-        isDelegateCall: true,
-      }],
+      calls: [
+        {
+          target: unsignedCall.to,
+          value: unsignedCall.value,
+          callData: unsignedCall.data,
+          allowFailure: false,
+          isDelegateCall: true,
+        },
+      ],
       chainId,
       signer,
       gasLimit: BigInt(hookGasLimit),
       deadline,
       nonce: bridgeHookNonce,
     })
 
-    const {to, data} = signedMulticall
+    const { to, data } = signedMulticall
     return {
       postHook: {
         target: to,
@@ -647,9 +630,7 @@ describe('YourBridgeProvider', () => {
         // ... rest of request
       }
 
-      await expect(provider.getQuote(request))
-        .rejects
-        .toThrow('Only sell orders are supported')
+      await expect(provider.getQuote(request)).rejects.toThrow('Only sell orders are supported')
     })
   })
 
@@ -663,23 +644,17 @@ describe('YourBridgeProvider', () => {
 
 ```typescript
 // Use specific error types
-throw new BridgeProviderQuoteError(
-  BridgeQuoteErrors.INSUFFICIENT_LIQUIDITY,
-  {
-    availableLiquidity: '1000',
-    requestedAmount: '2000'
-  }
-)
+throw new BridgeProviderQuoteError(BridgeQuoteErrors.INSUFFICIENT_LIQUIDITY, {
+  availableLiquidity: '1000',
+  requestedAmount: '2000',
+})
 
 // Handle API failures gracefully
 try {
   return await this.api.getQuote(params)
 } catch (error) {
   if (error.status === 404) {
-    throw new BridgeProviderQuoteError(
-      BridgeQuoteErrors.NO_ROUTES_FOUND,
-      { params }
-    )
+    throw new BridgeProviderQuoteError(BridgeQuoteErrors.NO_ROUTES_FOUND, { params })
   }
   throw error
 }
@@ -768,6 +743,7 @@ const bridgingSdk = new BridgingSdk({
 ### Common Issues
 
 1. **Gas Estimation Failures**
+
    ```typescript
    import { getGasLimitEstimationForHook } from '../utils/getGasLimitEstimationForHook'
 
@@ -783,6 +759,7 @@ const bridgingSdk = new BridgingSdk({
    ```
 
 2. **API Rate Limiting**
+
    ```typescript
    // Implement retry logic with exponential backoff
    private async withRetry<T>(operation: () => Promise<T>, maxRetries = 3): Promise<T> {
@@ -816,4 +793,3 @@ const bridgingSdk = new BridgingSdk({
 - Test with small amounts first
 - Validate against existing providers like `MockBridgeProvider`
 - Monitor transaction status on both chains
-

src/bridging/const.ts

@@ -3,6 +3,7 @@ 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
 // Based on https://dashboard.tenderly.co/shoom/project/tx/0x2971aee9aa7237d24b254da8ccd4345ff77410c8829c8e825e9a02cb2cece5e6/gas-usage
 export const COW_SHED_PROXY_CREATION_GAS = 360_000
 export const HOOK_DAPP_BRIDGE_PROVIDER_PREFIX = 'cow-sdk://bridging/providers'