Class AllbridgeCoreSdk

Hierarchy

AllbridgeCoreSdk

Constructors

constructor

new AllbridgeCoreSdk(nodeUrls: NodeUrlsConfig | NodeRpcUrls, params?: AllbridgeCoreSdkOptions): AllbridgeCoreSdk
Initializes the SDK object.
Parameters
- nodeUrls: NodeUrlsConfig | NodeRpcUrls
  
  node rpc urls for full functionality
- params: AllbridgeCoreSdkOptions = mainnet
  
  Optional. If not defined, the default mainnet parameters are used.
Returns AllbridgeCoreSdk
- Defined in src/index.ts:113

Properties

`Private` service

service: AllbridgeCoreSdkService

utils

utils: Utils

Methods

aprInPercents

aprInPercents(apr: string): string
Convert APR to percentage view

Returns
aprPercentageView
Parameters
- apr: string
Returns string
- Defined in src/index.ts:526

calculateFeePercentOnDestinationChain

calculateFeePercentOnDestinationChain(amountFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails): Promise<number>
Deprecated
Calculates the percentage of fee that is charged when swapping to the selected destination chain. The destination chain fee percent applies to the amount after the source chain fee. (Does not include fee related to the source chain. Does not include gas fee)

See
calculateFeePercentOnSourceChain

Returns
fee percent
Parameters
- amountFloat: BigSource
  
  initial amount of tokens to swap
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
Returns Promise<number>
- Defined in src/index.ts:259

calculateFeePercentOnSourceChain

calculateFeePercentOnSourceChain(amountFloat: BigSource, sourceChainToken: TokenWithChainDetails): Promise<number>
Deprecated
Calculates the percentage of fee from the initial amount that is charged when swapping from the selected source chain. (Does not include fee related to the destination chain. Does not include gas fee)

Returns
fee percent
Parameters
- amountFloat: BigSource
  
  initial amount of tokens to swap
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
Returns Promise<number>
- Defined in src/index.ts:242

chainDetailsMap

chainDetailsMap(type?: "swap" | "pool"): Promise<ChainDetailsMap>
Returns ChainDetailsMap containing a list of supported tokens groped by chain.
Parameters
- type: "swap" | "pool" = "swap"
  
  A string value which specifies ChainDetailsMap to retrieve. Can be either 'swap' for send or 'pool' for liquidity pools setup. Defaults to 'swap'.
Returns Promise<ChainDetailsMap>
- Defined in src/index.ts:134

checkAddress

checkAddress(chainSymbol: string, recipientAddress: string, tokenAddress?: string): Promise<CheckAddressResponse>
Check address and show gas balance

Deprecated
Parameters
- chainSymbol: string
  
  The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: ChainSymbol.
- recipientAddress: string
- Optional tokenAddress: string
Returns Promise<CheckAddressResponse>
- Defined in src/index.ts:186

getAmountFromVUsd

getAmountFromVUsd(vUsdAmount: string, destToken: TokenWithChainDetails): Promise<AmountFormatted>
Returns
amount of destToken
Parameters
- vUsdAmount: string
  
  amount of vUsd, int format
- destToken: TokenWithChainDetails
  
  selected token on the destination chain
Returns Promise<AmountFormatted>
- Defined in src/index.ts:562

getAmountToBeReceived

getAmountToBeReceived(amountToSendFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger?: Messenger): Promise<string>
Calculates the amount of tokens to be received as a result of transfer.
Parameters
- amountToSendFloat: BigSource
  
  the amount of tokens that will be sent
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
- Optional messenger: Messenger
  
  Optional. selected messenger
Returns Promise<string>
- Defined in src/index.ts:318

getAmountToBeReceivedAndGasFeeOptions

getAmountToBeReceivedAndGasFeeOptions(amountToSendFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: Messenger): Promise<AmountsAndGasFeeOptions>
Calculates the amount of tokens to be received as a result of transfer and fetches GasFeeOptions which contains available ways to pay the gas fee.
Parameters
- amountToSendFloat: BigSource
  
  the amount of tokens that will be sent
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
- messenger: Messenger
Returns Promise<AmountsAndGasFeeOptions>
- Defined in src/index.ts:275

getAmountToBeReceivedFromChain

