@opensea/sdk 9.0.0

package/lib/sdk/cancellation.js

@@ -0,0 +1,235 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancellationManager = void 0;
+const utils_1 = require("../orders/utils");
+const types_1 = require("../types");
+const utils_2 = require("../utils/utils");
+/**
+ * Order cancellation operations
+ */
+class CancellationManager {
+    context;
+    constructor(context) {
+        this.context = context;
+    }
+    /**
+     * Cancel an order onchain, preventing it from ever being fulfilled.
+     * This method accepts either a full OrderV2 object or an order hash with protocol address.
+     *
+     * @param options
+     * @param options.order The order to cancel (OrderV2 object)
+     * @param options.orderHash Optional order hash to cancel. Must provide protocolAddress if using this.
+     * @param options.accountAddress The account address that will be cancelling the order.
+     * @param options.protocolAddress Required when using orderHash. The Seaport protocol address for 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.
+     *
+     * @throws Error if neither order nor orderHash is provided.
+     * @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 cancelOrder({ order, orderHash, accountAddress, protocolAddress = utils_1.DEFAULT_SEAPORT_CONTRACT_ADDRESS, domain, }) {
+        // Validate input
+        if (!order && !orderHash) {
+            throw new Error("Either order or orderHash must be provided to cancel order");
+        }
+        // Check account availability after parameter validation
+        await this.context.requireAccountIsAvailable(accountAddress);
+        let orderComponents;
+        let effectiveProtocolAddress;
+        if (order) {
+            // Using OrderV2 object directly
+            (0, utils_2.requireValidProtocol)(order.protocolAddress);
+            effectiveProtocolAddress = order.protocolAddress;
+            orderComponents = order.protocolData.parameters;
+            this.context.dispatch(types_1.EventType.CancelOrder, {
+                orderV2: order,
+                accountAddress,
+            });
+        }
+        else if (orderHash) {
+            // Fetch order from API using order hash
+            (0, utils_2.requireValidProtocol)(protocolAddress);
+            const fetchedOrder = await this.context.api.getOrderByHash(orderHash, protocolAddress, this.context.chain);
+            (0, utils_2.requireValidProtocol)(fetchedOrder.protocol_address);
+            effectiveProtocolAddress = fetchedOrder.protocol_address;
+            orderComponents = fetchedOrder.protocol_data.parameters;
+            this.context.dispatch(types_1.EventType.CancelOrder, {
+                order: fetchedOrder,
+                accountAddress,
+            });
+        }
+        else {
+            // Should never reach here due to earlier validation
+            throw new Error("Invalid input");
+        }
+        // Transact and get the transaction hash
+        const transactionHash = await this.cancelSeaportOrders({
+            orders: [orderComponents],
+            accountAddress,
+            domain,
+            protocolAddress: effectiveProtocolAddress,
+        });
+        // Await transaction confirmation
+        await this.context.confirmTransaction(transactionHash, types_1.EventType.CancelOrder, "Cancelling order");
+    }
+    /**
+     * Cancel multiple orders onchain, preventing them from being fulfilled.
+     * This method accepts either full OrderV2 objects, OrderComponents, or order hashes with protocol address.
+     *
+     * **Event Behavior**: For backwards compatibility with the singular `cancelOrder` method,
+     * this method dispatches a `CancelOrder` event for the first order only, and only when
+     * an OrderV2 object is available (either provided directly or fetched via orderHashes).
+     * No event is dispatched when using OrderComponents directly, as they lack the full order data.
+     *
+     * @param options
+     * @param options.orders Array of orders to cancel. Can be OrderV2 objects or OrderComponents.
+     * @param options.orderHashes Optional array of order hashes to cancel. Must provide protocolAddress if using this.
+     * @param options.accountAddress The account address cancelling the orders.
+     * @param options.protocolAddress Required when using orderHashes. The Seaport protocol address for the orders.
+     * @param options.domain An optional domain to be hashed and included at the end of fulfillment calldata.
+     * @param options.overrides Transaction overrides, ignored if not set.
+     * @returns Transaction hash of the cancellation.
+     *
+     * @throws Error if orderHashes is provided without protocolAddress.
+     * @throws Error if neither orders nor orderHashes is provided.
+     * @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 cancelOrders({ orders, orderHashes, accountAddress, protocolAddress = utils_1.DEFAULT_SEAPORT_CONTRACT_ADDRESS, domain, overrides, }) {
+        // Validate input before making any external calls
+        if (!orders && !orderHashes) {
+            throw new Error("Either orders or orderHashes must be provided to cancel orders");
+        }
+        if (orders && orderHashes) {
+            throw new Error("Cannot provide both orders and orderHashes. Please use one or the other.");
+        }
+        if (orders && orders.length === 0) {
+            throw new Error("At least one order must be provided");
+        }
+        if (orderHashes && orderHashes.length === 0) {
+            throw new Error("At least one order hash must be provided");
+        }
+        (0, utils_2.requireValidProtocol)(protocolAddress);
+        // Check account availability after parameter validation
+        await this.context.requireAccountIsAvailable(accountAddress);
+        let orderComponents;
+        let effectiveProtocolAddress = protocolAddress;
+        if (orders) {
+            // Extract OrderComponents from either OrderV2 objects or use OrderComponents directly
+            let firstOrderV2;
+            orderComponents = orders.map(order => {
+                if ("protocolData" in order) {
+                    // It's an OrderV2 object
+                    const orderV2 = order;
+                    (0, utils_2.requireValidProtocol)(orderV2.protocolAddress);
+                    effectiveProtocolAddress = orderV2.protocolAddress;
+                    if (!firstOrderV2) {
+                        firstOrderV2 = orderV2;
+                    }
+                    return orderV2.protocolData.parameters;
+                }
+                else {
+                    // It's already OrderComponents
+                    return order;
+                }
+            });
+            // Dispatch event for the first OrderV2 if available
+            if (firstOrderV2) {
+                this.context.dispatch(types_1.EventType.CancelOrder, {
+                    orderV2: firstOrderV2,
+                    accountAddress,
+                });
+            }
+        }
+        else if (orderHashes) {
+            // Fetch orders from the API using order hashes
+            const fetchedOrders = [];
+            for (const hash of orderHashes) {
+                const fetched = await this.context.api.getOrderByHash(hash, protocolAddress, this.context.chain);
+                fetchedOrders.push(fetched);
+            }
+            // Extract OrderComponents from the fetched orders
+            orderComponents = fetchedOrders.map(fetched => {
+                (0, utils_2.requireValidProtocol)(fetched.protocol_address);
+                effectiveProtocolAddress = fetched.protocol_address;
+                return fetched.protocol_data.parameters;
+            });
+            // Dispatch event for the first fetched order
+            if (fetchedOrders.length > 0) {
+                this.context.dispatch(types_1.EventType.CancelOrder, {
+                    order: fetchedOrders[0],
+                    accountAddress,
+                });
+            }
+        }
+        else {
+            // Should never reach here due to earlier validation
+            throw new Error("Invalid input");
+        }
+        // Transact and get the transaction hash
+        const transactionHash = await this.cancelSeaportOrders({
+            orders: orderComponents,
+            accountAddress,
+            domain,
+            protocolAddress: effectiveProtocolAddress,
+            overrides,
+        });
+        // Await transaction confirmation
+        await this.context.confirmTransaction(transactionHash, types_1.EventType.CancelOrder, `Cancelling ${orderComponents.length} order(s)`);
+        return transactionHash;
+    }
+    /**
+     * Cancel orders onchain, preventing them from being fulfilled.
+     * @param options
+     * @param options.orders The orders to cancel
+     * @param options.accountAddress The account address cancelling the orders.
+     * @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 cancelSeaportOrders({ orders, accountAddress, domain, protocolAddress = utils_1.DEFAULT_SEAPORT_CONTRACT_ADDRESS, overrides, }) {
+        const seaport = (0, utils_2.getSeaportInstance)(protocolAddress, this.context.seaport);
+        const transaction = await seaport
+            .cancelOrders(orders, accountAddress, domain, overrides)
+            .transact();
+        return transaction.hash;
+    }
+    /**
+     * Get the offerer signature for canceling an order offchain.
+     * The signature will only be valid if the signer address is the address of the order's offerer.
+     */
+    async getOffererSignature(protocolAddress, orderHash, chain) {
+        const chainId = (0, utils_2.getChainId)(chain);
+        const name = "Seaport";
+        const version = (0, utils_2.getSeaportVersion)(protocolAddress);
+        if (typeof this.context.signerOrProvider.signTypedData ===
+            "undefined") {
+            throw new Error("Please pass an ethers Signer into this sdk to derive an offerer signature");
+        }
+        return this.context.signerOrProvider.signTypedData({ chainId, name, version, verifyingContract: protocolAddress }, { OrderHash: [{ name: "orderHash", type: "bytes32" }] }, { orderHash });
+    }
+    /**
+     * Offchain cancel an order, offer or listing, by its order hash when protected by the SignedZone.
+     * Protocol and Chain are required to prevent hash collisions.
+     * Please note cancellation is only assured if a fulfillment signature was not vended prior to cancellation.
+     * @param protocolAddress The Seaport address for the order.
+     * @param orderHash The order hash, or external identifier, of the order.
+     * @param chain The chain where the order is located.
+     * @param offererSignature An EIP-712 signature from the offerer of the order.
+     *                         If this is not provided, the API key used to initialize the SDK must belong to the order's offerer.
+     *                         The signature must be a EIP-712 signature consisting of the order's Seaport contract's
+     *                         name, version, address, and chain. The struct to sign is `OrderHash` containing a
+     *                         single bytes32 field.
+     * @param useSignerToDeriveOffererSignature Derive the offererSignature from the Ethers signer passed into this sdk.
+     * @returns The response from the API.
+     */
+    async offchainCancelOrder(protocolAddress, orderHash, chain = this.context.chain, offererSignature, useSignerToDeriveOffererSignature) {
+        if (useSignerToDeriveOffererSignature) {
+            offererSignature = await this.getOffererSignature(protocolAddress, orderHash, chain);
+        }
+        return this.context.api.offchainCancelOrder(protocolAddress, orderHash, chain, offererSignature);
+    }
+}
+exports.CancellationManager = CancellationManager;
+//# sourceMappingURL=cancellation.js.map

