AutomaticTokenBridge provides a consistent interface to the TokenBridge with Automatic redemption on the destination chain

Type Parameters

  • N extends Network

  • C extends Chain

Hierarchy

  • AutomaticTokenBridge

Implemented by

Methods

  • Get the list of tokens that are registered and acceptable to send

    Returns Promise<GetNativeAddress<ChainToPlatform<C>>[]>

  • Fee charged to relay

    Parameters

    Returns Promise<bigint>

  • Check if a given token is in the registered token list

    Parameters

    Returns Promise<boolean>

  • Maximum amount of sending tokens that can be swapped for native tokens

    Parameters

    Returns Promise<bigint>

  • Amount of native tokens a user would receive by swapping x amount of sending tokens

    Parameters

    Returns Promise<bigint>

  • Manually redeem a transfer, should not be used unless necessary to take over some stalled transfer

    Parameters

    Returns AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>

  • Initiate the transfer over the automatic bridge

    Parameters

    Returns AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>

Generated using TypeDoc