@opensea/sdk 9.0.0

package/lib/orders/utils.js

@@ -0,0 +1,177 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeOrder = exports.serializeOrdersQueryOptions = exports.getFulfillOfferPayload = exports.getFulfillListingPayload = exports.getFulfillmentDataPath = exports.getBuildCollectionOfferPayload = exports.getPostCollectionOfferPayload = exports.DEFAULT_SEAPORT_CONTRACT_ADDRESS = void 0;
+const constants_1 = require("@opensea/seaport-js/lib/constants");
+const apiPaths_1 = require("../api/apiPaths");
+const types_1 = require("../types");
+const utils_1 = require("../utils");
+exports.DEFAULT_SEAPORT_CONTRACT_ADDRESS = constants_1.CROSS_CHAIN_SEAPORT_V1_6_ADDRESS;
+const getPostCollectionOfferPayload = (collectionSlug, protocol_data, chain, traitType, traitValue, traits, numericTraits) => {
+    const payload = {
+        criteria: {
+            collection: { slug: collectionSlug },
+        },
+        protocol_data,
+        protocol_address: (0, utils_1.getSeaportAddress)(chain),
+    };
+    // Prioritize traits array if provided
+    if (traits && traits.length > 0) {
+        ;
+        payload.criteria.traits = traits;
+    }
+    else if (traitType && traitValue) {
+        // Fallback to single trait for backward compatibility
+        ;
+        payload.criteria.trait = {
+            type: traitType,
+            value: traitValue,
+        };
+    }
+    if (numericTraits && numericTraits.length > 0) {
+        ;
+        payload.criteria.numericTraits = numericTraits;
+    }
+    return payload;
+};
+exports.getPostCollectionOfferPayload = getPostCollectionOfferPayload;
+const getBuildCollectionOfferPayload = (offererAddress, quantity, collectionSlug, offerProtectionEnabled, chain, traitType, traitValue, traits, numericTraits) => {
+    const payload = {
+        offerer: offererAddress,
+        quantity,
+        criteria: {
+            collection: {
+                slug: collectionSlug,
+            },
+        },
+        protocol_address: (0, utils_1.getSeaportAddress)(chain),
+        offer_protection_enabled: offerProtectionEnabled,
+    };
+    // Prioritize traits array if provided
+    if (traits && traits.length > 0) {
+        ;
+        payload.criteria.traits = traits;
+    }
+    else if (traitType && traitValue) {
+        // Fallback to single trait for backward compatibility
+        ;
+        payload.criteria.trait = {
+            type: traitType,
+            value: traitValue,
+        };
+    }
+    if (numericTraits && numericTraits.length > 0) {
+        ;
+        payload.criteria.numericTraits = numericTraits;
+    }
+    return payload;
+};
+exports.getBuildCollectionOfferPayload = getBuildCollectionOfferPayload;
+const getFulfillmentDataPath = (side) => {
+    const sidePath = side === types_1.OrderSide.LISTING ? "listings" : "offers";
+    return `${apiPaths_1.API_V2_PREFIX}/${sidePath}/fulfillment_data`;
+};
+exports.getFulfillmentDataPath = getFulfillmentDataPath;
+const getFulfillListingPayload = (fulfillerAddress, order_hash, protocolAddress, chain, assetContractAddress, tokenId, unitsToFill = "1", recipientAddress, includeOptionalCreatorFees = false) => {
+    const payload = {
+        listing: {
+            hash: order_hash,
+            chain,
+            protocol_address: protocolAddress,
+        },
+        fulfiller: {
+            address: fulfillerAddress,
+        },
+        units_to_fill: unitsToFill,
+        include_optional_creator_fees: includeOptionalCreatorFees,
+    };
+    // Add consideration for criteria listings if needed
+    if (assetContractAddress && tokenId) {
+        payload.consideration = {
+            asset_contract_address: assetContractAddress,
+            token_id: tokenId,
+        };
+    }
+    // Add optional recipient for listings
+    if (recipientAddress) {
+        payload.recipient = recipientAddress;
+    }
+    return payload;
+};
+exports.getFulfillListingPayload = getFulfillListingPayload;
+const getFulfillOfferPayload = (fulfillerAddress, order_hash, protocolAddress, chain, assetContractAddress, tokenId, unitsToFill = "1", includeOptionalCreatorFees = false) => {
+    const payload = {
+        offer: {
+            hash: order_hash,
+            chain,
+            protocol_address: protocolAddress,
+        },
+        fulfiller: {
+            address: fulfillerAddress,
+        },
+        units_to_fill: unitsToFill,
+        include_optional_creator_fees: includeOptionalCreatorFees,
+    };
+    // Add consideration for criteria offers (e.g., collection offers)
+    if (assetContractAddress && tokenId) {
+        payload.consideration = {
+            asset_contract_address: assetContractAddress,
+            token_id: tokenId,
+        };
+    }
+    return payload;
+};
+exports.getFulfillOfferPayload = getFulfillOfferPayload;
+const serializeOrdersQueryOptions = (options) => {
+    const tokenIds = options.tokenIds && options.tokenIds.length > 0
+        ? options.tokenIds
+        : options.tokenId !== undefined
+            ? [options.tokenId]
+            : options.tokenIds;
+    return {
+        limit: options.limit,
+        cursor: options.cursor ?? options.next,
+        payment_token_address: options.paymentTokenAddress,
+        maker: options.maker,
+        taker: options.taker,
+        owner: options.owner,
+        listed_after: options.listedAfter,
+        listed_before: options.listedBefore,
+        token_ids: tokenIds,
+        asset_contract_address: options.assetContractAddress,
+        order_by: options.orderBy,
+        order_direction: options.orderDirection,
+        only_english: options.onlyEnglish,
+    };
+};
+exports.serializeOrdersQueryOptions = serializeOrdersQueryOptions;
+const deserializeOrder = (order) => {
+    return {
+        createdDate: order.created_date,
+        closingDate: order.closing_date,
+        listingTime: order.listing_time,
+        expirationTime: order.expiration_time,
+        orderHash: order.order_hash,
+        maker: (0, utils_1.accountFromJSON)(order.maker),
+        taker: order.taker ? (0, utils_1.accountFromJSON)(order.taker) : null,
+        protocolData: order.protocol_data,
+        protocolAddress: order.protocol_address,
+        currentPrice: BigInt(order.current_price),
+        makerFees: (order.maker_fees ?? []).map(({ account, basis_points }) => ({
+            account: (0, utils_1.accountFromJSON)(account),
+            basisPoints: basis_points,
+        })),
+        takerFees: (order.taker_fees ?? []).map(({ account, basis_points }) => ({
+            account: (0, utils_1.accountFromJSON)(account),
+            basisPoints: basis_points,
+        })),
+        side: order.side,
+        orderType: order.order_type,
+        cancelled: order.cancelled,
+        finalized: order.finalized,
+        markedInvalid: order.marked_invalid,
+        clientSignature: order.client_signature,
+        remainingQuantity: order.remaining_quantity,
+    };
+};
+exports.deserializeOrder = deserializeOrder;
+//# sourceMappingURL=utils.js.map

