@imtbl/orderbook 2.16.1-alpha.0 → 2.16.1-alpha.2

package/dist/types/openapi/sdk/index.d.ts

@@ -16,6 +16,7 @@ export type { ChainName } from './models/ChainName';
 export type { CollectionBidResult } from './models/CollectionBidResult';
 export type { CreateBidRequestBody } from './models/CreateBidRequestBody';
 export type { CreateCollectionBidRequestBody } from './models/CreateCollectionBidRequestBody';
+export type { CreateTraitBidRequestBody } from './models/CreateTraitBidRequestBody';
 export type { CreateListingRequestBody } from './models/CreateListingRequestBody';
 export type { ERC1155CollectionItem } from './models/ERC1155CollectionItem';
 export type { ERC1155Item } from './models/ERC1155Item';
@@ -34,6 +35,7 @@ export type { InactiveOrderStatus } from './models/InactiveOrderStatus';
 export type { Item } from './models/Item';
 export type { ListBidsResult } from './models/ListBidsResult';
 export type { ListCollectionBidsResult } from './models/ListCollectionBidsResult';
+export type { ListTraitBidsResult } from './models/ListTraitBidsResult';
 export type { ListingResult } from './models/ListingResult';
 export type { ListListingsResult } from './models/ListListingsResult';
 export type { ListTradeResult } from './models/ListTradeResult';
@@ -49,5 +51,7 @@ export { ProtocolData } from './models/ProtocolData';
 export type { Trade } from './models/Trade';
 export type { TradeBlockchainMetadata } from './models/TradeBlockchainMetadata';
 export type { TradeResult } from './models/TradeResult';
+export type { TraitBidResult } from './models/TraitBidResult';
+export type { TraitFilter } from './models/TraitFilter';
 export type { UnfulfillableOrder } from './models/UnfulfillableOrder';
 export { OrdersService } from './services/OrdersService';

package/dist/types/openapi/sdk/models/CreateTraitBidRequestBody.d.ts

@@ -0,0 +1,42 @@
+import type { AssetCollectionItem } from './AssetCollectionItem';
+import type { ERC20Item } from './ERC20Item';
+import type { Fee } from './Fee';
+import type { ProtocolData } from './ProtocolData';
+import type { TraitFilter } from './TraitFilter';
+export type CreateTraitBidRequestBody = {
+    account_address: string;
+    order_hash: string;
+    /**
+     * Buy item for trait bid should either be ERC721 or ERC1155 collection item
+     */
+    buy: Array<AssetCollectionItem>;
+    /**
+     * Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.
+     */
+    fees: Array<Fee>;
+    /**
+     * Time after which the Order is considered expired
+     */
+    end_at: string;
+    protocol_data: ProtocolData;
+    /**
+     * A random value added to the create Order request
+     */
+    salt: string;
+    /**
+     * Sell item for trait bid should be an ERC20 item
+     */
+    sell: Array<ERC20Item>;
+    /**
+     * Digital signature generated by the user for the specific Order
+     */
+    signature: string;
+    /**
+     * Time after which Order is considered active
+     */
+    start_at: string;
+    /**
+     * Trait criteria to match NFTs against
+     */
+    trait_criteria: Array<TraitFilter>;
+};

package/dist/types/openapi/sdk/models/ListTraitBidsResult.d.ts

@@ -0,0 +1,6 @@
+import type { Order } from './Order';
+import type { Page } from './Page';
+export type ListTraitBidsResult = {
+    page: Page;
+    result: Array<Order>;
+};

package/dist/types/openapi/sdk/models/Order.d.ts

@@ -4,6 +4,7 @@ import type { FillStatus } from './FillStatus';
 import type { Item } from './Item';
 import type { OrderStatus } from './OrderStatus';
 import type { ProtocolData } from './ProtocolData';
