@imtbl/orderbook 2.19.0 → 2.20.1-alpha.0

package/dist/types/api-client/api-client.d.ts

@@ -30,6 +30,6 @@ export declare class ImmutableApiClient {
     createListing({ orderHash, orderComponents, orderSignature, makerFees, }: CreateListingParams): Promise<ListingResult>;
     createBid({ orderHash, orderComponents, orderSignature, makerFees, }: CreateBidParams): Promise<BidResult>;
     createCollectionBid({ orderHash, orderComponents, orderSignature, makerFees, }: CreateCollectionBidParams): Promise<CollectionBidResult>;
-    createMetadataBid({ orderHash, orderComponents, orderSignature, makerFees, metadataId, }: CreateMetadataBidParams): Promise<MetadataBidResult>;
+    createMetadataBid(params: CreateMetadataBidParams): Promise<MetadataBidResult>;
     createTraitBid({ orderHash, orderComponents, orderSignature, makerFees, traitCriteria, }: CreateTraitBidParams): Promise<TraitBidResult>;
 }

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

@@ -56,5 +56,6 @@ export type { TradeResult } from './models/TradeResult';
 export type { TraitBidResult } from './models/TraitBidResult';
 export type { MetadataBidResult } from './models/MetadataBidResult';
 export type { TraitFilter } from './models/TraitFilter';
+export type { MetadataFieldFilter } from './models/MetadataFieldFilter';
 export type { UnfulfillableOrder } from './models/UnfulfillableOrder';
 export { OrdersService } from './services/OrdersService';

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

@@ -1,6 +1,7 @@
 import type { AssetCollectionItem } from './AssetCollectionItem';
 import type { ERC20Item } from './ERC20Item';
 import type { Fee } from './Fee';
