@0xsequence/marketplace-sdk 0.10.0 → 1.1.0

package/src/react/hooks/data/collectibles/useTokenBalances.test.tsx

@@ -0,0 +1,151 @@
+import { renderHook, server, waitFor } from '@test';
+import { HttpResponse, http } from 'msw';
+import { zeroAddress } from 'viem';
+import { describe, expect, it } from 'vitest';
+import {
+	mockIndexerEndpoint,
+	mockTokenBalance,
+} from '../../../_internal/api/__mocks__/indexer.msw';
+import { useTokenBalances } from './useTokenBalances';
+
+describe('useTokenBalances', () => {
+	const defaultArgs = {
+		collectionAddress: zeroAddress,
+		userAddress: '0x1234567890123456789012345678901234567890' as `0x${string}`,
+		chainId: 1,
+	};
+
+	it('should fetch balances successfully', async () => {
+		// Override the handler specifically for this test
+		server.use(
+			http.post(mockIndexerEndpoint('GetTokenBalances'), () => {
+				return HttpResponse.json({
+					page: { page: 1, pageSize: 10, more: false },
+					balances: [mockTokenBalance, { ...mockTokenBalance, tokenID: '2' }],
+				});
+			}),
+		);
+
+		const { result } = renderHook(() => useTokenBalances(defaultArgs));
+
+		// Initially loading
+		expect(result.current.isLoading).toBe(true);
+
+		// Wait for the query to complete
+		await waitFor(() => {
+			expect(result.current.isSuccess).toBe(true);
+		});
+
+		// Check the returned data matches mock
+		expect(result.current.data).toHaveLength(2);
+		expect(result.current.data?.[0]).toEqual(mockTokenBalance);
+		expect(result.current.data?.[1].tokenID).toBe('2');
+	});
+
+	it('should return empty array when userAddress is undefined', () => {
+		const { result } = renderHook(() =>
+			useTokenBalances({
+				...defaultArgs,
+				userAddress: undefined,
+			}),
+		);
+
+		expect(result.current.data).toBeUndefined();
+		expect(result.current.isLoading).toBe(false);
+	});
+
+	it('should respect enabled option in query config', () => {
+		const { result } = renderHook(() =>
+			useTokenBalances({
+				...defaultArgs,
+				query: {
+					enabled: false,
+				},
+			}),
+		);
+
+		expect(result.current.isLoading).toBe(false);
+		expect(result.current.data).toBeUndefined();
+	});
+
+	it('should handle error states', async () => {
+		// Override the handler to return an error
+		server.use(
+			http.post(mockIndexerEndpoint('GetTokenBalances'), () => {
+				return HttpResponse.json(
+					{ error: { message: 'Invalid address format' } },
+					{ status: 400 },
+				);
+			}),
+		);
+
+		const invalidArgs = {
+			...defaultArgs,
+			collectionAddress: '0xinvalid' as `0x${string}`, // Invalid address format
+		};
+
+		const { result } = renderHook(() => useTokenBalances(invalidArgs));
+
+		await waitFor(() => {
+			expect(result.current.isError).toBe(true);
+		});
+	});
+
+	it('should return all token balances for a collection', async () => {
+		const specificCollection = {
+			collectionAddress:
+				'0x1234567890123456789012345678901234567890' as `0x${string}`,
+			userAddress:
+				'0xabcdef1234567890abcdef1234567890abcdef12' as `0x${string}`,
+			chainId: 1,
+		};
+
+		const balances = [
+			{
+				...mockTokenBalance,
+				contractAddress: specificCollection.collectionAddress,
+				accountAddress: specificCollection.userAddress,
+				tokenID: '1',
+				balance: '2',
+			},
+			{
+				...mockTokenBalance,
+				contractAddress: specificCollection.collectionAddress,
+				accountAddress: specificCollection.userAddress,
+				tokenID: '2',
+				balance: '1',
+			},
+		];
+
+		server.use(
+			http.post(mockIndexerEndpoint('GetTokenBalances'), () => {
+				return HttpResponse.json({
+					page: { page: 1, pageSize: 10, more: false },
+					balances,
+				});
+			}),
+		);
+
+		const { result } = renderHook(() => useTokenBalances(specificCollection));
+
+		await waitFor(() => {
+			expect(result.current.isSuccess).toBe(true);
+		});
+
+		// Verify all token balances
+		expect(result.current.data).toEqual(balances);
+		expect(result.current.data).toHaveLength(2);
+		expect(result.current.data?.[0].balance).toBe('2');
+		expect(result.current.data?.[1].balance).toBe('1');
+		expect(
+			result.current.data?.every(
+				(b) => b.contractAddress === specificCollection.collectionAddress,
+			),
+		).toBe(true);
+		expect(
+			result.current.data?.every(
+				(b) => b.accountAddress === specificCollection.userAddress,
+			),
+		).toBe(true);
+	});
+});

