@0xsequence/marketplace-sdk 0.9.0 → 1.0.0

package/src/react/hooks/useGetTokenRanges.tsx

@@ -1,31 +0,0 @@
-import { useQuery } from '@tanstack/react-query';
-import type { Address } from 'viem';
-import { useConfig } from '..';
-import { getIndexerClient } from '../_internal';
-
-interface UseGetTokenRangesProps {
-	chainId: number;
-	collectionAddress: Address;
-	query?: {
-		enabled?: boolean;
-	};
-}
-
-export function useGetTokenRanges({
-	chainId,
-	collectionAddress,
-	query = {},
-}: UseGetTokenRangesProps) {
-	const config = useConfig();
-	const indexerClient = getIndexerClient(chainId, config);
-
-	return useQuery({
-		queryKey: ['indexer-tokenRanges', chainId, collectionAddress],
-		queryFn: () => {
-			return indexerClient.getTokenIDRanges({
-				contractAddress: collectionAddress,
-			});
-		},
-		enabled: query?.enabled,
-	});
-}

package/src/react/hooks/useGetTokenSuppliesMap.tsx

@@ -1,73 +0,0 @@
-'use client';
-
-import { useQuery } from '@tanstack/react-query';
-import type { Optional } from '../_internal';
-import {
-	type FetchGetTokenSuppliesMapParams,
-	type GetTokenSuppliesMapQueryOptions,
-	getTokenSuppliesMapQueryOptions,
-} from '../queries/getTokenSuppliesMap';
-import { useConfig } from './useConfig';
-
-export type UseGetTokenSuppliesMapParams = Optional<
-	GetTokenSuppliesMapQueryOptions,
-	'config'
->;
-
-/**
- * Hook to fetch token supplies mapping from the indexer
- *
- * Retrieves supply information for multiple tokens within a collection using the indexer API.
- * This is useful for getting supply data for batches of tokens efficiently.
- *
- * @param params - Configuration parameters
- * @param params.chainId - The chain ID (must be number, e.g., 1 for Ethereum, 137 for Polygon)
- * @param params.collectionAddress - The collection contract address
- * @param params.tokenIds - Array of token IDs to fetch supplies for
- * @param params.config - Optional SDK configuration (defaults from context)
- * @param params.query - Optional React Query configuration
- *
- * @returns Query result containing token supplies mapping
- *
- * @example
- * Basic usage:
- * ```typescript
- * const { data: suppliesMap, isLoading } = useGetTokenSuppliesMap({
- *   chainId: 137,
- *   collectionAddress: '0x...',
- *   tokenIds: ['1', '2', '3']
- * })
- * ```
- *
- * @example
- * With query options:
- * ```typescript
- * const { data: suppliesMap } = useGetTokenSuppliesMap({
- *   chainId: 1,
- *   collectionAddress: '0x...',
- *   tokenIds: selectedTokenIds,
- *   query: {
- *     enabled: selectedTokenIds.length > 0,
- *     staleTime: 30 * 1000 // 30 seconds
- *   }
- * })
- * ```
- */
-export function useGetTokenSuppliesMap(params: UseGetTokenSuppliesMapParams) {
-	const defaultConfig = useConfig();
-
-	const { config = defaultConfig, ...rest } = params;
-
-	const queryOptions = getTokenSuppliesMapQueryOptions({
-		config,
-		...rest,
-	});
-
-	return useQuery({
-		...queryOptions,
-	});
-}
-
-export { getTokenSuppliesMapQueryOptions };
-
-export type { FetchGetTokenSuppliesMapParams, GetTokenSuppliesMapQueryOptions };

package/src/react/hooks/useList1155SaleSupplies.tsx

