Interface BridgeService

rawTxBuilder

approve

• approve(
      provider: Provider,
      approveData: BridgeApproveParams,
  ): Promise<TransactionResponse>

• Parameters

  • provider: Provider

    will be used to access the network
  • approveData: BridgeApproveParams

  Returns Promise<TransactionResponse>

  Deprecated

  Use rawTxBuilder.RawBridgeTransactionBuilder.approve

  Approve tokens usage by another address on chains

  For ETH/USDT: due to specificity of the USDT contract:
  If the current allowance is not 0, this function will perform an additional transaction to set allowance to 0 before setting the new allowance value.

checkAllowance

• checkAllowance(
      provider: Provider,
      params: CheckAllowanceParams,
  ): Promise<boolean>

• Check if the amount of approved tokens is enough to make a transfer

  Parameters

  • provider: Provider

    will be used to access the network
  • params: CheckAllowanceParams

    See CheckAllowanceParams

  Returns Promise<boolean>

  true if the amount of approved tokens is enough to make a transfer
• checkAllowance(params: CheckAllowanceParams): Promise<boolean>

• Check if the amount of approved tokens is enough to make a transfer

  Parameters

  • params: CheckAllowanceParams

    See CheckAllowanceParams

  Returns Promise<boolean>

  true if the amount of approved tokens is enough to make a transfer

getAllowance

• getAllowance(provider: Provider, params: GetAllowanceParams): Promise<string>

• Get amount of tokens approved to be sent by the bridge

  Parameters

  • provider: Provider

    will be used to access the network
  • params: GetAllowanceParams

    See GetAllowanceParams

  Returns Promise<string>

  the amount of approved tokens
• getAllowance(params: GetAllowanceParams): Promise<string>

• Get amount of tokens approved to be sent by the bridge

  Parameters

  • params: GetAllowanceParams

    See GetAllowanceParams

  Returns Promise<string>

  the amount of approved tokens

send

• send(provider: Provider, params: SendParams): Promise<TransactionResponse>

• Parameters

  • provider: Provider

    will be used to access the network
  • params: SendParams

  Returns Promise<TransactionResponse>

  Deprecated

  Use rawTxBuilder.RawBridgeTransactionBuilder.send

  Send tokens through the ChainBridgeService