@imtbl/orderbook 2.17.2-alpha.2 → 2.17.2-alpha.3

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

@@ -1,8 +1,8 @@
-import { BidResult, CancelOrdersResult, CollectionBidResult, ListBidsResult, ListCollectionBidsResult, ListingResult, ListListingsResult, ListTradeResult, ListTraitBidsResult, OrdersService, TradeResult, TraitBidResult } from '../openapi/sdk';
+import { BidResult, CancelOrdersResult, CollectionBidResult, ListBidsResult, ListCollectionBidsResult, ListingResult, ListListingsResult, ListMetadataBidsResult, ListTradeResult, ListTraitBidsResult, MetadataBidResult, OrdersService, TradeResult, TraitBidResult } from '../openapi/sdk';
 import { FulfillableOrder } from '../openapi/sdk/models/FulfillableOrder';
 import { FulfillmentDataRequest } from '../openapi/sdk/models/FulfillmentDataRequest';
 import { UnfulfillableOrder } from '../openapi/sdk/models/UnfulfillableOrder';
-import { CreateBidParams, CreateCollectionBidParams, CreateListingParams, CreateTraitBidParams, ListBidsParams, ListCollectionBidsParams, ListListingsParams, ListTraitBidsParams, ListTradesParams } from '../types';
+import { CreateBidParams, CreateCollectionBidParams, CreateListingParams, CreateMetadataBidParams, CreateTraitBidParams, ListBidsParams, ListCollectionBidsParams, ListListingsParams, ListMetadataBidsParams, ListTraitBidsParams, ListTradesParams } from '../types';
 export declare class ImmutableApiClient {
     private readonly orderbookService;
     private readonly chainName;
@@ -23,10 +23,13 @@ export declare class ImmutableApiClient {
     listBids(listOrderParams: ListBidsParams): Promise<ListBidsResult>;
     listCollectionBids(listOrderParams: ListCollectionBidsParams): Promise<ListCollectionBidsResult>;
     listTraitBids(listOrderParams: ListTraitBidsParams): Promise<ListTraitBidsResult>;
+    getMetadataBid(metadataBidId: string): Promise<MetadataBidResult>;
+    listMetadataBids(listOrderParams: ListMetadataBidsParams): Promise<ListMetadataBidsResult>;
     listTrades(listTradesParams: ListTradesParams): Promise<ListTradeResult>;
     cancelOrders(orderIds: string[], accountAddress: string, signature: string): Promise<CancelOrdersResult>;
     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>;
     createTraitBid({ orderHash, orderComponents, orderSignature, makerFees, traitCriteria, }: CreateTraitBidParams): Promise<TraitBidResult>;
 }

package/dist/types/openapi/mapper.d.ts

@@ -1,4 +1,4 @@
-import { Bid, CollectionBid, Listing, Order, Page, Trade, TraitBid } from '../types';
+import { Bid, CollectionBid, Listing, MetadataBid, Order, Page, Trade, TraitBid } from '../types';
 import { Order as OpenApiOrder } from './sdk/models/Order';
 import { Page as OpenApiPage } from './sdk/models/Page';
 import { Trade as OpenApiTrade } from './sdk/models/Trade';
@@ -6,6 +6,7 @@ export declare function mapListingFromOpenApiOrder(order: OpenApiOrder): Listing
 export declare function mapBidFromOpenApiOrder(order: OpenApiOrder): Bid;
 export declare function mapCollectionBidFromOpenApiOrder(order: OpenApiOrder): CollectionBid;
 export declare function mapTraitBidFromOpenApiOrder(order: OpenApiOrder): TraitBid;
+export declare function mapMetadataBidFromOpenApiOrder(order: OpenApiOrder): MetadataBid;
 export declare function mapOrderFromOpenApiOrder(order: OpenApiOrder): Order;
 export declare function mapFromOpenApiTrade(trade: OpenApiTrade): Trade;
 export declare function mapFromOpenApiPage(page: OpenApiPage): Page;

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

@@ -17,6 +17,7 @@ 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 { CreateMetadataBidRequestBody } from './models/CreateMetadataBidRequestBody';
 export type { CreateListingRequestBody } from './models/CreateListingRequestBody';
 export type { ERC1155CollectionItem } from './models/ERC1155CollectionItem';
 export type { ERC1155Item } from './models/ERC1155Item';
@@ -36,6 +37,7 @@ 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 { ListMetadataBidsResult } from './models/ListMetadataBidsResult';
 export type { ListingResult } from './models/ListingResult';
 export type { ListListingsResult } from './models/ListListingsResult';
 export type { ListTradeResult } from './models/ListTradeResult';
@@ -52,6 +54,7 @@ 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 { MetadataBidResult } from './models/MetadataBidResult';
 export type { TraitFilter } from './models/TraitFilter';
 export type { UnfulfillableOrder } from './models/UnfulfillableOrder';
 export { OrdersService } from './services/OrdersService';

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

@@ -0,0 +1,41 @@
+import type { AssetCollectionItem } from './AssetCollectionItem';
+import type { ERC20Item } from './ERC20Item';
+import type { Fee } from './Fee';
+import type { ProtocolData } from './ProtocolData';
+export type CreateMetadataBidRequestBody = {
+    account_address: string;
+    order_hash: string;
+    /**
+     * Buy item for metadata 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 metadata 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;
+    /**
+     * The metadata_id (stack_id) that NFTs must have to fulfil this bid
+     */
+    metadata_id: string;
+};

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

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

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

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

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

@@ -51,6 +51,10 @@ export type Order = {
      * Trait criteria for trait bids when returned by the API
      */
     trait_criteria?: Array<TraitFilter>;
+    /**
+     * Metadata ID (stack ID) for metadata bids when returned by the API
+     */
+    metadata_id?: string;
 };
 export declare namespace Order {
     /**
@@ -60,6 +64,7 @@ export declare namespace Order {
         LISTING = "LISTING",
         BID = "BID",
         COLLECTION_BID = "COLLECTION_BID",
-        TRAIT_BID = "TRAIT_BID"
+        TRAIT_BID = "TRAIT_BID",
+        METADATA_BID = "METADATA_BID"
     }
 }

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

@@ -6,12 +6,14 @@ 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 { CreateMetadataBidRequestBody } from '../models/CreateMetadataBidRequestBody';
 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 { ListMetadataBidsResult } from '../models/ListMetadataBidsResult';
 import type { ListingResult } from '../models/ListingResult';
 import type { ListListingsResult } from '../models/ListListingsResult';
 import type { ListTradeResult } from '../models/ListTradeResult';
@@ -20,6 +22,7 @@ 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 { MetadataBidResult } from '../models/MetadataBidResult';
 import type { UnfulfillableOrder } from '../models/UnfulfillableOrder';
 import type { CancelablePromise } from '../core/CancelablePromise';
 import type { BaseHttpRequest } from '../core/BaseHttpRequest';
@@ -276,6 +279,78 @@ export declare class OrdersService {
         chainName: ChainName;
         requestBody: CreateTraitBidRequestBody;
     }): CancelablePromise<TraitBidResult>;
+    /**
+     * List all metadata bids
+     * List all metadata bids
+     * @returns ListMetadataBidsResult OK response.
+     * @throws ApiError
+     */
+    listMetadataBids({ chainName, status, buyItemContractAddress, sellItemContractAddress, accountAddress, metadataId, 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;
+        /**
+         * The metadata_id to filter by
+         */
+        metadataId?: 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<ListMetadataBidsResult>;
+    /**
+     * Create a metadata bid
+     * Create a metadata bid
+     * @returns MetadataBidResult Created response.
+     * @throws ApiError
+     */
+    createMetadataBid({ chainName, requestBody, }: {
+        chainName: ChainName;
+        requestBody: CreateMetadataBidRequestBody;
+    }): CancelablePromise<MetadataBidResult>;
+    /**
+     * Get a single metadata bid by ID
+     * Get a single metadata bid by ID
+     * @returns MetadataBidResult OK response.
+     * @throws ApiError
+     */
+    getMetadataBid({ chainName, metadataBidId, }: {
+        chainName: ChainName;
+        /**
+         * Global Metadata Bid identifier
+         */
+        metadataBidId: string;
+    }): CancelablePromise<MetadataBidResult>;
     /**
      * Get a single listing by ID
      * Get a single listing by ID

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, 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';
+import { BidResult, CancelOrdersOnChainResponse, CollectionBidResult, CreateBidParams, CreateCollectionBidParams, CreateMetadataBidParams, CreateTraitBidParams, CreateListingParams, FeeValue, FulfillBulkOrdersResponse, FulfillmentListing, FulfillmentOrder, FulfillOrderResponse, ListBidsParams, ListBidsResult, ListCollectionBidsParams, ListCollectionBidsResult, ListMetadataBidsParams, ListMetadataBidsResult, ListTraitBidsParams, ListTraitBidsResult, ListingResult, ListListingsParams, ListListingsResult, ListTradesParams, ListTradesResult, PrepareBidParams, PrepareBidResponse, PrepareBulkListingsParams, PrepareBulkListingsResponse, PrepareCancelOrdersResponse, PrepareCollectionBidParams, PrepareCollectionBidResponse, PrepareMetadataBidParams, PrepareMetadataBidResponse, PrepareTraitBidParams, PrepareTraitBidResponse, MetadataBidResult, TraitBidResult, PrepareListingParams, PrepareListingResponse, TradeResult } from './types';
 /**
  * zkEVM orderbook SDK
  * @constructor
@@ -46,6 +46,12 @@ export declare class Orderbook {
      * @return {TraitBidResult} The returned trait bid result.
      */
     getTraitBid(traitBidId: string): Promise<TraitBidResult>;
+    /**
+     * Get a metadata bid by ID
+     * @param {string} metadataBidId - The metadata bid id to find.
+     * @return {MetadataBidResult} The returned metadata bid result.
+     */
+    getMetadataBid(metadataBidId: string): Promise<MetadataBidResult>;
     /**
      * Get a trade by ID
      * @param {string} tradeId - The tradeId to find.
@@ -80,6 +86,13 @@ export declare class Orderbook {
      * @return {ListTraitBidsResult} The paged trait bids.
      */
     listTraitBids(listOrderParams: ListTraitBidsParams): Promise<ListTraitBidsResult>;
+    /**
+     * List metadata bids. This method is used to get a list of metadata bids filtered
+     * by conditions specified in the params object.
+     * @param {ListMetadataBidsParams} listOrderParams - Filtering, ordering and page parameters.
+     * @return {ListMetadataBidsResult} The paged metadata bids.
+     */
+    listMetadataBids(listOrderParams: ListMetadataBidsParams): Promise<ListMetadataBidsResult>;
     /**
      * List trades. This method is used to get a list of trades filtered by conditions specified
      * in the params object
@@ -168,6 +181,21 @@ export declare class Orderbook {
      * @return {TraitBidResult} The created trait bid.
      */
     createTraitBid(createTraitBidParams: CreateTraitBidParams): Promise<TraitBidResult>;
+    /**
+     * Get required transactions and messages for signing prior to creating a metadata bid
+     * through the {@linkcode createMetadataBid} method. Uses the same Seaport criteria-based
+     * order shape as collection bids.
+     * @param {PrepareMetadataBidParams} params - Details about the metadata bid to be created.
+     * @return {PrepareMetadataBidResponse} Unsigned approval (if any), typed order message, and
+     * order components for {@linkcode createMetadataBid}.
+     */
+    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.
+     * @return {MetadataBidResult} The created metadata bid.
+     */
+    createMetadataBid(createMetadataBidParams: CreateMetadataBidParams): Promise<MetadataBidResult>;
     /**
      * 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/test/helpers/order.d.ts

@@ -1,3 +1,4 @@
 import { Orderbook } from '../../orderbook';
-import { Order, OrderStatusName } from '../../types';
+import { MetadataBid, Order, OrderStatusName } from '../../types';
 export declare function waitForOrderToBeOfStatus(sdk: Orderbook, orderId: string, status: OrderStatusName, attemps?: number): Promise<Order>;
+export declare function waitForMetadataBidToBeOfStatus(sdk: Orderbook, metadataBidId: string, status: OrderStatusName, attempts?: number): Promise<MetadataBid>;

package/dist/types/test/metadata-bid.e2e.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/types.d.ts

@@ -32,7 +32,7 @@ export interface ERC1155CollectionItem {
     contractAddress: string;
     amount: string;
 }
-export type Order = Listing | Bid | CollectionBid | TraitBid;
+export type Order = Listing | Bid | CollectionBid | TraitBid | MetadataBid;
 export interface Listing extends OrderFields {
     type: 'LISTING';
     sell: (ERC721Item | ERC1155Item)[];
@@ -64,6 +64,15 @@ export interface TraitBid extends OrderFields {
      */
     traitCriteria: TraitFilter[];
 }
+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.
+     */
+    metadataId: string;
+}
 interface OrderFields {
     id: string;
     chain: {
@@ -285,6 +294,19 @@ export type PrepareTraitBidResponse = PrepareOrderResponse;
 export interface CreateTraitBidParams extends CreateCollectionBidParams {
     traitCriteria: TraitFilter[];
 }
+export type ListMetadataBidsParams = Omit<Parameters<typeof OrdersService.prototype.listMetadataBids>[0], 'chainName'>;
+export interface MetadataBidResult {
+    result: MetadataBid;
+}
+export interface ListMetadataBidsResult {
+    page: Page;
+    result: MetadataBid[];
+}
+export type PrepareMetadataBidParams = PrepareCollectionBidParams;
+export type PrepareMetadataBidResponse = PrepareOrderResponse;
+export interface CreateMetadataBidParams extends CreateCollectionBidParams {
+    metadataId: string;
+}
 export interface FulfillmentOrder {
     orderId: string;
     takerFees: FeeValue[];

package/package.json

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