package/src/react/hooks/data/collectibles/useTokenBalances.tsx

@@ -0,0 +1,47 @@
+import { useQuery } from '@tanstack/react-query';
+import { ContractType } from '../../../_internal';
+import {
+	tokenBalancesOptions,
+	type UseTokenBalancesArgs,
+} from '../../../queries/tokenBalances';
+import { useConfig } from '../../config/useConfig';
+import { useMarketplaceConfig } from '../../config/useMarketplaceConfig';
+
+/**
+ * Hook to fetch all token balances for a user in a collection
+ *
+ * @param args - The arguments for fetching the balances
+ * @returns Query result containing the balances data
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading, error } = useTokenBalances({
+ *   collectionAddress: '0x123...',
+ *   userAddress: '0x456...',
+ *   chainId: 1,
+ *   query: {
+ *     enabled: true,
+ *     refetchInterval: 10000,
+ *   }
+ * });
+ * ```
+ */
+export function useTokenBalances(args: UseTokenBalancesArgs) {
+	const config = useConfig();
+	const { data: marketplaceConfig } = useMarketplaceConfig();
+
+	const collection = marketplaceConfig?.market.collections.find(
+		(collection) => collection.itemsAddress === args.collectionAddress,
+	);
+	const isLaos721 = collection?.contractType === ContractType.LAOS_ERC_721;
+
+	return useQuery(
+		tokenBalancesOptions(
+			{
+				...args,
+				isLaos721,
+			},
+			config,
+		),
+	);
+}

package/src/react/hooks/{__tests__ → data/collections}/__snapshots__/useListCollections.test.tsx.snap

@@ -6,6 +6,7 @@ exports[`useListCollections > should fetch collections successfully 1`] = `
     "address": "0x0000000000000000000000000000000000000000",
     "bannerUrl": "https://example.com/market-banner.png",
     "bytecodeHash": "0x1234567890",
+    "cardType": "market",
     "chainId": 1,
     "contractType": "ERC721",
     "createdAt": "2025-03-16T13:04:16.098Z",
@@ -48,8 +49,8 @@ exports[`useListCollections > should fetch collections successfully 1`] = `
     "id": 1,
     "itemsAddress": "0x0000000000000000000000000000000000000000",
     "logoURI": "https://example.com/logo.png",
-    "marketplaceType": "market",
     "name": "Mock Collection",
+    "private": false,
     "projectId": 1,
     "source": "https://example.com/source",
     "status": "AVAILABLE",
@@ -61,6 +62,7 @@ exports[`useListCollections > should fetch collections successfully 1`] = `
     "address": "0x1234567890123456789012345678901234567890",
     "bannerUrl": "https://example.com/collection-banner.png",
     "bytecodeHash": "0x1234567890",
+    "cardType": "market",
     "chainId": 137,
     "contractType": "ERC1155",
     "createdAt": "2025-03-16T13:04:16.098Z",
@@ -107,8 +109,8 @@ exports[`useListCollections > should fetch collections successfully 1`] = `
     "id": 2,
     "itemsAddress": "0x1234567890123456789012345678901234567890",
     "logoURI": "https://example.com/logo.png",
-    "marketplaceType": "market",
     "name": "Mock Collection",
+    "private": false,
     "projectId": 1,
     "source": "https://example.com/source",
     "status": "AVAILABLE",
@@ -120,8 +122,10 @@ exports[`useListCollections > should fetch collections successfully 1`] = `
     "address": "0x0000000000000000000000000000000000000000",
     "bannerUrl": "https://example.com/shop-banner.png",
     "bytecodeHash": "0x1234567890",
+    "cardType": "shop",
     "chainId": 1,
     "createdAt": "2025-03-16T13:04:16.098Z",
+    "customTokenIds": [],
     "deployed": true,
     "extensions": {
       "blacklist": false,
@@ -142,8 +146,8 @@ exports[`useListCollections > should fetch collections successfully 1`] = `
     "id": 1,
     "itemsAddress": "0x0000000000000000000000000000000000000000",
     "logoURI": "https://example.com/logo.png",
-    "marketplaceType": "shop",
     "name": "Mock Collection",