package/lib/orders/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/orders/utils.ts"],"names":[],"mappings":";;;AAAA,iEAAoF;AACpF,8CAA+C;AAC/C,oCAAgD;AAChD,oCAA6D;AAQhD,QAAA,gCAAgC,GAAG,4CAAgC,CAAA;AAEzE,MAAM,6BAA6B,GAAG,CAC3C,cAAsB,EACtB,aAA2B,EAC3B,KAAY,EACZ,SAAkB,EAClB,UAAmB,EACnB,MAA+C,EAC/C,aAAmE,EACnE,EAAE;IACF,MAAM,OAAO,GAAG;QACd,QAAQ,EAAE;YACR,UAAU,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE;SACrC;QACD,aAAa;QACb,gBAAgB,EAAE,IAAA,yBAAiB,EAAC,KAAK,CAAC;KAC3C,CAAA;IAED,sCAAsC;IACtC,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,CAAC;QAAC,OAAO,CAAC,QAAgB,CAAC,MAAM,GAAG,MAAM,CAAA;IAC5C,CAAC;SAAM,IAAI,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,sDAAsD;QACtD,CAAC;QAAC,OAAO,CAAC,QAAgB,CAAC,KAAK,GAAG;YACjC,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,UAAU;SAClB,CAAA;IACH,CAAC;IACD,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9C,CAAC;QAAC,OAAO,CAAC,QAAgB,CAAC,aAAa,GAAG,aAAa,CAAA;IAC1D,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AA/BY,QAAA,6BAA6B,iCA+BzC;AAEM,MAAM,8BAA8B,GAAG,CAC5C,cAAsB,EACtB,QAAgB,EAChB,cAAsB,EACtB,sBAA+B,EAC/B,KAAY,EACZ,SAAkB,EAClB,UAAmB,EACnB,MAA+C,EAC/C,aAAmE,EACnE,EAAE;IACF,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,cAAc;QACvB,QAAQ;QACR,QAAQ,EAAE;YACR,UAAU,EAAE;gBACV,IAAI,EAAE,cAAc;aACrB;SACF;QACD,gBAAgB,EAAE,IAAA,yBAAiB,EAAC,KAAK,CAAC;QAC1C,wBAAwB,EAAE,sBAAsB;KACjD,CAAA;IAED,sCAAsC;IACtC,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,CAAC;QAAC,OAAO,CAAC,QAAgB,CAAC,MAAM,GAAG,MAAM,CAAA;IAC5C,CAAC;SAAM,IAAI,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,sDAAsD;QACtD,CAAC;QAAC,OAAO,CAAC,QAAgB,CAAC,KAAK,GAAG;YACjC,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,UAAU;SAClB,CAAA;IACH,CAAC;IACD,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9C,CAAC;QAAC,OAAO,CAAC,QAAgB,CAAC,aAAa,GAAG,aAAa,CAAA;IAC1D,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AArCY,QAAA,8BAA8B,kCAqC1C;AAEM,MAAM,sBAAsB,GAAG,CAAC,IAAe,EAAE,EAAE;IACxD,MAAM,QAAQ,GAAG,IAAI,KAAK,iBAAS,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAA;IACnE,OAAO,GAAG,wBAAa,IAAI,QAAQ,mBAAmB,CAAA;AACxD,CAAC,CAAA;AAHY,QAAA,sBAAsB,0BAGlC;AAEM,MAAM,wBAAwB,GAAG,CACtC,gBAAwB,EACxB,UAAkB,EAClB,eAAuB,EACvB,KAAY,EACZ,oBAA6B,EAC7B,OAAgB,EAChB,cAAsB,GAAG,EACzB,gBAAyB,EACzB,6BAAsC,KAAK,EAC3C,EAAE;IACF,MAAM,OAAO,GAgBT;QACF,OAAO,EAAE;YACP,IAAI,EAAE,UAAU;YAChB,KAAK;YACL,gBAAgB,EAAE,eAAe;SAClC;QACD,SAAS,EAAE;YACT,OAAO,EAAE,gBAAgB;SAC1B;QACD,aAAa,EAAE,WAAW;QAC1B,6BAA6B,EAAE,0BAA0B;KAC1D,CAAA;IAED,oDAAoD;IACpD,IAAI,oBAAoB,IAAI,OAAO,EAAE,CAAC;QACpC,OAAO,CAAC,aAAa,GAAG;YACtB,sBAAsB,EAAE,oBAAoB;YAC5C,QAAQ,EAAE,OAAO;SAClB,CAAA;IACH,CAAC;IAED,sCAAsC;IACtC,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,CAAC,SAAS,GAAG,gBAAgB,CAAA;IACtC,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAtDY,QAAA,wBAAwB,4BAsDpC;AAEM,MAAM,sBAAsB,GAAG,CACpC,gBAAwB,EACxB,UAAkB,EAClB,eAAuB,EACvB,KAAY,EACZ,oBAA6B,EAC7B,OAAgB,EAChB,cAAsB,GAAG,EACzB,6BAAsC,KAAK,EAC3C,EAAE;IACF,MAAM,OAAO,GAeT;QACF,KAAK,EAAE;YACL,IAAI,EAAE,UAAU;YAChB,KAAK;YACL,gBAAgB,EAAE,eAAe;SAClC;QACD,SAAS,EAAE;YACT,OAAO,EAAE,gBAAgB;SAC1B;QACD,aAAa,EAAE,WAAW;QAC1B,6BAA6B,EAAE,0BAA0B;KAC1D,CAAA;IAED,kEAAkE;IAClE,IAAI,oBAAoB,IAAI,OAAO,EAAE,CAAC;QACpC,OAAO,CAAC,aAAa,GAAG;YACtB,sBAAsB,EAAE,oBAAoB;YAC5C,QAAQ,EAAE,OAAO;SAClB,CAAA;IACH,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AA/CY,QAAA,sBAAsB,0BA+ClC;AAGM,MAAM,2BAA2B,GAAG,CACzC,OAAyD,EACzD,EAAE;IACF,MAAM,QAAQ,GACZ,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;QAC7C,CAAC,CAAC,OAAO,CAAC,QAAQ;QAClB,CAAC,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS;YAC7B,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;YACnB,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAA;IAExB,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI;QAEtC,qBAAqB,EAAE,OAAO,CAAC,mBAAmB;QAClD,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,YAAY,EAAE,OAAO,CAAC,WAAW;QACjC,aAAa,EAAE,OAAO,CAAC,YAAY;QACnC,SAAS,EAAE,QAAQ;QACnB,sBAAsB,EAAE,OAAO,CAAC,oBAAoB;QACpD,QAAQ,EAAE,OAAO,CAAC,OAAO;QACzB,eAAe,EAAE,OAAO,CAAC,cAAc;QACvC,YAAY,EAAE,OAAO,CAAC,WAAW;KAClC,CAAA;AACH,CAAC,CAAA;AA1BY,QAAA,2BAA2B,+BA0BvC;AAEM,MAAM,gBAAgB,GAAG,CAAC,KAAwB,EAAW,EAAE;IACpE,OAAO;QACL,WAAW,EAAE,KAAK,CAAC,YAAY;QAC/B,WAAW,EAAE,KAAK,CAAC,YAAY;QAC/B,WAAW,EAAE,KAAK,CAAC,YAAY;QAC/B,cAAc,EAAE,KAAK,CAAC,eAAe;QACrC,SAAS,EAAE,KAAK,CAAC,UAAU;QAC3B,KAAK,EAAE,IAAA,uBAAe,EAAC,KAAK,CAAC,KAAK,CAAC;QACnC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAA,uBAAe,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI;QACxD,YAAY,EAAE,KAAK,CAAC,aAAa;QACjC,eAAe,EAAE,KAAK,CAAC,gBAAgB;QACvC,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC;QACzC,SAAS,EAAE,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,CAAC;YACtE,OAAO,EAAE,IAAA,uBAAe,EAAC,OAAO,CAAC;YACjC,WAAW,EAAE,YAAY;SAC1B,CAAC,CAAC;QACH,SAAS,EAAE,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,CAAC;YACtE,OAAO,EAAE,IAAA,uBAAe,EAAC,OAAO,CAAC;YACjC,WAAW,EAAE,YAAY;SAC1B,CAAC,CAAC;QACH,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,SAAS,EAAE,KAAK,CAAC,UAAU;QAC3B,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,aAAa,EAAE,KAAK,CAAC,cAAc;QACnC,eAAe,EAAE,KAAK,CAAC,gBAAgB;QACvC,iBAAiB,EAAE,KAAK,CAAC,kBAAkB;KAC5C,CAAA;AACH,CAAC,CAAA;AA5BY,QAAA,gBAAgB,oBA4B5B"}

