@0xsequence/marketplace-sdk 0.9.0 → 1.0.0

package/src/react/hooks/useShopCollectibleSaleData.tsx

@@ -1,349 +0,0 @@
-import { useMemo } from 'react';
-
-import type { Address } from 'viem';
-import { useReadContract } from 'wagmi';
-import {
-	ERC721_ABI,
-	ERC721_SALE_ABI,
-	ERC1155_SALES_CONTRACT_ABI,
-	SEQUENCE_1155_ITEMS_ABI,
-} from '../../utils';
-import { ContractType } from '../_internal';
-
-interface ShopCollectibleSaleData {
-	salePrice: { amount: string; currencyAddress: Address } | null;
-	paymentToken: Address | null;
-	supplyCap: string;
-	totalMinted: string;
-	quantityRemaining: string;
-	startTime: number | null;
-	endTime: number | null;
-	isActive: boolean;
-	isLoading: boolean;
-	error: Error | null;
-	isAvailable: boolean;
-}
-
-interface BaseShopCollectibleSaleDataProps {
-	chainId: number;
-	salesContractAddress: Address;
-	itemsContractAddress: Address;
-	enabled?: boolean;
-}
-
-interface ERC721ShopCollectibleSaleDataProps
-	extends BaseShopCollectibleSaleDataProps {
-	collectionType: ContractType.ERC721;
-	tokenId?: string;
-}
-
-interface ERC1155ShopCollectibleSaleDataProps
-	extends BaseShopCollectibleSaleDataProps {
-	collectionType: ContractType.ERC1155;
-	tokenId: string;
-}
-
-type UseShopCollectibleSaleDataProps =
-	| ERC721ShopCollectibleSaleDataProps
-	| ERC1155ShopCollectibleSaleDataProps;
-
-export function useShopCollectibleSaleData({
-	chainId,
-	salesContractAddress,
-	itemsContractAddress,
-	tokenId,
-	collectionType,
-	enabled = true,
-}: UseShopCollectibleSaleDataProps): ShopCollectibleSaleData {
-	// ERC721 Sales Contract Calls
-	const {
-		data: erc721SaleDetails,
-		isLoading: erc721SaleLoading,
-		error: erc721SaleError,
-	} = useReadContract({
-		chainId,
-		address: salesContractAddress,
-		abi: ERC721_SALE_ABI,
-		functionName: 'saleDetails',
-		query: {
-			enabled: enabled && collectionType === ContractType.ERC721,
-		},
-	});
-
-	const {
-		data: erc721TotalSupply,
-		isLoading: erc721SupplyLoading,
-		error: erc721SupplyError,
-	} = useReadContract({
-		chainId,
-		address: itemsContractAddress,
-		abi: ERC721_ABI,
-		functionName: 'totalSupply',
-		query: {
-			enabled: enabled && collectionType === ContractType.ERC721,
-		},
-	});
-
-	// ERC1155 Sales Contract Calls
-	const {
-		data: erc1155TokenSaleDetails,
-		isLoading: erc1155TokenSaleLoading,
-		error: erc1155TokenSaleError,
-	} = useReadContract({
-		chainId,
-		address: salesContractAddress,
-		abi: ERC1155_SALES_CONTRACT_ABI,
-		functionName: 'tokenSaleDetails',
-		args:
-			collectionType === ContractType.ERC1155 ? [BigInt(tokenId)] : undefined,
-		query: {
-			enabled: enabled && collectionType === ContractType.ERC1155,
-		},
-	});
-
-	const {
-		data: erc1155GlobalSaleDetails,
-		isLoading: erc1155GlobalSaleLoading,
-		error: erc1155GlobalSaleError,
-	} = useReadContract({
-		chainId,
-		address: salesContractAddress,
-		abi: ERC1155_SALES_CONTRACT_ABI,
-		functionName: 'globalSaleDetails',
-		query: {
-			enabled: enabled && collectionType === ContractType.ERC1155,
-		},
-	});
-
-	const {
-		data: erc1155PaymentToken,
-		isLoading: erc1155PaymentTokenLoading,
-		error: erc1155PaymentTokenError,
-	} = useReadContract({
-		chainId,
-		address: salesContractAddress,
-		abi: ERC1155_SALES_CONTRACT_ABI,
-		functionName: 'paymentToken',
-		query: {
-			enabled: enabled && collectionType === ContractType.ERC1155,
-		},
-	});
-
-	const {
-		data: erc1155TotalSupply,
-		isLoading: erc1155SupplyLoading,
-		error: erc1155SupplyError,
-	} = useReadContract({
-		chainId,
-		address: itemsContractAddress,
-		abi: SEQUENCE_1155_ITEMS_ABI,
-		functionName: 'totalSupply',
-		query: {
-			enabled: enabled && collectionType === ContractType.ERC1155,
-		},
-	});
-
-	return useMemo(() => {
-		const isLoading =
-			collectionType === ContractType.ERC721
-				? erc721SaleLoading || erc721SupplyLoading
-				: erc1155TokenSaleLoading ||
-					erc1155GlobalSaleLoading ||
-					erc1155PaymentTokenLoading ||
-					erc1155SupplyLoading;
-
-		const error =
-			collectionType === ContractType.ERC721
-				? erc721SaleError || erc721SupplyError
-				: erc1155TokenSaleError ||
-					erc1155GlobalSaleError ||
-					erc1155PaymentTokenError ||
-					erc1155SupplyError;
-
-		if (isLoading) {
-			return {
-				salePrice: null,
-				paymentToken: null,
-				supplyCap: '0',
-				totalMinted: '0',
-				quantityRemaining: '0',
-				startTime: null,
-				endTime: null,
-				isActive: false,
-				isLoading: true,
-				error: null,
-				isAvailable: false,
-			};
-		}
-
-		if (error) {
-			return {
-				salePrice: null,
-				paymentToken: null,
-				supplyCap: '0',
-				totalMinted: '0',
-				quantityRemaining: '0',
-				startTime: null,
-				endTime: null,
-				isActive: false,
-				isLoading: false,
-				error: error as Error,
-				isAvailable: false,
-			};
-		}
-
-		if (
-			collectionType === ContractType.ERC721 &&
-			erc721SaleDetails &&
-			erc721TotalSupply !== undefined
-		) {
-			const saleDetails = erc721SaleDetails as {
-				supplyCap: bigint;
-				cost: bigint;
-				paymentToken: Address;
-				startTime: bigint;
-				endTime: bigint;
-				merkleRoot: string;
-			};
-
-			const supplyCap = saleDetails.supplyCap.toString();
-			const totalMinted = erc721TotalSupply.toString();
-			const quantityRemaining = (
-				saleDetails.supplyCap - erc721TotalSupply
-			).toString();
-
-			const now = Math.floor(Date.now() / 1000);
-			const startTime = Number(saleDetails.startTime);
-			const endTime = Number(saleDetails.endTime);
-			const isActive = now >= startTime && now <= endTime;
-
-			return {
-				salePrice: {
-					amount: saleDetails.cost.toString(),
-					currencyAddress: saleDetails.paymentToken,
-				},
-				paymentToken: saleDetails.paymentToken,
-				supplyCap,
-				totalMinted,
-				quantityRemaining,
-				startTime,
-				endTime,
-				isActive,
-				isLoading: false,
-				error: null,
-				isAvailable: BigInt(quantityRemaining) > 0 && isActive,
-			};
-		}
-
-		if (
-			collectionType === ContractType.ERC1155 &&
-			erc1155PaymentToken &&
-			erc1155TotalSupply !== undefined &&
-			(erc1155TokenSaleDetails || erc1155GlobalSaleDetails)
-		) {
-			// Type the sale details structures
-			type SaleDetails = {
-				cost: bigint;
-				supplyCap: bigint;
-				startTime: bigint;
-				endTime: bigint;
-				merkleRoot: string;
-			};
-
-			const tokenSaleDetails = erc1155TokenSaleDetails as
-				| SaleDetails
-				| undefined;
-			const globalSaleDetails = erc1155GlobalSaleDetails as
-				| SaleDetails
-				| undefined;
-
-			// If token-specific details have zero values, use global as fallback
-			const useGlobal = tokenSaleDetails && tokenSaleDetails.supplyCap === 0n;
-			const finalSaleDetails = useGlobal
-				? globalSaleDetails
-				: tokenSaleDetails || globalSaleDetails;
-
-			if (!finalSaleDetails) {
-				return {
-					salePrice: null,
-					paymentToken: null,
-					supplyCap: '0',
-					totalMinted: '0',
-					quantityRemaining: '0',
-					startTime: null,
-					endTime: null,
-					isActive: false,
-					isLoading: false,
-					error: null,
-					isAvailable: false,
-				};
-			}
-
-			const supplyCap = finalSaleDetails.supplyCap.toString();
-			const totalMintedBigInt = erc1155TotalSupply
-				? BigInt(erc1155TotalSupply as bigint)
-				: 0n;
-			const totalMinted = totalMintedBigInt.toString();
-			const quantityRemaining = (
-				finalSaleDetails.supplyCap - totalMintedBigInt
-			).toString();
-
-			const now = Math.floor(Date.now() / 1000);
-			const startTime = Number(finalSaleDetails.startTime);
-			const endTime = Number(finalSaleDetails.endTime);
-			const isActive = now >= startTime && now <= endTime;
-
-			return {
-				salePrice: {
-					amount: finalSaleDetails.cost.toString(),
-					currencyAddress: erc1155PaymentToken,
-				},
-				paymentToken: erc1155PaymentToken,
-				supplyCap,
-				totalMinted,
-				quantityRemaining,
-				startTime,
-				endTime,
-				isActive,
-				isLoading: false,
-				error: null,
-				isAvailable: BigInt(quantityRemaining) > 0 && isActive,
-			};
-		}
-
-		// No valid data found
-		return {
-			salePrice: null,
-			paymentToken: null,
-			supplyCap: '0',
-			totalMinted: '0',
-			quantityRemaining: '0',
-			startTime: null,
-			endTime: null,
-			isActive: false,
-			isLoading: false,
-			error: null,
-			isAvailable: false,
-		};
-	}, [
-		collectionType,
-		erc721SaleDetails,
-		erc721TotalSupply,
-		erc721SaleLoading,
-		erc721SupplyLoading,
-		erc721SaleError,
-		erc721SupplyError,
-		erc1155TokenSaleDetails,
-		erc1155GlobalSaleDetails,
-		erc1155PaymentToken,
-		erc1155TotalSupply,
-		erc1155TokenSaleLoading,
-		erc1155GlobalSaleLoading,
-		erc1155PaymentTokenLoading,
-		erc1155SupplyLoading,
-		erc1155TokenSaleError,
-		erc1155GlobalSaleError,
-		erc1155PaymentTokenError,
-		erc1155SupplyError,
-	]);
-}

