@imtbl/sdk 0.24.1 → 0.25.0

package/dist/orderbook.d.ts

@@ -699,6 +699,47 @@ declare abstract class BaseHttpRequest {
     abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
 }
 
+type CancelOrdersRequestBody = {
+    /**
+     * Address of the user initiating the cancel request
+     */
+    account_address: string;
+    /**
+     * List of order ids proposed for cancellation
+     */
+    orders: Array<string>;
+    /**
+     * Signature generated by the user for the specific cancellation request
+     */
+    signature: string;
+};
+
+type CancelOrdersResult = {
+    result: {
+        /**
+         * Orders which were successfully cancelled
+         */
+        successful_cancellations: Array<string>;
+        /**
+         * Orders which are marked for cancellation but the cancellation cannot be guaranteed
+         */
+        pending_cancellations: Array<string>;
+        /**
+         * Orders which failed to be cancelled
+         */
+        failed_cancellations: Array<{
+            /**
+             * ID of the order which failed to be cancelled
+             */
+            order: string;
+            /**
+             * Reason code indicating why the order failed to be cancelled
+             */
+            reason_code: 'ALREADY_FILLED';
+        }>;
+    };
+};
+
 /**
  * The name of chain
  */
@@ -852,17 +893,69 @@ type Chain = {
     name: string;
 };
 
+type ActiveOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'ACTIVE';
+};
+
+type CancelledOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'CANCELLED';
+    /**
+     * Whether the cancellation of the order is pending
+     */
+    is_pending: boolean;
+    /**
+     * Whether the cancellation was done on-chain or off-chain
+     */
+    cancellation_type: CancelledOrderStatus.cancellation_type;
+};
+declare namespace CancelledOrderStatus {
+    /**
+     * Whether the cancellation was done on-chain or off-chain
+     */
+    enum cancellation_type {
+        ON_CHAIN = "ON_CHAIN",
+        OFF_CHAIN = "OFF_CHAIN"
+    }
+}
+
+type ExpiredOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'EXPIRED';
+};
+
+type FilledOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'FILLED';
+};
+
+type InactiveOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'INACTIVE';
+};
+
+type PendingOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'PENDING';
+};
+
 /**
  * The Order status
  */
