@0xsequence/marketplace-sdk 1.0.0 → 1.1.1

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 {
@@ -53,30 +57,26 @@ export async function fetchFilters(
 		compareAddress(c.itemsAddress, collectionAddress),
 	)?.filterSettings;
 
-	if (
-		!collectionFilters?.exclusions ||
-		collectionFilters.exclusions.length === 0 ||
-		!collectionFilters.filterOrder ||
-		collectionFilters.filterOrder.length === 0
-	)
-		return filters;
-
-	const { filterOrder, exclusions } = collectionFilters;
-
-	const sortedFilters = filters.toSorted((a, b) => {
-		const aIndex =
-			filterOrder.indexOf(a.name) > -1
-				? filterOrder.indexOf(a.name)
-				: filterOrder.length;
-		const bIndex =
-			filterOrder.indexOf(b.name) > -1
-				? filterOrder.indexOf(b.name)
-				: filterOrder.length;
-		return aIndex - bIndex;
-	});
-
-	const filteredResults = sortedFilters.reduce<PropertyFilter[]>(
-		(acc, filter) => {
+	const filterOrder = collectionFilters?.filterOrder;
+	const exclusions = collectionFilters?.exclusions;
+	let sortedFilters = filters;
+
+	if (filterOrder) {
+		sortedFilters = filters.toSorted((a, b) => {
+			const aIndex =
+				filterOrder.indexOf(a.name) > -1
+					? filterOrder.indexOf(a.name)
+					: filterOrder.length;
+			const bIndex =
+				filterOrder.indexOf(b.name) > -1
+					? filterOrder.indexOf(b.name)
+					: filterOrder.length;
+			return aIndex - bIndex;
+		});
+	}
+
+	if (exclusions) {
+		sortedFilters = sortedFilters.reduce<PropertyFilter[]>((acc, filter) => {
 			const exclusionRule = exclusions.find((rule) => rule.key === filter.name);
 
 			if (!exclusionRule) {
@@ -100,17 +100,31 @@ export async function fetchFilters(
 			}
 
 			return acc;
-		},
-		[],
-	);
+		}, []);
+	}
 
-	return filteredResults;
+	return sortedFilters;
 }
 
 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 &&
@@ -120,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';

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

@@ -1,14 +1,16 @@
 import { queryOptions } from '@tanstack/react-query';
 import { type Address, zeroAddress } from 'viem';
-import type { SdkConfig } from '../../types';
-import { compareAddress } from '../../utils';
+import type { SdkConfig } from '../../../types';
+import { compareAddress } from '../../../utils';
 import {
 	currencyKeys,
 	getMarketplaceClient,
 	getQueryClient,
+	type ListCurrenciesArgs,
+	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 FetchMarketCurrenciesParams {
@@ -70,6 +72,23 @@ export type MarketCurrenciesQueryOptions =
 		query?: StandardQueryOptions;
 	};
 
+export function getMarketCurrenciesQueryKey(
+	params: MarketCurrenciesQueryOptions,
+) {
+	const apiArgs = {
+		chainId: String(params.chainId),
+	} satisfies QueryKeyArgs<ListCurrenciesArgs>;
+
+	return [
+		...currencyKeys.lists,
+		apiArgs,
+		{
+			includeNativeCurrency: params.includeNativeCurrency,
+			collectionAddress: params.collectionAddress,
+		},
+	] as const;
+}
+
 export function marketCurrenciesQueryOptions(
 	params: MarketCurrenciesQueryOptions,
 ) {
@@ -78,7 +97,7 @@ export function marketCurrenciesQueryOptions(
 	);
 
 	return queryOptions({
-		queryKey: [...currencyKeys.lists, params],
+		queryKey: getMarketCurrenciesQueryKey(params),
 		queryFn: () =>
 			fetchMarketCurrencies({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

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

@@ -1,15 +1,16 @@
 import { queryOptions } from '@tanstack/react-query';
-import type { ContractType, OrderbookKind, SdkConfig } from '../../types';
+import type { Address } from 'viem';
+import type { ContractType, OrderbookKind, SdkConfig } from '../../../types';
 import type {
 	MarketCollection,
 	MarketPage,
 	MarketplaceConfig,
 	ShopCollection,
 	ShopPage,
-} from '../../types/new-marketplace-types';
-import { configKeys, getBuilderClient } from '../_internal';
-import type { LookupMarketplaceReturn } from '../_internal/api/builder.gen';
-import { persistentQueryMeta } from '../_internal/query-meta';
+} from '../../../types/new-marketplace-types';
+import { configKeys, getBuilderClient } from '../../_internal';
+import type { LookupMarketplaceReturn } from '../../_internal/api/builder.gen';
+import { persistentQueryMeta } from '../../_internal/query-meta';
 
 export const fetchMarketplaceConfig = async ({
 	config,
@@ -37,7 +38,8 @@ export const fetchMarketplaceConfig = async ({
 			contractType: collection.contractType as ContractType,
 			destinationMarketplace:
 				collection.destinationMarketplace as OrderbookKind,
-			marketplaceType: 'market',
+			itemsAddress: collection.itemsAddress as Address,
+			cardType: 'market',
 		} satisfies MarketCollection;
 	});
 
@@ -45,7 +47,9 @@ export const fetchMarketplaceConfig = async ({
 		(collection) => {
 			return {
 				...collection,
-				marketplaceType: 'shop',
+				itemsAddress: collection.itemsAddress as Address,
+				saleAddress: collection.saleAddress as Address,
+				cardType: 'shop',
 			} satisfies ShopCollection;
 		},
 	);

package/src/react/queries/orders/countItemsOrdersForCollection.ts

@@ -0,0 +1,86 @@
+import { queryOptions } from '@tanstack/react-query';
+import type { SdkConfig } from '../../../types';
+import {
+	getMarketplaceClient,
+	type QueryKeyArgs,
+	type ValuesOptional,
+} from '../../_internal';
+import type {
+	GetCountOfAllOrdersArgs,
+	OrderSide,
+} from '../../_internal/api/marketplace.gen';
+import { collectionKeys } from '../../_internal/api/query-keys';
+import type { StandardQueryOptions } from '../../types/query';
+
+export interface FetchCountItemsOrdersForCollectionParams {
+	chainId: number;
+	collectionAddress: string;
+	config: SdkConfig;
+	side: OrderSide;
+}
+
+/**
+ * Fetches count of orders for a collection from the marketplace API
+ */
+export async function fetchCountItemsOrdersForCollection(
+	params: FetchCountItemsOrdersForCollectionParams,
+) {
+	const { collectionAddress, chainId, config, side } = params;
+
+	const client = getMarketplaceClient(config);
+
+	const apiArgs: GetCountOfAllOrdersArgs = {
+		contractAddress: collectionAddress,
+		chainId: String(chainId),
+		side,
+	};
+
+	const result = await client.getCountOfAllOrders(apiArgs);
+	return result.count;
+}
+
+export type CountItemsOrdersForCollectionQueryOptions =
+	ValuesOptional<FetchCountItemsOrdersForCollectionParams> & {
+		query?: StandardQueryOptions;
+	};
+
+export function getCountItemsOrdersForCollectionQueryKey(
+	params: CountItemsOrdersForCollectionQueryOptions,
+) {
+	const apiArgs = {
+		chainId: String(params.chainId),
+		contractAddress: params.collectionAddress,
+		side: params.side,
+	} satisfies QueryKeyArgs<GetCountOfAllOrdersArgs>;
+
+	return [...collectionKeys.collectionItemsOrdersCount, apiArgs] as const;
+}
+
+export function countItemsOrdersForCollectionQueryOptions(
+	params: CountItemsOrdersForCollectionQueryOptions,
+) {
+	const enabled = Boolean(
+		params.collectionAddress &&
+			params.chainId &&
+			params.config &&
+			params.side &&
+			(params.query?.enabled ?? true),
+	);
+
+	return queryOptions({
+		queryKey: getCountItemsOrdersForCollectionQueryKey(params),
+		queryFn: () =>
+			fetchCountItemsOrdersForCollection({
+				// 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
+				collectionAddress: params.collectionAddress!,
+				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined
+				config: params.config!,
+				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined
+				side: params.side!,
+			}),
+		...params.query,
+		enabled,
+	});
+}

package/src/react/queries/{countListingsForCollectible.ts → orders/countListingsForCollectible.ts}

@@ -1,12 +1,16 @@
 import { queryOptions } from '@tanstack/react-query';
-import type { SdkConfig } from '../../types';
-import { getMarketplaceClient, type ValuesOptional } from '../_internal';
+import type { SdkConfig } from '../../../types';
+import {
+	getMarketplaceClient,
+	type QueryKeyArgs,
+	type ValuesOptional,
+} from '../../_internal';
 import type {
 	GetCountOfListingsForCollectibleArgs,
 	OrderFilter,
-} from '../_internal/api/marketplace.gen';
-import { collectableKeys } from '../_internal/api/query-keys';
-import type { StandardQueryOptions } from '../types/query';
+} from '../../_internal/api/marketplace.gen';
+import { collectableKeys } from '../../_internal/api/query-keys';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface FetchCountListingsForCollectibleParams {
 	chainId: number;
@@ -42,6 +46,19 @@ export type CountListingsForCollectibleQueryOptions =
 		query?: StandardQueryOptions;
 	};
 
+export function getCountListingsForCollectibleQueryKey(
+	params: CountListingsForCollectibleQueryOptions,
+) {
+	const apiArgs = {
+		chainId: String(params.chainId),
+		contractAddress: params.collectionAddress,
+		tokenId: params.collectibleId,
+		filter: params.filter,
+	} satisfies QueryKeyArgs<GetCountOfListingsForCollectibleArgs>;
+
+	return [...collectableKeys.listingsCount, apiArgs] as const;
+}
+
 export function countListingsForCollectibleQueryOptions(
 	params: CountListingsForCollectibleQueryOptions,
 ) {
@@ -54,7 +71,7 @@ export function countListingsForCollectibleQueryOptions(
 	);
 
 	return queryOptions({
-		queryKey: [...collectableKeys.listingsCount, params],
+		queryKey: getCountListingsForCollectibleQueryKey(params),
 		queryFn: () =>
 			fetchCountListingsForCollectible({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

package/src/react/queries/{countOffersForCollectible.ts → orders/countOffersForCollectible.ts}

@@ -1,12 +1,16 @@
 import { queryOptions } from '@tanstack/react-query';
-import type { SdkConfig } from '../../types';
-import { getMarketplaceClient, type ValuesOptional } from '../_internal';
+import type { SdkConfig } from '../../../types';
+import {
+	getMarketplaceClient,
+	type QueryKeyArgs,
+	type ValuesOptional,
+} from '../../_internal';
 import type {
 	GetCountOfOffersForCollectibleArgs,
 	OrderFilter,
-} from '../_internal/api/marketplace.gen';
-import { collectableKeys } from '../_internal/api/query-keys';
-import type { StandardQueryOptions } from '../types/query';
+} from '../../_internal/api/marketplace.gen';
+import { collectableKeys } from '../../_internal/api/query-keys';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface FetchCountOffersForCollectibleParams {
 	chainId: number;
@@ -42,6 +46,19 @@ export type CountOffersForCollectibleQueryOptions =
 		query?: StandardQueryOptions;
 	};
 
+export function getCountOffersForCollectibleQueryKey(
+	params: CountOffersForCollectibleQueryOptions,
+) {
+	const apiArgs = {
+		chainId: String(params.chainId),
+		contractAddress: params.collectionAddress,
+		tokenId: params.collectibleId,
+		filter: params.filter,
+	} satisfies QueryKeyArgs<GetCountOfOffersForCollectibleArgs>;
+
+	return [...collectableKeys.offersCount, apiArgs] as const;
+}
+
 export function countOffersForCollectibleQueryOptions(
 	params: CountOffersForCollectibleQueryOptions,
 ) {
@@ -54,7 +71,7 @@ export function countOffersForCollectibleQueryOptions(
 	);
 
 	return queryOptions({
-		queryKey: [...collectableKeys.offersCount, params],
+		queryKey: getCountOffersForCollectibleQueryKey(params),
 		queryFn: () =>
 			fetchCountOffersForCollectible({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

package/src/react/queries/{floorOrder.ts → orders/floorOrder.ts}

@@ -1,12 +1,13 @@
 import { queryOptions } from '@tanstack/react-query';
-import type { SdkConfig } from '../../types';
+import type { SdkConfig } from '../../../types';
 import {
 	collectableKeys,
 	type GetFloorOrderArgs,
 	getMarketplaceClient,
+	type QueryKeyArgs,
 	type ValuesOptional,
-} from '../_internal';
-import type { StandardQueryOptions } from '../types/query';
+} from '../../_internal';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface FetchFloorOrderParams
 	extends Omit<GetFloorOrderArgs, 'contractAddress' | 'chainId'> {
@@ -37,6 +38,16 @@ export type FloorOrderQueryOptions = ValuesOptional<FetchFloorOrderParams> & {
 	query?: StandardQueryOptions;
 };
 
+export function getFloorOrderQueryKey(params: FloorOrderQueryOptions) {
+	const apiArgs = {
+		chainId: String(params.chainId),
+		contractAddress: params.collectionAddress,
+		filter: params.filter,
+	} satisfies QueryKeyArgs<GetFloorOrderArgs>;
+
+	return [...collectableKeys.floorOrders, apiArgs] as const;
+}
+
 export function floorOrderQueryOptions(params: FloorOrderQueryOptions) {
 	const enabled = Boolean(
 		params.collectionAddress &&
@@ -46,7 +57,7 @@ export function floorOrderQueryOptions(params: FloorOrderQueryOptions) {
 	);
 
 	return queryOptions({
-		queryKey: [...collectableKeys.floorOrders, params],
+		queryKey: getFloorOrderQueryKey(params),
 		queryFn: () =>
 			fetchFloorOrder({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

package/src/react/queries/orders/getCountOfFilteredOrders.ts

@@ -0,0 +1,88 @@
+import { queryOptions } from '@tanstack/react-query';
+import type { SdkConfig } from '../../../types';
+import {
+	getMarketplaceClient,
+	type QueryKeyArgs,
+	type ValuesOptional,
+} from '../../_internal';
+import type {
+	GetCountOfFilteredOrdersArgs,
+	OrderSide,
+	OrdersFilter,
+} from '../../_internal/api/marketplace.gen';
+import { collectionKeys } from '../../_internal/api/query-keys';
+import type { StandardQueryOptions } from '../../types/query';
+
+export interface FetchGetCountOfFilteredOrdersParams {
+	chainId: number;
+	collectionAddress: string;
+	config: SdkConfig;
+	side: OrderSide;
+	filter?: OrdersFilter;
+}
+
+export async function fetchGetCountOfFilteredOrders(
+	params: FetchGetCountOfFilteredOrdersParams,
+) {
+	const { collectionAddress, chainId, config, side, filter } = params;
+
+	const client = getMarketplaceClient(config);
+
+	const apiArgs: GetCountOfFilteredOrdersArgs = {
+		contractAddress: collectionAddress,
+		chainId: String(chainId),
+		side,
+		filter,
+	};
+
+	const result = await client.getCountOfFilteredOrders(apiArgs);
+	return result.count;
+}
+
+export type GetCountOfFilteredOrdersQueryOptions =
+	ValuesOptional<FetchGetCountOfFilteredOrdersParams> & {
+		query?: StandardQueryOptions;
+	};
+
+export function getCountOfFilteredOrdersQueryKey(
+	params: GetCountOfFilteredOrdersQueryOptions,
+) {
+	const apiArgs = {
+		chainId: String(params.chainId),
+		contractAddress: params.collectionAddress,
+		side: params.side,
+		filter: params.filter,
+	} satisfies QueryKeyArgs<GetCountOfFilteredOrdersArgs>;
+
+	return [...collectionKeys.getCountOfFilteredOrders, apiArgs] as const;
+}
+
+export function getCountOfFilteredOrdersQueryOptions(
+	params: GetCountOfFilteredOrdersQueryOptions,
+) {
+	const enabled = Boolean(
+		params.collectionAddress &&
+			params.chainId &&
+			params.config &&
+			params.side &&
+			(params.query?.enabled ?? true),
+	);
+
+	return queryOptions({
+		queryKey: getCountOfFilteredOrdersQueryKey(params),
+		queryFn: () =>
+			fetchGetCountOfFilteredOrders({
+				// 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
+				collectionAddress: params.collectionAddress!,
+				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined
+				config: params.config!,
+				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined
+				side: params.side!,
+				filter: params.filter,
+			}),
+		...params.query,
+		enabled,
+	});
+}

package/src/react/queries/{highestOffer.ts → orders/highestOffer.ts}

@@ -1,12 +1,13 @@
 import { queryOptions } from '@tanstack/react-query';
-import type { SdkConfig } from '../../types';
+import type { SdkConfig } from '../../../types';
 import {
 	collectableKeys,
 	type GetCollectibleHighestOfferArgs,
 	getMarketplaceClient,
+	type QueryKeyArgs,
 	type ValuesOptional,
-} from '../_internal';
-import type { StandardQueryOptions } from '../types/query';
+} from '../../_internal';
+import type { StandardQueryOptions } from '../../types/query';
 
 export interface FetchHighestOfferParams
 	extends Omit<GetCollectibleHighestOfferArgs, 'contractAddress' | 'chainId'> {
@@ -38,6 +39,17 @@ export type HighestOfferQueryOptions =
 		query?: StandardQueryOptions;
 	};
 
+export function getHighestOfferQueryKey(params: HighestOfferQueryOptions) {
+	const apiArgs = {
+		chainId: String(params.chainId),
+		contractAddress: params.collectionAddress,
+		tokenId: params.tokenId,
+		filter: params.filter,
+	} satisfies QueryKeyArgs<GetCollectibleHighestOfferArgs>;
+
+	return [...collectableKeys.highestOffers, apiArgs] as const;
+}
+
 export function highestOfferQueryOptions(params: HighestOfferQueryOptions) {
 	const enabled = Boolean(
 		params.collectionAddress &&
@@ -48,7 +60,7 @@ export function highestOfferQueryOptions(params: HighestOfferQueryOptions) {
 	);
 
 	return queryOptions({
-		queryKey: [...collectableKeys.highestOffers, params],
+		queryKey: getHighestOfferQueryKey(params),
 		queryFn: () =>
 			fetchHighestOffer({
 				// biome-ignore lint/style/noNonNullAssertion: The enabled check above ensures these are not undefined

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

@@ -0,0 +1,11 @@
+export * from './countItemsOrdersForCollection';
+export * from './countListingsForCollectible';
+export * from './countOffersForCollectible';
+export * from './floorOrder';
+export * from './getCountOfFilteredOrders';
+export * from './highestOffer';
+export * from './listItemsOrdersForCollection';
+export * from './listItemsOrdersForCollectionPaginated';
+export * from './listListingsForCollectible';
+export * from './listOffersForCollectible';
+export * from './lowestListing';