@cowprotocol/cow-sdk 6.2.0 → 6.3.0

package/dist/bridging/BridgingSdk/BridgingSdk.d.ts

@@ -1,6 +1,6 @@
 import { SwapAdvancedSettings, TradingSdk } from '../../trading';
-import { BridgeProvider, BridgeQuoteResult, BridgeStatusResult, BuyTokensParams, CrossChainOrder, CrossChainQuoteAndPost, QuoteBridgeRequest } from '../types';
-import { CowEnv, TokenInfo } from '../../common';
+import { BridgeProvider, BridgeQuoteResult, BridgeStatusResult, BuyTokensParams, CrossChainOrder, CrossChainQuoteAndPost, GetProviderBuyTokens, QuoteBridgeRequest } from '../types';
+import { CowEnv } from '../../common';
 import { ChainInfo, SupportedChainId } from '../../chains';
 import { OrderBookApi } from '../../order-book';
 export interface BridgingSdkOptions {
@@ -64,7 +64,7 @@ export declare class BridgingSdk {
   
      * @param params
      */
-    getBuyTokens(params: BuyTokensParams): Promise<TokenInfo[]>;
+    getBuyTokens(params: BuyTokensParams): Promise<GetProviderBuyTokens>;
     /**
      * Get quote details, including a callback function to post the order on-chain.
      *

package/dist/bridging/BridgingSdk/mock/bridgeRequestMocks.d.ts

@@ -1,4 +1,4 @@
-import { BridgeCallDetails, BridgeQuoteResult, QuoteBridgeRequest } from '../../types';
+import { BridgeCallDetails, BridgeQuoteResult, BuyTokensParams, QuoteBridgeRequest } from '../../types';
 import { OrderQuoteResponse, QuoteAmountsAndCosts } from '../../../order-book';
 import { AppDataInfo, OrderTypedData, TradeParameters } from '../../../trading';
 import { UnsignedOrder } from '../../../order-signing';
@@ -18,3 +18,4 @@ export declare const appDataInfo: AppDataInfo;
 export declare const tradeParameters: TradeParameters;
 export declare const orderToSign: UnsignedOrder;
 export declare const orderTypedData: OrderTypedData;
+export declare const buyTokensParams: BuyTokensParams;

package/dist/bridging/const.d.ts

@@ -1,4 +1,5 @@
 export declare const RAW_PROVIDERS_FILES_PATH = "https://raw.githubusercontent.com/cowprotocol/cow-sdk/refs/heads/main/src/bridging/providers";
 export declare const DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION = 240000;
+export declare const DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION = 100000;
 export declare const COW_SHED_PROXY_CREATION_GAS = 360000;
 export declare const HOOK_DAPP_BRIDGE_PROVIDER_PREFIX = "cow-sdk://bridging/providers";

package/dist/bridging/providers/across/AcrossBridgeProvider.d.ts

@@ -1,6 +1,6 @@
 import { Signer } from 'ethers';
 import { latest as latestAppData } from '@cowprotocol/app-data';
-import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, BridgingDepositParams, BuyTokensParams, QuoteBridgeRequest } from '../../types';
+import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, BridgingDepositParams, BuyTokensParams, GetProviderBuyTokens, QuoteBridgeRequest } from '../../types';
 import { ChainId, ChainInfo, SupportedChainId } from '../../../chains';
 import { EvmCall, TokenInfo } from '../../../common';
 import { AcrossApi, AcrossApiOptions } from './AcrossApi';
@@ -25,7 +25,7 @@ export declare class AcrossBridgeProvider implements BridgeProvider<AcrossQuoteR
     constructor(options: AcrossBridgeProviderOptions);
     info: BridgeProviderInfo;
     getNetworks(): Promise<ChainInfo[]>;
-    getBuyTokens(params: BuyTokensParams): Promise<TokenInfo[]>;
+    getBuyTokens(params: BuyTokensParams): Promise<GetProviderBuyTokens>;
     getIntermediateTokens(request: QuoteBridgeRequest): Promise<TokenInfo[]>;
     getQuote(request: QuoteBridgeRequest): Promise<AcrossQuoteResult>;
     getUnsignedBridgeCall(request: QuoteBridgeRequest, quote: AcrossQuoteResult): Promise<EvmCall>;

package/dist/bridging/providers/bungee/BungeeBridgeProvider.d.ts

@@ -1,5 +1,5 @@
 import { latest as latestAppData } from '@cowprotocol/app-data';
-import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, BridgingDepositParams, BuyTokensParams, QuoteBridgeRequest } from '../../types';
+import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, BridgingDepositParams, BuyTokensParams, GetProviderBuyTokens, QuoteBridgeRequest } from '../../types';
 import { ChainId, ChainInfo, SupportedChainId } from '../../../chains';
 import { EvmCall, TokenInfo } from '../../../common';
 import { BungeeApi, BungeeApiOptions } from './BungeeApi';
@@ -26,7 +26,7 @@ export declare class BungeeBridgeProvider implements BridgeProvider<BungeeQuoteR
     constructor(options: BungeeBridgeProviderOptions);
     info: BridgeProviderInfo;
     getNetworks(): Promise<ChainInfo[]>;
-    getBuyTokens(params: BuyTokensParams): Promise<TokenInfo[]>;
+    getBuyTokens(params: BuyTokensParams): Promise<GetProviderBuyTokens>;
     getIntermediateTokens(request: QuoteBridgeRequest): Promise<TokenInfo[]>;
     getQuote(request: QuoteBridgeRequest): Promise<BungeeQuoteResult>;
     getUnsignedBridgeCall(request: QuoteBridgeRequest, quote: BungeeQuoteResult): Promise<EvmCall>;
@@ -41,4 +41,5 @@ export declare class BungeeBridgeProvider implements BridgeProvider<BungeeQuoteR
     getStatus(_bridgingId: string): Promise<BridgeStatusResult>;
     getCancelBridgingTx(_bridgingId: string): Promise<EvmCall>;
     getRefundBridgingTx(_bridgingId: string): Promise<EvmCall>;
+    private isExtraGasRequired;
 }

package/dist/bridging/providers/bungee/types.d.ts

@@ -1,4 +1,4 @@
-export type SupportedBridge = 'across' | 'cctp';
+export type SupportedBridge = 'across' | 'cctp' | 'gnosis-native-bridge';
 export interface BungeeQuoteAPIRequest {
     userAddress: string;
     originChainId: string;
@@ -105,7 +105,8 @@ export interface BungeeQuoteAPIResponse {
 }
 export declare enum BungeeBridge {
     'Across' = "across",
-    'CircleCCTP' = "cctp"
+    'CircleCCTP' = "cctp",
+    'GnosisNative' = "gnosis-native-bridge"
 }
 export declare const BungeeBridgeNames: Record<string, BungeeBridge>;
 export interface BungeeQuote {

package/dist/bridging/providers/mock/MockBridgeProvider.d.ts

@@ -1,5 +1,5 @@
 import { latest as latestAppData } from '@cowprotocol/app-data';
-import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, BridgingDepositParams, BuyTokensParams, QuoteBridgeRequest } from '../../types';
+import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, BridgingDepositParams, BuyTokensParams, GetProviderBuyTokens, QuoteBridgeRequest } from '../../types';
 import { Signer } from '@ethersproject/abstract-signer';
 import { JsonRpcProvider } from '@ethersproject/providers';
 import { ChainId, ChainInfo, SupportedChainId } from '../../../chains';
@@ -8,7 +8,7 @@ export declare class MockBridgeProvider implements BridgeProvider<BridgeQuoteRes
     info: BridgeProviderInfo;
     getRpcProvider(): JsonRpcProvider;
     getNetworks(): Promise<ChainInfo[]>;
-    getBuyTokens(params: BuyTokensParams): Promise<TokenInfo[]>;
+    getBuyTokens(params: BuyTokensParams): Promise<GetProviderBuyTokens>;
     getIntermediateTokens({ sellTokenChainId }: QuoteBridgeRequest): Promise<TokenInfo[]>;
     getQuote(_request: QuoteBridgeRequest): Promise<BridgeQuoteResult>;
     getGasLimitEstimationForHook(_request: QuoteBridgeRequest): Promise<number>;

package/dist/bridging/providers/utils/getGasLimitEstimationForHook.d.ts

@@ -1,4 +1,4 @@
 import { QuoteBridgeRequest } from '../../types';
 import type { JsonRpcProvider } from '@ethersproject/providers';
 import { CowShedSdk } from '../../../cow-shed';
-export declare function getGasLimitEstimationForHook(cowShedSdk: CowShedSdk, request: QuoteBridgeRequest, provider: JsonRpcProvider): Promise<number>;
+export declare function getGasLimitEstimationForHook(cowShedSdk: CowShedSdk, request: QuoteBridgeRequest, provider: JsonRpcProvider, extraGas?: number): Promise<number>;

package/dist/bridging/types.d.ts

@@ -109,6 +109,10 @@ export interface BuyTokensParams {
     sellChainId?: SupportedChainId;
     sellTokenAddress?: string;
 }
+export interface GetProviderBuyTokens {
+    tokens: TokenInfo[];
+    isRouteAvailable: boolean;
+}
 /**
  * A bridge deposit. It includes the provideer information, sell amount and the minimum buy amount.
  *
@@ -130,7 +134,7 @@ export interface BridgeProvider<Q extends BridgeQuoteResult> {
     /**
      * Get supported tokens for a chain
      */
-    getBuyTokens(params: BuyTokensParams): Promise<TokenInfo[]>;
+    getBuyTokens(params: BuyTokensParams): Promise<GetProviderBuyTokens>;
     /**
      * Get intermediate tokens given a quote request.
      *
@@ -165,8 +169,12 @@ 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).
      */
-    getGasLimitEstimationForHook(request: Omit<QuoteBridgeRequest, 'amount'>): Promise<number>;
+    getGasLimitEstimationForHook(request: Omit<QuoteBridgeRequest, 'amount'> & {
+        extraGas?: number;
+    }): Promise<number>;
     /**
      * Get a pre-authorized hook for initiating a bridge.
      *

package/dist/chains/types.d.ts

@@ -126,4 +126,8 @@ export interface ChainInfo {
         [key: string]: ChainRpcUrls;
         default: ChainRpcUrls;
     };
+    /**
+     * Whether the chain is zkSync based.
+     */
+    readonly isZkSync?: boolean;
 }

package/dist/chains/utils.d.ts

@@ -16,3 +16,4 @@ export declare function isAdditionalTargetChain(chainId: ChainId): chainId is Ad
  * Check if the chain is supported by CoW Swap or the bridge providers.
  */
 export declare function isTargetChainId(chainId: ChainId): chainId is TargetChainId;
+export declare function isZkSyncChain(chainId: ChainId): boolean;