+    "private": false,
     "projectId": 1,
     "saleAddress": "0x0000000000000000000000000000000000000000",
     "saleBannerUrl": "https://example.com/shop-sale-banner.png",
@@ -162,8 +166,10 @@ exports[`useListCollections > should fetch collections successfully 1`] = `
     "address": "0x1234567890123456789012345678901234567890",
     "bannerUrl": "https://example.com/polygon-shop-banner.png",
     "bytecodeHash": "0x1234567890",
+    "cardType": "shop",
     "chainId": 137,
     "createdAt": "2025-03-16T13:04:16.098Z",
+    "customTokenIds": [],
     "deployed": true,
     "extensions": {
       "blacklist": false,
@@ -184,8 +190,8 @@ exports[`useListCollections > should fetch collections successfully 1`] = `
     "id": 2,
     "itemsAddress": "0x1234567890123456789012345678901234567890",
     "logoURI": "https://example.com/logo.png",
-    "marketplaceType": "shop",
     "name": "Mock Collection",
+    "private": false,
     "projectId": 1,
     "saleAddress": "0x1234567890123456789012345678901234567890",
     "saleBannerUrl": "https://example.com/polygon-shop-sale-banner.png",
@@ -209,8 +215,10 @@ exports[`useListCollections > should handle empty collections 1`] = `
     "address": "0x0000000000000000000000000000000000000000",
     "bannerUrl": "https://example.com/shop-banner.png",
     "bytecodeHash": "0x1234567890",
+    "cardType": "shop",
     "chainId": 1,
     "createdAt": "2025-03-16T13:04:16.098Z",
+    "customTokenIds": [],
     "deployed": true,
     "extensions": {
       "blacklist": false,
@@ -231,8 +239,8 @@ exports[`useListCollections > should handle empty collections 1`] = `
     "id": 1,
     "itemsAddress": "0x0000000000000000000000000000000000000000",
     "logoURI": "https://example.com/logo.png",
-    "marketplaceType": "shop",
     "name": "Mock Collection",
+    "private": false,
     "projectId": 1,
     "saleAddress": "0x0000000000000000000000000000000000000000",
     "saleBannerUrl": "https://example.com/shop-sale-banner.png",
@@ -251,8 +259,10 @@ exports[`useListCollections > should handle empty collections 1`] = `
     "address": "0x1234567890123456789012345678901234567890",
     "bannerUrl": "https://example.com/polygon-shop-banner.png",
     "bytecodeHash": "0x1234567890",
+    "cardType": "shop",
     "chainId": 137,
     "createdAt": "2025-03-16T13:04:16.098Z",
+    "customTokenIds": [],
     "deployed": true,
     "extensions": {
       "blacklist": false,
@@ -273,8 +283,8 @@ exports[`useListCollections > should handle empty collections 1`] = `
     "id": 2,
     "itemsAddress": "0x1234567890123456789012345678901234567890",
     "logoURI": "https://example.com/logo.png",
-    "marketplaceType": "shop",
     "name": "Mock Collection",
+    "private": false,
     "projectId": 1,
     "saleAddress": "0x1234567890123456789012345678901234567890",
     "saleBannerUrl": "https://example.com/polygon-shop-sale-banner.png",

package/src/react/hooks/data/collections/index.ts

@@ -0,0 +1,6 @@
+export * from './useCollection';
+export * from './useCollectionBalanceDetails';
+export * from './useCollectionDetails';
+export * from './useCollectionDetailsPolling';
+export * from './useListCollectionActivities';
+export * from './useListCollections';

package/src/react/hooks/{__tests__ → data/collections}/useCollection.test.tsx

