@0xsequence/marketplace-sdk 1.1.0 → 1.2.0

package/src/react/queries/{collection.ts → collections/collection.ts}

@@ -1,8 +1,13 @@
+import type { GetContractInfoArgs } from '@0xsequence/metadata';
 import { queryOptions } from '@tanstack/react-query';
-import type { SdkConfig } from '../../types';
-import { getMetadataClient, type ValuesOptional } from '../_internal';
-import { collectionKeys } from '../_internal/api/query-keys';
-import type { StandardQueryOptions } from '../types/query';
+import type { SdkConfig } from '../../../types';
+import {
+	getMetadataClient,
+	type QueryKeyArgs,
+	type ValuesOptional,
+} from '../../_internal';
+import { collectionKeys } from '../../_internal/api/query-keys';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface FetchCollectionParams {
 	chainId: number;
@@ -30,6 +35,15 @@ export type CollectionQueryOptions = ValuesOptional<FetchCollectionParams> & {
 	query?: StandardQueryOptions;
 };
 
+export function getCollectionQueryKey(params: CollectionQueryOptions) {
+	const apiArgs = {
+		chainID: String(params.chainId),
+		contractAddress: params.collectionAddress,
+	} satisfies QueryKeyArgs<GetContractInfoArgs>;
+
+	return [...collectionKeys.detail, apiArgs] as const;
+}
+
 export function collectionQueryOptions(params: CollectionQueryOptions) {
 	const enabled = Boolean(
 		params.collectionAddress &&
@@ -39,7 +53,7 @@ export function collectionQueryOptions(params: CollectionQueryOptions) {
 	);
 
 	return queryOptions({
-		queryKey: [...collectionKeys.detail, params],
+		queryKey: getCollectionQueryKey(params),
 		queryFn: () =>
 			fetchCollection({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

package/src/react/queries/{collectionBalanceDetails.ts → collections/collectionBalanceDetails.ts}

@@ -1,9 +1,13 @@
 import type { GetTokenBalancesDetailsReturn } from '@0xsequence/indexer';
 import { queryOptions } from '@tanstack/react-query';
 import type { Address } from 'viem';
-import type { SdkConfig } from '../../types';
-import { getIndexerClient, type ValuesOptional } from '../_internal';
-import type { StandardQueryOptions } from '../types/query';
+import type { SdkConfig } from '../../../types';
+import {
+	balanceQueries,
+	getIndexerClient,
+	type ValuesOptional,
+} from '../../_internal';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface CollectionBalanceFilter {
 	accountAddresses: Array<Address>;
@@ -65,6 +69,17 @@ export type CollectionBalanceDetailsQueryOptions =
 		query?: StandardQueryOptions;
 	};
 
+export function getCollectionBalanceDetailsQueryKey(
+	params: CollectionBalanceDetailsQueryOptions,
+) {
+	const apiArgs = {
+		chainId: params.chainId!,
+		filter: params.filter!,
+	};
+
+	return [...balanceQueries.collectionBalanceDetails, apiArgs] as const;
+}
+
 export function collectionBalanceDetailsQueryOptions(
 	params: CollectionBalanceDetailsQueryOptions,
 ) {
@@ -76,7 +91,7 @@ export function collectionBalanceDetailsQueryOptions(
 	);
 
 	return queryOptions({
-		queryKey: ['balances', 'collectionBalanceDetails', params],
+		queryKey: getCollectionBalanceDetailsQueryKey(params),
 		queryFn: () =>
 			fetchCollectionBalanceDetails({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

package/src/react/queries/{collectionDetails.ts → collections/collectionDetails.ts}

@@ -1,9 +1,13 @@
 import { queryOptions } from '@tanstack/react-query';
-import type { SdkConfig } from '../../types';
-import { getMarketplaceClient, type ValuesOptional } from '../_internal';
-import type { GetCollectionDetailArgs } from '../_internal/api/marketplace.gen';
-import { collectionKeys } from '../_internal/api/query-keys';
-import type { StandardQueryOptions } from '../types/query';
+import type { SdkConfig } from '../../../types';
+import {
+	getMarketplaceClient,
+	type QueryKeyArgs,
+	type ValuesOptional,
+} from '../../_internal';
+import type { GetCollectionDetailArgs } from '../../_internal/api/marketplace.gen';
+import { collectionKeys } from '../../_internal/api/query-keys';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface FetchCollectionDetailsParams
 	extends Omit<GetCollectionDetailArgs, 'chainId' | 'contractAddress'> {
@@ -37,6 +41,17 @@ export type CollectionDetailsQueryOptions =
 		query?: StandardQueryOptions;
 	};
 
+export function getCollectionDetailsQueryKey(
+	params: CollectionDetailsQueryOptions,
+) {
+	const apiArgs = {
+		chainId: String(params.chainId),
+		contractAddress: params.collectionAddress,
+	} satisfies QueryKeyArgs<GetCollectionDetailArgs>;
+
+	return [...collectionKeys.detail, apiArgs] as const;
+}
+
 export function collectionDetailsQueryOptions(
 	params: CollectionDetailsQueryOptions,
 ) {
@@ -48,7 +63,7 @@ export function collectionDetailsQueryOptions(
 	);
 
 	return queryOptions({
-		queryKey: [...collectionKeys.detail, params],
+		queryKey: getCollectionDetailsQueryKey(params),
 		queryFn: () =>
 			fetchCollectionDetails({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

package/src/react/queries/collections/index.ts

@@ -0,0 +1,7 @@
+export * from './activeListingsCurrencies';
+export * from './activeOffersCurrencies';
+export * from './collection';
+export * from './collectionBalanceDetails';
+export * from './collectionDetails';
+export * from './listCollectionActivities';
+export * from './listCollections';

package/src/react/queries/{listCollectionActivities.ts → collections/listCollectionActivities.ts}

@@ -1,15 +1,16 @@
 import { queryOptions } from '@tanstack/react-query';
 import type { Address } from 'viem';
-import type { Page, SdkConfig } from '../../types';
+import type { Page, SdkConfig } from '../../../types';
 import type {
 	ListCollectionActivitiesArgs,
 	ListCollectionActivitiesReturn,
+	QueryKeyArgs,
 	SortBy,
 	ValuesOptional,
-} from '../_internal';
-import { getMarketplaceClient } from '../_internal';
-import { collectionKeys } from '../_internal/api';
-import type { StandardQueryOptions } from '../types/query';
+} from '../../_internal';
+import { getMarketplaceClient } from '../../_internal';
+import { collectionKeys } from '../../_internal/api';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface FetchListCollectionActivitiesParams
 	extends Omit<
@@ -65,6 +66,27 @@ export type ListCollectionActivitiesQueryOptions =
 		query?: StandardQueryOptions;
 	};
 
+export function getListCollectionActivitiesQueryKey(
+	params: ListCollectionActivitiesQueryOptions,
+) {
+	const page =
+		params.page || params.pageSize || params.sort
+			? {
+					page: params.page ?? 1,
+					pageSize: params.pageSize ?? 10,
+					sort: params.sort,
+				}
+			: undefined;
+
+	const apiArgs = {
+		chainId: String(params.chainId),
+		contractAddress: params.collectionAddress,
+		page: page,
+	} satisfies QueryKeyArgs<ListCollectionActivitiesArgs>;
+
+	return [...collectionKeys.collectionActivities, apiArgs] as const;
+}
+
 export function listCollectionActivitiesQueryOptions(
 	params: ListCollectionActivitiesQueryOptions,
 ) {
@@ -76,7 +98,7 @@ export function listCollectionActivitiesQueryOptions(
 	);
 
 	return queryOptions({
-		queryKey: [...collectionKeys.collectionActivities, params],
+		queryKey: getListCollectionActivitiesQueryKey(params),
 		queryFn: () =>
 			fetchListCollectionActivities({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

package/src/react/queries/{listCollections.ts → collections/listCollections.ts}

@@ -1,18 +1,18 @@
 import type { ContractInfo } from '@0xsequence/metadata';
 import { queryOptions, skipToken } from '@tanstack/react-query';
-import type { CardType, SdkConfig } from '../../types';
+import type { CardType, SdkConfig } from '../../../types';
 import type {
 	MarketCollection,
 	MarketplaceConfig,
 	ShopCollection,
-} from '../../types/new-marketplace-types';
-import { compareAddress } from '../../utils';
+} from '../../../types/new-marketplace-types';
+import { compareAddress } from '../../../utils';
 import {
 	collectionKeys,
 	getMetadataClient,
 	type ValuesOptional,
-} from '../_internal';
-import type { StandardQueryOptions } from '../types/query';
+} from '../../_internal';
+import type { StandardQueryOptions } from '../../types/query';
 
 const allCollections = (marketplaceConfig: MarketplaceConfig) => {
 	return [
@@ -113,6 +113,17 @@ export type ListCollectionsQueryOptions =
 		query?: StandardQueryOptions;
 	};
 
+export function getListCollectionsQueryKey(
+	params: ListCollectionsQueryOptions,
+) {
+	const queryKeyParams = {
+		cardType: params.cardType,
+		marketplaceConfig: params.marketplaceConfig,
+	} as const;
+
+	return [...collectionKeys.list, queryKeyParams] as const;
+}
+
 export function listCollectionsQueryOptions(
 	params: ListCollectionsQueryOptions,
 ) {
@@ -123,7 +134,7 @@ export function listCollectionsQueryOptions(
 	);
 
 	return queryOptions({
-		queryKey: [...collectionKeys.list, params],
+		queryKey: getListCollectionsQueryKey(params),
 		queryFn: enabled
 			? () =>
 					fetchListCollections({

package/src/react/queries/index.ts

@@ -1,35 +1,8 @@
-export * from './balanceOfCollectible';
-export * from './checkoutOptions';
-export * from './checkoutOptionsSalesContract';
-export * from './collectible';
-export * from './collection';
-export * from './collectionBalanceDetails';
-export * from './collectionDetails';
-export * from './comparePrices';
-export * from './convertPriceToUSD';
-export * from './countListingsForCollectible';
-export * from './countOfCollectables';
-export * from './countOffersForCollectible';
-export * from './countOfPrimarySaleItems';
-export * from './currency';
-export * from './filters';
-export * from './floorOrder';
-export * from './getTokenRanges';
-export * from './highestOffer';
+export * from './collectibles';
+export * from './collections';
 export * from './inventory';
-export * from './listBalances';
-export * from './listCollectibleActivities';
-export * from './listCollectibles';
-export * from './listCollectiblesPaginated';
-export * from './listCollectionActivities';
-export * from './listCollections';
-export * from './listListingsForCollectible';
-export * from './listOffersForCollectible';
-export * from './listTokenMetadata';
-export * from './lowestListing';
-export * from './marketCurrencies';
-export * from './marketplaceConfig';
-export * from './primarySaleItems';
-export * from './primarySaleItemsCount';
-export * from './searchTokenMetadata';
-export * from './tokenSupplies';
+export * from './market';
+export * from './orders';
+export * from './primary-sales';
+export * from './tokens';
+export * from './utils';

package/src/react/queries/inventory/index.ts

@@ -0,0 +1 @@
+export * from './inventory';

package/src/react/queries/{inventory.ts → inventory/inventory.ts}

@@ -1,17 +1,20 @@
 import type { ContractInfo, TokenBalance } from '@0xsequence/indexer';
 import { queryOptions } from '@tanstack/react-query';
 import type { Address } from 'viem';
-import type { Page, SdkConfig } from '../../types';
-import { compareAddress } from '../../utils';
-import { type ContractType, getQueryClient } from '../_internal';
-import { fetchMarketplaceConfig } from './marketplaceConfig';
-import { tokenBalancesOptions } from './tokenBalances';
+import type { Page, SdkConfig } from '../../../types';
+import { compareAddress } from '../../../utils';
+import {
+	type ContractType,
+	getQueryClient,
+	MetadataStatus,
+} from '../../_internal';
+import { tokenBalancesOptions } from '../collectibles/tokenBalances';
+import { fetchMarketplaceConfig } from '../market/marketplaceConfig';
 
 export interface UseInventoryArgs {
 	accountAddress: Address;
 	collectionAddress: Address;
 	chainId: number;
-	isLaos721?: boolean;
 	includeNonTradable?: boolean;
 	query?: {
 		enabled?: boolean;
@@ -20,9 +23,7 @@ export interface UseInventoryArgs {
 	};
 }
 
-interface GetInventoryArgs extends Omit<UseInventoryArgs, 'query'> {
-	isLaos721: boolean;
-}
+type GetInventoryArgs = Omit<UseInventoryArgs, 'query'>;
 
 interface CollectibleWithBalance {
 	metadata: {
@@ -33,6 +34,7 @@ interface CollectibleWithBalance {
 		description?: string;
 		video?: string;
 		audio?: string;
+		status: MetadataStatus;
 	};
 	balance: string;
 	contractInfo?: ContractInfo;
@@ -57,6 +59,7 @@ function collectibleFromTokenBalance(
 			description: token.tokenMetadata?.description,
 			video: token.tokenMetadata?.video,
 			audio: token.tokenMetadata?.audio,
+			status: MetadataStatus.AVAILABLE,
 		},
 		contractInfo: token.contractInfo,
 		contractType: token.contractType as unknown as
@@ -71,7 +74,6 @@ async function fetchIndexerTokens(
 	accountAddress: Address,
 	collectionAddress: Address,
 	config: SdkConfig,
-	isLaos721: boolean,
 ): Promise<{ collectibles: CollectibleWithBalance[] }> {
 	const queryClient = getQueryClient();
 	const balances = await queryClient.fetchQuery(
@@ -80,7 +82,6 @@ async function fetchIndexerTokens(
 				collectionAddress,
 				userAddress: accountAddress,
 				chainId,
-				isLaos721,
 				includeMetadata: true,
 			},
 			config,
@@ -101,7 +102,7 @@ export async function fetchInventory(
 	config: SdkConfig,
 	page: Page,
 ): Promise<CollectiblesResponse> {
-	const { accountAddress, collectionAddress, chainId, isLaos721 } = args;
+	const { accountAddress, collectionAddress, chainId } = args;
 	const marketplaceConfig = await fetchMarketplaceConfig({ config });
 
 	const marketCollections = marketplaceConfig?.market.collections || [];
@@ -119,7 +120,6 @@ export async function fetchInventory(
 		accountAddress,
 		collectionAddress,
 		config,
-		isLaos721,
 	);
 
 	return {
@@ -150,7 +150,6 @@ export function inventoryOptions(args: UseInventoryArgs, config: SdkConfig) {
 			fetchInventory(
 				{
 					...args,
-					isLaos721: args.isLaos721 ?? false,
 				},
 				config,
 				{

package/src/react/queries/{checkoutOptions.ts → market/checkoutOptions.ts}

@@ -1,13 +1,18 @@
 import { queryOptions } from '@tanstack/react-query';
 import type { Address } from 'viem';
-import type { SdkConfig } from '../../types';
-import type { MarketplaceKind } from '../_internal';
-import { getMarketplaceClient, type ValuesOptional } from '../_internal';
+import type { SdkConfig } from '../../../types';
+import type { MarketplaceKind } from '../../_internal';
+import {
+	checkoutKeys,
+	getMarketplaceClient,
+	type QueryKeyArgs,
+	type ValuesOptional,
+} from '../../_internal';
 import type {
 	CheckoutOptionsMarketplaceArgs,
 	CheckoutOptionsMarketplaceReturn,
-} from '../_internal/api/marketplace.gen';
-import type { StandardQueryOptions } from '../types/query';
+} from '../../_internal/api/marketplace.gen';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface FetchCheckoutOptionsParams
 	extends Omit<
@@ -54,6 +59,23 @@ export type CheckoutOptionsQueryOptions =
 		query?: StandardQueryOptions;
 	};
 
+export function getCheckoutOptionsQueryKey(
+	params: CheckoutOptionsQueryOptions,
+) {
+	const apiArgs = {
+		chainId: String(params.chainId),
+		wallet: params.walletAddress,
+		orders: params.orders?.map((order) => ({
+			contractAddress: order.collectionAddress,
+			orderId: order.orderId,
+			marketplace: order.marketplace,
+		})),
+		additionalFee: params.additionalFee,
+	} satisfies QueryKeyArgs<CheckoutOptionsMarketplaceArgs>;
+
+	return [...checkoutKeys.options, apiArgs] as const;
+}
+
 export function checkoutOptionsQueryOptions(
 	params: CheckoutOptionsQueryOptions,
 ) {
@@ -66,7 +88,7 @@ export function checkoutOptionsQueryOptions(
 	);
 
 	return queryOptions({
-		queryKey: ['checkout', 'options', params],
+		queryKey: getCheckoutOptionsQueryKey(params),
 		queryFn: () =>
 			fetchCheckoutOptions({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

package/src/react/queries/{checkoutOptionsSalesContract.ts → market/checkoutOptionsSalesContract.ts}

@@ -1,13 +1,18 @@
 import { queryOptions } from '@tanstack/react-query';
 import type { Address } from 'viem';
-import type { SdkConfig } from '../../types';
-import { getMarketplaceClient, type ValuesOptional } from '../_internal';
+import type { SdkConfig } from '../../../types';
+import {
+	checkoutKeys,
+	getMarketplaceClient,
+	type QueryKeyArgs,
+	type ValuesOptional,
+} from '../../_internal';
 import type {
 	CheckoutOptionsItem,
 	CheckoutOptionsSalesContractArgs,
 	CheckoutOptionsSalesContractReturn,
-} from '../_internal/api/marketplace.gen';
-import type { StandardQueryOptions } from '../types/query';
+} from '../../_internal/api/marketplace.gen';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface FetchCheckoutOptionsSalesContractParams
 	extends Omit<CheckoutOptionsSalesContractArgs, 'chainId' | 'wallet'> {
@@ -53,6 +58,20 @@ export type CheckoutOptionsSalesContractQueryOptions =
 		query?: StandardQueryOptions;
 	};
 
+export function getCheckoutOptionsSalesContractQueryKey(
+	params: CheckoutOptionsSalesContractQueryOptions,
+) {
+	const apiArgs = {
+		chainId: String(params.chainId),
+		wallet: params.walletAddress,
+		contractAddress: params.contractAddress,
+		collectionAddress: params.collectionAddress,
+		items: params.items,
+	} satisfies QueryKeyArgs<CheckoutOptionsSalesContractArgs>;
+
+	return [...checkoutKeys.options, 'salesContract', apiArgs] as const;
+}
+
 export function checkoutOptionsSalesContractQueryOptions(
 	params: CheckoutOptionsSalesContractQueryOptions,
 ) {
@@ -67,7 +86,7 @@ export function checkoutOptionsSalesContractQueryOptions(
 	);
 
 	return queryOptions({
-		queryKey: ['checkout', 'options', 'salesContract', params],
+		queryKey: getCheckoutOptionsSalesContractQueryKey(params),
 		queryFn: () =>
 			fetchCheckoutOptionsSalesContract({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

package/src/react/queries/{currency.ts → market/currency.ts}

@@ -1,14 +1,14 @@
 import { queryOptions, skipToken } from '@tanstack/react-query';
 import type { Address } from 'viem';
-import type { SdkConfig } from '../../types';
+import type { SdkConfig } from '../../../types';
 import {
 	type Currency,
 	currencyKeys,
 	getMarketplaceClient,
 	getQueryClient,
 	type ValuesOptional,
-} from '../_internal';
-import type { StandardQueryOptions } from '../types/query';
+} from '../../_internal';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface FetchCurrencyParams {
 	chainId: number;
@@ -55,6 +55,15 @@ export type CurrencyQueryOptions = ValuesOptional<FetchCurrencyParams> & {
 	query?: StandardQueryOptions;
 };
 
+export function getCurrencyQueryKey(params: CurrencyQueryOptions) {
+	const apiArgs = {
+		chainId: String(params.chainId!),
+		currencyAddress: params.currencyAddress!,
+	};
+
+	return [...currencyKeys.details, apiArgs] as const;
+}
+
 export function currencyQueryOptions(params: CurrencyQueryOptions) {
 	const enabled = Boolean(
 		params.chainId &&
@@ -64,7 +73,7 @@ export function currencyQueryOptions(params: CurrencyQueryOptions) {
 	);
 
 	return queryOptions({
-		queryKey: [...currencyKeys.details, params],
+		queryKey: getCurrencyQueryKey(params),
 		queryFn:
 			params.chainId && params.currencyAddress
 				? () =>

package/src/react/queries/{filters.ts → market/filters.ts}

@@ -1,13 +1,17 @@
-import type { PropertyFilter } from '@0xsequence/metadata';
+import type {
+	GetTokenMetadataPropertyFiltersArgs,
+	PropertyFilter,
+} from '@0xsequence/metadata';
 import { queryOptions } from '@tanstack/react-query';
-import { FilterCondition, type SdkConfig } from '../../types';
-import { compareAddress } from '../../utils';
+import { FilterCondition, type SdkConfig } from '../../../types';
+import { compareAddress } from '../../../utils';
 import {
 	getMetadataClient,
 	getQueryClient,
+	type QueryKeyArgs,
 	type ValuesOptional,
-} from '../_internal';
-import type { StandardQueryOptions } from '../types/query';
+} from '../../_internal';
+import type { StandardQueryOptions } from '../../types/query';
 import { marketplaceConfigOptions } from './marketplaceConfig';
 
 export interface FetchFiltersParams {
@@ -106,6 +110,21 @@ export type FiltersQueryOptions = ValuesOptional<FetchFiltersParams> & {
 	query?: StandardQueryOptions;
 };
 
+export function getFiltersQueryKey(params: FiltersQueryOptions) {
+	const apiArgs = {
+		chainID: String(params.chainId),
+		contractAddress: params.collectionAddress,
+		excludeProperties: undefined,
+		excludePropertyValues: params.excludePropertyValues,
+	} satisfies QueryKeyArgs<GetTokenMetadataPropertyFiltersArgs>;
+
+	return [
+		'filters',
+		apiArgs,
+		{ showAllFilters: params.showAllFilters },
+	] as const;
+}
+
 export function filtersQueryOptions(params: FiltersQueryOptions) {
 	const enabled = Boolean(
 		params.chainId &&
@@ -115,7 +134,7 @@ export function filtersQueryOptions(params: FiltersQueryOptions) {
 	);
 
 	return queryOptions({
-		queryKey: ['filters', params],
+		queryKey: getFiltersQueryKey(params),
 		queryFn: () =>
 			fetchFilters({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

package/src/react/queries/market/index.ts

@@ -0,0 +1,6 @@
+export * from './checkoutOptions';
+export * from './checkoutOptionsSalesContract';
+export * from './currency';
+export * from './filters';
+export * from './marketCurrencies';
+export * from './marketplaceConfig';