@opensea/sdk 9.0.0

package/lib/sdk/fulfillment.js

@@ -0,0 +1,298 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FulfillmentManager = void 0;
+const Seaport_1 = require("@opensea/seaport-js/lib/abi/Seaport");
+const ethers_1 = require("ethers");
+const privateListings_1 = require("../orders/privateListings");
+const types_1 = require("../orders/types");
+const utils_1 = require("../orders/utils");
+const types_2 = require("../types");
+const utils_2 = require("../utils/utils");
+const FULFILL_BASIC_ORDER_ALIAS = "fulfillBasicOrder_efficient_6GL6yc";
+/**
+ * Manager for order fulfillment and validation operations.
+ * Handles fulfilling orders, validating orders onchain, and approving orders.
+ */
+class FulfillmentManager {
+    context;
+    ordersManager;
+    constructor(context, ordersManager) {
+        this.context = context;
+        this.ordersManager = ordersManager;
+    }
+    /**
+     * Fulfill a private order for a designated address.
+     * @param options
+     * @param options.order The order to fulfill
+     * @param options.accountAddress Address of the wallet taking the order.
+     * @param options.domain An optional domain to be hashed and included at the end of fulfillment calldata.
+     *                       This can be used for onchain order attribution to assist with analytics.
+     * @param options.overrides Transaction overrides, ignored if not set.
+     * @returns Transaction hash of the order.
+     */
+    async fulfillPrivateOrder({ order, accountAddress, domain, overrides, }) {
+        if (!order.taker?.address) {
+            throw new Error("Order is not a private listing - must have a taker address");
+        }
+        const counterOrder = (0, privateListings_1.constructPrivateListingCounterOrder)(order.protocolData, order.taker.address);
+        const fulfillments = (0, privateListings_1.getPrivateListingFulfillments)(order.protocolData);
+        // Compute ETH value from original order's consideration items
+        // This handles both standard private listings and zero-payment listings (e.g., rewards)
+        const value = (0, privateListings_1.computePrivateListingValue)(order.protocolData, order.taker.address);
+        const seaport = (0, utils_2.getSeaportInstance)(order.protocolAddress, this.context.seaport);
+        const transaction = await seaport
+            .matchOrders({
+            orders: [order.protocolData, counterOrder],
+            fulfillments,
+            overrides: {
+                ...overrides,
+                value,
+            },
+            accountAddress,
+            domain,
+        })
+            .transact();
+        const transactionReceipt = await transaction.wait();
+        if (!transactionReceipt) {
+            throw new Error("Missing transaction receipt");
+        }
+        await this.context.confirmTransaction(transactionReceipt.hash, types_2.EventType.MatchOrders, "Fulfilling order");
+        return transactionReceipt.hash;
+    }
+    /**
+     * Fulfill an order for an asset. The order can be either a listing or an offer.
+     * Uses the OpenSea API to generate fulfillment transaction data and executes it directly.
+     * @param options
+     * @param options.order The order to fulfill, a.k.a. "take"
+     * @param options.accountAddress Address of the wallet taking the offer.
+     * @param options.assetContractAddress Optional address of the NFT contract for criteria offers (e.g., collection offers). Required when fulfilling collection offers.
+     * @param options.tokenId Optional token ID for criteria offers (e.g., collection offers). Required when fulfilling collection offers.
+     * @param options.unitsToFill Optional number of units to fill. Defaults to 1 for both listings and offers.
+     * @param options.recipientAddress Optional recipient address for the NFT when fulfilling a listing. Not applicable for offers.
+     * @param options.includeOptionalCreatorFees Whether to include optional creator fees in the fulfillment. If creator fees are already required, this is a no-op. Defaults to false.
+     * @param options.overrides Transaction overrides, ignored if not set.
+     * @returns Transaction hash of the order.
+     *
+     * @throws Error if the accountAddress is not available through wallet or provider.
+     * @throws Error if the order's protocol address is not supported by OpenSea. See {@link isValidProtocol}.
+     * @throws Error if a signer is not provided (read-only providers cannot fulfill orders).
+     * @throws Error if the order hash is not available.
+     */
+    async fulfillOrder({ order, accountAddress, assetContractAddress, tokenId, unitsToFill, recipientAddress, includeOptionalCreatorFees = false, overrides, }) {
+        await this.context.requireAccountIsAvailable(accountAddress);
+        const protocolAddress = order.protocolAddress ?? order.protocol_address;
+        (0, utils_2.requireValidProtocol)(protocolAddress);
+        const orderHash = order.orderHash ?? order.order_hash;
+        const side = order.side ??
+            ("type" in order &&
+                [types_1.OrderType.BASIC, types_1.OrderType.ENGLISH].includes(order.type)
+                ? types_2.OrderSide.LISTING
+                : types_2.OrderSide.OFFER);
+        const isPrivateListing = "taker" in order ? !!order.taker : false;
+        if (isPrivateListing) {
+            return this.fulfillPrivateOrder({
+                order: order,
+                accountAddress,
+                overrides,
+            });
+        }
+        // Get fulfillment data from the API
+        if (!orderHash) {
+            throw new Error("Order hash is required to fulfill an order");
+        }
+        // Convert unitsToFill to string, defaulting to "1" if not provided
+        const unitsToFillStr = unitsToFill !== undefined ? unitsToFill.toString() : "1";
+        const fulfillmentData = await this.context.api.generateFulfillmentData(accountAddress, orderHash, protocolAddress, side, assetContractAddress, tokenId, unitsToFillStr, recipientAddress, includeOptionalCreatorFees);
+        // Use the transaction data returned by the API
+        const transaction = fulfillmentData.fulfillment_data.transaction;
+        const inputData = transaction.input_data;
+        // Use Seaport ABI to encode the transaction
+        const seaportInterface = new ethers_1.ethers.Interface(Seaport_1.SeaportABI);
+        // Extract function name and build parameters array in correct order
+        const rawFunctionName = transaction.function.split("(")[0];
+        const functionName = rawFunctionName === FULFILL_BASIC_ORDER_ALIAS
+            ? "fulfillBasicOrder"
+            : rawFunctionName;
+        let params;
+        // Order parameters based on the function being called
+        if (functionName === "fulfillAdvancedOrder" &&
+            "advancedOrder" in inputData) {
+            params = [
+                inputData.advancedOrder,
+                inputData.criteriaResolvers || [],
+                inputData.fulfillerConduitKey ||
+                    "0x0000000000000000000000000000000000000000000000000000000000000000",
+                inputData.recipient,
+            ];
+        }
+        else if ((functionName === "fulfillBasicOrder" ||
+            rawFunctionName === FULFILL_BASIC_ORDER_ALIAS) &&
+            "basicOrderParameters" in inputData) {
+            params = [inputData.basicOrderParameters];
+        }
+        else if (functionName === "fulfillOrder" && "order" in inputData) {
+            params = [
+                inputData.order,
+                inputData.fulfillerConduitKey ||
+                    "0x0000000000000000000000000000000000000000000000000000000000000000",
+            ];
+        }
+        else {
+            // Fallback: try to use values in object order
+            params = Object.values(inputData);
+        }
+        const encodedData = seaportInterface.encodeFunctionData(functionName, params);
+        // Send the transaction using the signer from context
+        const signer = this.context.signerOrProvider;
+        const tx = await signer.sendTransaction({
+            to: transaction.to,
+            value: transaction.value,
+            data: encodedData,
+            ...overrides,
+        });
+        await this.context.confirmTransaction(tx.hash, types_2.EventType.MatchOrders, "Fulfilling order");
+        return tx.hash;
+    }
+    /**
+     * Returns whether an order is fulfillable.
+     * An order may not be fulfillable if a target item's transfer function
+     * is locked for some reason, e.g. an item is being rented within a game
+     * or trading has been locked for an item type.
+     * @param options
+     * @param options.order Order to check
+     * @param options.accountAddress The account address that will be fulfilling the order
+     * @returns True if the order is fulfillable, else False.
+     *
+     * @throws Error if the order's protocol address is not supported by OpenSea. See {@link isValidProtocol}.
+     */
+    async isOrderFulfillable({ order, accountAddress, }) {
+        (0, utils_2.requireValidProtocol)(order.protocolAddress);
+        const seaport = (0, utils_2.getSeaportInstance)(order.protocolAddress, this.context.seaport);
+        try {
+            const isValid = await seaport
+                .validate([order.protocolData], accountAddress)
+                .staticCall();
+            return !!isValid;
+        }
+        catch (error) {
+            if ((0, utils_2.hasErrorCode)(error) && error.code === "CALL_EXCEPTION") {
+                return false;
+            }
+            throw error;
+        }
+    }
+    /**
+     * Instead of signing an off-chain order, this method allows you to approve an order
+     * with an onchain transaction.
+     * @param order Order to approve
+     * @param domain An optional domain to be hashed and included at the end of fulfillment calldata.  This can be used for onchain order attribution to assist with analytics.
+     * @returns Transaction hash of the approval transaction
+     *
+     * @throws Error if the accountAddress is not available through wallet or provider.
+     * @throws Error if the order's protocol address is not supported by OpenSea. See {@link isValidProtocol}.
+     */
+    async approveOrder(order, domain) {
+        await this.context.requireAccountIsAvailable(order.maker.address);
+        (0, utils_2.requireValidProtocol)(order.protocolAddress);
+        this.context.dispatch(types_2.EventType.ApproveOrder, {
+            orderV2: order,
+            accountAddress: order.maker.address,
+        });
+        const seaport = (0, utils_2.getSeaportInstance)(order.protocolAddress, this.context.seaport);
+        const transaction = await seaport
+            .validate([order.protocolData], order.maker.address, domain)
+            .transact();
+        await this.context.confirmTransaction(transaction.hash, types_2.EventType.ApproveOrder, "Approving order");
+        return transaction.hash;
+    }
+    /**
+     * Validates an order onchain using Seaport's validate() method. This submits the order onchain
+     * and pre-validates the order using Seaport, which makes it cheaper to fulfill since a signature
+     * is not needed to be verified during fulfillment for the order, but is not strictly required
+     * and the alternative is orders can be submitted to the API for free instead of sent onchain.
+     * @param orderComponents Order components to validate onchain
+     * @param accountAddress Address of the wallet that will pay the gas to validate the order
+     * @returns Transaction hash of the validation transaction
+     *
+     * @throws Error if the accountAddress is not available through wallet or provider.
+     */
+    async validateOrderOnchain(orderComponents, accountAddress) {
+        await this.context.requireAccountIsAvailable(accountAddress);
+        this.context.dispatch(types_2.EventType.ApproveOrder, {
+            orderV2: { protocolData: orderComponents },
+            accountAddress,
+        });
+        const seaport = (0, utils_2.getSeaportInstance)(utils_1.DEFAULT_SEAPORT_CONTRACT_ADDRESS, this.context.seaport);
+        const transaction = await seaport
+            .validate([{ parameters: orderComponents, signature: "0x" }], accountAddress)
+            .transact();
+        await this.context.confirmTransaction(transaction.hash, types_2.EventType.ApproveOrder, "Validating order onchain");
+        return transaction.hash;
+    }
+    /**
+     * Create and validate a listing onchain. Combines order building with onchain validation.
+     * Validation costs gas upfront but makes fulfillment cheaper (no signature verification needed).
+     * @param options
+     * @param options.asset The asset to trade. tokenAddress and tokenId must be defined.
+     * @param options.accountAddress Address of the wallet making the listing
+     * @param options.amount Amount in decimal format (e.g., "1.5" for 1.5 ETH, not wei). Automatically converted to base units.
+     * @param options.quantity Number of assets to list. Defaults to 1.
+     * @param options.domain Optional domain for onchain attribution. Hashed and included in salt.
+     * @param options.salt Arbitrary salt. Auto-generated if not provided.
+     * @param options.listingTime When order becomes fulfillable (UTC seconds). Defaults to now.
+     * @param options.expirationTime Expiration time (UTC seconds).
+     * @param options.buyerAddress Optional buyer restriction. Only this address can purchase.
+     * @param options.includeOptionalCreatorFees Include optional creator fees. Default: false.
+     * @param options.zone Zone for order protection. Defaults to no zone.
+     * @returns Transaction hash
+     *
+     * @throws Error if asset missing token id or accountAddress unavailable.
+     */
+    async createListingAndValidateOnchain({ asset, accountAddress, amount, quantity = 1, domain, salt, listingTime, expirationTime, buyerAddress, includeOptionalCreatorFees = false, zone, }) {
+        const orderComponents = await this.ordersManager.buildListingOrderComponents({
+            asset,
+            accountAddress,
+            amount,
+            quantity,
+            domain,
+            salt,
+            listingTime,
+            expirationTime,
+            buyerAddress,
+            includeOptionalCreatorFees,
+            zone,
+        });
+        return this.validateOrderOnchain(orderComponents, accountAddress);
+    }
+    /**
+     * Create and validate an offer onchain. Combines order building with onchain validation.
+     * Validation costs gas upfront but makes fulfillment cheaper (no signature verification needed).
+     * @param options
+     * @param options.asset The asset to trade. tokenAddress and tokenId must be defined.
+     * @param options.accountAddress Address of the wallet making the offer.
+     * @param options.amount Amount in decimal format (e.g., "1.5" for 1.5 ETH, not wei). Automatically converted to base units.
+     * @param options.quantity Number of assets to bid for. Defaults to 1.
+     * @param options.domain Optional domain for onchain attribution. Hashed and included in salt.
+     * @param options.salt Arbitrary salt. Auto-generated if not provided.
+     * @param options.expirationTime Expiration time (UTC seconds).
+     * @param options.zone Zone for order protection. Defaults to chain's signed zone.
+     * @returns Transaction hash
+     *
+     * @throws Error if asset missing token id or accountAddress unavailable.
+     */
+    async createOfferAndValidateOnchain({ asset, accountAddress, amount, quantity = 1, domain, salt, expirationTime, zone, }) {
+        const orderComponents = await this.ordersManager.buildOfferOrderComponents({
+            asset,
+            accountAddress,
+            amount,
+            quantity,
+            domain,
+            salt,
+            expirationTime,
+            zone,
+        });
+        return this.validateOrderOnchain(orderComponents, accountAddress);
+    }
+}
+exports.FulfillmentManager = FulfillmentManager;
+//# sourceMappingURL=fulfillment.js.map