+import type { TraitFilter } from './TraitFilter';
 export type Order = {
     account_address: string;
     buy: Array<Item>;
@@ -46,6 +47,10 @@ export type Order = {
      */
     updated_at: string;
     fill_status: FillStatus;
+    /**
+     * Trait criteria for trait bids when returned by the API
+     */
+    trait_criteria?: Array<TraitFilter>;
 };
 export declare namespace Order {
     /**
@@ -54,6 +59,7 @@ export declare namespace Order {
     enum type {
         LISTING = "LISTING",
         BID = "BID",
-        COLLECTION_BID = "COLLECTION_BID"
+        COLLECTION_BID = "COLLECTION_BID",
+        TRAIT_BID = "TRAIT_BID"
     }
 }

package/dist/types/openapi/sdk/models/TraitBidResult.d.ts

@@ -0,0 +1,4 @@
+import type { Order } from './Order';
+export type TraitBidResult = {
+    result: Order;
+};

package/dist/types/openapi/sdk/models/TraitFilter.d.ts

@@ -0,0 +1,10 @@
+export type TraitFilter = {
+    /**
+     * The trait type (attribute name)
+     */
+    trait_type: string;
+    /**
+     * The trait values to match against
+     */
+    values: Array<string>;
+};

package/dist/types/openapi/sdk/services/OrdersService.d.ts

@@ -5,11 +5,13 @@ import type { ChainName } from '../models/ChainName';
 import type { CollectionBidResult } from '../models/CollectionBidResult';
 import type { CreateBidRequestBody } from '../models/CreateBidRequestBody';
 import type { CreateCollectionBidRequestBody } from '../models/CreateCollectionBidRequestBody';
+import type { CreateTraitBidRequestBody } from '../models/CreateTraitBidRequestBody';
 import type { CreateListingRequestBody } from '../models/CreateListingRequestBody';
 import type { FulfillableOrder } from '../models/FulfillableOrder';
 import type { FulfillmentDataRequest } from '../models/FulfillmentDataRequest';
 import type { ListBidsResult } from '../models/ListBidsResult';
 import type { ListCollectionBidsResult } from '../models/ListCollectionBidsResult';
+import type { ListTraitBidsResult } from '../models/ListTraitBidsResult';
 import type { ListingResult } from '../models/ListingResult';
 import type { ListListingsResult } from '../models/ListListingsResult';
 import type { ListTradeResult } from '../models/ListTradeResult';
@@ -17,6 +19,7 @@ import type { OrderStatusName } from '../models/OrderStatusName';
 import type { PageCursor } from '../models/PageCursor';
 import type { PageSize } from '../models/PageSize';
 import type { TradeResult } from '../models/TradeResult';
+import type { TraitBidResult } from '../models/TraitBidResult';
 import type { UnfulfillableOrder } from '../models/UnfulfillableOrder';
 import type { CancelablePromise } from '../core/CancelablePromise';
 import type { BaseHttpRequest } from '../core/BaseHttpRequest';
@@ -218,6 +221,61 @@ export declare class OrdersService {
         chainName: ChainName;
         requestBody: CreateCollectionBidRequestBody;
     }): CancelablePromise<CollectionBidResult>;
+    /**
+     * List all trait bids
+     * List all trait bids
+     * @returns ListTraitBidsResult OK response.
+     * @throws ApiError
+     */
+    listTraitBids({ chainName, status, buyItemContractAddress, sellItemContractAddress, accountAddress, fromUpdatedAt, pageSize, sortBy, sortDirection, pageCursor, }: {
+        chainName: ChainName;
+        /**
+         * Order status to filter by
+         */
+        status?: OrderStatusName;
+        /**
+         * Buy item contract address to filter by
+         */
+        buyItemContractAddress?: string;
+        /**
+         * Sell item contract address to filter by
+         */
+        sellItemContractAddress?: string;
+        /**
+         * The account address of the user who created the bid
+         */
+        accountAddress?: string;
+        /**
+         * From updated at including given date
+         */
+        fromUpdatedAt?: string;
+        /**
+         * Maximum number of orders to return per page
+         */
+        pageSize?: PageSize;
+        /**
+         * Order field to sort by. `sell_item_amount` sorts by per token price, for example if 10eth is offered for 5 ERC1155 items, it’s sorted as 2eth for `sell_item_amount`.
+         */
+        sortBy?: 'created_at' | 'updated_at' | 'sell_item_amount';
+        /**
+         * Ascending or descending direction for sort
+         */
+        sortDirection?: 'asc' | 'desc';
+        /**
+         * Page cursor to retrieve previous or next page. Use the value returned in the response.
+         */
+        pageCursor?: PageCursor;
+    }): CancelablePromise<ListTraitBidsResult>;
+    /**
+     * Create a trait bid
+     * Create a trait bid
+     * @returns TraitBidResult Created response.
+     * @throws ApiError
+     */
+    createTraitBid({ chainName, requestBody, }: {
+        chainName: ChainName;
+        requestBody: CreateTraitBidRequestBody;
+    }): CancelablePromise<TraitBidResult>;
     /**
      * Get a single listing by ID
      * Get a single listing by ID
@@ -257,6 +315,19 @@ export declare class OrdersService {
          */
         collectionBidId: string;
     }): CancelablePromise<CollectionBidResult>;