package/src/react/hooks/useTokenSaleDetailsBatch.tsx

@@ -1,134 +0,0 @@
-import { useQuery } from '@tanstack/react-query';
-import { getUnixTime } from 'date-fns';
-import type { Address } from 'viem';
-import { useReadContracts } from 'wagmi';
-import { ERC1155_SALES_CONTRACT_ABI } from '../..';
-import { getIndexerClient } from '../_internal';
-import { useConfig } from './useConfig';
-
-interface useTokenSaleDetailsBatch {
-	tokenIds: string[];
-	salesContractAddress: Address;
-	collectionAddress: Address;
-	chainId: number;
-	query?: {
-		enabled?: boolean;
-	};
-}
-
-export function useTokenSaleDetailsBatch({
-	tokenIds,
-	salesContractAddress,
-	chainId,
-	collectionAddress,
-	query,
-}: useTokenSaleDetailsBatch) {
-	const config = useConfig();
-	const indexerClient = getIndexerClient(chainId, config);
-
-	const getReadContractsArgs = (tokenIds: string[]) =>
-		tokenIds.map((tokenId) => ({
-			address: salesContractAddress,
-			abi: ERC1155_SALES_CONTRACT_ABI,
-			functionName: 'tokenSaleDetails',
-			args: [tokenId],
-			chainId,
-		}));
-
-	const {
-		data: tokenSaleDetails,
-		isLoading: tokenSaleDetailsLoading,
-		error: tokenSaleDetailsError,
-	} = useReadContracts({
-		batchSize: 500_000, // Node gateway limit has a limit of 512kB, setting it to 500kB to be safe
-		contracts: getReadContractsArgs(tokenIds),
-		query: {
-			enabled: query?.enabled,
-		},
-	});
-
-	// Query token supplies individually using the indexer client:
-	/*
-	This way, if token 4 isn't minted, we can still get the supply information for tokens 0-3, and just treat token 4's supply as 0 (unminted). 
-	The problem is essentially that one unminted token was poisoning the entire response when querying all tokens at once.
-	*/
-	const {
-		data: tokenSupplies,
-		isLoading: tokenSuppliesLoading,
-		error: tokenSuppliesError,
-	} = useQuery({
-		queryKey: ['token-supplies-batch', chainId, collectionAddress, tokenIds],
-		queryFn: async () => {
-			const supplies = await Promise.all(
-				tokenIds.map(async (tokenId) => {
-					try {
-						const result = await indexerClient.getTokenSuppliesMap({
-							tokenMap: {
-								[collectionAddress]: [tokenId],
-							},
-							includeMetadata: false,
-						});
-						const supply = result.supplies?.[collectionAddress]?.find(
-							(s) => s.tokenID === tokenId,
-						);
-						return {
-							tokenId,
-							supply: supply ? Number(supply.supply) : 0,
-							error: null,
-						};
-					} catch (error) {
-						return {
-							tokenId,
-							supply: 0,
-							error,
-						};
-					}
-				}),
-			);
-			return supplies;
-		},
-		enabled: query?.enabled,
-	});
-
-	const extendedSupplyData = (tokenSaleDetails || [])
-		.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 getInitialSupply = (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);
-	};
-
-	const getRemainingSupply = (tokenId: string): number | undefined => {
-		const initialSupply = getInitialSupply(tokenId);
-		if (!initialSupply) return undefined;
-
-		const supplyData = tokenSupplies?.find((s) => s.tokenId === tokenId);
-		if (!supplyData || supplyData.error) return initialSupply; // If no supply data or error, assume nothing is minted
-
-		return initialSupply - supplyData.supply;
-	};
-
-	return {
-		extendedSupplyData,
-		getInitialSupply,
-		getRemainingSupply,
-		loading: tokenSuppliesLoading || tokenSaleDetailsLoading,
-		error: tokenSuppliesError || tokenSaleDetailsError,
-	};
-}

