Class LayerZeroScanClient

LayerZero Scan API Client

Use this client to track the status of cross-chain messages sent via LayerZero.

Index

Constructors

Methods

getMessage getMessagesByWallet waitForDelivery isDelivered

Constructors

constructor

new LayerZeroScanClient(baseUrl?: string): LayerZeroScanClient
Create a new LayerZero Scan client
Parameters
- baseUrl: string = LAYERZERO_SCAN_BASE_URL
  API base URL (default: production endpoint)
Returns LayerZeroScanClient
- Defined in mechanisms/evm/src/bridge/scan.ts:56

Methods

getMessage

getMessage(guid: string): Promise<LayerZeroMessage>
Get message by GUID
Parameters
- guid: string
  LayerZero message GUID
Returns Promise<LayerZeroMessage>
Message details including status

Throws
Error if message not found or API error
- Defined in mechanisms/evm/src/bridge/scan.ts:67

getMessagesByWallet

getMessagesByWallet(
address: string,
limit?: number,
): Promise<LayerZeroMessage[]>
Get messages by wallet address
Parameters
- address: string
  Wallet address that initiated messages
- limit: number = 20
  Maximum number of messages to return (default: 20)
Returns Promise<LayerZeroMessage[]>
Array of messages
- Defined in mechanisms/evm/src/bridge/scan.ts:95

waitForDelivery

waitForDelivery(
guid: string,
options?: WaitForDeliveryOptions,
): Promise<LayerZeroMessage>
Poll message status until delivered or failed
Parameters
- guid: string
  LayerZero message GUID
- options: WaitForDeliveryOptions = {}
  Wait configuration options
Returns Promise<LayerZeroMessage>
Final message state (DELIVERED)

Throws
Error if message fails, is blocked, or times out
- Defined in mechanisms/evm/src/bridge/scan.ts:122

isDelivered

isDelivered(guid: string): Promise<boolean>
Check if a message has been delivered
Parameters
- guid: string
  LayerZero message GUID
Returns Promise<boolean>
True if delivered, false otherwise
- Defined in mechanisms/evm/src/bridge/scan.ts:179