package/lib/sdk/cancellation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancellation.js","sourceRoot":"","sources":["../../src/sdk/cancellation.ts"],"names":[],"mappings":";;;AAIA,2CAAkE;AAClE,oCAAgD;AAChD,0CAKuB;AAGvB;;GAEG;AACH,MAAa,mBAAmB;IACV;IAApB,YAAoB,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;IAAG,CAAC;IAE3C;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,WAAW,CAAC,EAChB,KAAK,EACL,SAAS,EACT,cAAc,EACd,eAAe,GAAG,wCAAgC,EAClD,MAAM,GAOP;QACC,iBAAiB;QACjB,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAA;QACH,CAAC;QAED,wDAAwD;QACxD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAA;QAE5D,IAAI,eAAgC,CAAA;QACpC,IAAI,wBAAgC,CAAA;QAEpC,IAAI,KAAK,EAAE,CAAC;YACV,gCAAgC;YAChC,IAAA,4BAAoB,EAAC,KAAK,CAAC,eAAe,CAAC,CAAA;YAC3C,wBAAwB,GAAG,KAAK,CAAC,eAAe,CAAA;YAChD,eAAe,GAAG,KAAK,CAAC,YAAY,CAAC,UAAU,CAAA;YAC/C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;gBAC3C,OAAO,EAAE,KAAK;gBACd,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,SAAS,EAAE,CAAC;YACrB,wCAAwC;YACxC,IAAA,4BAAoB,EAAC,eAAe,CAAC,CAAA;YACrC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CACxD,SAAS,EACT,eAAe,EACf,IAAI,CAAC,OAAO,CAAC,KAAK,CACnB,CAAA;YACD,IAAA,4BAAoB,EAAC,YAAY,CAAC,gBAAgB,CAAC,CAAA;YACnD,wBAAwB,GAAG,YAAY,CAAC,gBAAgB,CAAA;YACxD,eAAe,GAAG,YAAY,CAAC,aAAa,CAAC,UAAU,CAAA;YACvD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;gBAC3C,KAAK,EAAE,YAAY;gBACnB,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,oDAAoD;YACpD,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;QAClC,CAAC;QAED,wCAAwC;QACxC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC;YACrD,MAAM,EAAE,CAAC,eAAe,CAAC;YACzB,cAAc;YACd,MAAM;YACN,eAAe,EAAE,wBAAwB;SAC1C,CAAC,CAAA;QAEF,iCAAiC;QACjC,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,eAAe,EACf,iBAAS,CAAC,WAAW,EACrB,kBAAkB,CACnB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,YAAY,CAAC,EACjB,MAAM,EACN,WAAW,EACX,cAAc,EACd,eAAe,GAAG,wCAAgC,EAClD,MAAM,EACN,SAAS,GAQV;QACC,kDAAkD;QAClD,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAA;QACH,CAAC;QAED,IAAI,MAAM,IAAI,WAAW,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAA;QACH,CAAC;QAED,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,CAAC;QAED,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;QAC7D,CAAC;QAED,IAAA,4BAAoB,EAAC,eAAe,CAAC,CAAA;QAErC,wDAAwD;QACxD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAA;QAE5D,IAAI,eAAkC,CAAA;QACtC,IAAI,wBAAwB,GAAG,eAAe,CAAA;QAE9C,IAAI,MAAM,EAAE,CAAC;YACX,sFAAsF;YACtF,IAAI,YAAiC,CAAA;YACrC,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBACnC,IAAI,cAAc,IAAI,KAAK,EAAE,CAAC;oBAC5B,yBAAyB;oBACzB,MAAM,OAAO,GAAG,KAAgB,CAAA;oBAChC,IAAA,4BAAoB,EAAC,OAAO,CAAC,eAAe,CAAC,CAAA;oBAC7C,wBAAwB,GAAG,OAAO,CAAC,eAAe,CAAA;oBAClD,IAAI,CAAC,YAAY,EAAE,CAAC;wBAClB,YAAY,GAAG,OAAO,CAAA;oBACxB,CAAC;oBACD,OAAO,OAAO,CAAC,YAAY,CAAC,UAAU,CAAA;gBACxC,CAAC;qBAAM,CAAC;oBACN,+BAA+B;oBAC/B,OAAO,KAAwB,CAAA;gBACjC,CAAC;YACH,CAAC,CAAC,CAAA;YACF,oDAAoD;YACpD,IAAI,YAAY,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;oBAC3C,OAAO,EAAE,YAAY;oBACrB,cAAc;iBACf,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;aAAM,IAAI,WAAW,EAAE,CAAC;YACvB,+CAA+C;YAC/C,MAAM,aAAa,GAAwB,EAAE,CAAA;YAC7C,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;gBAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CACnD,IAAI,EACJ,eAAe,EACf,IAAI,CAAC,OAAO,CAAC,KAAK,CACnB,CAAA;gBACD,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC7B,CAAC;YAED,kDAAkD;YAClD,eAAe,GAAG,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBAC5C,IAAA,4BAAoB,EAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;gBAC9C,wBAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAA;gBACnD,OAAO,OAAO,CAAC,aAAa,CAAC,UAAU,CAAA;YACzC,CAAC,CAAC,CAAA;YAEF,6CAA6C;YAC7C,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;oBAC3C,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;oBACvB,cAAc;iBACf,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,oDAAoD;YACpD,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;QAClC,CAAC;QAED,wCAAwC;QACxC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC;YACrD,MAAM,EAAE,eAAe;YACvB,cAAc;YACd,MAAM;YACN,eAAe,EAAE,wBAAwB;YACzC,SAAS;SACV,CAAC,CAAA;QAEF,iCAAiC;QACjC,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,eAAe,EACf,iBAAS,CAAC,WAAW,EACrB,cAAc,eAAe,CAAC,MAAM,WAAW,CAChD,CAAA;QAED,OAAO,eAAe,CAAA;IACxB,CAAC;IAED;;;;;;;;;OASG;IACK,KAAK,CAAC,mBAAmB,CAAC,EAChC,MAAM,EACN,cAAc,EACd,MAAM,EACN,eAAe,GAAG,wCAAgC,EAClD,SAAS,GAOV;QACC,MAAM,OAAO,GAAG,IAAA,0BAAkB,EAAC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAEzE,MAAM,WAAW,GAAG,MAAM,OAAO;aAC9B,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,CAAC;aACvD,QAAQ,EAAE,CAAA;QAEb,OAAO,WAAW,CAAC,IAAI,CAAA;IACzB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CACvB,eAAuB,EACvB,SAAiB,EACjB,KAAY;QAEZ,MAAM,OAAO,GAAG,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAA;QACjC,MAAM,IAAI,GAAG,SAAS,CAAA;QACtB,MAAM,OAAO,GAAG,IAAA,yBAAiB,EAAC,eAAe,CAAC,CAAA;QAElD,IACE,OAAQ,IAAI,CAAC,OAAO,CAAC,gBAA2B,CAAC,aAAa;YAC9D,WAAW,EACX,CAAC;YACD,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;QACH,CAAC;QAED,OAAQ,IAAI,CAAC,OAAO,CAAC,gBAA2B,CAAC,aAAa,CAC5D,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,EAC9D,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,EACvD,EAAE,SAAS,EAAE,CACd,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,mBAAmB,CACvB,eAAuB,EACvB,SAAiB,EACjB,QAAe,IAAI,CAAC,OAAO,CAAC,KAAK,EACjC,gBAAyB,EACzB,iCAA2C;QAE3C,IAAI,iCAAiC,EAAE,CAAC;YACtC,gBAAgB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAC/C,eAAe,EACf,SAAS,EACT,KAAK,CACN,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CACzC,eAAe,EACf,SAAS,EACT,KAAK,EACL,gBAAgB,CACjB,CAAA;IACH,CAAC;CACF;AAxUD,kDAwUC"}

