Classes

Relay

Main class for interacting with the Otmoic relay service. Provides functionality for bridge operations, quote management, and transaction tracking.

Constructor

constructor(relay: string)

Creates a new Relay instance.

• Parameters:
  • relay (string): The URL of the relay service
• Throws: Error if relay parameter is undefined

Methods

getBridge

getBridge(option: GetBridgesOption): Promise<Bridge[] | TranslatedBridge[]>

Retrieves all available bridges from the relay service.

• Parameters:

  • option (GetBridgesOption): Options for fetching bridges

• Returns:

  • Promise<Bridge[] | TranslatedBridge[]>: Array of bridges

ask

ask(askIF: AskIF, callback: OnQuoteIF): void

Initiates a quote request for a swap operation with continuous updates.

• Parameters:
  • askIF (AskIF): Quote request parameters
  • callback (OnQuoteIF): Callback interface for quote responses
• Returns: void

stopAsk

stopAsk(): void

Terminates the current quote request and stops receiving updates.

• Returns: void

swap

swap(quote: Quote, signData: SwapSignData, signed: string): Promise<PreBusiness>

Executes a swap operation with a signed quote.

• Parameters:
  • quote (Quote): The quote data for the swap
  • signData (SwapSignData): The signing data object
  • signed (string): The signature
• Returns:
  • Promise<PreBusiness>: Pre-business data for the swap

getHistory

getHistory(address: string): Promise<BusinessFullData[]>

Retrieves swap history for a given address.

• Parameters:
  • address (string): The wallet address to query
• Returns:
  • Promise<BusinessFullData[]>: Array of detailed business history

getBusiness

getBusiness(hash: string): Promise<Business>

Gets business details by transaction hash.

• Parameters:
  • hash (string): Transaction hash
  • options (GetBusinessOptions, optional): Options for fetching business details, if omitted, the Business type data will returned.
• Returns:
  • Promise<Business | BusinessFullData>: Business transaction details or full business data if detailed option is set