@opensea/sdk 9.0.0

package/lib/sdk/assets.js

@@ -0,0 +1,398 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetsManager = void 0;
+const ethers_1 = require("ethers");
+const constants_1 = require("../constants");
+const contracts_1 = require("../typechain/contracts");
+const types_1 = require("../types");
+const utils_1 = require("../utils/utils");
+/**
+ * Asset transfer and approval operations
+ */
+class AssetsManager {
+    context;
+    constructor(context) {
+        this.context = context;
+    }
+    /**
+     * Get an account's balance of any Asset. This asset can be an ERC20, ERC1155, or ERC721.
+     * @param options
+     * @param options.accountAddress Account address to check
+     * @param options.asset The Asset to check balance for. tokenStandard must be set.
+     * @returns The balance of the asset for the account.
+     *
+     * @throws Error if the token standard does not support balanceOf.
+     */
+    async getBalance({ accountAddress, asset, }) {
+        switch (asset.tokenStandard) {
+            case types_1.TokenStandard.ERC20: {
+                const contract = contracts_1.ERC20__factory.connect(asset.tokenAddress, this.context.provider);
+                return await contract.balanceOf.staticCall(accountAddress);
+            }
+            case types_1.TokenStandard.ERC1155: {
+                if (asset.tokenId === undefined || asset.tokenId === null) {
+                    throw new Error("Missing ERC1155 tokenId for getBalance");
+                }
+                const contract = contracts_1.ERC1155__factory.connect(asset.tokenAddress, this.context.provider);
+                return await contract.balanceOf.staticCall(accountAddress, asset.tokenId);
+            }
+            case types_1.TokenStandard.ERC721: {
+                if (asset.tokenId === undefined || asset.tokenId === null) {
+                    throw new Error("Missing ERC721 tokenId for getBalance");
+                }
+                const contract = contracts_1.ERC721__factory.connect(asset.tokenAddress, this.context.provider);
+                try {
+                    const owner = await contract.ownerOf.staticCall(asset.tokenId);
+                    return BigInt(owner.toLowerCase() === accountAddress.toLowerCase());
+                }
+                catch (error) {
+                    this.context.logger(`Failed to get ownerOf ERC721: ${error.message ?? error}`);
+                    return 0n;
+                }
+            }
+            default:
+                throw new Error("Unsupported token standard for getBalance");
+        }
+    }
+    /**
+     * Transfer an asset. This asset can be an ERC20, ERC1155, or ERC721.
+     * @param options
+     * @param options.asset The Asset to transfer. tokenStandard must be set.
+     * @param options.amount Amount of asset to transfer. Not used for ERC721.
+     * @param options.fromAddress The address to transfer from
+     * @param options.toAddress The address to transfer to
+     * @param options.overrides Transaction overrides, ignored if not set.
+     */
+    async transfer({ asset, amount, fromAddress, toAddress, overrides, }) {
+        overrides = { ...overrides, from: fromAddress };
+        let transaction;
+        switch (asset.tokenStandard) {
+            case types_1.TokenStandard.ERC20: {
+                if (!amount) {
+                    throw new Error("Missing ERC20 amount for transfer");
+                }
+                const contract = contracts_1.ERC20__factory.connect(asset.tokenAddress, this.context.signerOrProvider);
+                transaction = contract.transfer(toAddress, amount, overrides);
+                break;
+            }
+            case types_1.TokenStandard.ERC1155: {
+                if (asset.tokenId === undefined || asset.tokenId === null) {
+                    throw new Error("Missing ERC1155 tokenId for transfer");
+                }
+                if (!amount) {
+                    throw new Error("Missing ERC1155 amount for transfer");
+                }
+                const contract = contracts_1.ERC1155__factory.connect(asset.tokenAddress, this.context.signerOrProvider);
+                transaction = contract.safeTransferFrom(fromAddress, toAddress, asset.tokenId, amount, "0x", overrides);
+                break;
+            }
+            case types_1.TokenStandard.ERC721: {
+                if (asset.tokenId === undefined || asset.tokenId === null) {
+                    throw new Error("Missing ERC721 tokenId for transfer");
+                }
+                const contract = contracts_1.ERC721__factory.connect(asset.tokenAddress, this.context.signerOrProvider);
+                transaction = contract.transferFrom(fromAddress, toAddress, asset.tokenId, overrides);
+                break;
+            }
+            default:
+                throw new Error("Unsupported token standard for transfer");
+        }
+        try {
+            const transactionResponse = await transaction;
+            await this.context.confirmTransaction(transactionResponse.hash, types_1.EventType.Transfer, "Transferring asset");
+        }
+        catch (error) {
+            console.error(error);
+            this.context.dispatch(types_1.EventType.TransactionDenied, {
+                error,
+                accountAddress: fromAddress,
+            });
+        }
+    }
+    /**
+     * Bulk transfer multiple assets using OpenSea's TransferHelper contract.
+     * This method is more gas-efficient than calling transfer() multiple times.
+     * Note: All assets must be approved for transfer to the OpenSea conduit before calling this method.
+     * @param options
+     * @param options.assets Array of assets to transfer. Each asset must have tokenStandard set.
+     * @param options.fromAddress The address to transfer from
+     * @param options.overrides Transaction overrides, ignored if not set.
+     * @returns Transaction hash of the bulk transfer
+     *
+     * @throws Error if any asset is missing required fields (tokenId for NFTs, amount for ERC20/ERC1155).
+     * @throws Error if any asset is not approved for transfer to the OpenSea conduit.
+     * @throws Error if the fromAddress is not available through wallet or provider.
+     */
+    async bulkTransfer({ assets, fromAddress, overrides, }) {
+        // Validate basic parameters before making any blockchain calls
+        if (assets.length === 0) {
+            throw new Error("At least one asset must be provided");
+        }
+        // Validate asset data and build transfer items array for TransferHelper
+        // This validation happens before any blockchain calls to ensure proper error messages
+        const transferItems = [];
+        for (const { asset, toAddress, amount } of assets) {
+            let itemType;
+            let identifier;
+            let transferAmount;
+            switch (asset.tokenStandard) {
+                case types_1.TokenStandard.ERC20:
+                    itemType = 1; // ERC20
+                    identifier = "0";
+                    if (!amount) {
+                        throw new Error("Missing ERC20 amount for bulk transfer");
+                    }
+                    transferAmount = amount.toString();
+                    break;
+                case types_1.TokenStandard.ERC721:
+                    itemType = 2; // ERC721
+                    if (asset.tokenId === undefined || asset.tokenId === null) {
+                        throw new Error("Missing ERC721 tokenId for bulk transfer");
+                    }
+                    identifier = asset.tokenId.toString();
+                    transferAmount = "1";
+                    break;
+                case types_1.TokenStandard.ERC1155:
+                    itemType = 3; // ERC1155
+                    if (asset.tokenId === undefined || asset.tokenId === null) {
+                        throw new Error("Missing ERC1155 tokenId for bulk transfer");
+                    }
+                    if (!amount) {
+                        throw new Error("Missing ERC1155 amount for bulk transfer");
+                    }
+                    identifier = asset.tokenId.toString();
+                    transferAmount = amount.toString();
+                    break;
+                default:
+                    throw new Error(`Unsupported token standard for bulk transfer: ${asset.tokenStandard}`);
+            }
+            transferItems.push({
+                itemType,
+                token: asset.tokenAddress,
+                identifier,
+                amount: transferAmount,
+                recipient: toAddress,
+            });
+        }
+        // Check account availability after parameter validation
+        await this.context.requireAccountIsAvailable(fromAddress);
+        // Get the chain-specific default conduit
+        const defaultConduit = (0, utils_1.getDefaultConduit)(this.context.chain);
+        // Check approvals for all assets before attempting transfer
+        const unapprovedAssets = [];
+        for (const { asset, amount } of assets) {
+            const isApproved = await this.checkAssetApproval(asset, fromAddress, defaultConduit.address, amount);
+            if (!isApproved) {
+                const assetIdentifier = asset.tokenId !== undefined
+                    ? `${asset.tokenAddress}:${asset.tokenId}`
+                    : asset.tokenAddress;
+                unapprovedAssets.push(assetIdentifier);
+            }
+        }
+        if (unapprovedAssets.length > 0) {
+            throw new Error(`The following asset(s) are not approved for transfer to the OpenSea conduit:\n${unapprovedAssets.join("\n")}\n\n` +
+                `Please approve these assets before transferring. You can use the batchApproveAssets() method to approve multiple assets efficiently in a single transaction.`);
+        }
+        // Create TransferHelper contract instance
+        const transferHelper = this.getTransferHelperContract();
+        this.context.dispatch(types_1.EventType.Transfer, {
+            accountAddress: fromAddress,
+            assets,
+        });
+        try {
+            // Use chain-specific conduit key for bulk transfers
+            const transaction = await transferHelper.bulkTransfer(transferItems, defaultConduit.key, { ...overrides, from: fromAddress });
+            await this.context.confirmTransaction(transaction.hash, types_1.EventType.Transfer, `Bulk transferring ${assets.length} asset(s)`);
+            return transaction.hash;
+        }
+        catch (error) {
+            console.error(error);
+            this.context.dispatch(types_1.EventType.TransactionDenied, {
+                error,
+                accountAddress: fromAddress,
+            });
+            throw error;
+        }
+    }
+    /**
+     * Batch approve multiple assets for transfer to the OpenSea conduit.
+     * This method checks which assets need approval and batches them efficiently:
+     * - 0 approvals needed: Returns early
+     * - 1 approval needed: Sends single transaction
+     * - 2+ approvals needed: Uses Multicall3 to batch all approvals in one transaction
+     *
+     * @param options
+     * @param options.assets Array of assets to approve for transfer
+     * @param options.fromAddress The address that owns the assets
+     * @param options.overrides Transaction overrides, ignored if not set.
+     * @returns Transaction hash of the approval transaction, or undefined if no approvals needed
+     *
+     * @throws Error if the fromAddress is not available through wallet or provider.
+     */
+    async batchApproveAssets({ assets, fromAddress, overrides, }) {
+        // Validate basic parameters before making any blockchain calls
+        if (assets.length === 0) {
+            return undefined;
+        }
+        // Validate ERC20 assets have amounts before making any blockchain calls
+        for (const { asset, amount } of assets) {
+            if (asset.tokenStandard === types_1.TokenStandard.ERC20 && !amount) {
+                throw new Error(`Amount required for ERC20 approval: ${asset.tokenAddress}`);
+            }
+        }
+        // Check account availability after parameter validation
+        await this.context.requireAccountIsAvailable(fromAddress);
+        // Get the chain-specific default conduit
+        const defaultConduit = (0, utils_1.getDefaultConduit)(this.context.chain);
+        // Check which assets need approval and build approval calldata
+        const approvalsNeeded = [];
+        const processedContracts = new Set();
+        for (const { asset, amount } of assets) {
+            const isApproved = await this.checkAssetApproval(asset, fromAddress, defaultConduit.address, amount);
+            if (!isApproved) {
+                // For ERC721/ERC1155, only approve once per contract
+                if (asset.tokenStandard === types_1.TokenStandard.ERC721 ||
+                    asset.tokenStandard === types_1.TokenStandard.ERC1155) {
+                    if (processedContracts.has(asset.tokenAddress.toLowerCase())) {
+                        continue;
+                    }
+                    processedContracts.add(asset.tokenAddress.toLowerCase());
+                    // setApprovalForAll(operator, true)
+                    const iface = new ethers_1.ethers.Interface([
+                        "function setApprovalForAll(address operator, bool approved)",
+                    ]);
+                    const callData = iface.encodeFunctionData("setApprovalForAll", [
+                        defaultConduit.address,
+                        true,
+                    ]);
+                    approvalsNeeded.push({
+                        target: asset.tokenAddress,
+                        callData,
+                    });
+                }
+                else if (asset.tokenStandard === types_1.TokenStandard.ERC20) {
+                    // approve(spender, amount) - use max uint256 for unlimited
+                    const iface = new ethers_1.ethers.Interface([
+                        "function approve(address spender, uint256 amount) returns (bool)",
+                    ]);
+                    const callData = iface.encodeFunctionData("approve", [
+                        defaultConduit.address,
+                        ethers_1.ethers.MaxUint256, // Approve max for convenience
+                    ]);
+                    approvalsNeeded.push({
+                        target: asset.tokenAddress,
+                        callData,
+                    });
+                }
+            }
+        }
+        // No approvals needed
+        if (approvalsNeeded.length === 0) {
+            return undefined;
+        }
+        // Single approval: send directly
+        if (approvalsNeeded.length === 1) {
+            const { target, callData } = approvalsNeeded[0];
+            const signer = this.context.signerOrProvider;
+            const tx = await signer.sendTransaction({
+                to: target,
+                data: callData,
+                ...overrides,
+                from: fromAddress,
+            });
+            await this.context.confirmTransaction(tx.hash, types_1.EventType.ApproveAllAssets, "Approving asset for transfer");
+            return tx.hash;
+        }
+        // Multiple approvals: use Multicall3
+        const multicall3 = this.getMulticall3Contract();
+        const calls = approvalsNeeded.map(({ target, callData }) => ({
+            target,
+            allowFailure: false,
+            callData,
+        }));
+        try {
+            const transaction = await multicall3.aggregate3(calls, {
+                ...overrides,
+                from: fromAddress,
+            });
+            await this.context.confirmTransaction(transaction.hash, types_1.EventType.ApproveAllAssets, `Batch approving ${approvalsNeeded.length} asset(s) for transfer`);
+            return transaction.hash;
+        }
+        catch (error) {
+            console.error(error);
+            this.context.dispatch(types_1.EventType.TransactionDenied, {
+                error,
+                accountAddress: fromAddress,
+            });
+            throw error;
+        }
+    }
+    /**
+     * Check if an asset is approved for transfer to a specific operator (conduit).
+     * @param asset The asset to check approval for
+     * @param owner The owner address
+     * @param operator The operator address (conduit)
+     * @param amount Optional amount for ERC20 tokens
+     * @returns True if approved, false otherwise
+     */
+    async checkAssetApproval(asset, owner, operator, amount) {
+        try {
+            switch (asset.tokenStandard) {
+                case types_1.TokenStandard.ERC20: {
+                    const contract = contracts_1.ERC20__factory.connect(asset.tokenAddress, this.context.provider);
+                    const allowance = await contract.allowance.staticCall(owner, operator);
+                    // Check if allowance is sufficient
+                    if (!amount) {
+                        return false;
+                    }
+                    return allowance >= BigInt(amount.toString());
+                }
+                case types_1.TokenStandard.ERC721: {
+                    const contract = contracts_1.ERC721__factory.connect(asset.tokenAddress, this.context.provider);
+                    // Check isApprovedForAll first
+                    const isApprovedForAll = await contract.isApprovedForAll.staticCall(owner, operator);
+                    if (isApprovedForAll) {
+                        return true;
+                    }
+                    // Check individual token approval
+                    if (asset.tokenId !== undefined && asset.tokenId !== null) {
+                        const approved = await contract.getApproved.staticCall(asset.tokenId);
+                        return approved.toLowerCase() === operator.toLowerCase();
+                    }
+                    return false;
+                }
+                case types_1.TokenStandard.ERC1155: {
+                    const contract = contracts_1.ERC1155__factory.connect(asset.tokenAddress, this.context.provider);
+                    return await contract.isApprovedForAll.staticCall(owner, operator);
+                }
+                default:
+                    return false;
+            }
+        }
+        catch (error) {
+            // If there's an error checking approval (e.g., contract doesn't exist), return false
+            this.context.logger(`Error checking approval for ${asset.tokenAddress}: ${error}`);
+            return false;
+        }
+    }
+    /**
+     * Get a TransferHelper contract instance.
+     * @returns Contract instance for TransferHelper
+     */
+    getTransferHelperContract() {
+        return new ethers_1.Contract(constants_1.TRANSFER_HELPER_ADDRESS, [
+            "function bulkTransfer(tuple(uint8 itemType, address token, uint256 identifier, uint256 amount, address recipient)[] items, bytes32 conduitKey) external returns (bytes4)",
+        ], this.context.signerOrProvider);
+    }
+    /**
+     * Get a Multicall3 contract instance.
+     * @returns Contract instance for Multicall3
+     */
+    getMulticall3Contract() {
+        return new ethers_1.Contract(constants_1.MULTICALL3_ADDRESS, [
+            "function aggregate3(tuple(address target, bool allowFailure, bytes callData)[] calls) payable returns (tuple(bool success, bytes returnData)[] returnData)",
+        ], this.context.signerOrProvider);
+    }
+}
+exports.AssetsManager = AssetsManager;
+//# sourceMappingURL=assets.js.map

