AutomaticCircleBridge protocol definition, providing a consistent client interface for the CircleBridge protocol with Automatic delivery.

Type Parameters

  • N extends Network = Network

  • C extends Chain = Chain

Hierarchy

  • AutomaticCircleBridge

Methods

  • Get the fee required by the relayer to cover the costs of redemption on the destination chain

    Parameters

    • destination: "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia"

      The destination chain for which to get a fee quote

    Returns Promise<bigint>

    the fee required by the relayer to cover the costs of redemption on the destination chain

  • Parameters

    • sender: AccountAddress<C>

      address of the transaction sender

    • recipient: ChainAddress

      address of the destination chain recipient

    • amount: bigint

      how much to send, in base units

    • Optional nativeGas: bigint

      if set, determines how much native gas should be received by the recipient

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

Generated using TypeDoc