@opensea/sdk 9.0.0

package/lib/src/api/types.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderEventType = exports.AssetEventType = exports.TraitDisplayType = exports.OrderStatus = exports.CollectionOrderByOption = void 0;
+var CollectionOrderByOption;
+(function (CollectionOrderByOption) {
+    CollectionOrderByOption["CREATED_DATE"] = "created_date";
+    CollectionOrderByOption["ONE_DAY_CHANGE"] = "one_day_change";
+    CollectionOrderByOption["SEVEN_DAY_VOLUME"] = "seven_day_volume";
+    CollectionOrderByOption["SEVEN_DAY_CHANGE"] = "seven_day_change";
+    CollectionOrderByOption["NUM_OWNERS"] = "num_owners";
+    CollectionOrderByOption["MARKET_CAP"] = "market_cap";
+})(CollectionOrderByOption || (exports.CollectionOrderByOption = CollectionOrderByOption = {}));
+/**
+ * Order status enum.
+ * @category API Models
+ */
+var OrderStatus;
+(function (OrderStatus) {
+    OrderStatus["ACTIVE"] = "ACTIVE";
+    OrderStatus["INACTIVE"] = "INACTIVE";
+    OrderStatus["FULFILLED"] = "FULFILLED";
+    OrderStatus["EXPIRED"] = "EXPIRED";
+    OrderStatus["CANCELLED"] = "CANCELLED";
+})(OrderStatus || (exports.OrderStatus = OrderStatus = {}));
+/**
+ * Trait display type returned by OpenSea API.
+ * @category API Models
+ */
+var TraitDisplayType;
+(function (TraitDisplayType) {
+    TraitDisplayType["NUMBER"] = "number";
+    TraitDisplayType["BOOST_PERCENTAGE"] = "boost_percentage";
+    TraitDisplayType["BOOST_NUMBER"] = "boost_number";
+    TraitDisplayType["AUTHOR"] = "author";
+    TraitDisplayType["DATE"] = "date";
+    /** "None" is used for string traits */
+    TraitDisplayType["NONE"] = "None";
+})(TraitDisplayType || (exports.TraitDisplayType = TraitDisplayType = {}));
+/**
+ * Asset event type returned by OpenSea API.
+ * @category API Models
+ */
+var AssetEventType;
+(function (AssetEventType) {
+    AssetEventType["SALE"] = "sale";
+    AssetEventType["TRANSFER"] = "transfer";
+    AssetEventType["MINT"] = "mint";
+    AssetEventType["LISTING"] = "listing";
+    AssetEventType["ORDER"] = "order";
+    AssetEventType["OFFER"] = "offer";
+    AssetEventType["TRAIT_OFFER"] = "trait_offer";
+    AssetEventType["COLLECTION_OFFER"] = "collection_offer";
+})(AssetEventType || (exports.AssetEventType = AssetEventType = {}));
+/**
+ * Order type for order events.
+ * @category API Models
+ */
+var OrderEventType;
+(function (OrderEventType) {
+    OrderEventType["LISTING"] = "listing";
+    OrderEventType["ITEM_OFFER"] = "item_offer";
+    OrderEventType["COLLECTION_OFFER"] = "collection_offer";
+    OrderEventType["TRAIT_OFFER"] = "trait_offer";
+})(OrderEventType || (exports.OrderEventType = OrderEventType = {}));
+//# sourceMappingURL=types.js.map

package/lib/src/api/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/api/types.ts"],"names":[],"mappings":";;;AAmHA,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,wDAA6B,CAAA;IAC7B,4DAAiC,CAAA;IACjC,gEAAqC,CAAA;IACrC,gEAAqC,CAAA;IACrC,oDAAyB,CAAA;IACzB,oDAAyB,CAAA;AAC3B,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC;AAED;;;GAGG;AACH,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,gCAAiB,CAAA;IACjB,oCAAqB,CAAA;IACrB,sCAAuB,CAAA;IACvB,kCAAmB,CAAA;IACnB,sCAAuB,CAAA;AACzB,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB;AA4ND;;;GAGG;AACH,IAAY,gBAQX;AARD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,yDAAqC,CAAA;IACrC,iDAA6B,CAAA;IAC7B,qCAAiB,CAAA;IACjB,iCAAa,CAAA;IACb,uCAAuC;IACvC,iCAAa,CAAA;AACf,CAAC,EARW,gBAAgB,gCAAhB,gBAAgB,QAQ3B;AAED;;;GAGG;AACH,IAAY,cASX;AATD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,uCAAqB,CAAA;IACrB,+BAAa,CAAA;IACb,qCAAmB,CAAA;IACnB,iCAAe,CAAA;IACf,iCAAe,CAAA;IACf,6CAA2B,CAAA;IAC3B,uDAAqC,CAAA;AACvC,CAAC,EATW,cAAc,8BAAd,cAAc,QASzB;AAED;;;GAGG;AACH,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,2CAAyB,CAAA;IACzB,uDAAqC,CAAA;IACrC,6CAA2B,CAAA;AAC7B,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB"}