-declare enum OrderStatus {
-    PENDING = "PENDING",
-    ACTIVE = "ACTIVE",
-    INACTIVE = "INACTIVE",
-    FILLED = "FILLED",
-    CANCELLED = "CANCELLED",
-    EXPIRED = "EXPIRED"
-}
+type OrderStatus = (CancelledOrderStatus | PendingOrderStatus | ActiveOrderStatus | InactiveOrderStatus | FilledOrderStatus | ExpiredOrderStatus);
 
 type Order$1 = {
     account_address: string;
@@ -983,6 +1076,18 @@ type ListTradeResult = {
     result: Array<Trade$1>;
 };
 
+/**
+ * The Order status
+ */
+declare enum OrderStatusName {
+    PENDING = "PENDING",
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE",
+    FILLED = "FILLED",
+    EXPIRED = "EXPIRED",
+    CANCELLED = "CANCELLED"
+}
+
 /**
  * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
  */
@@ -997,7 +1102,7 @@ type TradeResult$1 = {
     result: Trade$1;
 };
 
-type UnfulfillableOrder = {
+type UnfulfillableOrder$1 = {
     /**
      * OrderID for the requested but unfulfillable order
      */
@@ -1011,6 +1116,16 @@ type UnfulfillableOrder = {
 declare class OrdersService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Cancel one or more orders
+     * Cancel one or more orders
+     * @returns CancelOrdersResult Orders cancellation response.
+     * @throws ApiError
+     */
+    cancelOrders({ chainName, requestBody, }: {
+        chainName: ChainName;
+        requestBody: CancelOrdersRequestBody;
+    }): CancelablePromise<CancelOrdersResult>;
     /**
      * List all listings
      * List all listings
@@ -1022,7 +1137,7 @@ declare class OrdersService {
         /**
          * Order status to filter by
          */
-        status?: OrderStatus;
+        status?: OrderStatusName;
         /**
          * Sell item contract address to filter by
          */
@@ -1087,7 +1202,7 @@ declare class OrdersService {
     }): CancelablePromise<{
         result: {
             fulfillable_orders: Array<FulfillableOrder>;
-            unfulfillable_orders: Array<UnfulfillableOrder>;
+            unfulfillable_orders: Array<UnfulfillableOrder$1>;
         };
     }>;
     /**
@@ -1208,6 +1323,20 @@ interface SignableAction {
     };
 }
 type Action = TransactionAction | SignableAction;
+interface FulfillmentListing {
+    listingId: string;
+    takerFees: Array<FeeValue>;
+}
+interface FulfillBulkOrdersResponse {
+    actions: Action[];
+    expiration: string;
+    fulfillableOrders: Order[];
+    unfulfillableOrders: UnfulfillableOrder[];
+}
+interface UnfulfillableOrder {
+    orderId: string;
+    reason: string;
+}
 interface FulfillOrderResponse {
     actions: Action[];
     /**
@@ -1378,6 +1507,7 @@ declare class Orderbook {
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
     fulfillOrder(listingId: string, takerAddress: string, takerFees: FeeValue[]): Promise<FulfillOrderResponse>;
+    fulfillBulkOrders(listings: Array<FulfillmentListing>, takerAddress: string): Promise<FulfillBulkOrdersResponse>;
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
      * the account that created them.
@@ -1392,4 +1522,4 @@ declare const constants: {
     estimatedFulfillmentGasGwei: number;
 };
 
-export { Action, ActionType, CancelOrderResponse, CreateListingParams, ERC20Item, ERC721Item, Fee, FeeType, FeeValue, FulfillOrderResponse, ListListingsParams, ListListingsResult, ListTradesParams, ListTradesResult, ListingResult, NativeItem, Order, OrderStatus, Orderbook, Page, PrepareListingParams, PrepareListingResponse, RoyaltyInfo, SignableAction, SignablePurpose, Trade, TradeResult, TransactionAction, TransactionBuilder, TransactionPurpose, constants };
+export { Action, ActionType, CancelOrderResponse, CreateListingParams, ERC20Item, ERC721Item, Fee, FeeType, FeeValue, FulfillBulkOrdersResponse, FulfillOrderResponse, FulfillmentListing, ListListingsParams, ListListingsResult, ListTradesParams, ListTradesResult, ListingResult, NativeItem, Order, OrderStatusName, Orderbook, Page, PrepareListingParams, PrepareListingResponse, RoyaltyInfo, SignableAction, SignablePurpose, Trade, TradeResult, TransactionAction, TransactionBuilder, TransactionPurpose, UnfulfillableOrder, constants };

package/dist/orderbook.js

@@ -398,6 +398,31 @@ class OrdersService {
     constructor(httpRequest) {
         this.httpRequest = httpRequest;
     }
+    /**
+     * Cancel one or more orders
+     * Cancel one or more orders
+     * @returns CancelOrdersResult Orders cancellation response.
+     * @throws ApiError
+     */
+    cancelOrders({ chainName, requestBody, }) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/v1/chains/{chain_name}/orders/cancel',
+            path: {
+                'chain_name': chainName,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Bad Request (400)`,
+                401: `Unauthorised Request (401)`,
+                404: `The specified resource was not found (404)`,
+                429: `Too Many Requests (429)`,
+                500: `Internal Server Error (500)`,
+                501: `Not Implemented Error (501)`,
+            },
+        });
+    }
     /**
      * List all listings
      * List all listings
@@ -562,6 +587,17 @@ class OrderBookClient {
     }
 }
 
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+var CancelledOrderStatus;
+(function (CancelledOrderStatus) {
+    (function (cancellation_type) {
+        cancellation_type["ON_CHAIN"] = "ON_CHAIN";
+        cancellation_type["OFF_CHAIN"] = "OFF_CHAIN";
+    })(CancelledOrderStatus.cancellation_type || (CancelledOrderStatus.cancellation_type = {}));
+})(CancelledOrderStatus || (CancelledOrderStatus = {}));
+
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -581,15 +617,15 @@ var Fee;
 /**
  * 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 = {}));
+var OrderStatusName;
+(function (OrderStatusName) {
+    OrderStatusName["PENDING"] = "PENDING";
+    OrderStatusName["ACTIVE"] = "ACTIVE";
+    OrderStatusName["INACTIVE"] = "INACTIVE";
+    OrderStatusName["FILLED"] = "FILLED";
+    OrderStatusName["EXPIRED"] = "EXPIRED";
+    OrderStatusName["CANCELLED"] = "CANCELLED";
+})(OrderStatusName || (OrderStatusName = {}));
 
 /* istanbul ignore file */
 /* tslint:disable */
@@ -964,18 +1000,57 @@ class Seaport {
             buildTransaction: prepareTransaction(fulfilOrderAction.transactionMethods),
             purpose: TransactionPurpose.FULFILL_ORDER,
         });
-        // Expirtaion bytes in SIP7 extra data [21:29]
-        // In hex string -> [21 * 2 + 2 (0x) : 29 * 2]
-        // In JS slice (start, end_inclusive), (44,60)
-        // 8 bytes uint64 epoch time in seconds
-        const expirationHex = extraData.slice(44, 60);
-        const expirationInSeconds = parseInt(expirationHex, 16);
         return {
             actions: fulfillmentActions,
-            expiration: (new Date(expirationInSeconds * 1000)).toISOString(),
+            expiration: Seaport.getExpirationISOTimeFromExtraData(extraData),
             order: mapFromOpenApiOrder(order),
         };
     }
+    async fulfillBulkOrders(fulfillingOrders, account) {
+        // TODO: this function right now does not handle errors from the seaport.js
+        // we should figure out why orders are rejected and return a submission
+        // transaction on best efforts basis
+        const fulfillOrderDetails = fulfillingOrders.map((o) => {
+            const { orderComponents, tips } = this.mapImmutableOrderToSeaportOrderComponents(o.order);
+            return {
+                order: {
+                    parameters: orderComponents,
+                    signature: o.order.signature,
+                },
+                extraData: o.extra_data,
+                tips,
+            };
+        });
+        const { actions: seaportActions } = await this.getSeaportLib().fulfillOrders({
+            fulfillOrderDetails,
+            accountAddress: account,
+        });
+        const fulfillmentActions = [];
+        const approvalAction = seaportActions.find((action) => action.type === 'approval');
+        if (approvalAction) {
+            fulfillmentActions.push({
+                type: ActionType.TRANSACTION,
+                buildTransaction: prepareTransaction(approvalAction.transactionMethods),
+                purpose: TransactionPurpose.APPROVAL,
+            });
+        }
+        const fulfilOrderAction = seaportActions.find((action) => action.type === 'exchange');
+        if (!fulfilOrderAction) {
+            throw new Error('No exchange action found');
+        }
+        fulfillmentActions.push({
+            type: ActionType.TRANSACTION,
+            buildTransaction: prepareTransaction(fulfilOrderAction.transactionMethods),
+            purpose: TransactionPurpose.FULFILL_ORDER,
+        });
+        return {
+            actions: fulfillmentActions,
+            // return the shortest expiration out of all extraData - they should be very close
+            expiration: fulfillOrderDetails
+                .map((d) => Seaport.getExpirationISOTimeFromExtraData(d.extraData))
+                .reduce((p, c) => (new Date(p) < new Date(c) ? p : c)),
+        };
+    }
     async cancelOrder(order, account) {
         const { orderComponents } = this.mapImmutableOrderToSeaportOrderComponents(order);
         const seaportLib = this.getSeaportLib(order);
@@ -999,9 +1074,7 @@ class Seaport {
             ],
             consideration: [
                 {
-                    token: considerationItem.type === 'ERC20'
-                        ? considerationItem.contractAddress
-                        : undefined,
+                    token: considerationItem.type === 'ERC20' ? considerationItem.contractAddress : undefined,
                     amount: considerationItem.amount,
                     recipient: offerer,
                 },
@@ -1034,6 +1107,15 @@ class Seaport {
         // }
         return this.seaportLibFactory.create(seaportVersion, seaportAddress);
     }
+    static getExpirationISOTimeFromExtraData(extraData) {
+        // Expirtaion bytes in SIP7 extra data [21:29]
+        // In hex string -> [21 * 2 + 2 (0x) : 29 * 2]
+        // In JS slice (start, end_inclusive), (44,60)
+        // 8 bytes uint64 epoch time in seconds
+        const expirationHex = extraData.slice(44, 60);
+        const expirationInSeconds = parseInt(expirationHex, 16);
+        return new Date(expirationInSeconds * 1000).toISOString();
+    }
 }
 
 class ImmutableApiClient {
@@ -1332,11 +1414,29 @@ class Orderbook {
         }
         const extraData = fulfillmentDataRes.result.fulfillable_orders[0].extra_data;
         const orderResult = fulfillmentDataRes.result.fulfillable_orders[0].order;
-        if (orderResult.status !== OrderStatus.ACTIVE) {
+        if (orderResult.status.name !== OrderStatusName.ACTIVE) {
             throw new Error(`Cannot fulfil order that is not active. Current status: ${orderResult.status}`);
         }
         return this.seaport.fulfillOrder(orderResult, takerAddress, extraData);
     }
+    async fulfillBulkOrders(listings, takerAddress) {
+        const fulfillmentDataRes = await this.apiClient.fulfillmentData(listings.map((listingRequest) => ({
+            order_id: listingRequest.listingId,
+            fees: listingRequest.takerFees.map((fee) => ({
+                amount: fee.amount,
+                fee_type: FeeType.TAKER_ECOSYSTEM,
+                recipient: fee.recipient,
+            })),
+        })));
+        return {
+            ...(await this.seaport.fulfillBulkOrders(fulfillmentDataRes.result.fulfillable_orders, takerAddress)),
+            fulfillableOrders: fulfillmentDataRes.result.fulfillable_orders.map((o) => mapFromOpenApiOrder(o.order)),
+            unfulfillableOrders: fulfillmentDataRes.result.unfulfillable_orders.map((o) => ({
+                orderId: o.order_id,
+                reason: o.reason,
+            })),
+        };
+    }
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
      * the account that created them.
@@ -1346,9 +1446,9 @@ class Orderbook {
      */
     async cancelOrder(listingId, accountAddress) {
         const orderResult = await this.apiClient.getListing(listingId);
-        if (orderResult.result.status !== OrderStatus.ACTIVE
-            && orderResult.result.status !== OrderStatus.INACTIVE
-            && orderResult.result.status !== OrderStatus.PENDING) {
+        if (orderResult.result.status.name !== OrderStatusName.ACTIVE
+            && orderResult.result.status.name !== OrderStatusName.INACTIVE
+            && orderResult.result.status.name !== OrderStatusName.PENDING) {
             throw new Error(`Cannot cancel order with status ${orderResult.result.status}`);
         }
         if (orderResult.result.account_address !== accountAddress.toLowerCase()) {
@@ -1367,4 +1467,4 @@ const constants = {
     estimatedFulfillmentGasGwei: ESTIMATED_FULFILLMENT_GAS_GWEI,
 };
 
-export { ActionType, FeeType, OrderStatus, Orderbook, SignablePurpose, TransactionPurpose, constants };
+export { ActionType, FeeType, OrderStatusName, Orderbook, SignablePurpose, TransactionPurpose, constants };