Hierarchy

  • Base
    • Messenger

Constructors

Properties

Accessors

Methods

bundleExit execute exitBundle getBundleCommittedEvents getBundleForwardedEvents getBundleProofFromMessageId getBundleProofFromTransactionHash getBundleReceivedEvents getBundleSetEvents getChainIdsSupportedByTokenSymbol getColorForChainId getConfigAddress getConfigStartBlock getContractAddresses getContractExists getDefaultProvider getDefaultProviders getEstimatedTxCostForForwardMessage getEthersWeb3Signer getEventFetcher getEventNames getExecutorContractAddress getExplorerApiBaseUrl getFeesSentToHubEvents getHasAuctionStarted getHubChainId getHubMessageBridgeContractAddress getIsBundleSet getIsL2TxHashExited getIsMessageIdRelayed getMaxBundleMessageCount getMerkleProofForMessageId getMessageBundleIdFromMessageId getMessageBundleIdFromTransactionHash getMessageBundledEventFromMessageId getMessageBundledEventFromTransactionHash getMessageBundledEvents getMessageBundledEventsForBundleId getMessageCalldataFromMessageId getMessageExecutedEventFromMessageId getMessageExecutedEvents getMessageFee getMessageIdFromTransactionHash getMessageIdsForBundleId getMessageSentEventFromMessageId getMessageSentEventFromTransactionHash getMessageSentEventFromTransactionReceipt getMessageSentEvents getMessageSentEventsFromTransactionReceipt getMessageTreeIndexFromMessageId getMessageTreeIndexFromTransactionHash getProvider getRelayFee getRelayMessageDataFromTransactionHash getRelayReward getRelayWindowHours getRouteData getShouldAttemptForwardMessage getSigner getSignerAddress getSignerOrProvider getSignerProviderChainId getSpokeExitTime getSpokeMessageBridgeContractAddress getSupportedChainIds getSupportedTokenSymbols getSupportedTokenSymbolsByChainId getTokenAddressByTokenSymbol getTokenSymbolByTokenAddress getTxOverrides isValidBundleProof relayMessage sendMessage sendTransaction setContractAddresses setExplorerApiBaseUrl setHubChainId setProvider setProviderUrl setProviderUrls setProviders throwError deriveNetwork getBundleCommittedEventSignature getBundleForwardedEventSignature getBundleReceivedEventSignature getBundleSetEventSignature getDefaultProvider getDefaultProviders getFeesSentToHubEventSignature getMessageBundledEventSignature getMessageExecutedEventSignature getMessageSentEventSignature

Constructors

Properties

batchBlocks: number
chainId: BigNumberish
contractAddresses: Addresses
gasPriceMultiplier: number
gasPriceOracle: GasPriceOracle
hubChainId: string
l1ChainId: number
network: string
signersOrProviders: SignersOrProviders
EventName: typeof MessengerEventName = EventName