package/lib/src/constants.d.ts

@@ -0,0 +1,22 @@
+import { FixedNumber } from "ethers";
+export declare const FIXED_NUMBER_100: FixedNumber;
+export declare const INVERSE_BASIS_POINT = 10000n;
+export declare const API_BASE_MAINNET = "https://api.opensea.io";
+export declare const OPENSEA_FEE_RECIPIENT = "0x0000a26b00c1f0df003000390027140000faa719";
+export declare const OPENSEA_CONDUIT_KEY = "0x0000007b02230091a7ed01230072f7006a004d60a8d4e71d599b8104250f0000";
+export declare const OPENSEA_CONDUIT_ADDRESS = "0x1e0049783f008a0085193e00003d00cd54003c71";
+export declare const OPENSEA_CONDUIT_KEY_2 = "0x61159fefdfada89302ed55f8b9e89e2d67d8258712b3a3f89aa88525877f1d5e";
+export declare const OPENSEA_CONDUIT_ADDRESS_2 = "0x963f00d3ff000064ffcba824b800c0000000c300";
+export declare const OPENSEA_SIGNED_ZONE_V2 = "0x000056f7000000ece9003ca63978907a00ffd100";
+export declare const ALTERNATE_CONDUIT_ADDRESS = "0x00000000001566479594a2e05532d81afa09bc52";
+export declare const ALTERNATE_CONDUIT_KEY = "0x86d26897267711ea4b173c8c124a0a73612001da35562f1ee3b26929b6575e89";
+export declare const ALTERNATE_SEAPORT_V1_6_ADDRESS = "0x00000000006687982678b03100B9bDC8be440814";
+export declare const ALTERNATE_SIGNED_ZONE_V2_ADDRESS = "0xdfe0000000005ce3008800300037e4c803ed08c7";
+export declare const GUNZILLA_FEE_RECIPIENT = "0xd9f68d28e451a83affdb7c71cc2c20552555b07f";
+export declare const SOMNIA_FEE_RECIPIENT = "0xdfe1593dca6ad8a20eeb418643e48577c1626f7c";
+export declare const ALTERNATE_FEE_RECIPIENT = "0x07d3a100c3880830dd43fe5c938b5144721ce9d6";
+export declare const WPOL_ADDRESS = "0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270";
+export declare const MULTICALL3_ADDRESS = "0xcA11bde05977b3631167028862bE2a173976CA11";
+export declare const TRANSFER_HELPER_ADDRESS = "0x0000000000c2d145a2526bd8c716263bfebe1a72";
+export declare const SHARED_STOREFRONT_ADDRESSES: Set<string>;
+export declare const SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS = "0xa604060890923ff400e8c6f5290461a83aedacec";