getAmountToBeReceivedFromChain(amountToSendFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger?: Messenger, sourceProvider?: Provider, destinationProvider?: Provider): Promise<string>
Calculates the amount of tokens to be received as a result of transfer based on actual blockchain pool state.
Parameters
- amountToSendFloat: BigSource
  
  the amount of tokens that will be sent
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
- Optional messenger: Messenger
  
  Optional. selected messenger
- Optional sourceProvider: Provider
  
  Optional. source chain Provider
- Optional destinationProvider: Provider
  
  Optional. destination chain Provider
Returns Promise<string>
- Defined in src/index.ts:341

getAmountToBeReceivedFromPools

getAmountToBeReceivedFromPools(amountToSendFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, sourcePool: PoolInfo, destinationPool: PoolInfo, messenger?: Messenger): string
Calculates the amount of tokens to be received as a result of transfer based on passed pool state.
Parameters
- amountToSendFloat: BigSource
  
  the amount of tokens that will be sent
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
- sourcePool: PoolInfo
  
  source token pool state
- destinationPool: PoolInfo
  
  destination token pool state
- Optional messenger: Messenger
  
  Optional. selected messenger
Returns string
- Defined in src/index.ts:373

getAmountToSend

getAmountToSend(amountToBeReceivedFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger?: Messenger): Promise<string>
Calculates the amount of tokens to send based on requested tokens amount be received as a result of transfer.
Parameters
- amountToBeReceivedFloat: BigSource
  
  the amount of tokens that should be received
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
- Optional messenger: Messenger
  
  Optional. selected messenger
Returns Promise<string>
- Defined in src/index.ts:398

getAmountToSendAndGasFeeOptions

getAmountToSendAndGasFeeOptions(amountToBeReceivedFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: Messenger): Promise<AmountsAndGasFeeOptions>
Calculates the amount of tokens to send based on requested tokens amount be received as a result of transfer. and fetches GasFeeOptions which contains available ways to pay the gas fee.
Parameters
- amountToBeReceivedFloat: BigSource
  
  the amount of tokens that should be received
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
- messenger: Messenger
Returns Promise<AmountsAndGasFeeOptions>
- Defined in src/index.ts:297

getAmountToSendFromChain

getAmountToSendFromChain(amountToBeReceivedFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger?: Messenger, sourceProvider?: Provider, destinationProvider?: Provider): Promise<string>
Calculates the amount of tokens to send based on requested tokens amount be received as a result of transfer based on actual blockchain pool state.
Parameters
- amountToBeReceivedFloat: BigSource
  
  the amount of tokens that should be received
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
- Optional messenger: Messenger
  
  Optional. selected messenger
- Optional sourceProvider: Provider
  
  Optional. source chain Provider
- Optional destinationProvider: Provider
  
  Optional. destination chain Provider
Returns Promise<string>
- Defined in src/index.ts:421

getAmountToSendFromPools

getAmountToSendFromPools(amountToBeReceivedFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, sourcePool: PoolInfo, destinationPool: PoolInfo, messenger?: Messenger): string
Calculates the amount of tokens to send based on requested tokens amount be received as a result of transfer based on passed pool state.
Parameters
- amountToBeReceivedFloat: BigSource
  
  the amount of tokens that should be received
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
- sourcePool: PoolInfo
  
  source token pool state
- destinationPool: PoolInfo
  
  destination token pool state
- Optional messenger: Messenger
  
  Optional. selected messenger
Returns string
- Defined in src/index.ts:453

getAverageTransferTime

getAverageTransferTime(sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: Messenger): null | number
Gets the average time in ms to complete a transfer for given tokens and messenger.

Returns
Average transfer time in milliseconds or null if a given combination of tokens and messenger is not supported.
Parameters
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain.
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain.
- messenger: Messenger
Returns null | number
- Defined in src/index.ts:493

getExtraGasMaxLimits

getExtraGasMaxLimits(sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails): Promise<ExtraGasMaxLimitResponse>
Get possible limit of extra gas amount.

Returns
ExtraGasMaxLimitResponse
Parameters
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
Returns Promise<ExtraGasMaxLimitResponse>
- Defined in src/index.ts:536

getGasBalance

getGasBalance(chainSymbol: string, address: string): Promise<GasBalanceResponse>
Get gas balance
Parameters
- chainSymbol: string
  
  The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: ChainSymbol.
- address: string
Returns Promise<GasBalanceResponse>
- Defined in src/index.ts:175