@@ -1,62 +0,0 @@
-import { getUnixTime } from 'date-fns';
-import type { Address } from 'viem';
-import { useReadContracts } from 'wagmi';
-import { ERC1155_SALES_CONTRACT_ABI } from '../..';
-
-interface UseSaleSupplyDataProps {
-	tokenIds: string[];
-	salesContractAddress: Address;
-}
-
-export function useList1155SaleSupplies({
-	tokenIds,
-	salesContractAddress,
-}: UseSaleSupplyDataProps) {
-	const getReadContractsArgs = (tokenIds: string[]) =>
-		tokenIds.map((tokenId) => ({
-			address: salesContractAddress,
-			abi: ERC1155_SALES_CONTRACT_ABI,
-			functionName: 'tokenSaleDetails',
-			args: [tokenId],
-		}));
-
-	const {
-		data: supplyData,
-		isLoading: supplyDataLoading,
-		error: supplyDataError,
-	} = useReadContracts({
-		batchSize: 500_000, // Node gateway limit has a limit of 512kB, setting it to 500kB to be safe
-		contracts: getReadContractsArgs(tokenIds),
-	});
-
-	const extendedSupplyData = (supplyData || [])
-		.map((data, index) => ({
-			...data,
-			tokenId: tokenIds[index],
-		}))
-		.filter((data) => data.status === 'success')
-		.filter((data) => {
-			if (typeof data.result !== 'object') return false;
-			const now = BigInt(getUnixTime(new Date()));
-			return data.result.endTime > now && data.result.startTime < now;
-		});
-
-	const getSupply = (tokenId: string): number | undefined => {
-		const found = extendedSupplyData.find((data) => data.tokenId === tokenId);
-		if (!found || typeof found.result !== 'object' || found.result === null)
-			return undefined;
-		const supply = found.result.supplyCap;
-		if (supply === undefined) return undefined;
-		// https://github.com/0xsequence/contracts-library/blob/ead1baf34270c76260d01cfc130bb7cc9d57518e/src/tokens/ERC1155/utility/sale/IERC1155Sale.sol#L8
-		// 0 means infinite
-		if (supply === 0n) return Number.POSITIVE_INFINITY;
-		return Number(supply);
-	};
-
-	return {
-		extendedSupplyData,
-		getSupply,
-		supplyDataLoading,
-		supplyDataError,
-	};
-}

package/src/react/hooks/useList721ShopCardData.tsx