package/lib/src/constants.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS = exports.SHARED_STOREFRONT_ADDRESSES = exports.TRANSFER_HELPER_ADDRESS = exports.MULTICALL3_ADDRESS = exports.WPOL_ADDRESS = exports.ALTERNATE_FEE_RECIPIENT = exports.SOMNIA_FEE_RECIPIENT = exports.GUNZILLA_FEE_RECIPIENT = exports.ALTERNATE_SIGNED_ZONE_V2_ADDRESS = exports.ALTERNATE_SEAPORT_V1_6_ADDRESS = exports.ALTERNATE_CONDUIT_KEY = exports.ALTERNATE_CONDUIT_ADDRESS = exports.OPENSEA_SIGNED_ZONE_V2 = exports.OPENSEA_CONDUIT_ADDRESS_2 = exports.OPENSEA_CONDUIT_KEY_2 = exports.OPENSEA_CONDUIT_ADDRESS = exports.OPENSEA_CONDUIT_KEY = exports.OPENSEA_FEE_RECIPIENT = exports.API_BASE_MAINNET = exports.INVERSE_BASIS_POINT = exports.FIXED_NUMBER_100 = void 0;
+const ethers_1 = require("ethers");
+// =============================================================================
+// Math & Calculation Constants
+// =============================================================================
+exports.FIXED_NUMBER_100 = ethers_1.FixedNumber.fromValue(100);
+exports.INVERSE_BASIS_POINT = 10000n; // 100 basis points per 1%
+// =============================================================================
+// API Configuration
+// =============================================================================
+exports.API_BASE_MAINNET = "https://api.opensea.io";
+// =============================================================================
+// OpenSea Protocol Addresses
+// =============================================================================
+exports.OPENSEA_FEE_RECIPIENT = "0x0000a26b00c1f0df003000390027140000faa719";
+exports.OPENSEA_CONDUIT_KEY = "0x0000007b02230091a7ed01230072f7006a004d60a8d4e71d599b8104250f0000";
+exports.OPENSEA_CONDUIT_ADDRESS = "0x1e0049783f008a0085193e00003d00cd54003c71";
+exports.OPENSEA_CONDUIT_KEY_2 = "0x61159fefdfada89302ed55f8b9e89e2d67d8258712b3a3f89aa88525877f1d5e";
+exports.OPENSEA_CONDUIT_ADDRESS_2 = "0x963f00d3ff000064ffcba824b800c0000000c300";
+exports.OPENSEA_SIGNED_ZONE_V2 = "0x000056f7000000ece9003ca63978907a00ffd100";
+// =============================================================================
+// Alternate Protocol Constants (shared by Gunzilla, Somnia, etc.)
+// =============================================================================
+exports.ALTERNATE_CONDUIT_ADDRESS = "0x00000000001566479594a2e05532d81afa09bc52";
+exports.ALTERNATE_CONDUIT_KEY = "0x86d26897267711ea4b173c8c124a0a73612001da35562f1ee3b26929b6575e89";
+exports.ALTERNATE_SEAPORT_V1_6_ADDRESS = "0x00000000006687982678b03100B9bDC8be440814";
+exports.ALTERNATE_SIGNED_ZONE_V2_ADDRESS = "0xdfe0000000005ce3008800300037e4c803ed08c7";
+// =============================================================================
+// Chain-Specific Fee Recipients
+// =============================================================================
+exports.GUNZILLA_FEE_RECIPIENT = "0xd9f68d28e451a83affdb7c71cc2c20552555b07f";
+exports.SOMNIA_FEE_RECIPIENT = "0xdfe1593dca6ad8a20eeb418643e48577c1626f7c";
+exports.ALTERNATE_FEE_RECIPIENT = "0x07d3a100c3880830dd43fe5c938b5144721ce9d6";
+// =============================================================================
+// Token & Helper Addresses
+// =============================================================================
+exports.WPOL_ADDRESS = "0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270";
+exports.MULTICALL3_ADDRESS = "0xcA11bde05977b3631167028862bE2a173976CA11";
+exports.TRANSFER_HELPER_ADDRESS = "0x0000000000c2d145a2526bd8c716263bfebe1a72";
+// =============================================================================
+// Shared Storefront Addresses
+// =============================================================================
+const SHARED_STOREFRONT_ADDRESS_MAINNET = "0x495f947276749ce646f68ac8c248420045cb7b5e";
+const SHARED_STOREFRONT_ADDRESS_POLYGON = "0x2953399124f0cbb46d2cbacd8a89cf0599974963";
+exports.SHARED_STOREFRONT_ADDRESSES = new Set([
+    SHARED_STOREFRONT_ADDRESS_MAINNET,
+    SHARED_STOREFRONT_ADDRESS_POLYGON,
+]);
+exports.SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS = "0xa604060890923ff400e8c6f5290461a83aedacec";
+//# sourceMappingURL=constants.js.map

package/lib/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AAEpC,gFAAgF;AAChF,+BAA+B;AAC/B,gFAAgF;AAEnE,QAAA,gBAAgB,GAAG,oBAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;AAC7C,QAAA,mBAAmB,GAAG,MAAO,CAAA,CAAC,0BAA0B;AAErE,gFAAgF;AAChF,oBAAoB;AACpB,gFAAgF;AAEnE,QAAA,gBAAgB,GAAG,wBAAwB,CAAA;AAExD,gFAAgF;AAChF,6BAA6B;AAC7B,gFAAgF;AAEnE,QAAA,qBAAqB,GAChC,4CAA4C,CAAA;AAEjC,QAAA,mBAAmB,GAC9B,oEAAoE,CAAA;AAEzD,QAAA,uBAAuB,GAClC,4CAA4C,CAAA;AAEjC,QAAA,qBAAqB,GAChC,oEAAoE,CAAA;AAEzD,QAAA,yBAAyB,GACpC,4CAA4C,CAAA;AAEjC,QAAA,sBAAsB,GACjC,4CAA4C,CAAA;AAE9C,gFAAgF;AAChF,kEAAkE;AAClE,gFAAgF;AAEnE,QAAA,yBAAyB,GACpC,4CAA4C,CAAA;AAEjC,QAAA,qBAAqB,GAChC,oEAAoE,CAAA;AAEzD,QAAA,8BAA8B,GACzC,4CAA4C,CAAA;AAEjC,QAAA,gCAAgC,GAC3C,4CAA4C,CAAA;AAE9C,gFAAgF;AAChF,gCAAgC;AAChC,gFAAgF;AAEnE,QAAA,sBAAsB,GACjC,4CAA4C,CAAA;AAEjC,QAAA,oBAAoB,GAAG,4CAA4C,CAAA;AAEnE,QAAA,uBAAuB,GAClC,4CAA4C,CAAA;AAE9C,gFAAgF;AAChF,2BAA2B;AAC3B,gFAAgF;AAEnE,QAAA,YAAY,GAAG,4CAA4C,CAAA;AAE3D,QAAA,kBAAkB,GAAG,4CAA4C,CAAA;AAEjE,QAAA,uBAAuB,GAClC,4CAA4C,CAAA;AAE9C,gFAAgF;AAChF,8BAA8B;AAC9B,gFAAgF;AAEhF,MAAM,iCAAiC,GACrC,4CAA4C,CAAA;AAC9C,MAAM,iCAAiC,GACrC,4CAA4C,CAAA;AACjC,QAAA,2BAA2B,GAAG,IAAI,GAAG,CAAC;IACjD,iCAAiC;IACjC,iCAAiC;CAClC,CAAC,CAAA;AACW,QAAA,uDAAuD,GAClE,4CAA4C,CAAA"}