getGasFeeOptions

getGasFeeOptions(sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: Messenger): Promise<GasFeeOptions>
Fetches possible ways to pay the transfer gas fee.

Returns
GasFeeOptions
Parameters
- sourceChainToken: TokenWithChainDetails
  
  selected token on the source chain
- destinationChainToken: TokenWithChainDetails
  
  selected token on the destination chain
- messenger: Messenger
Returns Promise<GasFeeOptions>
- Defined in src/index.ts:478

getNativeTokenBalance

getNativeTokenBalance(params: GetNativeTokenBalanceParams, provider?: Provider): Promise<AmountFormatted>
Get native (gas) token balance

Returns
Token balance
Parameters
- params: GetNativeTokenBalanceParams
- Optional provider: Provider
Returns Promise<AmountFormatted>
- Defined in src/index.ts:230

getPendingStatusInfo

getPendingStatusInfo(amount: string, amountFormat: AmountFormat, sourceToken: TokenWithChainDetails, destToken: TokenWithChainDetails): Promise<PendingStatusInfoResponse>
Returns information about pending transactions for the same destination chain and the amount of tokens can be received as a result of transfer considering pending transactions.

Returns
range of possible amount based on already pending transactions
Parameters
- amount: string
  
  the amount of tokens that will be sent
- amountFormat: AmountFormat
  
  amount format
- sourceToken: TokenWithChainDetails
  
  selected token transfer from
- destToken: TokenWithChainDetails
  
  selected token transfer to
Returns Promise<PendingStatusInfoResponse>
- Defined in src/index.ts:205

getPoolInfoByToken

getPoolInfoByToken(token: TokenWithChainDetails): Promise<PoolInfo>
Gets information about the poolInfo by token

Returns
poolInfo
Parameters
- token: TokenWithChainDetails
Returns Promise<PoolInfo>
- Defined in src/index.ts:506

getSendAmountDetails

getSendAmountDetails(amount: string, amountFormat: AmountFormat, sourceToken: TokenWithChainDetails, destToken: TokenWithChainDetails): Promise<SendAmountDetails>
Show amount changes (fee and amount adjustment) during send through pools on source and destination chains
Parameters
- amount: string
- amountFormat: AmountFormat
- sourceToken: TokenWithChainDetails
- destToken: TokenWithChainDetails
Returns Promise<SendAmountDetails>
- Defined in src/index.ts:597

getTokenBalance

getTokenBalance(params: GetTokenBalanceParams, provider?: Provider): Promise<string>
Get token balance

Returns
Token balance
Parameters
- params: GetTokenBalanceParams
- Optional provider: Provider
Returns Promise<string>
- Defined in src/index.ts:220

getTransferStatus

getTransferStatus(chainSymbol: string, txId: string): Promise<TransferStatusResponse>
Fetches information about tokens transfer by chosen chainSymbol and transaction Id from the Allbridge Core API.
Parameters
- chainSymbol: string
  
  The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: ChainSymbol.
- txId: string
Returns Promise<TransferStatusResponse>
- Defined in src/index.ts:166

getVUsdFromAmount

getVUsdFromAmount(amount: string, amountFormat: AmountFormat, sourceToken: TokenWithChainDetails): Promise<AmountFormatted>
Returns
virtual amount
Parameters
- amount: string
  
  amount
- amountFormat: AmountFormat
  
  AmountFormat
- sourceToken: TokenWithChainDetails
  
  selected token on the source chain
Returns Promise<AmountFormatted>
- Defined in src/index.ts:549

refreshPoolInfo

refreshPoolInfo(tokens?: TokenWithChainDetails | TokenWithChainDetails[]): Promise<void>
Forces refresh of cached information about the state of liquidity pools. Outdated cache leads to calculated amounts being less accurate. The cache is invalidated at regular intervals, but it can be forced to be refreshed by calling this method.+
Parameters
- Optional tokens: TokenWithChainDetails | TokenWithChainDetails[]
  
  if present, the corresponding liquidity pools will be updated
Returns Promise<void>
- Defined in src/index.ts:517

swapAndBridgeFeeCalculation