package/lib/sdk/assets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.js","sourceRoot":"","sources":["../../src/sdk/assets.ts"],"names":[],"mappings":";;;AAAA,mCAOe;AACf,4CAA0E;AAC1E,sDAI+B;AAC/B,oCAAgF;AAChF,0CAAkD;AAGlD;;GAEG;AACH,MAAa,aAAa;IACJ;IAApB,YAAoB,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;IAAG,CAAC;IAE3C;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CAAC,EACf,cAAc,EACd,KAAK,GAIN;QACC,QAAQ,KAAK,CAAC,aAAa,EAAE,CAAC;YAC5B,KAAK,qBAAa,CAAC,KAAK,CAAC,CAAC,CAAC;gBACzB,MAAM,QAAQ,GAAG,0BAAc,CAAC,OAAO,CACrC,KAAK,CAAC,YAAY,EAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,CACtB,CAAA;gBACD,OAAO,MAAM,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YAC5D,CAAC;YACD,KAAK,qBAAa,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC3B,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;oBAC1D,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;gBAC3D,CAAC;gBACD,MAAM,QAAQ,GAAG,4BAAgB,CAAC,OAAO,CACvC,KAAK,CAAC,YAAY,EAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,CACtB,CAAA;gBACD,OAAO,MAAM,QAAQ,CAAC,SAAS,CAAC,UAAU,CACxC,cAAc,EACd,KAAK,CAAC,OAAO,CACd,CAAA;YACH,CAAC;YACD,KAAK,qBAAa,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC1B,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;oBAC1D,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;gBAC1D,CAAC;gBACD,MAAM,QAAQ,GAAG,2BAAe,CAAC,OAAO,CACtC,KAAK,CAAC,YAAY,EAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,CACtB,CAAA;gBACD,IAAI,CAAC;oBACH,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;oBAC9D,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,WAAW,EAAE,CAAC,CAAA;gBACrE,CAAC;gBAAC,OAAO,KAAU,EAAE,CAAC;oBACpB,IAAI,CAAC,OAAO,CAAC,MAAM,CACjB,iCAAiC,KAAK,CAAC,OAAO,IAAI,KAAK,EAAE,CAC1D,CAAA;oBACD,OAAO,EAAE,CAAA;gBACX,CAAC;YACH,CAAC;YACD;gBACE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;QAChE,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,QAAQ,CAAC,EACb,KAAK,EACL,MAAM,EACN,WAAW,EACX,SAAS,EACT,SAAS,GAOV;QACC,SAAS,GAAG,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,CAAA;QAC/C,IAAI,WAAiD,CAAA;QAErD,QAAQ,KAAK,CAAC,aAAa,EAAE,CAAC;YAC5B,KAAK,qBAAa,CAAC,KAAK,CAAC,CAAC,CAAC;gBACzB,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;gBACtD,CAAC;gBACD,MAAM,QAAQ,GAAG,0BAAc,CAAC,OAAO,CACrC,KAAK,CAAC,YAAY,EAClB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAC9B,CAAA;gBACD,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,CAAA;gBAC7D,MAAK;YACP,CAAC;YACD,KAAK,qBAAa,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC3B,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;oBAC1D,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;gBACzD,CAAC;gBACD,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;gBACxD,CAAC;gBACD,MAAM,QAAQ,GAAG,4BAAgB,CAAC,OAAO,CACvC,KAAK,CAAC,YAAY,EAClB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAC9B,CAAA;gBACD,WAAW,GAAG,QAAQ,CAAC,gBAAgB,CACrC,WAAW,EACX,SAAS,EACT,KAAK,CAAC,OAAO,EACb,MAAM,EACN,IAAI,EACJ,SAAS,CACV,CAAA;gBACD,MAAK;YACP,CAAC;YACD,KAAK,qBAAa,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC1B,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;oBAC1D,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;gBACxD,CAAC;gBACD,MAAM,QAAQ,GAAG,2BAAe,CAAC,OAAO,CACtC,KAAK,CAAC,YAAY,EAClB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAC9B,CAAA;gBACD,WAAW,GAAG,QAAQ,CAAC,YAAY,CACjC,WAAW,EACX,SAAS,EACT,KAAK,CAAC,OAAO,EACb,SAAS,CACV,CAAA;gBACD,MAAK;YACP,CAAC;YACD;gBACE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;QAC9D,CAAC;QAED,IAAI,CAAC;YACH,MAAM,mBAAmB,GAAG,MAAM,WAAW,CAAA;YAC7C,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,mBAAmB,CAAC,IAAI,EACxB,iBAAS,CAAC,QAAQ,EAClB,oBAAoB,CACrB,CAAA;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACpB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,iBAAiB,EAAE;gBACjD,KAAK;gBACL,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,YAAY,CAAC,EACjB,MAAM,EACN,WAAW,EACX,SAAS,GASV;QACC,+DAA+D;QAC/D,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,CAAC;QAED,wEAAwE;QACxE,sFAAsF;QACtF,MAAM,aAAa,GAMd,EAAE,CAAA;QAEP,KAAK,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,MAAM,EAAE,CAAC;YAClD,IAAI,QAAgB,CAAA;YACpB,IAAI,UAAkB,CAAA;YACtB,IAAI,cAAsB,CAAA;YAE1B,QAAQ,KAAK,CAAC,aAAa,EAAE,CAAC;gBAC5B,KAAK,qBAAa,CAAC,KAAK;oBACtB,QAAQ,GAAG,CAAC,CAAA,CAAC,QAAQ;oBACrB,UAAU,GAAG,GAAG,CAAA;oBAChB,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;oBAC3D,CAAC;oBACD,cAAc,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;oBAClC,MAAK;gBAEP,KAAK,qBAAa,CAAC,MAAM;oBACvB,QAAQ,GAAG,CAAC,CAAA,CAAC,SAAS;oBACtB,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;wBAC1D,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;oBAC7D,CAAC;oBACD,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAA;oBACrC,cAAc,GAAG,GAAG,CAAA;oBACpB,MAAK;gBAEP,KAAK,qBAAa,CAAC,OAAO;oBACxB,QAAQ,GAAG,CAAC,CAAA,CAAC,UAAU;oBACvB,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;wBAC1D,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;oBAC9D,CAAC;oBACD,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;oBAC7D,CAAC;oBACD,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAA;oBACrC,cAAc,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;oBAClC,MAAK;gBAEP;oBACE,MAAM,IAAI,KAAK,CACb,iDAAiD,KAAK,CAAC,aAAa,EAAE,CACvE,CAAA;YACL,CAAC;YAED,aAAa,CAAC,IAAI,CAAC;gBACjB,QAAQ;gBACR,KAAK,EAAE,KAAK,CAAC,YAAY;gBACzB,UAAU;gBACV,MAAM,EAAE,cAAc;gBACtB,SAAS,EAAE,SAAS;aACrB,CAAC,CAAA;QACJ,CAAC;QAED,wDAAwD;QACxD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAA;QAEzD,yCAAyC;QACzC,MAAM,cAAc,GAAG,IAAA,yBAAiB,EAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAE5D,4DAA4D;QAC5D,MAAM,gBAAgB,GAAa,EAAE,CAAA;QACrC,KAAK,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,MAAM,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAC9C,KAAK,EACL,WAAW,EACX,cAAc,CAAC,OAAO,EACtB,MAAM,CACP,CAAA;YACD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,MAAM,eAAe,GACnB,KAAK,CAAC,OAAO,KAAK,SAAS;oBACzB,CAAC,CAAC,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,OAAO,EAAE;oBAC1C,CAAC,CAAC,KAAK,CAAC,YAAY,CAAA;gBACxB,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;YACxC,CAAC;QACH,CAAC;QAED,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,iFAAiF,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;gBAChH,8JAA8J,CACjK,CAAA;QACH,CAAC;QAED,0CAA0C;QAC1C,MAAM,cAAc,GAAG,IAAI,CAAC,yBAAyB,EAAE,CAAA;QAEvD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,QAAQ,EAAE;YACxC,cAAc,EAAE,WAAW;YAC3B,MAAM;SACP,CAAC,CAAA;QAEF,IAAI,CAAC;YACH,oDAAoD;YACpD,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,YAAY,CACnD,aAAa,EACb,cAAc,CAAC,GAAG,EAClB,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,CACpC,CAAA;YAED,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,WAAW,CAAC,IAAI,EAChB,iBAAS,CAAC,QAAQ,EAClB,qBAAqB,MAAM,CAAC,MAAM,WAAW,CAC9C,CAAA;YAED,OAAO,WAAW,CAAC,IAAI,CAAA;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACpB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,iBAAiB,EAAE;gBACjD,KAAK;gBACL,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAA;YACF,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,kBAAkB,CAAC,EACvB,MAAM,EACN,WAAW,EACX,SAAS,GAQV;QACC,+DAA+D;QAC/D,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,wEAAwE;QACxE,KAAK,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,MAAM,EAAE,CAAC;YACvC,IAAI,KAAK,CAAC,aAAa,KAAK,qBAAa,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3D,MAAM,IAAI,KAAK,CACb,uCAAuC,KAAK,CAAC,YAAY,EAAE,CAC5D,CAAA;YACH,CAAC;QACH,CAAC;QAED,wDAAwD;QACxD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAA;QAEzD,yCAAyC;QACzC,MAAM,cAAc,GAAG,IAAA,yBAAiB,EAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAE5D,+DAA+D;QAC/D,MAAM,eAAe,GAAgD,EAAE,CAAA;QACvE,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAA;QAE5C,KAAK,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,MAAM,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAC9C,KAAK,EACL,WAAW,EACX,cAAc,CAAC,OAAO,EACtB,MAAM,CACP,CAAA;YAED,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,qDAAqD;gBACrD,IACE,KAAK,CAAC,aAAa,KAAK,qBAAa,CAAC,MAAM;oBAC5C,KAAK,CAAC,aAAa,KAAK,qBAAa,CAAC,OAAO,EAC7C,CAAC;oBACD,IAAI,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;wBAC7D,SAAQ;oBACV,CAAC;oBACD,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAA;oBAExD,oCAAoC;oBACpC,MAAM,KAAK,GAAG,IAAI,eAAM,CAAC,SAAS,CAAC;wBACjC,6DAA6D;qBAC9D,CAAC,CAAA;oBACF,MAAM,QAAQ,GAAG,KAAK,CAAC,kBAAkB,CAAC,mBAAmB,EAAE;wBAC7D,cAAc,CAAC,OAAO;wBACtB,IAAI;qBACL,CAAC,CAAA;oBACF,eAAe,CAAC,IAAI,CAAC;wBACnB,MAAM,EAAE,KAAK,CAAC,YAAY;wBAC1B,QAAQ;qBACT,CAAC,CAAA;gBACJ,CAAC;qBAAM,IAAI,KAAK,CAAC,aAAa,KAAK,qBAAa,CAAC,KAAK,EAAE,CAAC;oBACvD,2DAA2D;oBAC3D,MAAM,KAAK,GAAG,IAAI,eAAM,CAAC,SAAS,CAAC;wBACjC,kEAAkE;qBACnE,CAAC,CAAA;oBACF,MAAM,QAAQ,GAAG,KAAK,CAAC,kBAAkB,CAAC,SAAS,EAAE;wBACnD,cAAc,CAAC,OAAO;wBACtB,eAAM,CAAC,UAAU,EAAE,8BAA8B;qBAClD,CAAC,CAAA;oBACF,eAAe,CAAC,IAAI,CAAC;wBACnB,MAAM,EAAE,KAAK,CAAC,YAAY;wBAC1B,QAAQ;qBACT,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAED,sBAAsB;QACtB,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,iCAAiC;QACjC,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;YAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,gBAA0B,CAAA;YACtD,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC;gBACtC,EAAE,EAAE,MAAM;gBACV,IAAI,EAAE,QAAQ;gBACd,GAAG,SAAS;gBACZ,IAAI,EAAE,WAAW;aAClB,CAAC,CAAA;YAEF,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,EAAE,CAAC,IAAI,EACP,iBAAS,CAAC,gBAAgB,EAC1B,8BAA8B,CAC/B,CAAA;YAED,OAAO,EAAE,CAAC,IAAI,CAAA;QAChB,CAAC;QAED,qCAAqC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAA;QAE/C,MAAM,KAAK,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;YAC3D,MAAM;YACN,YAAY,EAAE,KAAK;YACnB,QAAQ;SACT,CAAC,CAAC,CAAA;QAEH,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE;gBACrD,GAAG,SAAS;gBACZ,IAAI,EAAE,WAAW;aAClB,CAAC,CAAA;YAEF,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,WAAW,CAAC,IAAI,EAChB,iBAAS,CAAC,gBAAgB,EAC1B,mBAAmB,eAAe,CAAC,MAAM,wBAAwB,CAClE,CAAA;YAED,OAAO,WAAW,CAAC,IAAI,CAAA;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACpB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,iBAAiB,EAAE;gBACjD,KAAK;gBACL,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAA;YACF,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACK,KAAK,CAAC,kBAAkB,CAC9B,KAA6B,EAC7B,KAAa,EACb,QAAgB,EAChB,MAAqB;QAErB,IAAI,CAAC;YACH,QAAQ,KAAK,CAAC,aAAa,EAAE,CAAC;gBAC5B,KAAK,qBAAa,CAAC,KAAK,CAAC,CAAC,CAAC;oBACzB,MAAM,QAAQ,GAAG,0BAAc,CAAC,OAAO,CACrC,KAAK,CAAC,YAAY,EAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,CACtB,CAAA;oBACD,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;oBACtE,mCAAmC;oBACnC,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,OAAO,KAAK,CAAA;oBACd,CAAC;oBACD,OAAO,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;gBAC/C,CAAC;gBAED,KAAK,qBAAa,CAAC,MAAM,CAAC,CAAC,CAAC;oBAC1B,MAAM,QAAQ,GAAG,2BAAe,CAAC,OAAO,CACtC,KAAK,CAAC,YAAY,EAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,CACtB,CAAA;oBACD,+BAA+B;oBAC/B,MAAM,gBAAgB,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,UAAU,CACjE,KAAK,EACL,QAAQ,CACT,CAAA;oBACD,IAAI,gBAAgB,EAAE,CAAC;wBACrB,OAAO,IAAI,CAAA;oBACb,CAAC;oBACD,kCAAkC;oBAClC,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;wBAC1D,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,UAAU,CACpD,KAAK,CAAC,OAAO,CACd,CAAA;wBACD,OAAO,QAAQ,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,CAAA;oBAC1D,CAAC;oBACD,OAAO,KAAK,CAAA;gBACd,CAAC;gBAED,KAAK,qBAAa,CAAC,OAAO,CAAC,CAAC,CAAC;oBAC3B,MAAM,QAAQ,GAAG,4BAAgB,CAAC,OAAO,CACvC,KAAK,CAAC,YAAY,EAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,CACtB,CAAA;oBACD,OAAO,MAAM,QAAQ,CAAC,gBAAgB,CAAC,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;gBACpE,CAAC;gBAED;oBACE,OAAO,KAAK,CAAA;YAChB,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,qFAAqF;YACrF,IAAI,CAAC,OAAO,CAAC,MAAM,CACjB,+BAA+B,KAAK,CAAC,YAAY,KAAK,KAAK,EAAE,CAC9D,CAAA;YACD,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,yBAAyB;QAC/B,OAAO,IAAI,iBAAQ,CACjB,mCAAuB,EACvB;YACE,0KAA0K;SAC3K,EACD,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAC9B,CAAA;IACH,CAAC;IAED;;;OAGG;IACK,qBAAqB;QAC3B,OAAO,IAAI,iBAAQ,CACjB,8BAAkB,EAClB;YACE,4JAA4J;SAC7J,EACD,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAC9B,CAAA;IACH,CAAC;CACF;AAzjBD,sCAyjBC"}