package/lib/src/index.d.ts

@@ -0,0 +1,18 @@
+import { OpenSeaSDK } from "./sdk";
+export * from "./api/types";
+export * from "./orders/types";
+export * from "./types";
+export * from "./utils";
+/**
+ * @example
+ * // Example Setup
+ * ```ts
+ * import { ethers } from 'ethers'
+ * import { OpenSeaSDK, Chain } from 'opensea-js'
+ * const provider = new ethers.JsonRpcProvider('https://mainnet.infura.io')
+ * const client = new OpenSeaSDK(provider, {
+ *   chain: Chain.Mainnet
+ * })
+ * ```
+ */
+export { OpenSeaSDK, };

package/lib/src/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenSeaSDK = void 0;
+const sdk_1 = require("./sdk");
+Object.defineProperty(exports, "OpenSeaSDK", { enumerable: true, get: function () { return sdk_1.OpenSeaSDK; } });
+__exportStar(require("./api/types"), exports);
+__exportStar(require("./orders/types"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);
+//# sourceMappingURL=index.js.map

package/lib/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+BAAkC;AAoBhC,2FApBO,gBAAU,OAoBP;AAlBZ,8CAA2B;AAC3B,iDAA8B;AAC9B,0CAAuB;AACvB,0CAAuB"}

package/lib/src/orders/privateListings.d.ts

@@ -0,0 +1,12 @@
+import type { ConsiderationInputItem, CreateInputItem, MatchOrdersFulfillment, Order, OrderWithCounter } from "@opensea/seaport-js/lib/types";
+/**
+ * Compute the native currency (ETH) value required to fulfill a private listing.
+ * Sums all native currency consideration items not going to the taker.
+ * @param order The private listing order
+ * @param takerAddress The address of the private listing recipient
+ * @returns The total native currency value as a bigint
+ */
+export declare const computePrivateListingValue: (order: OrderWithCounter, takerAddress: string) => bigint;
+export declare const getPrivateListingConsiderations: (offer: CreateInputItem[], privateSaleRecipient: string) => ConsiderationInputItem[];
+export declare const constructPrivateListingCounterOrder: (order: OrderWithCounter, privateSaleRecipient: string) => Order;
+export declare const getPrivateListingFulfillments: (privateListingOrder: OrderWithCounter) => MatchOrdersFulfillment[];

package/lib/src/orders/privateListings.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPrivateListingFulfillments = exports.constructPrivateListingCounterOrder = exports.getPrivateListingConsiderations = exports.computePrivateListingValue = void 0;
+const constants_1 = require("@opensea/seaport-js/lib/constants");
+const item_1 = require("@opensea/seaport-js/lib/utils/item");
+const order_1 = require("@opensea/seaport-js/lib/utils/order");
+const ethers_1 = require("ethers");
+/**
+ * Compute the native currency (ETH) value required to fulfill a private listing.
+ * Sums all native currency consideration items not going to the taker.
+ * @param order The private listing order
+ * @param takerAddress The address of the private listing recipient
+ * @returns The total native currency value as a bigint
+ */
+const computePrivateListingValue = (order, takerAddress) => {
+    return order.parameters.consideration
+        .filter(item => item.recipient.toLowerCase() !== takerAddress.toLowerCase() &&
+        item.token.toLowerCase() === ethers_1.ZeroAddress.toLowerCase() &&
+        item.itemType === constants_1.ItemType.NATIVE)
+        .reduce((sum, item) => sum + BigInt(item.startAmount), 0n);
+};
+exports.computePrivateListingValue = computePrivateListingValue;
+const getPrivateListingConsiderations = (offer, privateSaleRecipient) => {
+    return offer.map(item => {
+        return { ...item, recipient: privateSaleRecipient };
+    });
+};
+exports.getPrivateListingConsiderations = getPrivateListingConsiderations;
+const constructPrivateListingCounterOrder = (order, privateSaleRecipient) => {
+    // Counter order offers up all the items in the private listing consideration
+    // besides the items that are going to the private listing recipient
+    const paymentItems = order.parameters.consideration.filter(item => item.recipient.toLowerCase() !== privateSaleRecipient.toLowerCase());
+    // Only validate payment items if there are any (zero-payment private listings are valid)
+    if (paymentItems.length > 0) {
+        if (!paymentItems.every(item => (0, item_1.isCurrencyItem)(item))) {
+            throw new Error("The consideration for the private listing did not contain only currency items");
+        }
+        if (!paymentItems.every(item => item.itemType === paymentItems[0].itemType)) {
+            throw new Error("Not all currency items were the same for private order");
+        }
+    }
+    const { aggregatedStartAmount, aggregatedEndAmount } = paymentItems.reduce(({ aggregatedStartAmount, aggregatedEndAmount }, item) => ({
+        aggregatedStartAmount: aggregatedStartAmount + BigInt(item.startAmount),
+        aggregatedEndAmount: aggregatedEndAmount + BigInt(item.endAmount),
+    }), {
+        aggregatedStartAmount: 0n,
+        aggregatedEndAmount: 0n,
+    });
+    const counterOrder = {
+        parameters: {
+            ...order.parameters,
+            offerer: privateSaleRecipient,
+            // Empty offer for zero-payment private listings, single aggregated item otherwise
+            offer: paymentItems.length > 0
+                ? [
+                    {
+                        itemType: paymentItems[0].itemType,
+                        token: paymentItems[0].token,
+                        identifierOrCriteria: paymentItems[0].identifierOrCriteria,
+                        startAmount: aggregatedStartAmount.toString(),
+                        endAmount: aggregatedEndAmount.toString(),
+                    },
+                ]
+                : [],
+            // The consideration here is empty as the original private listing order supplies
+            // the taker address to receive the desired items.
+            consideration: [],
+            salt: (0, order_1.generateRandomSalt)(),
+            totalOriginalConsiderationItems: 0,
+        },
+        signature: "0x",
+    };
+    return counterOrder;
+};
+exports.constructPrivateListingCounterOrder = constructPrivateListingCounterOrder;
+const getPrivateListingFulfillments = (privateListingOrder) => {
+    const nftRelatedFulfillments = [];
+    // For the original order, we need to match everything offered with every consideration item
+    // on the original order that's set to go to the private listing recipient
+    privateListingOrder.parameters.offer.forEach((offerItem, offerIndex) => {
+        const considerationIndex = privateListingOrder.parameters.consideration.findIndex(considerationItem => considerationItem.itemType === offerItem.itemType &&
+            considerationItem.token === offerItem.token &&
+            considerationItem.identifierOrCriteria ===
+                offerItem.identifierOrCriteria);
+        if (considerationIndex === -1) {
+            throw new Error("Could not find matching offer item in the consideration for private listing");
+        }
+        nftRelatedFulfillments.push({
+            offerComponents: [
+                {
+                    orderIndex: 0,
+                    itemIndex: offerIndex,
+                },
+            ],
+            considerationComponents: [
+                {
+                    orderIndex: 0,
+                    itemIndex: considerationIndex,
+                },
+            ],
+        });
+    });
+    const currencyRelatedFulfillments = [];
+    // For the original order, we need to match everything offered with every consideration item
+    // on the original order that's set to go to the private listing recipient
+    privateListingOrder.parameters.consideration.forEach((considerationItem, considerationIndex) => {
+        if (!(0, item_1.isCurrencyItem)(considerationItem)) {
+            return;
+        }
+        // We always match the offer item (index 0) of the counter order (index 1)
+        // with all of the payment items on the private listing
+        currencyRelatedFulfillments.push({
+            offerComponents: [
+                {
+                    orderIndex: 1,
+                    itemIndex: 0,
+                },
+            ],
+            considerationComponents: [
+                {
+                    orderIndex: 0,
+                    itemIndex: considerationIndex,
+                },
+            ],
+        });
+    });
+    return [...nftRelatedFulfillments, ...currencyRelatedFulfillments];
+};
+exports.getPrivateListingFulfillments = getPrivateListingFulfillments;
+//# sourceMappingURL=privateListings.js.map

package/lib/src/orders/privateListings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"privateListings.js","sourceRoot":"","sources":["../../../src/orders/privateListings.ts"],"names":[],"mappings":";;;AAAA,iEAA4D;AAQ5D,6DAAmE;AACnE,+DAAwE;AACxE,mCAAoC;AAEpC;;;;;;GAMG;AACI,MAAM,0BAA0B,GAAG,CACxC,KAAuB,EACvB,YAAoB,EACZ,EAAE;IACV,OAAO,KAAK,CAAC,UAAU,CAAC,aAAa;SAClC,MAAM,CACL,IAAI,CAAC,EAAE,CACL,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,WAAW,EAAE;QAC3D,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,oBAAW,CAAC,WAAW,EAAE;QACtD,IAAI,CAAC,QAAQ,KAAK,oBAAQ,CAAC,MAAM,CACpC;SACA,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,CAAA;AAC9D,CAAC,CAAA;AAZY,QAAA,0BAA0B,8BAYtC;AAEM,MAAM,+BAA+B,GAAG,CAC7C,KAAwB,EACxB,oBAA4B,EACF,EAAE;IAC5B,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QACtB,OAAO,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAA;IACrD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAPY,QAAA,+BAA+B,mCAO3C;AAEM,MAAM,mCAAmC,GAAG,CACjD,KAAuB,EACvB,oBAA4B,EACrB,EAAE;IACT,6EAA6E;IAC7E,oEAAoE;IACpE,MAAM,YAAY,GAAG,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,CACxD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,oBAAoB,CAAC,WAAW,EAAE,CAC5E,CAAA;IAED,yFAAyF;IACzF,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,qBAAc,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAA;QACH,CAAC;QACD,IACE,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EACvE,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;QAC3E,CAAC;IACH,CAAC;IAED,MAAM,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,GAAG,YAAY,CAAC,MAAM,CACxE,CAAC,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACzD,qBAAqB,EAAE,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;QACvE,mBAAmB,EAAE,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;KAClE,CAAC,EACF;QACE,qBAAqB,EAAE,EAAE;QACzB,mBAAmB,EAAE,EAAE;KACxB,CACF,CAAA;IAED,MAAM,YAAY,GAAU;QAC1B,UAAU,EAAE;YACV,GAAG,KAAK,CAAC,UAAU;YACnB,OAAO,EAAE,oBAAoB;YAC7B,kFAAkF;YAClF,KAAK,EACH,YAAY,CAAC,MAAM,GAAG,CAAC;gBACrB,CAAC,CAAC;oBACE;wBACE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ;wBAClC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK;wBAC5B,oBAAoB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,oBAAoB;wBAC1D,WAAW,EAAE,qBAAqB,CAAC,QAAQ,EAAE;wBAC7C,SAAS,EAAE,mBAAmB,CAAC,QAAQ,EAAE;qBAC1C;iBACF;gBACH,CAAC,CAAC,EAAE;YACR,iFAAiF;YACjF,kDAAkD;YAClD,aAAa,EAAE,EAAE;YACjB,IAAI,EAAE,IAAA,0BAAkB,GAAE;YAC1B,+BAA+B,EAAE,CAAC;SACnC;QACD,SAAS,EAAE,IAAI;KAChB,CAAA;IAED,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA;AA9DY,QAAA,mCAAmC,uCA8D/C;AAEM,MAAM,6BAA6B,GAAG,CAC3C,mBAAqC,EACX,EAAE;IAC5B,MAAM,sBAAsB,GAA6B,EAAE,CAAA;IAE3D,4FAA4F;IAC5F,0EAA0E;IAC1E,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE;QACrE,MAAM,kBAAkB,GACtB,mBAAmB,CAAC,UAAU,CAAC,aAAa,CAAC,SAAS,CACpD,iBAAiB,CAAC,EAAE,CAClB,iBAAiB,CAAC,QAAQ,KAAK,SAAS,CAAC,QAAQ;YACjD,iBAAiB,CAAC,KAAK,KAAK,SAAS,CAAC,KAAK;YAC3C,iBAAiB,CAAC,oBAAoB;gBACpC,SAAS,CAAC,oBAAoB,CACnC,CAAA;QACH,IAAI,kBAAkB,KAAK,CAAC,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAA;QACH,CAAC;QACD,sBAAsB,CAAC,IAAI,CAAC;YAC1B,eAAe,EAAE;gBACf;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,UAAU;iBACtB;aACF;YACD,uBAAuB,EAAE;gBACvB;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,kBAAkB;iBAC9B;aACF;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,MAAM,2BAA2B,GAA6B,EAAE,CAAA;IAEhE,4FAA4F;IAC5F,0EAA0E;IAC1E,mBAAmB,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAClD,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,EAAE;QACxC,IAAI,CAAC,IAAA,qBAAc,EAAC,iBAAiB,CAAC,EAAE,CAAC;YACvC,OAAM;QACR,CAAC;QACD,0EAA0E;QAC1E,uDAAuD;QACvD,2BAA2B,CAAC,IAAI,CAAC;YAC/B,eAAe,EAAE;gBACf;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,CAAC;iBACb;aACF;YACD,uBAAuB,EAAE;gBACvB;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,kBAAkB;iBAC9B;aACF;SACF,CAAC,CAAA;IACJ,CAAC,CACF,CAAA;IAED,OAAO,CAAC,GAAG,sBAAsB,EAAE,GAAG,2BAA2B,CAAC,CAAA;AACpE,CAAC,CAAA;AAlEY,QAAA,6BAA6B,iCAkEzC"}

