Class AllbridgeCoreSdk

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

bridge

Readonlyparams

pool

utils

yield

aprInPercents

• aprInPercents(apr: string): string

  Convert APR to percentage view

  Parameters

  • apr: string

  Returns string

  aprPercentageView

calculateFeePercentOnDestinationChain

• calculateFeePercentOnDestinationChain(
      amountFloat: BigSource,
      sourceChainToken: TokenWithChainDetails,
      destinationChainToken: TokenWithChainDetails,
  ): Promise<number>

  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>

  fee percent

  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

calculateFeePercentOnSourceChain

• calculateFeePercentOnSourceChain(
      amountFloat: BigSource,
      sourceChainToken: TokenWithChainDetails,
  ): Promise<number>

  Parameters

  • amountFloat: BigSource

    initial amount of tokens to swap

  • sourceChainToken: TokenWithChainDetails

    selected token on the source chain

  Returns Promise<number>

  fee percent

  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)

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>

checkAddress

• checkAddress(
      _chainSymbol: string,
      _recipientAddress: string,
      _tokenAddress?: string,
  ): Promise<CheckAddressResponse>

  Check address and show 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.

  • _recipientAddress: string
  • Optional_tokenAddress: string

  Returns Promise<CheckAddressResponse>

  Deprecated

getAmountFromVUsd

• getAmountFromVUsd(
      vUsdAmount: string,
      destToken: TokenWithChainDetails,
  ): Promise<AmountFormatted>

  Parameters

  • vUsdAmount: string

    amount of vUsd, int format

  • destToken: TokenWithChainDetails

    selected token on the destination chain

  Returns Promise<AmountFormatted>

  amount of destToken

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

  • messenger: Messenger = Messenger.ALLBRIDGE

    selected messenger

  Returns Promise<string>

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>

  Deprecated

  Use getGasFeeOptions and separately call one of: getAmountToBeReceived, getAmountToBeReceivedFromChain, or getAmountToBeReceivedFromPools.

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

  • messenger: Messenger = Messenger.ALLBRIDGE

    selected messenger

  • OptionalsourceProvider: Provider

    Optional. source chain Provider

  • OptionaldestinationProvider: Provider

    Optional. destination chain Provider

  Returns Promise<string>

getAmountToBeReceivedFromPools

• getAmountToBeReceivedFromPools(
      amountToSendFloat: BigSource,
      sourceChainToken: TokenWithChainDetails,
      destinationChainToken: TokenWithChainDetails,
      sourcePool: PoolInfo,
      destinationPool: PoolInfo,
      messenger?: ALLBRIDGE | WORMHOLE | CCTP | CCTP_V2 | X_RESERVE,
  ): 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

  • messenger: ALLBRIDGE | WORMHOLE | CCTP | CCTP_V2 | X_RESERVE = Messenger.ALLBRIDGE

    selected messenger

  Returns string

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

  • messenger: Messenger = Messenger.ALLBRIDGE

    selected messenger

  Returns Promise<string>

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>

  Deprecated

  Use getGasFeeOptions and separately call one of: getAmountToSend, getAmountToSendFromChain, or getAmountToSendFromPools.

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

  • messenger: Messenger = Messenger.ALLBRIDGE

    selected messenger

  • OptionalsourceProvider: Provider

    Optional. source chain Provider

  • OptionaldestinationProvider: Provider

    Optional. destination chain Provider

  Returns Promise<string>

getAmountToSendFromPools

• getAmountToSendFromPools(
      amountToBeReceivedFloat: BigSource,
      sourceChainToken: TokenWithChainDetails,
      destinationChainToken: TokenWithChainDetails,
      sourcePool: PoolInfo,
      destinationPool: PoolInfo,
      messenger?: ALLBRIDGE | WORMHOLE | CCTP | CCTP_V2 | X_RESERVE,
  ): 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

  • messenger: ALLBRIDGE | WORMHOLE | CCTP | CCTP_V2 | X_RESERVE = Messenger.ALLBRIDGE

    selected messenger

  Returns string

getAverageTransferTime

• getAverageTransferTime(
      sourceChainToken: TokenWithChainDetails,
      destinationChainToken: TokenWithChainDetails,
      messenger: Messenger,
  ): number | null

  Gets the average time in ms to complete a transfer for given tokens and messenger.

  Parameters

  • sourceChainToken: TokenWithChainDetails

    selected token on the source chain.

  • destinationChainToken: TokenWithChainDetails

    selected token on the destination chain.

  • messenger: Messenger

  Returns number | null

  Average transfer time in milliseconds or null if a given combination of tokens and messenger is not supported.