package/lib/sdk/context.d.ts

@@ -0,0 +1,28 @@
+import type { Seaport } from "@opensea/seaport-js";
+import type { JsonRpcProvider, Signer } from "ethers";
+import type { OpenSeaAPI } from "../api/api";
+import type { Chain, EventData, EventType } from "../types";
+/**
+ * Shared context passed to all SDK managers.
+ * Contains common dependencies and utilities needed across managers.
+ */
+export interface SDKContext {
+    /** The blockchain chain being used */
+    chain: Chain;
+    /** Signer or provider for blockchain interactions */
+    signerOrProvider: Signer | JsonRpcProvider;
+    /** JSON-RPC provider for read operations */
+    provider: JsonRpcProvider;
+    /** OpenSea API client */
+    api: OpenSeaAPI;
+    /** Seaport client instance */
+    seaport: Seaport;
+    /** Logger function for debugging */
+    logger: (msg: string) => void;
+    /** Event dispatcher */
+    dispatch: (event: EventType, data: EventData) => void;
+    /** Transaction confirmation helper */
+    confirmTransaction: (hash: string, event: EventType, description: string) => Promise<void>;
+    /** Account availability checker */
+    requireAccountIsAvailable: (address: string) => Promise<void>;
+}

package/lib/sdk/context.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context.js.map