@@ -1,160 +0,0 @@
-import type { Address } from 'viem';
-import { useReadContract } from 'wagmi';
-import { ContractType, OrderSide, type TokenMetadata } from '../../types';
-import { ERC721_SALE_ABI } from '../../utils';
-import type { ShopCollectibleCardProps } from '../ui/components/marketplace-collectible-card/types';
-import { useFilterState } from './useFilterState';
-import { useListCollectibles } from './useListCollectibles';
-import { useListPrimarySaleItems } from './useListPrimarySaleItems';
-
-interface UseList721ShopCardDataProps {
-	tokenIds: string[];
-	chainId: number;
-	contractAddress: Address;
-	salesContractAddress: Address;
-	enabled?: boolean;
-}
-
-export function useList721ShopCardData({
-	tokenIds,
-	chainId,
-	contractAddress,
-	salesContractAddress,
-	enabled = true,
-}: UseList721ShopCardDataProps) {
-	const { showListedOnly } = useFilterState();
-
-	const {
-		data: primarySaleItems,
-		isLoading: primarySaleItemsLoading,
-		error: primarySaleItemsError,
-	} = useListPrimarySaleItems({
-		chainId,
-		primarySaleContractAddress: salesContractAddress,
-		filter: {
-			includeEmpty: !showListedOnly,
-		},
-	});
-
-	// Check if we have minted tokens by looking at the first available token ID
-	const firstAvailableTokenId =
-		primarySaleItems?.pages[0]?.primarySaleItems[0]?.primarySaleItem.tokenId?.toString();
-	const hasMintedTokens: boolean =
-		Boolean(firstAvailableTokenId) && Number(firstAvailableTokenId) > 0;
-
-	// Fetch metadata for minted tokens
-	const { data: mintedTokensMetadata, isLoading: mintedTokensMetadataLoading } =
-		useListCollectibles({
-			chainId,
-			collectionAddress: contractAddress,
-			side: OrderSide.listing,
-			filter: {
-				includeEmpty: true,
-			},
-			query: {
-				enabled: enabled && hasMintedTokens,
-			},
-		});
-
-	// For ERC721, we'll fetch the sale details directly from the contract
-	const {
-		data: saleDetails,
-		isLoading: saleDetailsLoading,
-		error: saleDetailsError,
-	} = useReadContract({
-		chainId,
-		address: salesContractAddress,
-		abi: ERC721_SALE_ABI,
-		functionName: 'saleDetails',
-		query: {
-			enabled,
-		},
-	});
-
-	const isLoading =
-		saleDetailsLoading ||
-		primarySaleItemsLoading ||
-		mintedTokensMetadataLoading;
-
-	// Create a map of token metadata from minted tokens
-	const mintedTokensMetadataMap = new Map<string, TokenMetadata>();
-	for (const page of mintedTokensMetadata?.pages ?? []) {
-		for (const collectible of page.collectibles) {
-			mintedTokensMetadataMap.set(
-				collectible.metadata.tokenId,
-				collectible.metadata,
-			);
-		}
-	}
-
-	const collectibleCards = tokenIds.map((tokenId) => {
-		const minted =
-			hasMintedTokens && Number(tokenId) < Number(firstAvailableTokenId);
-
-		const matchingPrimarySaleItem = primarySaleItems?.pages
-			.flatMap((page) => page.primarySaleItems)
-			.find(
-				(item: { primarySaleItem: { tokenId: { toString: () => string } } }) =>
-					item.primarySaleItem.tokenId?.toString() === tokenId,
-			);
-
-		const saleData = matchingPrimarySaleItem?.primarySaleItem;
-		let tokenMetadata = matchingPrimarySaleItem?.metadata;
-
-		// If token is minted, prefer metadata from mintedTokensMetadata
-		if (minted && mintedTokensMetadataMap.has(tokenId)) {
-			tokenMetadata = mintedTokensMetadataMap.get(tokenId);
-		}
-		// Fallback to empty metadata if none found
-		tokenMetadata = tokenMetadata || ({} as TokenMetadata);
-
-		const salePrice = saleData
-			? {
-					amount: saleData.priceAmount?.toString() || '',
-					currencyAddress: saleData.currencyAddress as Address,
-				}
-			: {
-					amount: saleDetails?.cost?.toString() || '',
-					currencyAddress: saleDetails?.paymentToken ?? ('0x' as Address),
-				};
-
-		const quantityInitial =
-			saleData?.supply?.toString() ??
-			(saleDetails?.supplyCap ? saleDetails.supplyCap.toString() : undefined);
-
-		const quantityRemaining = minted ? undefined : '1';
-
-		const saleStartsAt =
-			saleData?.startDate?.toString() ?? saleDetails?.startTime?.toString();
-
-		const saleEndsAt =
-			saleData?.endDate?.toString() ?? saleDetails?.endTime?.toString();
-
-		return {
-			collectibleId: tokenId,
-			chainId,
-			collectionAddress: contractAddress,
-			collectionType: ContractType.ERC721,
-			tokenMetadata: tokenMetadata,
-			cardLoading: isLoading,
-			salesContractAddress: salesContractAddress,
-			salePrice,
-			quantityInitial,
-			quantityRemaining,
-			quantityDecimals: 0,
-			saleStartsAt,
-			saleEndsAt,
-			marketplaceType: 'shop',
-		} satisfies ShopCollectibleCardProps;
-	});
-
-	return {
-		salePrice: collectibleCards[0]?.salePrice,
-		collectibleCards,
-		saleDetailsError,
-		primarySaleItemsError,
-		saleDetails,
-		primarySaleItems,
-		isLoading,
-	};
-}

package/src/react/hooks/useListCollections.tsx