package/src/react/provider.tsx

@@ -1,43 +0,0 @@
-'use client';
-
-import { QueryClientProvider } from '@tanstack/react-query';
-import { createContext } from 'react';
-import type { SdkConfig } from '../types';
-import { InvalidProjectAccessKeyError } from '../utils/_internal/error/config';
-import { getQueryClient } from './_internal/api/get-query-client';
-import { PROVIDER_ID } from './_internal/get-provider';
-
-export const MarketplaceSdkContext = createContext({} as SdkConfig);
-
-export type MarketplaceSdkProviderProps = {
-	config: SdkConfig;
-	children: React.ReactNode;
-};
-
-export function MarketplaceQueryClientProvider({
-	children,
-}: {
-	children: React.ReactNode;
-}) {
-	const queryClient = getQueryClient();
-	return (
-		<QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
-	);
-}
-
-export function MarketplaceProvider({
-	config,
-	children,
-}: MarketplaceSdkProviderProps) {
-	if (config.projectAccessKey === '' || !config.projectAccessKey) {
-		throw new InvalidProjectAccessKeyError(config.projectAccessKey);
-	}
-
-	return (
-		<MarketplaceQueryClientProvider>
-			<MarketplaceSdkContext.Provider value={config}>
-				<div id={PROVIDER_ID}>{children}</div>
-			</MarketplaceSdkContext.Provider>
-		</MarketplaceQueryClientProvider>
-	);
-}

