@imtbl/sdk 0.1.7 → 0.1.8-alpha.1

package/dist/orderbook.d.ts

@@ -0,0 +1,64 @@
+import { OrderbookModuleConfiguration } from 'config/config';
+import { OrderResult, ListOrdersResult } from 'openapi/sdk';
+import { ListOrderParams, PrepareListingParams, PrepareListingResponse, CreateOrderParams, FulfilOrderResponse, CancelOrderResponse } from 'types';
+
+/**
+ * zkEVM orderbook SDK
+ * @constructor
+ * @param {OrderbookModuleConfiguration} config - Configuration for Immutable services.
+ */
+declare class Orderbook {
+    private config;
+    private apiClient;
+    private seaport;
+    constructor(config: OrderbookModuleConfiguration);
+    /**
+     * Get an order by ID
+     * @param {string} orderId - The orderId to find.
+     * @return {OrderResult} The returned order result.
+     */
+    getOrder(orderId: string): Promise<OrderResult>;
+    /**
+     * List orders. This method is used to get a list of orders filtered by conditions specified
+     * in the params object.
+     * @param {ListOrderParams} listOrderParams - Filtering, ordering and page parameters.
+     * @return {Orders} The paged orders.
+     */
+    listOrders(listOrderParams: ListOrderParams): Promise<ListOrdersResult>;
+    /**
+     * Get required transactions and messages for signing prior to creating a listing
+     * through the createOrder method
+     * @param {PrepareListingParams} prepareListingParams - Details about the listing to be created.
+     * @return {PrepareListingResponse} PrepareListingResponse includes
+     * the unsigned approval transaction, the typed order message for signing and
+     * the order components that can be submitted to `createOrder` with a signature.
+     */
+    prepareListing({ offerer, listingItem, considerationItem, orderExpiry, }: PrepareListingParams): Promise<PrepareListingResponse>;
+    /**
+     * Create an order
+     * @param {CreateOrderParams} createOrderParams - create an order with the given params.
+     * @return {OrderResult} The result of the order created in the Immutable services.
+     */
+    createOrder(createOrderParams: CreateOrderParams): Promise<OrderResult>;
+    /**
+     * Get unsigned transactions that can be submitted to fulfil an open order. If the approval
+     * transaction exists it must be signed and submitted to the chain before the fulfilment
+     * transaction can be submitted or it will be reverted.
+     * @param {string} orderId - The orderId to fulfil.
+     * @param {string} fulfillerAddress - The address of the account fulfilling the order.
+     * @return {FulfilOrderResponse} Approval and fulfilment transactions.
+     */
+    fulfillOrder(orderId: string, fulfillerAddress: string): Promise<FulfilOrderResponse>;
+    /**
+     * Get an unsigned cancel order transaction. Orders can only be cancelled by
+     * the account that created them.
+     * @param {string} orderId - The orderId to cancel.
+     * @param {string} accountAddress - The address of the account cancelling the order.
+     * @return {CancelOrderResponse} The unsigned cancel order transaction
+     */
+    cancelOrder(orderId: string, accountAddress: string): Promise<CancelOrderResponse>;
+}
+
+declare const module = "orderbook";
+
+export { Orderbook, module };