@@ -1,80 +0,0 @@
-'use client';
-
-import { useQuery } from '@tanstack/react-query';
-import type { Optional } from '../_internal';
-import {
-	type FetchListCollectionsParams,
-	type ListCollectionsQueryOptions,
-	listCollectionsQueryOptions,
-} from '../queries/listCollections';
-import { useConfig } from './useConfig';
-import { useMarketplaceConfig } from './useMarketplaceConfig';
-
-export type UseListCollectionsParams = Optional<
-	ListCollectionsQueryOptions,
-	'config' | 'marketplaceConfig'
->;
-
-/**
- * Hook to fetch a list of collections from the marketplace
- *
- * This hook fetches collections from the marketplace configuration and enriches them with
- * metadata from the metadata API. Collections can be filtered by marketplace type (market/shop).
- *
- * @param params - Configuration parameters
- * @param params.marketplaceType - Optional filter for marketplace type ('market' or 'shop')
- * @param params.marketplaceConfig - Optional marketplace configuration (defaults from context)
- * @param params.config - Optional SDK configuration (defaults from context)
- * @param params.query - Optional React Query configuration
- *
- * @returns Query result containing an array of collections with metadata
- *
- * @example
- * Basic usage - fetch all collections:
- * ```typescript
- * const { data: collections, isLoading } = useListCollections()
- * ```
- *
- * @example
- * Filter by marketplace type:
- * ```typescript
- * const { data: marketCollections } = useListCollections({
- *   marketplaceType: 'market'
- * })
- * ```
- *
- * @example
- * With custom query options:
- * ```typescript
- * const { data: collections } = useListCollections({
- *   query: {
- *     enabled: isReady,
- *     staleTime: 5 * 60 * 1000 // 5 minutes
- *   }
- * })
- * ```
- */
-export function useListCollections(params: UseListCollectionsParams = {}) {
-	const defaultConfig = useConfig();
-	const { data: defaultMarketplaceConfig } = useMarketplaceConfig();
-
-	const {
-		config = defaultConfig,
-		marketplaceConfig = defaultMarketplaceConfig,
-		...rest
-	} = params;
-
-	const queryOptions = listCollectionsQueryOptions({
-		config,
-		marketplaceConfig,
-		...rest,
-	});
-
-	return useQuery({
-		...queryOptions,
-	});
-}
-
-export { listCollectionsQueryOptions };
-
-export type { FetchListCollectionsParams, ListCollectionsQueryOptions };

package/src/react/hooks/useListPrimarySaleItems.ts

@@ -1,102 +0,0 @@
-import { useInfiniteQuery, useQuery } from '@tanstack/react-query';
-import type { Address } from 'viem';
-import type { SdkConfig } from '../../types';
-import {
-	getMarketplaceClient,
-	type ListPrimarySaleItemsArgs,
-	type ListPrimarySaleItemsReturn,
-	type Page,
-	type PrimarySaleItemsFilter,
-} from '../_internal';
-import { useConfig } from './useConfig';
-
-interface UseListPrimarySaleItemsArgs {
-	chainId: number;
-	primarySaleContractAddress: Address | undefined;
-	filter?: PrimarySaleItemsFilter;
-	page?: Page;
-	query?: {
-		enabled?: boolean;
-	};
-}
-
-const fetchListPrimarySaleItems = async (
-	args: ListPrimarySaleItemsArgs,
-	config: SdkConfig,
-): Promise<ListPrimarySaleItemsReturn> => {
-	const arg = {
-		chainId: String(args.chainId),
-		primarySaleContractAddress: args.primarySaleContractAddress,
-		filter: args.filter,
-		page: args.page,
-	} satisfies ListPrimarySaleItemsArgs;
-
-	const marketplaceClient = getMarketplaceClient(config);
-	return marketplaceClient.listPrimarySaleItems(arg);
-};
-
-const listPrimarySaleItemsOptions = (
-	args: UseListPrimarySaleItemsArgs,
-	config: SdkConfig,
-) => {
-	const primarySaleContractAddress = args.primarySaleContractAddress as Address;
-	return {
-		queryKey: ['listPrimarySaleItems', args],
-		queryFn: async ({ pageParam }: { pageParam: Page }) => {
-			return fetchListPrimarySaleItems(
-				{
-					chainId: String(args.chainId),
-					primarySaleContractAddress,
-					filter: args.filter,
-					page: pageParam,
-				},
-				config,
-			);
-		},
-		initialPageParam: { page: 1, pageSize: 30 } as Page,
-		getNextPageParam: (lastPage: ListPrimarySaleItemsReturn) =>
-			lastPage.page?.more
-				? {
-						page: lastPage.page?.page || 1,
-						pageSize: lastPage.page?.pageSize || 30,
-					}
-				: undefined,
-		...args.query,
-		enabled: !!primarySaleContractAddress && args.query?.enabled !== false,
-	};
-};
-
-export const useListPrimarySaleItems = (args: UseListPrimarySaleItemsArgs) => {
-	const config = useConfig();
-	return useInfiniteQuery(listPrimarySaleItemsOptions(args, config));
-};
-
-interface UseGetCountOfPrimarySaleItemsArgs {
-	chainId: number;
-	primarySaleContractAddress: Address | undefined;
-	filter?: PrimarySaleItemsFilter;
-	query?: {
-		enabled?: boolean;
-	};
-}
-
-export const useGetCountOfPrimarySaleItems = (
-	args: UseGetCountOfPrimarySaleItemsArgs,
-) => {
-	const config = useConfig();
-
-	return useQuery({
-		queryKey: ['getCountOfPrimarySaleItems', args],
-		queryFn: async () => {
-			const marketplaceClient = getMarketplaceClient(config);
-
-			return marketplaceClient.getCountOfPrimarySaleItems({
-				chainId: String(args.chainId),
-				primarySaleContractAddress: args.primarySaleContractAddress || '',
-				filter: args.filter,
-			});
-		},
-		...args.query,
-		enabled: !!args.primarySaleContractAddress && args.query?.enabled !== false,
-	});
-};