+    /**
+     * Get a single trait bid by ID
+     * Get a single trait bid by ID
+     * @returns TraitBidResult OK response.
+     * @throws ApiError
+     */
+    getTraitBid({ chainName, traitBidId, }: {
+        chainName: ChainName;
+        /**
+         * Global Trait Bid identifier
+         */
+        traitBidId: string;
+    }): CancelablePromise<TraitBidResult>;
     /**
      * Retrieve fulfillment data for orders
      * Retrieve signed fulfillment data based on the list of order IDs and corresponding fees.

package/dist/types/orderbook.d.ts

@@ -1,7 +1,7 @@
 import { ModuleConfiguration } from '@imtbl/config';
 import { OrderbookModuleConfiguration, OrderbookOverrides } from './config/config';
 import { CancelOrdersResult } from './openapi/sdk';
-import { BidResult, CancelOrdersOnChainResponse, CollectionBidResult, CreateBidParams, CreateCollectionBidParams, CreateListingParams, FeeValue, FulfillBulkOrdersResponse, FulfillmentListing, FulfillmentOrder, FulfillOrderResponse, ListBidsParams, ListBidsResult, ListCollectionBidsParams, ListCollectionBidsResult, ListingResult, ListListingsParams, ListListingsResult, ListTradesParams, ListTradesResult, PrepareBidParams, PrepareBidResponse, PrepareBulkListingsParams, PrepareBulkListingsResponse, PrepareCancelOrdersResponse, PrepareCollectionBidParams, PrepareCollectionBidResponse, PrepareListingParams, PrepareListingResponse, TradeResult } from './types';
+import { BidResult, CancelOrdersOnChainResponse, CollectionBidResult, CreateBidParams, CreateCollectionBidParams, CreateTraitBidParams, CreateListingParams, FeeValue, FulfillBulkOrdersResponse, FulfillmentListing, FulfillmentOrder, FulfillOrderResponse, ListBidsParams, ListBidsResult, ListCollectionBidsParams, ListCollectionBidsResult, ListTraitBidsParams, ListTraitBidsResult, ListingResult, ListListingsParams, ListListingsResult, ListTradesParams, ListTradesResult, PrepareBidParams, PrepareBidResponse, PrepareBulkListingsParams, PrepareBulkListingsResponse, PrepareCancelOrdersResponse, PrepareCollectionBidParams, PrepareCollectionBidResponse, PrepareTraitBidParams, PrepareTraitBidResponse, TraitBidResult, PrepareListingParams, PrepareListingResponse, TradeResult } from './types';
 /**
  * zkEVM orderbook SDK
  * @constructor
@@ -40,6 +40,12 @@ export declare class Orderbook {
      * @return {CollectionBidResult} The returned collection bid result.
      */
     getCollectionBid(collectionBidId: string): Promise<CollectionBidResult>;
+    /**
+     * Get a trait bid by ID
+     * @param {string} traitBidId - The trait bid id to find.
+     * @return {TraitBidResult} The returned trait bid result.
+     */
+    getTraitBid(traitBidId: string): Promise<TraitBidResult>;
     /**
      * Get a trade by ID
      * @param {string} tradeId - The tradeId to find.
@@ -67,6 +73,13 @@ export declare class Orderbook {
      * @return {ListCollectionBidsResult} The paged collection bids.
      */
     listCollectionBids(listOrderParams: ListCollectionBidsParams): Promise<ListCollectionBidsResult>;
