@imtbl/sdk 0.3.3 → 0.4.0-alpha

package/dist/orderbook.d.ts

@@ -0,0 +1,81 @@
+import { OrderbookOverrides } from 'config/config';
+import { ListingResult, ListListingsResult } from 'openapi/sdk';
+import { ListListingsParams, PrepareListingParams, PrepareListingResponse, CreateListingParams, FulfillOrderResponse, CancelOrderResponse } from 'types';
+
+declare enum Environment {
+    PRODUCTION = "production",
+    SANDBOX = "sandbox"
+}
+declare class ImmutableConfiguration {
+    readonly environment: Environment;
+    readonly apiKey?: string;
+    constructor(options: {
+        environment: Environment;
+        apiKey?: string;
+    });
+}
+interface ModuleConfiguration<T> {
+    baseConfig: ImmutableConfiguration;
+    overrides?: T;
+}
+
+/**
+ * zkEVM orderbook SDK
+ * @constructor
+ * @param {OrderbookModuleConfiguration} config - Configuration for Immutable services.
+ */
+declare class Orderbook {
+    private apiClient;
+    private seaport;
+    private orderbookConfig;
+    constructor(config: ModuleConfiguration<OrderbookOverrides>);
+    /**
+     * Get an order by ID
+     * @param {string} listingId - The listingId to find.
+     * @return {ListingResult} The returned order result.
+     */
+    getListing(listingId: string): Promise<ListingResult>;
+    /**
+     * 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.
+     */
+    listListings(listOrderParams: ListListingsParams): Promise<ListListingsResult>;
+    /**
+     * Get required transactions and messages for signing prior to creating a listing
+     * through the createListing 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 `createListing` with a signature.
+     */
+    prepareListing({ makerAddress, sell, buy, orderExpiry, }: PrepareListingParams): Promise<PrepareListingResponse>;
+    /**
+     * Create an order
+     * @param {CreateListingParams} createListingParams - create an order with the given params.
+     * @return {ListingResult} The result of the order created in the Immutable services.
+     */
+    createListing(createListingParams: CreateListingParams): Promise<ListingResult>;
+    /**
+     * 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} listingId - The listingId to fulfil.
+     * @param {string} fulfillerAddress - The address of the account fulfilling the order.
+     * @return {FulfillOrderResponse} Approval and fulfilment transactions.
+     */
+    fulfillOrder(listingId: string, takerAddress: string): Promise<FulfillOrderResponse>;
+    /**
+     * Get an unsigned cancel order transaction. Orders can only be cancelled by
+     * the account that created them.
+     * @param {string} listingId - The listingId to cancel.
+     * @param {string} accountAddress - The address of the account cancelling the order.
+     * @return {CancelOrderResponse} The unsigned cancel order transaction
+     */
+    cancelOrder(listingId: string, accountAddress: string): Promise<CancelOrderResponse>;
+}
+
+declare const module = "orderbook";
+
+export { Orderbook, module };