package/src/react/hooks/useListShopCardData.tsx

@@ -1,70 +0,0 @@
-import type { Address } from 'viem';
-import { ContractType } from '../_internal';
-import { useList721ShopCardData } from './useList721ShopCardData';
-import { useList1155ShopCardData } from './useList1155ShopCardData';
-
-interface UseListShopCardDataProps {
-	tokenIds: string[];
-	chainId: number;
-	contractAddress: Address;
-	salesContractAddress: Address;
-	contractType: ContractType | undefined;
-	enabled?: boolean;
-}
-
-export function useListShopCardData({
-	tokenIds,
-	chainId,
-	contractAddress,
-	salesContractAddress,
-	contractType,
-	enabled = true,
-}: UseListShopCardDataProps) {
-	const shouldUse721 = contractType === ContractType.ERC721;
-	const shouldUse1155 = contractType === ContractType.ERC1155;
-
-	const erc721Data = useList721ShopCardData({
-		tokenIds,
-		chainId,
-		contractAddress,
-		salesContractAddress,
-		enabled: enabled && shouldUse721,
-	});
-
-	const erc1155Data = useList1155ShopCardData({
-		tokenIds,
-		chainId,
-		contractAddress,
-		salesContractAddress,
-		enabled: enabled && shouldUse1155,
-	});
-
-	if (shouldUse721) {
-		return erc721Data;
-	}
-
-	if (shouldUse1155) {
-		// Map ERC1155 data to match ERC721 structure
-		return {
-			collectibleCards: erc1155Data.collectibleCards,
-			isLoading: erc1155Data.isLoading,
-			saleDetailsError: erc1155Data.tokenSaleDetailsError,
-			primarySaleItemsError: erc1155Data.tokenMetadataError,
-			saleDetails: undefined,
-			primarySaleItems: undefined,
-			salePrice: erc1155Data.collectibleCards[0]?.salePrice,
-		};
-	}
-
-	// Return a default state when contract type is not determined yet
-	return {
-		collectibleCards: [],
-		isLoading: !contractType,
-		collectionDetailsError: null,
-		saleDetailsError: null,
-		primarySaleItemsError: null,
-		saleDetails: undefined,
-		primarySaleItems: undefined,
-		salePrice: undefined,
-	};
-}