package/src/react/queries/getTokenSuppliesMap.ts

@@ -1,77 +0,0 @@
-import type { GetTokenSuppliesMapArgs } from '@0xsequence/indexer';
-import { queryOptions } from '@tanstack/react-query';
-import type { SdkConfig } from '../../types';
-import {
-	collectableKeys,
-	getIndexerClient,
-	type ValuesOptional,
-} from '../_internal';
-import type { StandardQueryOptions } from '../types/query';
-
-export interface FetchGetTokenSuppliesMapParams
-	extends Omit<GetTokenSuppliesMapArgs, 'tokenMap'> {
-	chainId: number;
-	tokenIds: string[];
-	collectionAddress: string;
-	config: SdkConfig;
-}
-
-/**
- * Fetches token supplies mapping from the indexer API
- */
-export async function fetchGetTokenSuppliesMap(
-	params: FetchGetTokenSuppliesMapParams,
-) {
-	const { chainId, tokenIds, collectionAddress, config } = params;
-	const indexerClient = getIndexerClient(chainId, config);
-
-	const {
-		chainId: _,
-		tokenIds: __,
-		collectionAddress: ___,
-		config: ____,
-		...restParams
-	} = params;
-
-	return indexerClient.getTokenSuppliesMap({
-		tokenMap: {
-			[collectionAddress]: tokenIds,
-		},
-		includeMetadata: false,
-		...restParams,
-	});
-}
-
-export type GetTokenSuppliesMapQueryOptions =
-	ValuesOptional<FetchGetTokenSuppliesMapParams> & {
-		query?: StandardQueryOptions;
-	};
-
-export function getTokenSuppliesMapQueryOptions(
-	params: GetTokenSuppliesMapQueryOptions,
-) {
-	const enabled = Boolean(
-		params.chainId &&
-			params.tokenIds?.length &&
-			params.collectionAddress &&
-			params.config &&
-			(params.query?.enabled ?? true),
-	);
-
-	return queryOptions({
-		queryKey: [...collectableKeys.lists, 'tokenSuppliesMap', params],
-		queryFn: () =>
-			fetchGetTokenSuppliesMap({
-				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined
-				chainId: params.chainId!,
-				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined
-				tokenIds: params.tokenIds!,
-				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined
-				collectionAddress: params.collectionAddress!,
-				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined
-				config: params.config!,
-			}),
-		...params.query,
-		enabled,
-	});
-}