Accessors

  • get populateTransaction(): {
        bundleExit: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
        execute: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
        relayMessage: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
        sendMessage: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    }
  • Returns {
        bundleExit: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
        execute: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
        relayMessage: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
        sendMessage: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>);
    }

    • bundleExit: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
        • (__namedParameters, txOverrides?): Promise<TransactionRequest>
        • Parameters

          Returns Promise<TransactionRequest>

    • execute: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
        • (__namedParameters, txOverrides?): Promise<TransactionRequest>
        • Parameters

          • __namedParameters: ExecuteInput
          • txOverrides: TxOverrides = {}

          Returns Promise<TransactionRequest>

    • relayMessage: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
        • (__namedParameters, txOverrides?): Promise<TransactionRequest>
        • Parameters

          Returns Promise<TransactionRequest>

    • sendMessage: ((__namedParameters, txOverrides?) => Promise<TransactionRequest>)
        • (__namedParameters, txOverrides?): Promise<TransactionRequest>
        • Parameters

          Returns Promise<TransactionRequest>

  • get utils(): {
        estimateGas: ((provider, tx) => Promise<BigNumber>);
        generateZeroBytes32: (() => string);
        getAddressExplorerUrl: ((address, chainId) => string);
        getBumpedGasPrice: ((provider, percent) => Promise<BigNumber>);
        getChainInfo: ((chainId) => any);
        getChainSlug: ((chainId) => string);
        getConnectedChainId: ((provider) => Promise<BigNumber>);
        getGasPrice: ((signerOrProvider) => Promise<BigNumber>);
        getLogoForChainId: ((chainId) => string);
        getLogoForChainSlug: ((chainSlug) => string);
        getLogoForTokenSymbol: ((tokenSymbol) => string);
        getTokenExplorerUrl: ((address, chainId) => string);
        getTransactionHashExplorerUrl: ((txHash, chainId) => string);
        isContractError: ((err) => boolean);
        isValidAddress: ((address) => boolean);
        isValidBytes: ((bytes) => boolean);
        isValidBytes32: ((hash) => boolean);
        isValidChainId: ((chainId) => boolean);
        isValidFilterBlock: ((blockTag) => boolean);
        isValidNumericValue: ((value) => boolean);
        isValidObject: ((obj) => boolean);
        isValidTxHash: ((txHash) => boolean);
        switchChain: ((chainId, provider) => Promise<void>);
        willTransactionFail: ((provider, tx) => Promise<boolean>);
    }
  • Returns {
        estimateGas: ((provider, tx) => Promise<BigNumber>);
        generateZeroBytes32: (() => string);
        getAddressExplorerUrl: ((address, chainId) => string);
        getBumpedGasPrice: ((provider, percent) => Promise<BigNumber>);
        getChainInfo: ((chainId) => any);
        getChainSlug: ((chainId) => string);
        getConnectedChainId: ((provider) => Promise<BigNumber>);
        getGasPrice: ((signerOrProvider) => Promise<BigNumber>);
        getLogoForChainId: ((chainId) => string);
        getLogoForChainSlug: ((chainSlug) => string);
        getLogoForTokenSymbol: ((tokenSymbol) => string);
        getTokenExplorerUrl: ((address, chainId) => string);
        getTransactionHashExplorerUrl: ((txHash, chainId) => string);
        isContractError: ((err) => boolean);
        isValidAddress: ((address) => boolean);
        isValidBytes: ((bytes) => boolean);
        isValidBytes32: ((hash) => boolean);
        isValidChainId: ((chainId) => boolean);
        isValidFilterBlock: ((blockTag) => boolean);
        isValidNumericValue: ((value) => boolean);
        isValidObject: ((obj) => boolean);
        isValidTxHash: ((txHash) => boolean);
        switchChain: ((chainId, provider) => Promise<void>);
        willTransactionFail: ((provider, tx) => Promise<boolean>);
    }

    • estimateGas: ((provider, tx) => Promise<BigNumber>)
        • (provider, tx): Promise<BigNumber>
        • Parameters

          • provider: Provider
          • tx: TransactionRequest

          Returns Promise<BigNumber>

    • generateZeroBytes32: (() => string)
        • (): string
        • Returns string

    • getAddressExplorerUrl: ((address, chainId) => string)
        • (address, chainId): string
        • Parameters

          • address: string
          • chainId: BigNumberish

          Returns string

    • getBumpedGasPrice: ((provider, percent) => Promise<BigNumber>)
        • (provider, percent): Promise<BigNumber>
        • Parameters

          • provider: Provider
          • percent: number

          Returns Promise<BigNumber>

    • getChainInfo: ((chainId) => any)
        • (chainId): any
        • Parameters

          • chainId: BigNumberish

          Returns any

    • getChainSlug: ((chainId) => string)
        • (chainId): string
        • Parameters

          • chainId: BigNumberish

          Returns string

    • getConnectedChainId: ((provider) => Promise<BigNumber>)
        • (provider): Promise<BigNumber>
        • Parameters

          • provider: Provider

          Returns Promise<BigNumber>

    • getGasPrice: ((signerOrProvider) => Promise<BigNumber>)
        • (signerOrProvider): Promise<BigNumber>
        • Parameters

          • signerOrProvider: Provider | Signer

          Returns Promise<BigNumber>

    • getLogoForChainId: ((chainId) => string)
        • (chainId): string
        • Parameters

          • chainId: BigNumberish

          Returns string

    • getLogoForChainSlug: ((chainSlug) => string)
        • (chainSlug): string
        • Parameters

          • chainSlug: string

          Returns string

    • getLogoForTokenSymbol: ((tokenSymbol) => string)
        • (tokenSymbol): string
        • Parameters

          • tokenSymbol: string

          Returns string

    • getTokenExplorerUrl: ((address, chainId) => string)
        • (address, chainId): string
        • Parameters

          • address: string
          • chainId: BigNumberish

          Returns string

    • getTransactionHashExplorerUrl: ((txHash, chainId) => string)
        • (txHash, chainId): string
        • Parameters

          • txHash: string
          • chainId: BigNumberish

          Returns string

    • isContractError: ((err) => boolean)
        • (err): boolean
        • Parameters

          • err: unknown

          Returns boolean

    • isValidAddress: ((address) => boolean)
        • (address): boolean
        • Parameters

          • address: string

          Returns boolean

    • isValidBytes: ((bytes) => boolean)
        • (bytes): boolean
        • Parameters

          • bytes: string

          Returns boolean

    • isValidBytes32: ((hash) => boolean)
        • (hash): boolean
        • Parameters

          • hash: string

          Returns boolean

    • isValidChainId: ((chainId) => boolean)
        • (chainId): boolean
        • Parameters

          • chainId: BigNumberish

          Returns boolean

    • isValidFilterBlock: ((blockTag) => boolean)
        • (blockTag): boolean
        • Parameters

          • blockTag: string | number

          Returns boolean

    • isValidNumericValue: ((value) => boolean)
        • (value): boolean
        • Parameters

          • value: null | object | BigNumberish

          Returns boolean

    • isValidObject: ((obj) => boolean)
        • (obj): boolean
        • Parameters

          • obj: any

          Returns boolean

    • isValidTxHash: ((txHash) => boolean)
        • (txHash): boolean
        • Parameters

          • txHash: string

          Returns boolean

    • switchChain: ((chainId, provider) => Promise<void>)
        • (chainId, provider): Promise<void>
        • Parameters

          • chainId: BigNumberish
          • provider: Provider

          Returns Promise<void>

    • willTransactionFail: ((provider, tx) => Promise<boolean>)
        • (provider, tx): Promise<boolean>
        • Parameters

          • provider: Provider
          • tx: TransactionRequest

          Returns Promise<boolean>