getExtraGasMaxLimits

• getExtraGasMaxLimits(
      sourceChainToken: TokenWithChainDetails,
      destinationChainToken: TokenWithChainDetails,
      messenger?: Messenger,
  ): Promise<ExtraGasMaxLimitResponse>

  Get possible limit of extra gas amount.

  Parameters

  • sourceChainToken: TokenWithChainDetails

    selected token on the source chain

  • destinationChainToken: TokenWithChainDetails

    selected token on the destination chain

  • messenger: Messenger = Messenger.ALLBRIDGE

    selected Messenger, Allbridge by default

  Returns Promise<ExtraGasMaxLimitResponse>

  ExtraGasMaxLimitResponse

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>

getGasFeeOptions

• getGasFeeOptions(
      sourceChainToken: TokenWithChainDetails,
      destinationChainToken: TokenWithChainDetails,
      messenger: Messenger,
  ): Promise<GasFeeOptions>

  Fetches possible ways to pay the transfer gas fee.

  Parameters

  • sourceChainToken: TokenWithChainDetails

    selected token on the source chain

  • destinationChainToken: TokenWithChainDetails

    selected token on the destination chain

  • messenger: Messenger

  Returns Promise<GasFeeOptions>

  GasFeeOptions

getNativeTokenBalance

• getNativeTokenBalance(
      params: GetNativeTokenBalanceParams,
      provider?: Provider,
  ): Promise<AmountFormatted>

  Get native (gas) token balance

  Parameters

  • params: GetNativeTokenBalanceParams
  • Optionalprovider: Provider

  Returns Promise<AmountFormatted>

  Token balance

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.

  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>

  range of possible amount based on already pending transactions

getPoolInfoByToken

• getPoolInfoByToken(token: TokenWithChainDetails): Promise<PoolInfo>

  Gets information about the poolInfo by token

  Parameters

  • token: TokenWithChainDetails

  Returns Promise<PoolInfo>

  poolInfo

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>

getTokenBalance

• getTokenBalance(
      params: GetTokenBalanceParams,
      provider?: Provider,
  ): Promise<string>

  Get token balance

  Parameters

  • params: GetTokenBalanceParams
  • Optionalprovider: Provider

  Returns Promise<string>

  Token balance

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>

getVUsdFromAmount

• getVUsdFromAmount(
      amount: string,
      amountFormat: AmountFormat,
      sourceToken: TokenWithChainDetails,
  ): Promise<AmountFormatted>

  Parameters

  • amount: string

    amount

  • amountFormat: AmountFormat

    AmountFormat

  • sourceToken: TokenWithChainDetails

    selected token on the source chain

  Returns Promise<AmountFormatted>

  virtual amount

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

  • Optionaltokens: TokenWithChainDetails | TokenWithChainDetails[]

    if present, the corresponding liquidity pools will be updated

  Returns Promise<void>

swapAndBridgeFeeCalculation

• swapAndBridgeFeeCalculation(
      amountInTokenPrecision: string,
      sourceToken: TokenWithChainDetails,
      destToken: TokenWithChainDetails,
  ): Promise<SwapAndBridgeCalculationData>

  Parameters

  • amountInTokenPrecision: string
  • sourceToken: TokenWithChainDetails
  • destToken: TokenWithChainDetails

  Returns Promise<SwapAndBridgeCalculationData>

  Deprecated

  Use getSendAmountDetails

swapAndBridgeFeeCalculationReverse

• swapAndBridgeFeeCalculationReverse(
      amountInTokenPrecision: string,
      sourceToken: TokenWithChainDetails,
      destToken: TokenWithChainDetails,
  ): Promise<SwapAndBridgeCalculationData>

  Parameters

  • amountInTokenPrecision: string
  • sourceToken: TokenWithChainDetails
  • destToken: TokenWithChainDetails

  Returns Promise<SwapAndBridgeCalculationData>

  Deprecated

  Use getAmountToBeReceived and then getSendAmountDetails

tokens

• tokens(type?: "swap" | "pool"): Promise<TokenWithChainDetails[]>

  Returns a list of supported tokens.

  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[]>

  A promise that resolves to an array of TokenWithChainDetails.

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[]>