package/lib/sdk/assets.d.ts

@@ -0,0 +1,104 @@
+import { type BigNumberish, type Overrides } from "ethers";
+import { type AssetWithTokenStandard } from "../types";
+import type { SDKContext } from "./context";
+/**
+ * Asset transfer and approval operations
+ */
+export declare class AssetsManager {
+    private context;
+    constructor(context: SDKContext);
+    /**
+     * 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.
+     */
+    getBalance({ accountAddress, asset, }: {
+        accountAddress: string;
+        asset: AssetWithTokenStandard;
+    }): Promise<bigint>;
+    /**
+     * 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.
+     */
+    transfer({ asset, amount, fromAddress, toAddress, overrides, }: {
+        asset: AssetWithTokenStandard;
+        amount?: BigNumberish;
+        fromAddress: string;
+        toAddress: string;
+        overrides?: Overrides;
+    }): Promise<void>;
+    /**
+     * 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.
+     */
+    bulkTransfer({ assets, fromAddress, overrides, }: {
+        assets: Array<{
+            asset: AssetWithTokenStandard;
+            toAddress: string;
+            amount?: BigNumberish;
+        }>;
+        fromAddress: string;
+        overrides?: Overrides;
+    }): Promise<string>;
+    /**
+     * 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.
+     */
+    batchApproveAssets({ assets, fromAddress, overrides, }: {
+        assets: Array<{
+            asset: AssetWithTokenStandard;
+            amount?: BigNumberish;
+        }>;
+        fromAddress: string;
+        overrides?: Overrides;
+    }): Promise<string | undefined>;
+    /**
+     * 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
+     */
+    private checkAssetApproval;
+    /**
+     * Get a TransferHelper contract instance.
+     * @returns Contract instance for TransferHelper
+     */
+    private getTransferHelperContract;
+    /**
+     * Get a Multicall3 contract instance.
+     * @returns Contract instance for Multicall3
+     */
+    private getMulticall3Contract;
+}