package/lib/src/orders/types.d.ts

@@ -0,0 +1,160 @@
+import type { BasicOrderParametersStruct } from "@opensea/seaport-js/lib/typechain-types/seaport/contracts/Seaport";
+import type { AdvancedOrder, OrderWithCounter } from "@opensea/seaport-js/lib/types";
+import type { Listing, Offer } from "../api/types";
+import type { OpenSeaAccount, OrderSide } from "../types";
+type OrderProtocolToProtocolData = {
+    seaport: OrderWithCounter;
+};
+export type OrderProtocol = keyof OrderProtocolToProtocolData;
+export type ProtocolData = OrderProtocolToProtocolData[keyof OrderProtocolToProtocolData];
+export declare enum OrderType {
+    BASIC = "basic",
+    ENGLISH = "english",
+    CRITERIA = "criteria"
+}
+type OrderFee = {
+    account: OpenSeaAccount;
+    basisPoints: string;
+};
+/**
+ * The latest OpenSea Order schema.
+ */
+export type OrderV2 = {
+    /** The date the order was created. */
+    createdDate: string;
+    /** The date the order was closed. */
+    closingDate: string | null;
+    /** The date the order was listed. Order can be created before the listing time. */
+    listingTime: number;
+    /** The date the order expires. */
+    expirationTime: number;
+    /** The hash of the order. */
+    orderHash: string | null;
+    /** The account that created the order. */
+    maker: OpenSeaAccount;
+    /** The account that filled the order. */
+    taker: OpenSeaAccount | null;
+    /** The protocol data for the order. Only 'seaport' is currently supported. */
+    protocolData: ProtocolData;
+    /** The contract address of the protocol. */
+    protocolAddress: string;
+    /** The current price of the order. */
+    currentPrice: bigint;
+    /** The maker fees for the order. */
+    makerFees: OrderFee[];
+    /** The taker fees for the order. */
+    takerFees: OrderFee[];
+    /** The side of the order. Listing/Offer */
+    side: OrderSide;
+    /** The type of the order. Basic/English/Criteria */
+    orderType: OrderType;
+    /** Whether or not the maker has cancelled the order. */
+    cancelled: boolean;
+    /** Whether or not the order is finalized. */
+    finalized: boolean;
+    /** Whether or not the order is marked invalid and therefore not fillable. */
+    markedInvalid: boolean;
+    /** The signature the order is signed with. */
+    clientSignature: string | null;
+    /** Amount of items left in the order which can be taken. */
+    remainingQuantity: number;
+};
+export type FulfillmentDataResponse = {
+    protocol: string;
+    fulfillment_data: FulfillmentData;
+};
+type FulfillmentData = {
+    transaction: Transaction;
+    orders: ProtocolData[];
+};
+type Transaction = {
+    function: string;
+    chain: number;
+    to: string;
+    value: string;
+    input_data: {
+        advancedOrder: AdvancedOrder;
+        criteriaResolvers?: unknown[];
+        fulfillerConduitKey?: string;
+        recipient: string;
+    } | {
+        basicOrderParameters: BasicOrderParametersStruct;
+    } | {
+        order: OrderWithCounter;
+        fulfillerConduitKey?: string;
+        recipient: string;
+    } | {
+        orders: OrderWithCounter[] | AdvancedOrder[] | BasicOrderParametersStruct[];
+    };
+};
+type OpenOrderOrderingOption = "created_date" | "eth_price";
+type OrderByDirection = "asc" | "desc";
+export type OrderAPIOptions = {
+    protocol?: OrderProtocol;
+    protocolAddress?: string;
+    side: OrderSide;
+};
+export type OrdersQueryOptions = OrderAPIOptions & {
+    limit?: number;
+    cursor?: string;
+    next?: string;
+    paymentTokenAddress?: string;
+    maker?: string;
+    taker?: string;
+    owner?: string;
+    listedAfter?: number | string;
+    listedBefore?: number | string;
+    tokenId?: string;
+    tokenIds?: string[];
+    assetContractAddress?: string;
+    orderBy?: OpenOrderOrderingOption;
+    orderDirection?: OrderByDirection;
+    onlyEnglish?: boolean;
+};
+export type SerializedOrderV2 = {
+    created_date: string;
+    closing_date: string | null;
+    listing_time: number;
+    expiration_time: number;
+    order_hash: string | null;
+    maker: unknown;
+    taker: unknown | null;
+    protocol_data: ProtocolData;
+    protocol_address: string;
+    current_price: string;
+    maker_fees: {
+        account: unknown;
+        basis_points: string;
+    }[];
+    taker_fees: {
+        account: unknown;
+        basis_points: string;
+    }[];
+    side: OrderSide;
+    order_type: OrderType;
+    cancelled: boolean;
+    finalized: boolean;
+    marked_invalid: boolean;
+    client_signature: string | null;
+    remaining_quantity: number;
+};
+export type QueryCursors = {
+    next: string | null;
+    previous: string | null;
+};
+export type OrdersQueryResponse = QueryCursors & {
+    orders: SerializedOrderV2[];
+};
+/** @deprecated Use ListingPostQueryResponse or OfferPostQueryResponse instead. */
+export type OrdersPostQueryResponse = {
+    order: SerializedOrderV2;
+};
+export type ListingPostQueryResponse = {
+    order: SerializedOrderV2;
+    listing: Listing;
+};
+export type OfferPostQueryResponse = {
+    order: SerializedOrderV2;
+    offer: Offer;
+};
+export {};

