Skip to main content
Version: 2.0.4

EvmRelay

The EvmRelay class provides functionality to interact with the Garden Finance relay server, which offers a gasless API to handle init and redeem operations for atomic swaps. This abstraction ensures that users don't need to manage gas fees directly, and the relay server also automatically handles refunds for expired transactions.

Constructor​

new EvmRelay(url: string | Url, auth: IAuth): IEvmRelay

Parameters:

  • url (string | Url): The base URL of the relay server.
  • auth (IAuth): An authentication object used to fetch tokens for authorized requests.

Returns:

Methods​

init​

init(
  walletClient: WalletClient,
  order: MatchedOrder,
): AsyncResult<string, string>;

Initiates an atomic swap by validating the order, preparing the required data, and submitting the initialization request to the relay server.

Parameters:

  • walletClient (WalletClient): The wallet client used to sign the transaction.
  • order (MatchedOrder): The order to be initialized.

Returns:

redeem​

redeem(orderId: string, secret: string): AsyncResult<string, string>;

Redeems an atomic swap by submitting the secret to the relay server.

Parameters:

  • orderId (string): The ID of the order to be redeemed.
  • secret (string): The secret used to redeem the order.

Returns: