@imtbl/sdk 0.1.7-alpha.2 → 0.1.7-alpha.3

package/dist/orderbook.d.ts

@@ -1,6 +1,6 @@
 import { OrderbookModuleConfiguration } from 'config/config';
-import { Order } from 'openapi/sdk';
-import { PrepareListingParams, PrepareListingResponse, CreateOrderParams, FulfilOrderResponse, CancelOrderResponse } from 'types';
+import { OrderResult, ListOrdersResult } from 'openapi/sdk';
+import { ListOrderParams, PrepareListingParams, PrepareListingResponse, CreateOrderParams, FulfilOrderResponse, CancelOrderResponse } from 'types';
 
 /**
  * zkEVM orderbook SDK
@@ -15,9 +15,16 @@ declare class Orderbook {
     /**
      * Get an order by ID
      * @param {string} orderId - The orderId to find.
-     * @return {Order} The returned order.
+     * @return {OrderResult} The returned order result.
      */
-    getOrder(orderId: string): Promise<Order>;
+    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
@@ -30,9 +37,9 @@ declare class Orderbook {
     /**
      * Create an order
      * @param {CreateOrderParams} createOrderParams - create an order with the given params.
-     * @return {Order} The order created in the Immutable services.
+     * @return {OrderResult} The result of the order created in the Immutable services.
      */
-    createOrder(createOrderParams: CreateOrderParams): Promise<Order>;
+    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

package/dist/orderbook.js

@@ -402,10 +402,10 @@ class OrdersService {
     /**
      * List all orders
      * List all orders
-     * @returns Orders OK response.
+     * @returns ListOrdersResult OK response.
      * @throws ApiError
      */
-    listOrders({ chainId, pageSize = 100, sortBy, sortDirection, pageCursor, }) {
+    listOrders({ chainId, status, sellItemContractAddress, sellItemTokenId, pageSize, sortBy, sortDirection, pageCursor, }) {
         return this.httpRequest.request({
             method: 'GET',
             url: '/v1/chains/{chain_id}/orders',
@@ -413,21 +413,25 @@ class OrdersService {
                 'chain_id': chainId,
             },
             query: {
+                'status': status,
+                'sell_item_contract_address': sellItemContractAddress,
+                'sell_item_token_id': sellItemTokenId,
                 'page_size': pageSize,
                 'sort_by': sortBy,
                 'sort_direction': sortDirection,
                 'page_cursor': pageCursor,
             },
             errors: {
-                404: `not_found: Resource not found`,
-                500: `internal_error: Internal server error`,
+                400: `Client error`,
+                404: `The specified resource was not found`,
+                500: `Internal server error`,
             },
         });
     }
     /**
      * Create an order
      * Create an order
-     * @returns Order Created response.
+     * @returns OrderResult Created response.
      * @throws ApiError
      */
     createOrder({ chainId, requestBody, }) {
@@ -440,16 +444,16 @@ class OrdersService {
             body: requestBody,
             mediaType: 'application/json',
             errors: {
-                400: `bad_request: Bad Request`,
-                404: `not_found: Resource not found`,
-                500: `internal_error: Internal server error`,
+                400: `Client error`,
+                404: `The specified resource was not found`,
+                500: `Internal server error`,
             },
         });
     }
     /**
      * Get a single order by ID
      * Get a single order by ID
-     * @returns Order OK response.
+     * @returns OrderResult OK response.
      * @throws ApiError
      */
     getOrder({ chainId, orderId, }) {
@@ -461,8 +465,9 @@ class OrdersService {
                 'order_id': orderId,
             },
             errors: {
-                404: `not_found: Resource not found`,
-                500: `internal_error: Internal server error`,
+                400: `Client error`,
+                404: `The specified resource was not found`,
+                500: `Internal server error`,
             },
         });
     }