package/lib/src/orders/types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderType = void 0;
+var OrderType;
+(function (OrderType) {
+    OrderType["BASIC"] = "basic";
+    OrderType["ENGLISH"] = "english";
+    OrderType["CRITERIA"] = "criteria";
+})(OrderType || (exports.OrderType = OrderType = {}));
+//# sourceMappingURL=types.js.map

package/lib/src/orders/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/orders/types.ts"],"names":[],"mappings":";;;AAgBA,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;AACvB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB"}

package/lib/src/orders/utils.d.ts

@@ -0,0 +1,89 @@
+import { type Chain, OrderSide } from "../types";
+import type { OrdersQueryOptions, OrderV2, ProtocolData, SerializedOrderV2 } from "./types";
+export declare const DEFAULT_SEAPORT_CONTRACT_ADDRESS = "0x0000000000000068F116a894984e2DB1123eB395";
+export declare const getPostCollectionOfferPayload: (collectionSlug: string, protocol_data: ProtocolData, chain: Chain, traitType?: string, traitValue?: string, traits?: Array<{
+    type: string;
+    value: string;
+}>, numericTraits?: Array<{
+    type: string;
+    min?: number;
+    max?: number;
+}>) => {
+    criteria: {
+        collection: {
+            slug: string;
+        };
+    };
+    protocol_data: import("@opensea/seaport-js/lib/types").OrderWithCounter;
+    protocol_address: string;
+};
+export declare const getBuildCollectionOfferPayload: (offererAddress: string, quantity: number, collectionSlug: string, offerProtectionEnabled: boolean, chain: Chain, traitType?: string, traitValue?: string, traits?: Array<{
+    type: string;
+    value: string;
+}>, numericTraits?: Array<{
+    type: string;
+    min?: number;
+    max?: number;
+}>) => {
+    offerer: string;
+    quantity: number;
+    criteria: {
+        collection: {
+            slug: string;
+        };
+    };
+    protocol_address: string;
+    offer_protection_enabled: boolean;
+};
+export declare const getFulfillmentDataPath: (side: OrderSide) => string;
+export declare const getFulfillListingPayload: (fulfillerAddress: string, order_hash: string, protocolAddress: string, chain: Chain, assetContractAddress?: string, tokenId?: string, unitsToFill?: string, recipientAddress?: string, includeOptionalCreatorFees?: boolean) => {
+    listing: {
+        hash: string;
+        chain: Chain;
+        protocol_address: string;
+    };
+    fulfiller: {
+        address: string;
+    };
+    consideration?: {
+        asset_contract_address: string;
+        token_id: string;
+    };
+    units_to_fill: string;
+    recipient?: string;
+    include_optional_creator_fees: boolean;
+};
+export declare const getFulfillOfferPayload: (fulfillerAddress: string, order_hash: string, protocolAddress: string, chain: Chain, assetContractAddress?: string, tokenId?: string, unitsToFill?: string, includeOptionalCreatorFees?: boolean) => {
+    offer: {
+        hash: string;
+        chain: Chain;
+        protocol_address: string;
+    };
+    fulfiller: {
+        address: string;
+    };
+    consideration?: {
+        asset_contract_address: string;
+        token_id: string;
+    };
+    units_to_fill: string;
+    include_optional_creator_fees: boolean;
+};
+type OrdersQueryPathOptions = "protocol" | "side";
+export declare const serializeOrdersQueryOptions: (options: Omit<OrdersQueryOptions, OrdersQueryPathOptions>) => {
+    limit: number | undefined;
+    cursor: string | undefined;
+    payment_token_address: string | undefined;
+    maker: string | undefined;
+    taker: string | undefined;
+    owner: string | undefined;
+    listed_after: string | number | undefined;
+    listed_before: string | number | undefined;
+    token_ids: string[] | undefined;
+    asset_contract_address: string | undefined;
+    order_by: ("created_date" | "eth_price") | undefined;
+    order_direction: ("asc" | "desc") | undefined;
+    only_english: boolean | undefined;
+};
+export declare const deserializeOrder: (order: SerializedOrderV2) => OrderV2;
+export {};