package/lib/sdk/fulfillment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fulfillment.js","sourceRoot":"","sources":["../../src/sdk/fulfillment.ts"],"names":[],"mappings":";;;AAAA,iEAAgE;AAEhE,mCAA+E;AAE/E,+DAIkC;AAClC,2CAAyD;AACzD,2CAAkE;AAClE,oCAAsE;AACtE,0CAIuB;AAIvB,MAAM,yBAAyB,GAAG,oCAAoC,CAAA;AAEtE;;;GAGG;AACH,MAAa,kBAAkB;IAEnB;IACA;IAFV,YACU,OAAmB,EACnB,aAA4B;QAD5B,YAAO,GAAP,OAAO,CAAY;QACnB,kBAAa,GAAb,aAAa,CAAe;IACnC,CAAC;IAEJ;;;;;;;;;OASG;IACK,KAAK,CAAC,mBAAmB,CAAC,EAChC,KAAK,EACL,cAAc,EACd,MAAM,EACN,SAAS,GAMV;QACC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAA;QACH,CAAC;QACD,MAAM,YAAY,GAAG,IAAA,qDAAmC,EACtD,KAAK,CAAC,YAAY,EAClB,KAAK,CAAC,KAAK,CAAC,OAAO,CACpB,CAAA;QACD,MAAM,YAAY,GAAG,IAAA,+CAA6B,EAAC,KAAK,CAAC,YAAY,CAAC,CAAA;QAEtE,8DAA8D;QAC9D,wFAAwF;QACxF,MAAM,KAAK,GAAG,IAAA,4CAA0B,EACtC,KAAK,CAAC,YAAY,EAClB,KAAK,CAAC,KAAK,CAAC,OAAO,CACpB,CAAA;QAED,MAAM,OAAO,GAAG,IAAA,0BAAkB,EAChC,KAAK,CAAC,eAAe,EACrB,IAAI,CAAC,OAAO,CAAC,OAAO,CACrB,CAAA;QACD,MAAM,WAAW,GAAG,MAAM,OAAO;aAC9B,WAAW,CAAC;YACX,MAAM,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC;YAC1C,YAAY;YACZ,SAAS,EAAE;gBACT,GAAG,SAAS;gBACZ,KAAK;aACN;YACD,cAAc;YACd,MAAM;SACP,CAAC;aACD,QAAQ,EAAE,CAAA;QACb,MAAM,kBAAkB,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;QACnD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAChD,CAAC;QAED,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,kBAAkB,CAAC,IAAI,EACvB,iBAAS,CAAC,WAAW,EACrB,kBAAkB,CACnB,CAAA;QACD,OAAO,kBAAkB,CAAC,IAAI,CAAA;IAChC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,YAAY,CAAC,EACjB,KAAK,EACL,cAAc,EACd,oBAAoB,EACpB,OAAO,EACP,WAAW,EACX,gBAAgB,EAChB,0BAA0B,GAAG,KAAK,EAClC,SAAS,GAUV;QACC,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAA;QAE5D,MAAM,eAAe,GAClB,KAAiB,CAAC,eAAe,IAAK,KAAe,CAAC,gBAAgB,CAAA;QACzE,IAAA,4BAAoB,EAAC,eAAe,CAAC,CAAA;QAErC,MAAM,SAAS,GACZ,KAAiB,CAAC,SAAS,IAAK,KAAe,CAAC,UAAU,CAAA;QAE7D,MAAM,IAAI,GACP,KAAiB,CAAC,IAAI;YACvB,CAAC,MAAM,IAAI,KAAK;gBAChB,CAAC,iBAAS,CAAC,KAAK,EAAE,iBAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAiB,CAAC;gBACpE,CAAC,CAAC,iBAAS,CAAC,OAAO;gBACnB,CAAC,CAAC,iBAAS,CAAC,KAAK,CAAC,CAAA;QAEtB,MAAM,gBAAgB,GAAG,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAA;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC,mBAAmB,CAAC;gBAC9B,KAAK,EAAE,KAAgB;gBACvB,cAAc;gBACd,SAAS;aACV,CAAC,CAAA;QACJ,CAAC;QAED,oCAAoC;QACpC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;QAC/D,CAAC;QAED,mEAAmE;QACnE,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;QAE1D,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CACpE,cAAc,EACd,SAAS,EACT,eAAe,EACf,IAAI,EACJ,oBAAoB,EACpB,OAAO,EACP,cAAc,EACd,gBAAgB,EAChB,0BAA0B,CAC3B,CAAA;QAED,+CAA+C;QAC/C,MAAM,WAAW,GAAG,eAAe,CAAC,gBAAgB,CAAC,WAAW,CAAA;QAChE,MAAM,SAAS,GAAG,WAAW,CAAC,UAAU,CAAA;QAExC,4CAA4C;QAC5C,MAAM,gBAAgB,GAAG,IAAI,eAAM,CAAC,SAAS,CAAC,oBAAU,CAAC,CAAA;QAEzD,oEAAoE;QACpE,MAAM,eAAe,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QAC1D,MAAM,YAAY,GAChB,eAAe,KAAK,yBAAyB;YAC3C,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,eAAe,CAAA;QACrB,IAAI,MAAiB,CAAA;QAErB,sDAAsD;QACtD,IACE,YAAY,KAAK,sBAAsB;YACvC,eAAe,IAAI,SAAS,EAC5B,CAAC;YACD,MAAM,GAAG;gBACP,SAAS,CAAC,aAAa;gBACvB,SAAS,CAAC,iBAAiB,IAAI,EAAE;gBACjC,SAAS,CAAC,mBAAmB;oBAC3B,oEAAoE;gBACtE,SAAS,CAAC,SAAS;aACpB,CAAA;QACH,CAAC;aAAM,IACL,CAAC,YAAY,KAAK,mBAAmB;YACnC,eAAe,KAAK,yBAAyB,CAAC;YAChD,sBAAsB,IAAI,SAAS,EACnC,CAAC;YACD,MAAM,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAA;QAC3C,CAAC;aAAM,IAAI,YAAY,KAAK,cAAc,IAAI,OAAO,IAAI,SAAS,EAAE,CAAC;YACnE,MAAM,GAAG;gBACP,SAAS,CAAC,KAAK;gBACf,SAAS,CAAC,mBAAmB;oBAC3B,oEAAoE;aACvE,CAAA;QACH,CAAC;aAAM,CAAC;YACN,8CAA8C;YAC9C,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QACnC,CAAC;QAED,MAAM,WAAW,GAAG,gBAAgB,CAAC,kBAAkB,CACrD,YAAY,EACZ,MAAM,CACP,CAAA;QAED,qDAAqD;QACrD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,gBAA0B,CAAA;QACtD,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC;YACtC,EAAE,EAAE,WAAW,CAAC,EAAE;YAClB,KAAK,EAAE,WAAW,CAAC,KAAK;YACxB,IAAI,EAAE,WAAW;YACjB,GAAG,SAAS;SACb,CAAC,CAAA;QAEF,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,EAAE,CAAC,IAAI,EACP,iBAAS,CAAC,WAAW,EACrB,kBAAkB,CACnB,CAAA;QACD,OAAO,EAAE,CAAC,IAAI,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,kBAAkB,CAAC,EACvB,KAAK,EACL,cAAc,GAIf;QACC,IAAA,4BAAoB,EAAC,KAAK,CAAC,eAAe,CAAC,CAAA;QAE3C,MAAM,OAAO,GAAG,IAAA,0BAAkB,EAChC,KAAK,CAAC,eAAe,EACrB,IAAI,CAAC,OAAO,CAAC,OAAO,CACrB,CAAA;QAED,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,OAAO;iBAC1B,QAAQ,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC;iBAC9C,UAAU,EAAE,CAAA;YACf,OAAO,CAAC,CAAC,OAAO,CAAA;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,IAAA,oBAAY,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;gBAC3D,OAAO,KAAK,CAAA;YACd,CAAC;YACD,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,YAAY,CAAC,KAAc,EAAE,MAAe;QAChD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACjE,IAAA,4BAAoB,EAAC,KAAK,CAAC,eAAe,CAAC,CAAA;QAE3C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,YAAY,EAAE;YAC5C,OAAO,EAAE,KAAK;YACd,cAAc,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO;SACpC,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,IAAA,0BAAkB,EAChC,KAAK,CAAC,eAAe,EACrB,IAAI,CAAC,OAAO,CAAC,OAAO,CACrB,CAAA;QACD,MAAM,WAAW,GAAG,MAAM,OAAO;aAC9B,QAAQ,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC;aAC3D,QAAQ,EAAE,CAAA;QAEb,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,WAAW,CAAC,IAAI,EAChB,iBAAS,CAAC,YAAY,EACtB,iBAAiB,CAClB,CAAA;QAED,OAAO,WAAW,CAAC,IAAI,CAAA;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,oBAAoB,CACxB,eAAgC,EAChC,cAAsB;QAEtB,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAA;QAE5D,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,YAAY,EAAE;YAC5C,OAAO,EAAE,EAAE,YAAY,EAAE,eAAe,EAAwB;YAChE,cAAc;SACf,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,IAAA,0BAAkB,EAChC,wCAAgC,EAChC,IAAI,CAAC,OAAO,CAAC,OAAO,CACrB,CAAA;QACD,MAAM,WAAW,GAAG,MAAM,OAAO;aAC9B,QAAQ,CACP,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAClD,cAAc,CACf;aACA,QAAQ,EAAE,CAAA;QAEb,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,WAAW,CAAC,IAAI,EAChB,iBAAS,CAAC,YAAY,EACtB,0BAA0B,CAC3B,CAAA;QAED,OAAO,WAAW,CAAC,IAAI,CAAA;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,+BAA+B,CAAC,EACpC,KAAK,EACL,cAAc,EACd,MAAM,EACN,QAAQ,GAAG,CAAC,EACZ,MAAM,EACN,IAAI,EACJ,WAAW,EACX,cAAc,EACd,YAAY,EACZ,0BAA0B,GAAG,KAAK,EAClC,IAAI,GAaL;QACC,MAAM,eAAe,GACnB,MAAM,IAAI,CAAC,aAAa,CAAC,2BAA2B,CAAC;YACnD,KAAK;YACL,cAAc;YACd,MAAM;YACN,QAAQ;YACR,MAAM;YACN,IAAI;YACJ,WAAW;YACX,cAAc;YACd,YAAY;YACZ,0BAA0B;YAC1B,IAAI;SACL,CAAC,CAAA;QAEJ,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,EAAE,cAAc,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,6BAA6B,CAAC,EAClC,KAAK,EACL,cAAc,EACd,MAAM,EACN,QAAQ,GAAG,CAAC,EACZ,MAAM,EACN,IAAI,EACJ,cAAc,EACd,IAAI,GAUL;QACC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC;YACzE,KAAK;YACL,cAAc;YACd,MAAM;YACN,QAAQ;YACR,MAAM;YACN,IAAI;YACJ,cAAc;YACd,IAAI;SACL,CAAC,CAAA;QAEF,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,EAAE,cAAc,CAAC,CAAA;IACnE,CAAC;CACF;AAncD,gDAmcC"}