package/lib/sdk/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/sdk/context.ts"],"names":[],"mappings":""}

package/lib/sdk/fulfillment.d.ts

@@ -0,0 +1,153 @@
+import type { OrderComponents } from "@opensea/seaport-js/lib/types";
+import { type BigNumberish, type Overrides } from "ethers";
+import type { Listing, Offer, Order } from "../api/types";
+import { type OrderV2 } from "../orders/types";
+import { type AssetWithTokenId } from "../types";
+import type { SDKContext } from "./context";
+import type { OrdersManager } from "./orders";
+/**
+ * Manager for order fulfillment and validation operations.
+ * Handles fulfilling orders, validating orders onchain, and approving orders.
+ */
+export declare class FulfillmentManager {
+    private context;
+    private ordersManager;
+    constructor(context: SDKContext, 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.
+     */
+    private fulfillPrivateOrder;
+    /**
+     * 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.
+     */
+    fulfillOrder({ order, accountAddress, assetContractAddress, tokenId, unitsToFill, recipientAddress, includeOptionalCreatorFees, overrides, }: {
+        order: OrderV2 | Order | Listing | Offer;
+        accountAddress: string;
+        assetContractAddress?: string;
+        tokenId?: string;
+        unitsToFill?: BigNumberish;
+        recipientAddress?: string;
+        includeOptionalCreatorFees?: boolean;
+        overrides?: Overrides;
+    }): Promise<string>;
+    /**
+     * 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}.
+     */
+    isOrderFulfillable({ order, accountAddress, }: {
+        order: OrderV2;
+        accountAddress: string;
+    }): Promise<boolean>;
+    /**
+     * 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}.
+     */
+    approveOrder(order: OrderV2, domain?: string): Promise<string>;
+    /**
+     * 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.
+     */
+    validateOrderOnchain(orderComponents: OrderComponents, accountAddress: string): Promise<string>;
+    /**
+     * 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.
+     */
+    createListingAndValidateOnchain({ 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<string>;
+    /**
+     * 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.
+     */
+    createOfferAndValidateOnchain({ 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<string>;
+}