Skip to main content

Class: BridgingSdk

SDK for bridging for swapping tokens between different chains.

Constructors​

constructor​

• new BridgingSdk(options): BridgingSdk

Parameters​

NameType
optionsBridgingSdkOptions

Returns​

BridgingSdk

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:68

Properties​

config​

• Protected config: Required<Omit<BridgingSdkOptions, "enableLogging">>

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:66

options​

• Readonly options: BridgingSdkOptions

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:68

Accessors​

provider​

• get provider(): BridgeProvider<BridgeQuoteResult>

Returns​

BridgeProvider<BridgeQuoteResult>

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:91

Methods​

getBuyTokens​

▸ getBuyTokens(params): Promise<TokenInfo[]>

Get the available buy tokens for buying in a specific target chain

Parameters​

NameType
paramsBuyTokensParams

Returns​

Promise<TokenInfo[]>

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:123

getOrder​

▸ getOrder(params): Promise<null | CrossChainOrder>

Parameters​

NameType
paramsGetOrderParams

Returns​

Promise<null | CrossChainOrder>

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:168

getOrderBridgingStatus​

▸ getOrderBridgingStatus(bridgingId, originChainId): Promise<BridgeStatusResult>

Parameters​

NameType
bridgingIdstring
originChainIdSupportedChainId

Returns​

Promise<BridgeStatusResult>

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:182

getProviderFromAppData​

▸ getProviderFromAppData(fullAppData): undefined | BridgeProvider<BridgeQuoteResult>

Parameters​

NameType
fullAppDatastring

Returns​

undefined | BridgeProvider<BridgeQuoteResult>

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:186

getProviders​

▸ getProviders(): BridgeProvider<BridgeQuoteResult>[]

Get the providers for the bridging.

Returns​

BridgeProvider<BridgeQuoteResult>[]

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:100

getQuote​

▸ getQuote(quoteBridgeRequest, advancedSettings?): Promise<CrossChainQuoteAndPost>

Get quote details, including a callback function to post the order on-chain.

This method support both, cross-chain swaps and single-chain swap.

The return type will be either QuoteAndPost or BridgeQuoteAndPost.

To safely assert the type in Typescript, you can use:

  • isBridgeQuoteAndPost(result) utility.
  • isQuoteAndPost(result) utility.
  • assertIsBridgeQuoteAndPost(result) assertion.
  • assertIsQuoteAndPost(result) assertion.

Parameters​

NameType
quoteBridgeRequestQuoteBridgeRequest
advancedSettings?SwapAdvancedSettings

Returns​

Promise<CrossChainQuoteAndPost>

Throws

Error if no path is found

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:142

getSourceNetworks​

▸ getSourceNetworks(): Promise<ChainInfo[]>

Get the available sources networks for the bridging.

Returns​

Promise<ChainInfo[]>

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:107

getTargetNetworks​

▸ getTargetNetworks(): Promise<ChainInfo[]>

Get the available target networks for the bridging.

Returns​

Promise<ChainInfo[]>

Defined in​

external/cow-sdk/src/bridging/BridgingSdk/BridgingSdk.ts:114