package/src/react/ui/modals/TransferModal/_store.ts

@@ -1,66 +0,0 @@
-import { observable } from '@legendapp/state';
-import type { Hex } from 'viem';
-import type { CollectionType } from '../../../_internal';
-import type { ModalCallbacks } from '../_internal/types';
-import type { ShowTransferModalArgs } from '.';
-
-export type TransferModalView =
-	| 'enterReceiverAddress'
-	| 'followWalletInstructions'
-	| undefined;
-
-export interface TransferModalState {
-	isOpen: boolean;
-	open: (args: ShowTransferModalArgs) => void;
-	close: () => void;
-	state: {
-		chainId: number;
-		collectionAddress: Hex;
-		collectionType?: CollectionType | undefined;
-		collectibleId: string;
-		quantity: string;
-		receiverAddress: string;
-		callbacks?: ModalCallbacks;
-		transferIsBeingProcessed: boolean;
-	};
-	view: TransferModalView;
-	hash: Hex | undefined;
-}
-
-export const initialState: TransferModalState = {
-	isOpen: false,
-	open: ({
-		chainId,
-		collectionAddress,
-		collectibleId,
-		callbacks,
-	}: ShowTransferModalArgs) => {
-		transferModal$.state.set({
-			...transferModal$.state.get(),
-			chainId,
-			collectionAddress,
-			collectibleId,
-			callbacks,
-		});
-		transferModal$.isOpen.set(true);
-	},
-	close: () => {
-		transferModal$.isOpen.set(false);
-		transferModal$.state.receiverAddress.set('');
-		transferModal$.state.transferIsBeingProcessed.set(false);
-		transferModal$.view.set('enterReceiverAddress');
-		transferModal$.hash.set(undefined);
-	},
-	state: {
-		receiverAddress: '',
-		collectionAddress: '0x',
-		chainId: 0,
-		collectibleId: '',
-		quantity: '1',
-		transferIsBeingProcessed: false,
-	},
-	view: 'enterReceiverAddress',
-	hash: undefined,
-};
-
-export const transferModal$ = observable(initialState);