package/lib/sdk/orders.d.ts

@@ -0,0 +1,253 @@
+import type { OrderComponents } from "@opensea/seaport-js/lib/types";
+import { type BigNumberish } from "ethers";
+import type { CollectionOffer } from "../api/types";
+import type { OrderV2, ProtocolData } from "../orders/types";
+import { type AssetWithTokenId, OrderSide } from "../types";
+import type { SDKContext } from "./context";
+/**
+ * Result type for bulk operations that may partially succeed.
+ * Contains successfully submitted orders and any failures with error information.
+ */
+export interface BulkOrderResult {
+    /** Successfully submitted orders */
+    successful: OrderV2[];
+    /** Failed order submissions with error information */
+    failed: Array<{
+        /** Index of the failed order in the original input array */
+        index: number;
+        /** The signed order that failed to submit (undefined if order creation failed before signing) */
+        order?: ProtocolData;
+        /** The error that occurred during submission */
+        error: Error;
+    }>;
+}
+/**
+ * Manager for order building and creation operations.
+ * Handles listing creation, offer creation, and collection offers.
+ */
+export declare class OrdersManager {
+    private context;
+    private getPriceParametersCallback;
+    constructor(context: SDKContext, getPriceParametersCallback: (orderSide: OrderSide, tokenAddress: string, amount: BigNumberish) => Promise<{
+        basePrice: bigint;
+    }>);
+    private getAmountWithBasisPointsApplied;
+    private isNotMarketplaceFee;
+    private getNFTItems;
+    private getFees;
+    /**
+     * Build listing order without submitting to API
+     * @param options Listing parameters
+     * @returns OrderWithCounter ready for API submission or onchain validation
+     */
+    private _buildListingOrder;
+    /**
+     * Build listing order components without submitting to API
+     * @param options Listing parameters
+     * @returns OrderComponents ready for onchain validation
+     */
+    buildListingOrderComponents({ asset, accountAddress, amount, quantity, domain, salt, listingTime, expirationTime, buyerAddress, includeOptionalCreatorFees, zone, }: {
+        asset: AssetWithTokenId;
+        accountAddress: string;
+        amount: BigNumberish;
+        quantity?: BigNumberish;
+        domain?: string;
+        salt?: BigNumberish;
+        listingTime?: number;
+        expirationTime?: number;
+        buyerAddress?: string;
+        includeOptionalCreatorFees?: boolean;
+        zone?: string;
+    }): Promise<OrderComponents>;
+    /**
+     * Build offer order without submitting to API
+     * @param options Offer parameters
+     * @returns OrderWithCounter ready for API submission or onchain validation
+     */
+    private _buildOfferOrder;
+    /**
+     * Build offer order components without submitting to API
+     * @param options Offer parameters
+     * @returns OrderComponents ready for onchain validation
+     */
+    buildOfferOrderComponents({ asset, accountAddress, amount, quantity, domain, salt, expirationTime, zone, }: {
+        asset: AssetWithTokenId;
+        accountAddress: string;
+        amount: BigNumberish;
+        quantity?: BigNumberish;
+        domain?: string;
+        salt?: BigNumberish;
+        expirationTime?: BigNumberish;
+        zone?: string;
+    }): Promise<OrderComponents>;
+    /**
+     * Create and submit an offer on an asset.
+     * @param options
+     * @param options.asset The asset to trade. tokenAddress and tokenId must be defined.
+     * @param options.accountAddress Address of the wallet making the offer.
+     * @param options.amount Amount in decimal format (e.g., "1.5" for 1.5 ETH, not wei). Automatically converted to base units.
+     * @param options.quantity Number of assets to bid for. Defaults to 1.
+     * @param options.domain Optional domain for onchain attribution. Hashed and included in salt.
+     * @param options.salt Arbitrary salt. Auto-generated if not provided.
+     * @param options.expirationTime Expiration time for the order, in UTC seconds
+     * @param options.zone Zone for order protection. Defaults to chain's signed zone.
+     *
+     * @returns The {@link OrderV2} that was created.
+     *
+     * @throws Error if the asset does not contain a token id.
+     * @throws Error if the accountAddress is not available through wallet or provider.
+     * @throws Error if the amount is not greater than 0.
+     */
+    createOffer({ asset, accountAddress, amount, quantity, domain, salt, expirationTime, zone, }: {
+        asset: AssetWithTokenId;
+        accountAddress: string;
+        amount: BigNumberish;
+        quantity?: BigNumberish;
+        domain?: string;
+        salt?: BigNumberish;
+        expirationTime?: BigNumberish;
+        zone?: string;
+    }): Promise<OrderV2>;
+    /**
+     * Create and submit a listing for an asset.
+     * @param options
+     * @param options.asset The asset to trade. tokenAddress and tokenId must be defined.
+     * @param options.accountAddress  Address of the wallet making the listing
+     * @param options.amount Amount in decimal format (e.g., "1.5" for 1.5 ETH, not wei). Automatically converted to base units.
+     * @param options.quantity Number of assets to list. Defaults to 1.
+     * @param options.domain Optional domain for onchain attribution. Hashed and included in salt. This can be used for onchain order attribution to assist with analytics.
+     * @param options.salt Arbitrary salt. Auto-generated if not provided.
+     * @param options.listingTime Optional time when the order will become fulfillable, in UTC seconds. Undefined means it will start now.
+     * @param options.expirationTime Expiration time for the order, in UTC seconds.
+     * @param options.buyerAddress Optional address that's allowed to purchase this item. If specified, no other address will be able to take the order, unless its value is the null address.
+     * @param options.includeOptionalCreatorFees If true, optional creator fees will be included in the listing. Default: false.
+     * @param options.zone Zone for order protection. Defaults to no zone.
+     * @returns The {@link OrderV2} that was created.
+     *
+     * @throws Error if the asset does not contain a token id.
+     * @throws Error if the accountAddress is not available through wallet or provider.
+     * @throws Error if the amount is not greater than 0.
+     */
+    createListing({ asset, accountAddress, amount, quantity, domain, salt, listingTime, expirationTime, buyerAddress, includeOptionalCreatorFees, zone, }: {
+        asset: AssetWithTokenId;
+        accountAddress: string;
+        amount: BigNumberish;
+        quantity?: BigNumberish;
+        domain?: string;
+        salt?: BigNumberish;
+        listingTime?: number;
+        expirationTime?: number;
+        buyerAddress?: string;
+        includeOptionalCreatorFees?: boolean;
+        zone?: string;
+    }): Promise<OrderV2>;
+    /**
+     * Create and submit multiple listings using Seaport's bulk order creation.
+     * This method uses a single signature for all listings and submits them individually to the OpenSea API with rate limit handling.
+     * All listings must be from the same account address.
+     *
+     * Note: If only one listing is provided, this method will use a normal order signature instead of a bulk signature,
+     * as bulk signatures are more expensive to decode onchain due to the merkle proof verification.
+     *
+     * @param options
+     * @param options.listings Array of listing parameters. Each listing requires asset, amount, and optionally other listing parameters.
+     * @param options.accountAddress Address of the wallet making the listings
+     * @param options.continueOnError If true, continue submitting remaining listings even if some fail. Default: false (throw on first error).
+     * @param options.onProgress Optional callback for progress updates. Called after each listing is submitted (successfully or not).
+     * @returns {@link BulkOrderResult} containing successful orders and any failures.
+     *
+     * @throws Error if listings array is empty
+     * @throws Error if the accountAddress is not available through wallet or provider.
+     * @throws Error if any asset does not contain a token id.
+     * @throws Error if continueOnError is false and any submission fails.
+     */
+    createBulkListings({ listings, accountAddress, continueOnError, onProgress, }: {
+        listings: Array<{
+            asset: AssetWithTokenId;
+            amount: BigNumberish;
+            quantity?: BigNumberish;
+            domain?: string;
+            salt?: BigNumberish;
+            listingTime?: number;
+            expirationTime?: number;
+            buyerAddress?: string;
+            includeOptionalCreatorFees?: boolean;
+            zone?: string;
+        }>;
+        accountAddress: string;
+        continueOnError?: boolean;
+        onProgress?: (completed: number, total: number) => void;
+    }): Promise<BulkOrderResult>;
+    /**
+     * Create and submit multiple offers using Seaport's bulk order creation.
+     * This method uses a single signature for all offers and submits them individually to the OpenSea API with rate limit handling.
+     * All offers must be from the same account address.
+     *
+     * Note: If only one offer is provided, this method will use a normal order signature instead of a bulk signature,
+     * as bulk signatures are more expensive to decode onchain due to the merkle proof verification.
+     *
+     * @param options
+     * @param options.offers Array of offer parameters. Each offer requires asset, amount, and optionally other offer parameters.
+     * @param options.accountAddress Address of the wallet making the offers
+     * @param options.continueOnError If true, continue submitting remaining offers even if some fail. Default: false (throw on first error).
+     * @param options.onProgress Optional callback for progress updates. Called after each offer is submitted (successfully or not).
+     * @returns {@link BulkOrderResult} containing successful orders and any failures.
+     *
+     * @throws Error if offers array is empty
+     * @throws Error if the accountAddress is not available through wallet or provider.
+     * @throws Error if any asset does not contain a token id.
+     * @throws Error if continueOnError is false and any submission fails.
+     */
+    createBulkOffers({ offers, accountAddress, continueOnError, onProgress, }: {
+        offers: Array<{
+            asset: AssetWithTokenId;
+            amount: BigNumberish;
+            quantity?: BigNumberish;
+            domain?: string;
+            salt?: BigNumberish;
+            expirationTime?: BigNumberish;
+            zone?: string;
+        }>;
+        accountAddress: string;
+        continueOnError?: boolean;
+        onProgress?: (completed: number, total: number) => void;
+    }): Promise<BulkOrderResult>;
+    /**
+     * Create and submit a collection offer.
+     * @param options
+     * @param options.collectionSlug Identifier for the collection.
+     * @param options.accountAddress Address of the wallet making the offer.
+     * @param options.amount Amount in decimal format (e.g., "1.5" for 1.5 ETH, not wei). Automatically converted to base units.
+     * @param options.quantity Number of assets to bid for.
+     * @param options.domain Optional domain for onchain attribution. Hashed and included in salt. This can be used for onchain order attribution to assist with analytics.
+     * @param options.salt Arbitrary salt. Auto-generated if not provided.
+     * @param options.expirationTime Expiration time for the order, in UTC seconds.
+     * @param options.offerProtectionEnabled Use signed zone for protection against disabled items. Default: true.
+     * @param options.traitType If defined, the trait name to create the collection offer for.
+     * @param options.traitValue If defined, the trait value to create the collection offer for.
+     * @param options.traits If defined, an array of traits to create the multi-trait collection offer for.
+     * @param options.numericTraits If defined, an array of numeric trait criteria with min/max ranges.
+     * @returns The {@link CollectionOffer} that was created.
+     */
+    createCollectionOffer({ collectionSlug, accountAddress, amount, quantity, domain, salt, expirationTime, offerProtectionEnabled, traitType, traitValue, traits, numericTraits, }: {
+        collectionSlug: string;
+        accountAddress: string;
+        amount: BigNumberish;
+        quantity: number;
+        domain?: string;
+        salt?: BigNumberish;
+        expirationTime?: number | string;
+        offerProtectionEnabled?: boolean;
+        traitType?: string;
+        traitValue?: string;
+        traits?: Array<{
+            type: string;
+            value: string;
+        }>;
+        numericTraits?: Array<{
+            type: string;
+            min?: number;
+            max?: number;
+        }>;
+    }): Promise<CollectionOffer | null>;
+}