+    /**
+     * List trait bids. This method is used to get a list of trait bids filtered
+     * by conditions specified in the params object.
+     * @param {ListTraitBidsParams} listOrderParams - Filtering, ordering and page parameters.
+     * @return {ListTraitBidsResult} The paged trait bids.
+     */
+    listTraitBids(listOrderParams: ListTraitBidsParams): Promise<ListTraitBidsResult>;
     /**
      * List trades. This method is used to get a list of trades filtered by conditions specified
      * in the params object
@@ -140,6 +153,21 @@ export declare class Orderbook {
      *                               in the Immutable services.
      */
     createCollectionBid(createCollectionBidParams: CreateCollectionBidParams): Promise<CollectionBidResult>;
+    /**
+     * Get required transactions and messages for signing prior to creating a trait bid
+     * through the {@linkcode createTraitBid} method. Uses the same Seaport criteria-based
+     * order shape as collection bids.
+     * @param {PrepareTraitBidParams} params - Details about the trait bid to be created.
+     * @return {PrepareTraitBidResponse} Unsigned approval (if any), typed order message, and
+     * order components for {@linkcode createTraitBid}.
+     */
+    prepareTraitBid({ makerAddress, sell, buy, orderStart, orderExpiry, }: PrepareTraitBidParams): Promise<PrepareTraitBidResponse>;
+    /**
+     * Create a trait bid (collection criteria offer plus trait filters submitted to the API).
+     * @param {CreateTraitBidParams} createTraitBidParams - Signed order and trait criteria.
+     * @return {TraitBidResult} The created trait bid.
+     */
+    createTraitBid(createTraitBidParams: CreateTraitBidParams): Promise<TraitBidResult>;
     /**
      * 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/types/types.d.ts

@@ -32,7 +32,7 @@ export interface ERC1155CollectionItem {
     contractAddress: string;
     amount: string;
 }
-export type Order = Listing | Bid | CollectionBid;
+export type Order = Listing | Bid | CollectionBid | TraitBid;
 export interface Listing extends OrderFields {
     type: 'LISTING';
     sell: (ERC721Item | ERC1155Item)[];
@@ -48,6 +48,22 @@ export interface CollectionBid extends OrderFields {
     sell: ERC20Item[];
     buy: (ERC721CollectionItem | ERC1155CollectionItem)[];
 }
+/**
+ * A single trait filter (attribute name + acceptable values).
+ */
+export interface TraitFilter {
+    traitType: string;
+    values: string[];
+}
+export interface TraitBid extends OrderFields {
+    type: 'TRAIT_BID';
+    sell: ERC20Item[];
+    buy: (ERC721CollectionItem | ERC1155CollectionItem)[];
+    /**
+     * Trait criteria for this bid. Empty if the API response omits criteria.
+     */
+    traitCriteria: TraitFilter[];
+}
 interface OrderFields {
     id: string;
     chain: {
@@ -256,6 +272,19 @@ export interface BulkCollectionBidsResult {
         order?: CollectionBid;
     }[];
 }
+export type ListTraitBidsParams = Omit<Parameters<typeof OrdersService.prototype.listTraitBids>[0], 'chainName'>;
+export interface TraitBidResult {
+    result: TraitBid;
+}
+export interface ListTraitBidsResult {
+    page: Page;
+    result: TraitBid[];
+}
+export type PrepareTraitBidParams = PrepareCollectionBidParams;
+export type PrepareTraitBidResponse = PrepareOrderResponse;
+export interface CreateTraitBidParams extends CreateCollectionBidParams {
+    traitCriteria: TraitFilter[];
+}
 export interface FulfillmentOrder {
     orderId: string;
     takerFees: FeeValue[];

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@imtbl/orderbook",
-  "version": "2.16.1-alpha.0",
+  "version": "2.16.1-alpha.2",
   "author": "Immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
-    "@imtbl/config": "2.16.1-alpha.0",
-    "@imtbl/metrics": "2.16.1-alpha.0",
+    "@imtbl/config": "2.16.1-alpha.2",
+    "@imtbl/metrics": "2.16.1-alpha.2",
     "@opensea/seaport-js": "4.0.3",
     "axios": "^1.6.5",
     "ethers": "^6.13.4",