Type alias Bridger

Type declaration

• chainType: ChainTypes

• chains: Computed<BridgeChain[]>

• isInitialized: Ref<boolean>

• provider: IProvider

• approve:function

  • approve(token, operator): Promise<void | TransactionResponse>

  • Sets allowance for the provided operator address to spend the token

    Parameters

    • token: Token

    • operator: string

    Returns Promise<void | TransactionResponse>

    A Transaction Response or undefined if input token is native

• approveIfNeeded:function

  • approveIfNeeded(token, operator, amount?): Promise<void | TransactionResponse>

  • Sets allowance for the provided operator address to spend the token if allowance amount is less than provided one

    Parameters

    • token: Token

    • operator: string

    • Optional amount: Amount

    Returns Promise<void | TransactionResponse>

    A Transaction Response or undefined if input token is native or allowance is enough

• getChainById:function

  • getChainById(id): void | BridgeChain

  • Get the chain that are supported for the bridging by ID

    Parameters

    • id: ChainId

    Returns void | BridgeChain

    Supported chain and information about it or void

• getDestinationTx:function

  • getDestinationTx(sourceChain, sourceTxHash): Promise<DestinationTransaction>

  • Get the destination chain transaction hash as the result of the bridging

    Parameters

    • sourceChain: BridgeChain

    • sourceTxHash: string

    Returns Promise<DestinationTransaction>

    Destination transaction hash and transaction status

• getSupportedChains:function

  • getSupportedChains(kind?): Promise<BridgeChain[]>

  • Get the chains that are supported for the bridging

    Parameters

    • Optional kind: ChainKind

    Returns Promise<BridgeChain[]>

    A list of supported chains and information about them

• init:function

  • init(): Promise<void>

  • Returns Promise<void>

• isApproveRequired:function

  • isApproveRequired(token, operator, amount?): Promise<boolean>

  • Checks if the allowance is less than the provided amount or doesn't exist

    Parameters

    • token: Token

    • operator: string

    • Optional amount: Amount

    Returns Promise<boolean>

    true if the allowance is less than the provided amount or doesn't exist