@imtbl/sdk 0.27.15 → 0.28.0

package/dist/index.d.ts

@@ -5739,7 +5739,7 @@ interface CancelOrderRequest {
  * @export
  * @interface CancelOrderResponse
  */
-interface CancelOrderResponse$1 {
+interface CancelOrderResponse {
     /**
      * ID of the cancelled order
      * @type {number}
@@ -12964,7 +12964,7 @@ declare class OrdersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
-    cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse$1, any>>;
+    cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
     /**
      * Cancel an order (V3)
      * @summary Cancel an order (V3)
@@ -12973,7 +12973,7 @@ declare class OrdersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
-    cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse$1, any>>;
+    cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
     /**
      * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Create an order
@@ -14733,7 +14733,7 @@ interface IMXProvider {
      * @param {GetSignableCancelOrderRequest} request The signable cancel order request
      * @return {Promise<CancelOrderResponse>} Returns a promise that resolves with the cancelled Order
      */
-    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse$1>;
+    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse>;
     /**
      * Create a Trade
      *
@@ -14793,7 +14793,7 @@ declare class GenericIMXProvider implements IMXProvider {
     getAddress(): Promise<string>;
     registerOffchain(): Promise<RegisterUserResponse>;
     batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
-    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse$1>;
+    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse>;
     completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
     createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse>;
     createTrade(request: GetSignableTradeRequest): Promise<CreateTradeResponse>;
@@ -15053,53 +15053,6 @@ interface OrderbookModuleConfiguration {
     provider: JsonRpcProvider | Web3Provider;
 }
 
-declare enum OrderType {
-    FULL_OPEN = 0,
-    PARTIAL_OPEN = 1,
-    FULL_RESTRICTED = 2,
-    PARTIAL_RESTRICTED = 3
-}
-declare enum ItemType$1 {
-    NATIVE = 0,
-    ERC20 = 1,
-    ERC721 = 2,
-    ERC1155 = 3,
-    ERC721_WITH_CRITERIA = 4,
-    ERC1155_WITH_CRITERIA = 5
-}
-
-type OfferItem = {
-    itemType: ItemType$1;
-    token: string;
-    identifierOrCriteria: string;
-    startAmount: string;
-    endAmount: string;
-};
-type ConsiderationItem = {
-    itemType: ItemType$1;
-    token: string;
-    identifierOrCriteria: string;
-    startAmount: string;
-    endAmount: string;
-    recipient: string;
-};
-type OrderParameters = {
-    offerer: string;
-    zone: string;
-    orderType: OrderType;
-    startTime: BigNumberish;
-    endTime: BigNumberish;
-    zoneHash: string;
-    salt: string;
-    offer: OfferItem[];
-    consideration: ConsiderationItem[];
-    totalOriginalConsiderationItems: BigNumberish;
-    conduitKey: string;
-};
-type OrderComponents = OrderParameters & {
-    counter: BigNumberish;
-};
-
 type ApiRequestOptions = {
     readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
     readonly url: string;
@@ -15187,7 +15140,7 @@ declare namespace FailedOrderCancellation {
      * Reason code indicating why the order failed to be cancelled
      */
     enum reason_code {
-        ALREADY_FILLED = "ALREADY_FILLED"
+        FILLED = "FILLED"
     }
 }
 
@@ -15365,20 +15318,20 @@ type Chain = {
 
 type ActiveOrderStatus = {
     /**
-     * The order status
+     * The order status that indicates an order can be fulfilled.
      */
     name: 'ACTIVE';
 };
 
 type CancelledOrderStatus = {
     /**
-     * The order status
+     * The order status indicating a order is has been cancelled or about to be cancelled.
      */
     name: 'CANCELLED';
     /**
      * Whether the cancellation of the order is pending
      */
-    is_pending: boolean;
+    pending: boolean;
     /**
      * Whether the cancellation was done on-chain or off-chain
      */
@@ -15396,30 +15349,46 @@ declare namespace CancelledOrderStatus {
 
 type ExpiredOrderStatus = {
     /**
-     * The order status
+     * A terminal order status indicating that an order cannot be fulfilled due to expiry.
      */
     name: 'EXPIRED';
 };
 
 type FilledOrderStatus = {
     /**
-     * The order status
+     * A terminal order status indicating that an order has been fulfilled.
      */
     name: 'FILLED';
 };
 
 type InactiveOrderStatus = {
     /**
-     * The order status
+     * The order status that indicates an order cannot be fulfilled.
      */
     name: 'INACTIVE';
+    /**
+     * Whether the order offerer has sufficient approvals
+     */
+    sufficient_approvals: boolean;
+    /**
+     * Whether the order offerer still has sufficient balance to complete the order
+     */
+    sufficient_balances: boolean;
 };
 
 type PendingOrderStatus = {
     /**
-     * The order status
+     * The order status that indicates the order is yet to be active due to various reasons.
      */
     name: 'PENDING';
+    /**
+     * Whether the order has been evaluated after its creation
+     */
+    evaluated: boolean;
+    /**
+     * Whether the order has reached its specified start time
+     */
+    started: boolean;
 };
 
 /**
@@ -15724,6 +15693,53 @@ declare class OrdersService {
     }): CancelablePromise<TradeResult$1>;
 }
 
+declare enum OrderType {
+    FULL_OPEN = 0,
+    PARTIAL_OPEN = 1,
+    FULL_RESTRICTED = 2,
+    PARTIAL_RESTRICTED = 3
+}
+declare enum ItemType$1 {
+    NATIVE = 0,
+    ERC20 = 1,
+    ERC721 = 2,
+    ERC1155 = 3,
+    ERC721_WITH_CRITERIA = 4,
+    ERC1155_WITH_CRITERIA = 5
+}
+
+type OfferItem = {
+    itemType: ItemType$1;
+    token: string;
+    identifierOrCriteria: string;
+    startAmount: string;
+    endAmount: string;
+};
+type ConsiderationItem = {
+    itemType: ItemType$1;
+    token: string;
+    identifierOrCriteria: string;
+    startAmount: string;
+    endAmount: string;
+    recipient: string;
+};
+type OrderParameters = {
+    offerer: string;
+    zone: string;
+    orderType: OrderType;
+    startTime: BigNumberish;
+    endTime: BigNumberish;
+    zoneHash: string;
+    salt: string;
+    offer: OfferItem[];
+    consideration: ConsiderationItem[];
+    totalOriginalConsiderationItems: BigNumberish;
+    conduitKey: string;
+};
+type OrderComponents = OrderParameters & {
+    counter: BigNumberish;
+};
+
 interface ERC721Item {
     type: 'ERC721';
     contractAddress: string;
@@ -15753,6 +15769,9 @@ interface PrepareListingResponse {
     orderComponents: OrderComponents;
     orderHash: string;
 }
+interface PrepareCancelOrdersResponse {
+    signableAction: SignableAction;
+}
 interface CreateListingParams {
     orderComponents: OrderComponents;
     orderHash: string;
@@ -15776,10 +15795,12 @@ interface Fee$1 extends FeeValue {
 }
 declare enum TransactionPurpose {
     APPROVAL = "APPROVAL",
-    FULFILL_ORDER = "FULFILL_ORDER"
+    FULFILL_ORDER = "FULFILL_ORDER",
+    CANCEL = "CANCEL"
 }
 declare enum SignablePurpose {
-    CREATE_LISTING = "CREATE_LISTING"
+    CREATE_LISTING = "CREATE_LISTING",
+    OFF_CHAIN_CANCELLATION = "OFF_CHAIN_CANCELLATION"
 }
 declare enum ActionType {
     TRANSACTION = "TRANSACTION",
@@ -15831,8 +15852,8 @@ interface FulfillOrderResponse {
     expiration: string;
     order: Order;
 }
-interface CancelOrderResponse {
-    unsignedCancelOrderTransaction: PopulatedTransaction;
+interface CancelOrdersOnChainResponse {
+    cancellationAction: TransactionAction;
 }
 interface Order {
     id: string;
@@ -15994,13 +16015,36 @@ declare class Orderbook {
     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.
-     * @param {string} listingId - The listingId to cancel.
+     * Cancelling orders is a gasless alternative to on-chain cancellation exposed with
+     * `cancelOrdersOnChain`. For the orderbook to authenticate the cancellation, the creator
+     * of the orders must sign an EIP712 message containing the orderIds
+     * @param {string} orderIds - The orderIds to attempt to cancel.
+     * @return {PrepareCancelOrdersResponse} The signable action to cancel the orders.
+     */
+    prepareOrderCancellations(orderIds: string[]): Promise<PrepareCancelOrdersResponse>;
+    /**
+     * Cancelling orders is a gasless alternative to on-chain cancellation exposed with
+     * `cancelOrdersOnChain`. Orders cancelled this way cannot be fulfilled and will be removed
+     * from the orderbook. If there is pending fulfillment data outstanding for the order, its
+     * cancellation will be pending until the fulfillment window has passed.
+     * `prepareOffchainOrderCancellations` can be used to get the signable action that is signed
+     * to get the signature required for this call.
+     * @param {string[]} orderIds - The orderIds to attempt to cancel.
+     * @param {string} accountAddress - The address of the account cancelling the orders.
+     * @param {string} accountAddress - The address of the account cancelling the orders.
+     * @return {CancelOrdersResult} The result of the off-chain cancellation request
+     */
+    cancelOrders(orderIds: string[], accountAddress: string, signature: string): Promise<CancelOrdersResult>;
+    /**
+     * Get an unsigned order cancellation transaction. Orders can only be cancelled by
+     * the account that created them. All of the orders must be from the same seaport contract.
+     * If trying to cancel orders from multiple seaport contracts, group the orderIds by seaport
+     * contract and call this method for each group.
+     * @param {string[]} orderIds - The orderIds to cancel.
      * @param {string} accountAddress - The address of the account cancelling the order.
-     * @return {CancelOrderResponse} The unsigned cancel order transaction
+     * @return {CancelOrdersOnChainResponse} The unsigned cancel order action
      */
-    cancelOrder(listingId: string, accountAddress: string): Promise<CancelOrderResponse>;
+    cancelOrdersOnChain(orderIds: string[], accountAddress: string): Promise<CancelOrdersOnChainResponse>;
 }
 
 declare const constants: {
@@ -16010,7 +16054,7 @@ declare const constants: {
 type orderbook_d_Action = Action;
 type orderbook_d_ActionType = ActionType;
 declare const orderbook_d_ActionType: typeof ActionType;
-type orderbook_d_CancelOrderResponse = CancelOrderResponse;
+type orderbook_d_CancelOrdersOnChainResponse = CancelOrdersOnChainResponse;
 type orderbook_d_CreateListingParams = CreateListingParams;
 type orderbook_d_ERC20Item = ERC20Item;
 type orderbook_d_ERC721Item = ERC721Item;
@@ -16034,6 +16078,7 @@ declare const orderbook_d_OrderStatusName: typeof OrderStatusName;
 type orderbook_d_Orderbook = Orderbook;
 declare const orderbook_d_Orderbook: typeof Orderbook;
 type orderbook_d_Page = Page;
+type orderbook_d_PrepareCancelOrdersResponse = PrepareCancelOrdersResponse;
 type orderbook_d_PrepareListingParams = PrepareListingParams;
 type orderbook_d_PrepareListingResponse = PrepareListingResponse;
 type orderbook_d_RoyaltyInfo = RoyaltyInfo;
@@ -16052,7 +16097,7 @@ declare namespace orderbook_d {
   export {
     orderbook_d_Action as Action,
     orderbook_d_ActionType as ActionType,
-    orderbook_d_CancelOrderResponse as CancelOrderResponse,
+    orderbook_d_CancelOrdersOnChainResponse as CancelOrdersOnChainResponse,
     orderbook_d_CreateListingParams as CreateListingParams,
     orderbook_d_ERC20Item as ERC20Item,
     orderbook_d_ERC721Item as ERC721Item,
@@ -16074,6 +16119,7 @@ declare namespace orderbook_d {
     orderbook_d_OrderStatusName as OrderStatusName,
     orderbook_d_Orderbook as Orderbook,
     orderbook_d_Page as Page,
+    orderbook_d_PrepareCancelOrdersResponse as PrepareCancelOrdersResponse,
     orderbook_d_PrepareListingParams as PrepareListingParams,
     orderbook_d_PrepareListingResponse as PrepareListingResponse,
     orderbook_d_RoyaltyInfo as RoyaltyInfo,