Orderbook

The Orderbook class extends IOrdersProvider and allows creating and managing orders easily.

Usage

import { Orderbook } from '@gardenfi/orderbook';

Constructor

new Orderbook(orderbookConfig: OrderbookConfig): IOrderbook

Parameters:

• url: orderbook service's base URL.

Returns:

• IOrderbook

---

Methods

createOrder

createOrder(
  order: CreateOrderRequestWithAdditionalData,
): AsyncResult<string, string>;

Creates a new order.

Parameters:

• order (CreateOrderRequestWithAdditionalData): The order details to be created.

Returns:

• AsyncResult<string, string>: The result containing the order ID on success or an error message.

getOrder

  getOrder<T extends boolean>(
    id: string,
    matched: T,
  ): AsyncResult<T extends true ? MatchedOrder : CreateOrder, string>;

Retrieves a specific order by its id, based on whether it's matched or unmatched.

Parameters:

• id: The createId of the order.
• matched: A boolean indicating whether to fetch a matched (true) or unmatched (false) order.

Returns:

• An AsyncResult containing either a MatchedOrder or a CreateOrder depending on the matched value.

getMatchedOrders

getMatchedOrders(
    address: string,
    status: Status,
    paginationConfig?: PaginationConfig,
  ): AsyncResult<PaginatedData<MatchedOrder>, string>;

Fetches all matched orders for a given address, with an option to filter by pending status.

Parameters:

• address: The address for which the matched orders are retrieved.
• status: The status of the orders to be retrieved.
• paginationConfig: Optional pagination configuration for results.

Returns:

• AsyncResult<PaginatedData<MatchedOrder>, string>

getUnMatchedOrders

  getUnMatchedOrders(
    address: string,
    paginationConfig?: PaginationConfig,
  ): AsyncResult<PaginatedData<CreateOrder>, string>;

Fetches all unmatched orders for a given address, with optional pagination configuration.

Parameters:

• address: The address for which the unmatched orders are retrieved.
• paginationConfig: Optional pagination configuration.

Returns:

• AsyncResult<PaginatedData<CreateOrder>, string>

getOrders

getOrders<T extends boolean>(
  matched: T,
  paginationConfig?: PaginationConfig,
): AsyncResult<
  PaginatedData<T extends true ? MatchedOrder : CreateOrder>,
  string
>;

Retrieves either matched or unmatched orders based on the matched parameter, with optional pagination.

Parameters:

• matched: If true, returns matched orders; otherwise, returns unmatched orders.
• paginationConfig: Optional pagination configuration.

Returns:

• AsyncResult<PaginatedData<T extends true ? MatchedOrder : CreateOrder>, string>

subscribeOrders

subscribeOrders<T extends boolean>(
  account: string,
  matched: T,
  interval: number,
  cb: (
    orders: PaginatedData<T extends true ? MatchedOrder : CreateOrder>,
  ) => Promise<void>,
  status?: Status,
  paginationConfig?: PaginationConfig,
): Promise<() => void>;

Subscribes to an account’s orders by polling at a specified interval. The method continuously fetches orders at the given interval and invokes the provided callback with the received orders.

Parameters:

• account: The account to subscribe to.
• matched: If true, subscribes to matched orders; otherwise, subscribes to unmatched orders.
• interval: The interval (in milliseconds) to fetch orders.
• cb: The callback to execute when the orders are updated.
• status: Optional status to filter orders.
• paginationConfig: Optional pagination configuration.

Returns:

• A promise that resolves to a function that can be called to unsubscribe from the updates.

getOrdersCount

getOrdersCount(address: string): AsyncResult<number, string>

Fetches the number of orders associated with a given address, typically used for nonce calculation.

Parameters:

• address: The address for which the order count is fetched.

Returns:

• AsyncResult<number, string>