swapAndBridgeFeeCalculation(amountInTokenPrecision: string, sourceToken: TokenWithChainDetails, destToken: TokenWithChainDetails): Promise<SwapAndBridgeCalculationData>
Deprecated
Use getSendAmountDetails
Parameters
- amountInTokenPrecision: string
- sourceToken: TokenWithChainDetails
- destToken: TokenWithChainDetails
Returns Promise<SwapAndBridgeCalculationData>
- Defined in src/index.ts:572

swapAndBridgeFeeCalculationReverse

swapAndBridgeFeeCalculationReverse(amountInTokenPrecision: string, sourceToken: TokenWithChainDetails, destToken: TokenWithChainDetails): Promise<SwapAndBridgeCalculationData>
Deprecated
Use getAmountToBeReceived and then getSendAmountDetails
Parameters
- amountInTokenPrecision: string
- sourceToken: TokenWithChainDetails
- destToken: TokenWithChainDetails
Returns Promise<SwapAndBridgeCalculationData>
- Defined in src/index.ts:586

tokens

tokens(type?: "swap" | "pool"): Promise<TokenWithChainDetails[]>
Returns a list of supported tokens.

Returns
A promise that resolves to an array of TokenWithChainDetails.
Parameters
- type: "swap" | "pool" = "swap"
  
  A string value which specifies a set of tokens to retrieve. Can be either 'swap' for tokens to send or 'pool' for liquidity pools operations. Defaults to 'swap'.
Returns Promise<TokenWithChainDetails[]>
- Defined in src/index.ts:146

tokensByChain

tokensByChain(chainSymbol: string, type?: "swap" | "pool"): Promise<TokenWithChainDetails[]>
Returns a list of supported tokens on the selected chain.
Parameters
- chainSymbol: string
  
  The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: ChainSymbol.
- type: "swap" | "pool" = "swap"
  
  A string value which specifies a set of tokens to retrieve. Can be either 'swap' for tokens to send or 'pool' for liquidity pools operations. Defaults to 'swap'.
Returns Promise<TokenWithChainDetails[]>
- Defined in src/index.ts:157

Class AllbridgeCoreSdk

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

nodeUrls: NodeUrlsConfig | NodeRpcUrls

params: AllbridgeCoreSdkOptions = mainnet

Returns AllbridgeCoreSdk

Properties

bridge

Readonly params

pool

Private service

utils

Methods

aprInPercents

Returns

Parameters

apr: string

Returns string

calculateFeePercentOnDestinationChain

Deprecated

See

Returns

Parameters

amountFloat: BigSource

sourceChainToken: TokenWithChainDetails

destinationChainToken: TokenWithChainDetails

Returns Promise<number>

calculateFeePercentOnSourceChain

Deprecated

Returns

Parameters

amountFloat: BigSource

sourceChainToken: TokenWithChainDetails

Returns Promise<number>

chainDetailsMap

Parameters

type: "swap" | "pool" = "swap"

Returns Promise<ChainDetailsMap>

checkAddress

Deprecated

Parameters

chainSymbol: string

recipientAddress: string

Optional tokenAddress: string

Returns Promise<CheckAddressResponse>

getAmountFromVUsd

Returns

Parameters

vUsdAmount: string

destToken: TokenWithChainDetails

Returns Promise<AmountFormatted>

getAmountToBeReceived

Parameters

amountToSendFloat: BigSource

sourceChainToken: TokenWithChainDetails

destinationChainToken: TokenWithChainDetails

Optional messenger: Messenger

Returns Promise<string>

getAmountToBeReceivedAndGasFeeOptions

Parameters

amountToSendFloat: BigSource

sourceChainToken: TokenWithChainDetails

destinationChainToken: TokenWithChainDetails

messenger: Messenger

Returns Promise<AmountsAndGasFeeOptions>

getAmountToBeReceivedFromChain

Parameters

amountToSendFloat: BigSource

sourceChainToken: TokenWithChainDetails

destinationChainToken: TokenWithChainDetails

Optional messenger: Messenger

Optional sourceProvider: Provider

Optional destinationProvider: Provider

Returns Promise<string>

`Readonly` params

`Private` service

`Optional` tokenAddress: string

`Optional` messenger: Messenger

`Optional` messenger: Messenger

`Optional` sourceProvider: Provider

`Optional` destinationProvider: Provider

`Optional` messenger: Messenger

`Optional` messenger: Messenger

`Optional` messenger: Messenger

`Optional` sourceProvider: Provider

`Optional` destinationProvider: Provider

`Optional` messenger: Messenger