@@ -5,9 +5,8 @@ import { describe, expect, it } from 'vitest';
 import {
 	mockEthCollection,
 	mockMetadataEndpoint,
-} from '../../_internal/api/__mocks__/metadata.msw';
-import type { UseCollectionParams } from '../useCollection';
-import { useCollection } from '../useCollection';
+} from '../../../_internal/api/__mocks__/metadata.msw';
+import { type UseCollectionParams, useCollection } from './useCollection';
 
 describe('useCollection', () => {
 	const defaultArgs: UseCollectionParams = {

package/src/react/hooks/{useCollection.tsx → data/collections/useCollection.tsx}

@@ -1,13 +1,13 @@
 'use client';
 
 import { useQuery } from '@tanstack/react-query';
-import type { Optional } from '../_internal';
+import type { Optional } from '../../../_internal';
 import {
 	type CollectionQueryOptions,
 	collectionQueryOptions,
 	type FetchCollectionParams,
-} from '../queries/collection';
-import { useConfig } from './useConfig';
+} from '../../../queries/collection';
+import { useConfig } from '../../config/useConfig';
 
 export type UseCollectionParams = Optional<CollectionQueryOptions, 'config'>;
 

package/src/react/hooks/{__tests__ → data/collections}/useCollectionBalanceDetails.test.tsx

@@ -6,8 +6,8 @@ import { describe, expect, it } from 'vitest';
 import {
 	mockIndexerEndpoint,
 	mockTokenBalance,
-} from '../../_internal/api/__mocks__/indexer.msw';
-import { useCollectionBalanceDetails } from '../useCollectionBalanceDetails';
+} from '../../../_internal/api/__mocks__/indexer.msw';
+import { useCollectionBalanceDetails } from './useCollectionBalanceDetails';
 
 describe('useCollectionBalanceDetails', () => {
 	const defaultArgs = {

package/src/react/hooks/{useCollectionBalanceDetails.tsx → data/collections/useCollectionBalanceDetails.tsx}

@@ -1,15 +1,15 @@
 'use client';
 
 import { useQuery } from '@tanstack/react-query';
-import type { Optional } from '../_internal';
+import type { Optional } from '../../../_internal';
 import {
 	type CollectionBalanceDetailsQueryOptions,
 	type CollectionBalanceFilter,
 	collectionBalanceDetailsQueryOptions,
 	type FetchCollectionBalanceDetailsParams,
 	type fetchCollectionBalanceDetails,
-} from '../queries/collectionBalanceDetails';
-import { useConfig } from './useConfig';
+} from '../../../queries/collectionBalanceDetails';
+import { useConfig } from '../../config/useConfig';
 
 export type UseCollectionBalanceDetailsParams = Optional<
 	CollectionBalanceDetailsQueryOptions,

package/src/react/hooks/{__tests__ → data/collections}/useCollectionDetails.test.tsx

@@ -5,8 +5,8 @@ import { describe, expect, it } from 'vitest';
 import {
 	mockCollection,
 	mockMarketplaceEndpoint,
-} from '../../_internal/api/__mocks__/marketplace.msw';
-import { useCollectionDetails } from '../useCollectionDetails';
+} from '../../../_internal/api/__mocks__/marketplace.msw';
+import { useCollectionDetails } from './useCollectionDetails';
 
 describe('useCollectionDetails', () => {
 	const defaultArgs = {

package/src/react/hooks/{useCollectionDetails.ts → data/collections/useCollectionDetails.ts}

@@ -1,13 +1,13 @@
 'use client';
 
 import { useQuery } from '@tanstack/react-query';
-import type { Optional } from '../_internal';
+import type { Optional } from '../../../_internal';
 import {
 	type CollectionDetailsQueryOptions,
 	collectionDetailsQueryOptions,
 	type FetchCollectionDetailsParams,
-} from '../queries/collectionDetails';
-import { useConfig } from './useConfig';
+} from '../../../queries/collectionDetails';
+import { useConfig } from '../../config/useConfig';
 
 export type UseCollectionDetailsParams = Optional<
 	CollectionDetailsQueryOptions,

package/src/react/hooks/{__tests__ → data/collections}/useCollectionDetailsPolling.test.tsx

@@ -5,9 +5,9 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';
 import {
 	mockCollection,
 	mockMarketplaceEndpoint,
-} from '../../_internal/api/__mocks__/marketplace.msw';
-import { CollectionStatus } from '../../_internal/api/marketplace.gen';
-import { useCollectionDetailsPolling } from '../useCollectionDetailsPolling';
+} from '../../../_internal/api/__mocks__/marketplace.msw';
+import { CollectionStatus } from '../../../_internal/api/marketplace.gen';
+import { useCollectionDetailsPolling } from './useCollectionDetailsPolling';
 
 describe('useCollectionDetailsPolling', () => {
 	const defaultArgs = {

package/src/react/hooks/{useCollectionDetailsPolling.tsx → data/collections/useCollectionDetailsPolling.tsx}

@@ -1,8 +1,8 @@
 import { queryOptions, useQuery } from '@tanstack/react-query';
-import type { SdkConfig } from '../../types';
-import { CollectionStatus } from '../_internal';
-import { collectionDetailsQueryOptions } from './useCollectionDetails';
-import { useConfig } from './useConfig';
+import type { SdkConfig } from '../../../../types';
+import { CollectionStatus } from '../../../_internal';
+import { useConfig } from '../../config/useConfig';
+import { collectionDetailsQueryOptions } from '../../data/collections/useCollectionDetails';
 
 type UseCollectionDetailsPolling = {
 	collectionAddress: string;

package/src/react/hooks/{__tests__ → data/collections}/useListCollectionActivities.test.tsx

@@ -5,11 +5,11 @@ import { describe, expect, it } from 'vitest';
 import {
 	mockActivity,
 	mockMarketplaceEndpoint,
-} from '../../_internal/api/__mocks__/marketplace.msw';
-import type { ListCollectionActivitiesArgs } from '../../_internal/api/marketplace.gen';
-import { SortOrder } from '../../_internal/api/marketplace.gen';
-import type { UseListCollectionActivitiesParams } from '../useListCollectionActivities';
-import { useListCollectionActivities } from '../useListCollectionActivities';
+} from '../../../_internal/api/__mocks__/marketplace.msw';
+import type { ListCollectionActivitiesArgs } from '../../../_internal/api/marketplace.gen';
+import { SortOrder } from '../../../_internal/api/marketplace.gen';
+import type { UseListCollectionActivitiesParams } from './useListCollectionActivities';
+import { useListCollectionActivities } from './useListCollectionActivities';
 
 describe('useListCollectionActivities', () => {
 	const defaultArgs: UseListCollectionActivitiesParams = {

package/src/react/hooks/{useListCollectionActivities.tsx → data/collections/useListCollectionActivities.tsx}

@@ -1,14 +1,14 @@
 'use client';
 
 import { useQuery } from '@tanstack/react-query';
-import type { Optional } from '../_internal';
+import type { Optional } from '../../../_internal';
 import {
 	type FetchListCollectionActivitiesParams,
 	type fetchListCollectionActivities,
 	type ListCollectionActivitiesQueryOptions,
 	listCollectionActivitiesQueryOptions,
-} from '../queries/listCollectionActivities';
-import { useConfig } from './useConfig';
+} from '../../../queries/listCollectionActivities';
+import { useConfig } from '../../config/useConfig';
 
 export type UseListCollectionActivitiesParams = Optional<
 	ListCollectionActivitiesQueryOptions,

package/src/react/hooks/{__tests__ → data/collections}/useListCollections.test.tsx

@@ -2,13 +2,13 @@ import { renderHook, server, waitFor } from '@test';
 import { HttpResponse, http } from 'msw';
 import type { Address } from 'viem';
 import { describe, expect, it } from 'vitest';
-import { OrderbookKind } from '../../_internal';
+import { OrderbookKind } from '../../../_internal';
 import {
 	createLookupMarketplaceHandler,
 	mockConfig,
-} from '../../_internal/api/__mocks__/builder.msw';
-import { mockEthCollection } from '../../_internal/api/__mocks__/metadata.msw';
-import { useListCollections } from '../useListCollections';
+} from '../../../_internal/api/__mocks__/builder.msw';
+import { mockEthCollection } from '../../../_internal/api/__mocks__/metadata.msw';
+import { useListCollections } from './useListCollections';
 
 describe('useListCollections', () => {
 	it('should fetch collections successfully', async () => {
@@ -68,6 +68,7 @@ describe('useListCollections', () => {
 						},
 						createdAt: new Date('2025-03-16T13:04:16.098Z').toISOString(),
 						updatedAt: new Date('2025-03-16T13:04:16.098Z').toISOString(),
+						private: false,
 					},
 				],
 			}),

package/src/react/hooks/{useListCollections.tsx → data/collections/useListCollections.tsx}

@@ -1,14 +1,14 @@
 'use client';
 
 import { useQuery } from '@tanstack/react-query';
-import type { Optional } from '../_internal';
+import type { Optional } from '../../../_internal';
 import {
 	type FetchListCollectionsParams,
 	type ListCollectionsQueryOptions,
 	listCollectionsQueryOptions,
-} from '../queries/listCollections';
-import { useConfig } from './useConfig';
-import { useMarketplaceConfig } from './useMarketplaceConfig';
+} from '../../../queries/listCollections';
+import { useConfig } from '../../config/useConfig';
+import { useMarketplaceConfig } from '../../config/useMarketplaceConfig';
 
 export type UseListCollectionsParams = Optional<
 	ListCollectionsQueryOptions,

package/src/react/hooks/data/index.ts

@@ -0,0 +1,6 @@
+export * from './collectibles';
+export * from './collections';
+export * from './market';
+export * from './orders';
+export * from './primary-sales';
+export * from './tokens';

package/src/react/hooks/data/inventory/index.ts

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