Methods

  • Parameters

    Returns Promise<TransactionResponse>

  • Parameters

    Returns Promise<TransactionResponse>

  • Parameters

    Returns Promise<TransactionResponse>

  • Parameters

    • __namedParameters: GetEventsInput

    Returns Promise<EthersEventWithDecodedTypes<BundleCommitted>[]>

  • Parameters

    • __namedParameters: GetEventsInput

    Returns Promise<EthersEventWithDecodedTypes<BundleForwarded>[]>

  • Parameters

    • __namedParameters: GetEventsInput

    Returns Promise<EthersEventWithDecodedTypes<BundleReceived>[]>

  • Parameters

    • __namedParameters: GetEventsInput

    Returns Promise<EthersEventWithDecodedTypes<BundleSet>[]>

  • Parameters

    • tokenSymbol: string

    Returns string[]

  • Parameters

    • chainId: BigNumberish

    Returns string

  • Parameters

    • chainId: BigNumberish
    • key: string

    Returns string

  • Parameters

    • chainId: BigNumberish

    Returns number

  • Returns Addresses

  • Parameters

    • address: string
    • provider: Provider

    Returns Promise<boolean>

  • Parameters

    • chainId: BigNumberish

    Returns Provider

  • Returns SignersOrProviders

  • Returns Promise<number>

  • Parameters

    • signer: any

    Returns Signer

  • Parameters

    • eventName: string

    Returns any

  • Returns string[]

  • Returns string

  • Returns string

  • Parameters

    • __namedParameters: GetEventsInput

    Returns Promise<EthersEventWithDecodedTypes<FeesSentToHub>[]>

  • Parameters

    Returns Promise<boolean>

  • Returns string

  • Returns string

  • Parameters

    Returns Promise<boolean>

  • Parameters

    Returns Promise<boolean>

  • Parameters

    Returns Promise<boolean>

  • Parameters

    Returns Promise<null | EthersEventWithDecodedTypes<MessageBundled>>

  • Returns Promise<null | EthersEventWithDecodedTypes<MessageBundled>>

  • Parameters

    • __namedParameters: GetEventsInput

    Returns Promise<EthersEventWithDecodedTypes<MessageBundled>[]>

  • Parameters

    Returns Promise<EthersEventWithDecodedTypes<MessageBundled>[]>

  • Parameters

    Returns Promise<string>

  • Parameters

    Returns Promise<null | EthersEventWithDecodedTypes<MessageExecuted>>

  • Parameters

    • __namedParameters: GetEventsInput

    Returns Promise<EthersEventWithDecodedTypes<MessageExecuted>[]>

  • Parameters

    Returns Promise<BigNumber>

  • Parameters

    Returns Promise<string[]>

  • Parameters

    Returns Promise<null | EthersEventWithDecodedTypes<MessageSent>>

  • Parameters

    Returns Promise<null | EthersEventWithDecodedTypes<MessageSent>>

  • Returns Promise<null | EthersEventWithDecodedTypes<MessageSent>>

  • Parameters

    • __namedParameters: GetEventsInput

    Returns Promise<EthersEventWithDecodedTypes<MessageSent>[]>

  • Returns Promise<null | EthersEventWithDecodedTypes<MessageSent>[]>

  • Parameters

    • chainId: BigNumberish

    Returns null | Provider

  • Parameters

    Returns Promise<BigNumber>

  • Parameters

    Returns Promise<number>

  • Returns Promise<number>

  • Parameters

    • chainId: BigNumberish

    Returns Promise<null | Signer>

  • Parameters

    • chainId: BigNumberish

    Returns Promise<null | string>

  • Parameters

    • chainId: BigNumberish

    Returns Promise<Provider | Signer>

  • Parameters

    • chainId: BigNumberish

    Returns Promise<BigNumber>

  • Parameters

    Returns Promise<number>

  • Returns string

  • Returns string[]

  • Returns string[]

  • Parameters

    • chainId: BigNumberish

    Returns string[]

  • Parameters

    • chainId: BigNumberish
    • tokenSymbol: string

    Returns string

  • Parameters

    • chainId: BigNumberish
    • tokenAddress: string

    Returns string

  • Parameters

    • fromChainId: BigNumberish
    • toChainId: BigNumberish

    Returns Promise<TxOverrides>

  • Parameters

    Returns boolean

  • Parameters

    Returns Promise<TransactionResponse>

  • Parameters

    Returns Promise<TransactionResponse>

  • Parameters

    • transactionRequest: TransactionRequest
    • Optional chainId: BigNumberish
    • Optional customSigner: null | Signer

    Returns Promise<TransactionResponse>

  • Parameters

    • contractAddresses: Addresses

    Returns void

  • Parameters

    • url: string

    Returns void

  • Parameters

    • newChainId: BigNumberish

    Returns void

  • Parameters

    • chainId: BigNumberish
    • provider: Provider | Signer

    Returns void

  • Parameters

    • chainId: BigNumberish
    • url: string | string[]

    Returns void

  • Parameters

    • signersOrProvidersUrls: Record<string, string | string[]>

    Returns void

  • Parameters

    • signersOrProviders: SignersOrProviders

    Returns void

  • Parameters

    • err: unknown

    Returns unknown

  • Parameters

    • chainId: BigNumberish

    Returns string

  • Returns string

  • Returns string

  • Returns string

  • Returns string

  • Parameters

    • chainId: BigNumberish

    Returns Provider

  • Parameters

    • network: string

    Returns SignersOrProviders

  • Returns string

  • Returns string

  • Returns string

  • Returns string