package/lib/sdk/cancellation.d.ts

@@ -0,0 +1,97 @@
+import type { OrderComponents } from "@opensea/seaport-js/lib/types";
+import type { Overrides } from "ethers";
+import type { OrderV2 } from "../orders/types";
+import { type Chain } from "../types";
+import type { SDKContext } from "./context";
+/**
+ * Order cancellation operations
+ */
+export declare class CancellationManager {
+    private context;
+    constructor(context: SDKContext);
+    /**
+     * 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}.
+     */
+    cancelOrder({ order, orderHash, accountAddress, protocolAddress, domain, }: {
+        order?: OrderV2;
+        orderHash?: string;
+        accountAddress: string;
+        protocolAddress?: string;
+        domain?: string;
+    }): Promise<void>;
+    /**
+     * 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}.
+     */
+    cancelOrders({ orders, orderHashes, accountAddress, protocolAddress, domain, overrides, }: {
+        orders?: Array<OrderV2 | OrderComponents>;
+        orderHashes?: string[];
+        accountAddress: string;
+        protocolAddress?: string;
+        domain?: string;
+        overrides?: Overrides;
+    }): Promise<string>;
+    /**
+     * 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.
+     */
+    private cancelSeaportOrders;
+    /**
+     * 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.
+     */
+    getOffererSignature(protocolAddress: string, orderHash: string, chain: Chain): Promise<string>;
+    /**
+     * 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.
+     */
+    offchainCancelOrder(protocolAddress: string, orderHash: string, chain?: Chain, offererSignature?: string, useSignerToDeriveOffererSignature?: boolean): Promise<import("../api/types").CancelOrderResponse>;
+}