@@ -493,8 +498,8 @@ class OrderBookClient {
 var BuyItem;
 (function (BuyItem) {
     (function (item_type) {
+        item_type["NATIVE"] = "NATIVE";
         item_type["ERC20"] = "ERC20";
-        item_type["IMX"] = "IMX";
     })(BuyItem.item_type || (BuyItem.item_type = {}));
 })(BuyItem || (BuyItem = {}));
 
@@ -504,7 +509,7 @@ var BuyItem;
 var CreateOrderProtocolData;
 (function (CreateOrderProtocolData) {
     (function (order_type) {
-        order_type["FULL_OPEN"] = "FULL_OPEN";
+        order_type["FULL_RESTRICTED"] = "FULL_RESTRICTED";
     })(CreateOrderProtocolData.order_type || (CreateOrderProtocolData.order_type = {}));
 })(CreateOrderProtocolData || (CreateOrderProtocolData = {}));
 
@@ -521,18 +526,18 @@ var Fee;
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-var Order;
-(function (Order) {
-    (function (status) {
-        status["PENDING"] = "PENDING";
-        status["ACTIVE"] = "ACTIVE";
-        status["CANCELLED"] = "CANCELLED";
-        status["INACTIVE"] = "INACTIVE";
-        status["REJECTED"] = "REJECTED";
-        status["FILLED"] = "FILLED";
-        status["EXPIRED"] = "EXPIRED";
-    })(Order.status || (Order.status = {}));
-})(Order || (Order = {}));
+/**
+ * The Order status
+ */
+var OrderStatus;
+(function (OrderStatus) {
+    OrderStatus["PENDING"] = "PENDING";
+    OrderStatus["ACTIVE"] = "ACTIVE";
+    OrderStatus["INACTIVE"] = "INACTIVE";
+    OrderStatus["FILLED"] = "FILLED";
+    OrderStatus["CANCELLED"] = "CANCELLED";
+    OrderStatus["EXPIRED"] = "EXPIRED";
+})(OrderStatus || (OrderStatus = {}));
 
 /* istanbul ignore file */
 /* tslint:disable */
@@ -554,6 +559,12 @@ class ImmutableApiClient {
     async getOrder(orderId) {
         return this.orderbookService.getOrder({ chainId: this.chainId, orderId });
     }
+    async listOrders(listOrderParams) {
+        return this.orderbookService.listOrders({
+            chainId: this.chainId,
+            ...listOrderParams,
+        });
+    }
     async createOrder({ orderHash, orderComponents, offerer, orderSignature, }) {
         if (orderComponents.offer.length !== 1) {
             throw new Error('Only one item can be listed at a time');
@@ -573,7 +584,7 @@ class ImmutableApiClient {
                 buy: [
                     {
                         item_type: Number(orderComponents.consideration[0].itemType) === ItemType.NATIVE
-                            ? BuyItem.item_type.IMX
+                            ? BuyItem.item_type.NATIVE
                             : BuyItem.item_type.ERC20,
                         start_amount: orderComponents.consideration[0].startAmount,
                     }
@@ -589,7 +600,7 @@ class ImmutableApiClient {
                     : [],
                 end_time: new Date(parseInt(`${orderComponents.endTime.toString()}000`, 10)).toISOString(),
                 protocol_data: {
-                    order_type: CreateOrderProtocolData.order_type.FULL_OPEN,
+                    order_type: CreateOrderProtocolData.order_type.FULL_RESTRICTED,
                     zone_address: orderComponents.zone,
                 },
                 salt: orderComponents.salt,
@@ -1640,6 +1651,7 @@ class Seaport {
                         parameters: orderComponents,
                         signature: order.signature,
                     },
+                    extraData: order.protocol_data.operator_signature,
                 }],
         });
         let approvalTransaction;
@@ -1761,11 +1773,20 @@ class Orderbook {
     /**
      * Get an order by ID
      * @param {string} orderId - The orderId to find.
-     * @return {Order} The returned order.
+     * @return {OrderResult} The returned order result.
      */
     getOrder(orderId) {
         return this.apiClient.getOrder(orderId);
     }
+    /**
+     * 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) {
+        return this.apiClient.listOrders(listOrderParams);
+    }
     /**
      * Get required transactions and messages for signing prior to creating a listing
      * through the createOrder method
@@ -1786,7 +1807,7 @@ class Orderbook {
     /**
      * Create an order
      * @param {CreateOrderParams} createOrderParams - create an order with the given params.
-     * @return {Order} The order created in the Immutable services.
+     * @return {OrderResult} The result of the order created in the Immutable services.
      */
     createOrder(createOrderParams) {
         return this.apiClient.createOrder(createOrderParams);
@@ -1800,11 +1821,11 @@ class Orderbook {
      * @return {FulfilOrderResponse} Approval and fulfilment transactions.
      */
     async fulfillOrder(orderId, fulfillerAddress) {
-        const order = await this.apiClient.getOrder(orderId);
-        if (order.status !== Order.status.ACTIVE) {
-            throw new Error(`Cannot fulfil order that is not active. Current status: ${order.status}`);
+        const orderResult = await this.apiClient.getOrder(orderId);
+        if (orderResult.result.status !== OrderStatus.ACTIVE) {
+            throw new Error(`Cannot fulfil order that is not active. Current status: ${orderResult.result.status}`);
         }
-        return this.seaport.fulfilOrder(order, fulfillerAddress);
+        return this.seaport.fulfilOrder(orderResult.result, fulfillerAddress);
     }
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
@@ -1814,16 +1835,16 @@ class Orderbook {
      * @return {CancelOrderResponse} The unsigned cancel order transaction
      */
     async cancelOrder(orderId, accountAddress) {
-        const order = await this.apiClient.getOrder(orderId);
-        if (order.status !== Order.status.ACTIVE
-            && order.status !== Order.status.INACTIVE
-            && order.status !== Order.status.PENDING) {
-            throw new Error(`Cannot cancel order with status ${order.status}`);
+        const orderResult = await this.apiClient.getOrder(orderId);
+        if (orderResult.result.status !== OrderStatus.ACTIVE
+            && orderResult.result.status !== OrderStatus.INACTIVE
+            && orderResult.result.status !== OrderStatus.PENDING) {
+            throw new Error(`Cannot cancel order with status ${orderResult.result.status}`);
         }
-        if (order.account_address !== accountAddress.toLowerCase()) {
-            throw new Error(`Only account ${order.account_address} can cancel order ${orderId}`);
+        if (orderResult.result.account_address !== accountAddress.toLowerCase()) {
+            throw new Error(`Only account ${orderResult.result.account_address} can cancel order ${orderId}`);
         }
-        const cancelOrderTransaction = await this.seaport.cancelOrder(order, accountAddress);
+        const cancelOrderTransaction = await this.seaport.cancelOrder(orderResult.result, accountAddress);
         return { unsignedCancelOrderTransaction: cancelOrderTransaction };
     }
 }