+import type { MetadataFieldFilter } from './MetadataFieldFilter';
 import type { ProtocolData } from './ProtocolData';
 export type CreateMetadataBidRequestBody = {
     account_address: string;
@@ -35,7 +36,13 @@ export type CreateMetadataBidRequestBody = {
      */
     start_at: string;
     /**
-     * The metadata_id (stack_id) that NFTs must have to fulfil this bid
+     * The metadata_id (stack_id) that NFTs must have to fulfil this bid.
+     * Mutually exclusive with `metadata_criteria`; exactly one must be set.
      */
-    metadata_id: string;
+    metadata_id?: string;
+    /**
+     * Field-level metadata filters that NFTs must satisfy to fulfil this bid.
+     * Mutually exclusive with `metadata_id`; exactly one must be set.
+     */
+    metadata_criteria?: Array<MetadataFieldFilter>;
 };

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

@@ -0,0 +1,14 @@
+export type MetadataFieldFilter = {
+    /**
+     * The metadata field name. Either a top-level NFT metadata field
+     * (`name`, `image`, `description`, `animation_url`, `external_url`,
+     * `youtube_url`) or an attribute identified by the `attribute:<trait_type>`
+     * prefix (e.g. `attribute:Background`).
+     */
+    field_name: string;
+    /**
+     * The metadata field values to match against. Matching is case-insensitive
+     * and OR-style within a single filter; multiple filters on a bid AND.
+     */
+    values: Array<string>;
+};

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

@@ -2,6 +2,7 @@ import type { Chain } from './Chain';
 import type { Fee } from './Fee';
 import type { FillStatus } from './FillStatus';
 import type { Item } from './Item';
+import type { MetadataFieldFilter } from './MetadataFieldFilter';
 import type { OrderStatus } from './OrderStatus';
 import type { ProtocolData } from './ProtocolData';
 import type { TraitFilter } from './TraitFilter';
@@ -52,9 +53,16 @@ export type Order = {
      */
     trait_criteria?: Array<TraitFilter>;
     /**
-     * Metadata ID (stack ID) for metadata bids when returned by the API
+     * Metadata ID (stack ID) for metadata bids created with a single metadata
+     * stack. Omitted for metadata bids created with `metadata_criteria`.
      */
     metadata_id?: string;
+    /**
+     * Field-level metadata filters for metadata bids created with criteria
+     * instead of a `metadata_id`. Omitted for metadata bids created with a
+     * `metadata_id`.
+     */
+    metadata_criteria?: Array<MetadataFieldFilter>;
 };
 export declare namespace Order {
     /**

package/dist/types/orderbook.d.ts

@@ -191,8 +191,14 @@ export declare class Orderbook {
      */
     prepareMetadataBid({ makerAddress, sell, buy, orderStart, orderExpiry, }: PrepareMetadataBidParams): Promise<PrepareMetadataBidResponse>;
     /**
-     * Create a metadata bid (collection criteria offer plus metadata ID submitted to the API).
-     * @param {CreateMetadataBidParams} createMetadataBidParams - Signed order and metadata ID.
+     * Create a metadata bid (collection criteria offer plus a metadata matching
+     * spec submitted to the API). The matching spec is either a single
+     * `metadataId` (NFTs whose indexed metadata stack ID equals this UUID) or
+     * a `metadataCriteria` array of field-level filters (NFTs whose metadata
+     * satisfies every filter; AND across filters, OR within a filter's
+     * `values`, case-insensitive). Exactly one of the two must be provided.
+     * @param {CreateMetadataBidParams} createMetadataBidParams - Signed order and
+     *   metadata ID or criteria.
      * @return {MetadataBidResult} The created metadata bid.
      */
     createMetadataBid(createMetadataBidParams: CreateMetadataBidParams): Promise<MetadataBidResult>;

package/dist/types/types.d.ts

@@ -64,14 +64,46 @@ export interface TraitBid extends OrderFields {
      */
     traitCriteria: TraitFilter[];
 }
+/**
+ * Top-level NFT metadata fields a metadata bid criterion may target.
+ * Mirrors the ERC-721 / OpenSea metadata schema indexed by Immutable.
+ */
+export type MetadataTopLevelField = 'name' | 'image' | 'description' | 'animation_url' | 'external_url' | 'youtube_url';
+/**
+ * An attribute-style field name. The portion after `attribute:` is the
+ * attribute's `trait_type` (e.g. `attribute:Background`).
+ */
+export type MetadataAttributeField = `attribute:${string}`;
+/**
+ * Field name a single metadata bid criterion can target. Either a known
+ * top-level metadata field, or an attribute-prefixed name.
+ */
+export type MetadataFieldName = MetadataTopLevelField | MetadataAttributeField;
+/**
+ * A single metadata bid criterion: a field name plus the acceptable values
+ * for that field. Within a filter values are OR'd; across filters they AND.
+ * Comparisons are case-insensitive.
+ */
+export interface MetadataFieldFilter {
+    fieldName: MetadataFieldName;
+    values: string[];
+}
 export interface MetadataBid extends OrderFields {
     type: 'METADATA_BID';
     sell: ERC20Item[];
     buy: (ERC721CollectionItem | ERC1155CollectionItem)[];
     /**
      * The metadata ID (stack ID) that NFTs must match to fulfil this bid.
+     * Set when the bid was created with a single metadata stack identifier.
+     * Mutually exclusive with `metadataCriteria`.
      */
-    metadataId: string;
+    metadataId?: string;
+    /**
+     * Field-level metadata filters that NFTs must match to fulfil this bid.
+     * Set when the bid was created with criteria instead of a metadata ID.
+     * Empty when the bid was created with a `metadataId`.
+     */
+    metadataCriteria: MetadataFieldFilter[];
 }
 interface OrderFields {
     id: string;
@@ -304,9 +336,23 @@ export interface ListMetadataBidsResult {
 }
 export type PrepareMetadataBidParams = PrepareCollectionBidParams;
 export type PrepareMetadataBidResponse = PrepareOrderResponse;
-export interface CreateMetadataBidParams extends CreateCollectionBidParams {
+/**
+ * Parameters for creating a metadata bid. Exactly one of `metadataId` or
+ * `metadataCriteria` must be provided.
+ *
+ * - `metadataId` mode: matches NFTs whose indexed metadata stack ID equals
+ *   the supplied UUID.
+ * - `metadataCriteria` mode: matches NFTs whose metadata satisfies every
+ *   filter (AND across filters, OR within a filter's `values`,
+ *   case-insensitive).
+ */
+export type CreateMetadataBidParams = CreateCollectionBidParams & ({
     metadataId: string;
-}
+    metadataCriteria?: never;
+} | {
+    metadataId?: never;
+    metadataCriteria: MetadataFieldFilter[];
+});
 export interface FulfillmentOrder {
     orderId: string;
     takerFees: FeeValue[];

package/package.json

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