diff --git a/docs.json b/docs.json index 8a8ce2ff..ce2ced04 100644 --- a/docs.json +++ b/docs.json @@ -400,7 +400,8 @@ "sdk/web/marketplace-sdk/hooks/marketplace-actions/useBuyModal", "sdk/web/marketplace-sdk/hooks/marketplace-actions/useMakeOfferModal", "sdk/web/marketplace-sdk/hooks/marketplace-actions/useSellModal", - "sdk/web/marketplace-sdk/hooks/marketplace-actions/useCancelOrder" + "sdk/web/marketplace-sdk/hooks/marketplace-actions/useCancelOrder", + "sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal" ] }, { @@ -412,6 +413,10 @@ "sdk/web/marketplace-sdk/hooks/marketplace-data/useListListingsForCollectible", "sdk/web/marketplace-sdk/hooks/marketplace-data/useListOffersForCollectible", "sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOfCollectables", + "sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders", + "sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems", + "sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible", + "sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible", "sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollectibles", "sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollectiblesPaginated", "sdk/web/marketplace-sdk/hooks/marketplace-data/useMarketplaceConfig", @@ -421,7 +426,12 @@ "sdk/web/marketplace-sdk/hooks/marketplace-data/useCollectionDetails", "sdk/web/marketplace-sdk/hooks/marketplace-data/useInventory", "sdk/web/marketplace-sdk/hooks/marketplace-data/useLowestListing", - "sdk/web/marketplace-sdk/hooks/marketplace-data/useListPrimarySaleItems" + "sdk/web/marketplace-sdk/hooks/marketplace-data/useListPrimarySaleItems", + "sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections", + "sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer", + "sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder", + "sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters", + "sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency" ] } ] diff --git a/es/guides/guide-cards.json b/es/guides/guide-cards.json index 1ccad102..ae8805ef 100644 --- a/es/guides/guide-cards.json +++ b/es/guides/guide-cards.json @@ -1 +1 @@ -{"lastUpdated":"2025-12-04T11:16:33.409Z","totalCards":"7","sections":[{"title":"Desarrolladores de videojuegos","cards":[{"title":"Cree un juego móvil con Unity + Sequence","img":"/images/unity/jellyforest-iphone.jpg","href":"/guias/jelly-forest-unity-guia","description":"Aprenda a crear un juego atractivo para iOS y Android que utiliza Sequence Embedded Wallets en segundo plano para habilitar un marketplace integrado y una moneda dentro del juego."},{"title":"Cómo crear un juego con Unreal Engine","img":"/images/guides/overview/unreal-ew-guide.th.png","href":"/guias/unreal-ew-guia","description":"Utilice el SDK de Unreal de Sequence para mostrar información de Embedded Wallet, firmar mensajes y enviar transacciones."},{"title":"Cree un juego Dungeon Crawler con recompensas generadas por IA","img":"/images/guides/treasure-chest/dungeonMinter.th.png","href":"/guias/tesoro-guia","description":"Con este tutorial, cree un laberinto web donde los objetos de caja de recompensas (lootbox) se generan usando IA y se mintean dinámicamente en el wallet universal del jugador."},{"title":"Cree un juego WebGL en Typescript","img":"/images/aviator.th.jpg","href":"/guias/webgl-guia","description":"Siga una guía paso a paso para crear una demo de juego web que utiliza Sequence Embedded Wallet y tokens de logros personalizados dentro del juego."},{"title":"Venda objetos del juego a través de una tienda web","img":"/images/guides/overview/primary-sales.th.jpg","href":"/guias/ventas-primarias","description":"Impulse el crecimiento de su juego vendiendo objetos directamente a sus jugadores. En esta guía, le mostraremos cómo desplegar un contrato de Primary Sale paso a paso usando cualquier moneda personalizada o existente para una tienda web que utiliza objetos del juego de un contrato ERC1155."},{"title":"Compre artículos on-chain en Unity","img":"/images/guides/overview/unity-primary-sales.th.jpg","href":"/guias/unity-ventas-primarias","description":"Esta guía cubre la creación de una Primary Sale con el SDK de Unity de Sequence."},{"title":"Configurar un contrato ERC1155Pack","img":"/images/guides/overview/packs.th.jpg","href":"/guides/packs","description":"Esta guía explica cómo configurar un contrato ERC1155Pack usando Sequence Builder."}]}]} \ No newline at end of file +{"lastUpdated":"2026-01-05T15:02:56.281Z","totalCards":"7","sections":[{"title":"Desarrolladores de videojuegos","cards":[{"title":"Cree un juego móvil con Unity + Sequence","img":"/images/unity/jellyforest-iphone.jpg","href":"/guias/jelly-forest-unity-guia","description":"Aprenda a crear un juego atractivo para iOS y Android que utiliza Sequence Embedded Wallets en segundo plano para habilitar un marketplace integrado y una moneda dentro del juego."},{"title":"Cómo crear un juego con Unreal Engine","img":"/images/guides/overview/unreal-ew-guide.th.png","href":"/guias/unreal-ew-guia","description":"Utilice el SDK de Unreal de Sequence para mostrar información de Embedded Wallet, firmar mensajes y enviar transacciones."},{"title":"Cree un juego Dungeon Crawler con recompensas generadas por IA","img":"/images/guides/treasure-chest/dungeonMinter.th.png","href":"/guias/tesoro-guia","description":"Con este tutorial, cree un laberinto web donde los objetos de caja de recompensas (lootbox) se generan usando IA y se mintean dinámicamente en el wallet universal del jugador."},{"title":"Cree un juego WebGL en Typescript","img":"/images/aviator.th.jpg","href":"/guias/webgl-guia","description":"Siga una guía paso a paso para crear una demo de juego web que utiliza Sequence Embedded Wallet y tokens de logros personalizados dentro del juego."},{"title":"Venda objetos del juego a través de una tienda web","img":"/images/guides/overview/primary-sales.th.jpg","href":"/guias/ventas-primarias","description":"Impulse el crecimiento de su juego vendiendo objetos directamente a sus jugadores. En esta guía, le mostraremos cómo desplegar un contrato de Primary Sale paso a paso usando cualquier moneda personalizada o existente para una tienda web que utiliza objetos del juego de un contrato ERC1155."},{"title":"Compre artículos on-chain en Unity","img":"/images/guides/overview/unity-primary-sales.th.jpg","href":"/guias/unity-ventas-primarias","description":"Esta guía cubre la creación de una Primary Sale con el SDK de Unity de Sequence."},{"title":"Configurar un contrato ERC1155Pack","img":"/images/guides/overview/packs.th.jpg","href":"/guides/packs","description":"Esta guía explica cómo configurar un contrato ERC1155Pack usando Sequence Builder."}]}]} \ No newline at end of file diff --git a/es/sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal.mdx b/es/sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal.mdx new file mode 100644 index 00000000..8889c597 --- /dev/null +++ b/es/sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal.mdx @@ -0,0 +1,35 @@ +--- +title: useTransferModal +description: Hook que proporciona funciones para transferir NFTs desde su cuenta a otra cuenta +sidebarTitle: useTransferModal +--- + +## Retorno +Un objeto que contiene las funciones `show` y `close` para iniciar transferencias de NFTs desde su cuenta a otra cuenta + +## Importar + +```typescript +import { useTransferModal } from "@0xsequence/marketplace-sdk/react"; +``` + +## Ejemplo +Uso básico: + +```typescript +const { show: showTransferModal } = useTransferModal(); + +return ( + +); +``` \ No newline at end of file diff --git a/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible.mdx b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible.mdx new file mode 100644 index 00000000..0d76c475 --- /dev/null +++ b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible.mdx @@ -0,0 +1,43 @@ +--- +title: useCountListingsForCollectible +description: Hook para obtener la cantidad de listings para un coleccionable específico. Cuenta el número de listings activos para un coleccionable dado en el marketplace. Útil para mostrar la cantidad de listings en componentes de la interfaz. +sidebarTitle: useCountListingsForCollectible +--- + +## Parámetros + +| Nombre | Tipo | Descripción | +| -------------------------- | ---------------------- | --------------------------------------------------------------------------------------- | +| `params.config` | `SdkConfig` | Parámetros de configuración | +| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) | +| `params.collectionAddress` | `string` | La dirección del contrato de la colección | +| `params.collectibleId` | `string` | El ID específico del coleccionable/token | +| `params.filter` | `OrdersFilter` | Criterios de filtro opcionales para los listings | +| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) | + +## Devuelve +Resultado de la consulta que contiene la cantidad de listings + +## Ejemplo +Uso básico: + +```typescript +const { data: listingCount, isLoading } = useCountListingsForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123' +}); +``` + +Con filtro: + +```typescript +const { data: filteredCount } = useCountListingsForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123', + filter: { + priceRange: { min: '1000000000000000000' } + } +}); +``` \ No newline at end of file diff --git a/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible.mdx b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible.mdx new file mode 100644 index 00000000..deaa35cf --- /dev/null +++ b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible.mdx @@ -0,0 +1,43 @@ +--- +title: useCountOffersForCollectible +description: Hook para obtener la cantidad de ofertas para un coleccionable específico. Cuenta el número de ofertas activas para un coleccionable dado en el marketplace. Útil para mostrar la cantidad de ofertas en componentes de la interfaz. +sidebarTitle: useCountOffersForCollectible +--- + +## Parámetros + +| Nombre | Tipo | Descripción | +| -------------------------- | ---------------------- | --------------------------------------------------------------------------------------- | +| `params.config` | `SdkConfig` | Parámetros de configuración | +| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) | +| `params.collectionAddress` | `string` | La dirección del contrato de la colección | +| `params.collectibleId` | `string` | El ID específico del coleccionable/token | +| `params.filter` | `OrdersFilter` | Criterios de filtro opcionales para las ofertas | +| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) | + +## Devuelve +Resultado de la consulta que contiene la cantidad de ofertas + +## Ejemplo +Uso básico: + +```typescript +const { data: offerCount, isLoading } = useCountOffersForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123' +}); +``` + +Con filtro: + +```typescript +const { data: filteredCount } = useCountOffersForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123', + filter: { + priceRange: { min: '1000000000000000000' } + } +}); +``` \ No newline at end of file diff --git a/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency.mdx b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency.mdx new file mode 100644 index 00000000..e0e0d182 --- /dev/null +++ b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency.mdx @@ -0,0 +1,39 @@ +--- +title: useCurrency +description: Hook para obtener detalles de una moneda desde el marketplace. Recupera información detallada sobre una moneda específica por su dirección de contrato. Los datos de la moneda se almacenan en caché de llamadas previas a la lista de monedas cuando es posible. +sidebarTitle: useCurrency +--- + +## Parámetros + +| Nombre | Tipo | Descripción | +| ------------------------ | ---------------------- | --------------------------------------------------------------------------------------- | +| `params.config` | `SdkConfig` | Parámetros de configuración | +| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) | +| `params.currencyAddress` | `string` | La dirección del contrato de la moneda | +| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) | + +## Devuelve +Resultado de la consulta que contiene los detalles de la moneda + +## Ejemplo +Uso básico: + +```typescript +const { data, isLoading } = useCurrency({ + chainId: 137, + currencyAddress: '0x...' +}); +``` + +Con opciones personalizadas de consulta: + +```typescript +const { data, isLoading } = useCurrency({ + chainId: 1, + currencyAddress: '0x...', + query: { + enabled: true + } +}); +``` \ No newline at end of file diff --git a/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters.mdx b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters.mdx new file mode 100644 index 00000000..7873fb8b --- /dev/null +++ b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters.mdx @@ -0,0 +1,63 @@ +--- +title: useFilters +description: Hook para obtener filtros de metadatos de una colección. Recupera filtros de propiedades para una colección desde el servicio de metadatos, con soporte para configuración de filtros específica del marketplace, incluyendo reglas de exclusión y orden personalizado. +sidebarTitle: useFilters +--- + +## Parámetros + +| Nombre | Tipo | Descripción | +| ------------------------------ | ---------------------- | --------------------------------------------------------------------------------------- | +| `params.config` | `SdkConfig` | Parámetros de configuración | +| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) | +| `params.collectionAddress` | `string` | La dirección del contrato de la colección para obtener los filtros | +| `params.showAllFilters` | `boolean` | Indica si se deben mostrar todos los filtros o aplicar el filtrado del marketplace | +| `params.excludePropertyValues` | `boolean` | Indica si se deben excluir los valores de propiedad de la respuesta | +| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) | + +## Devuelve +Resultado de la consulta que contiene los filtros de propiedades para la colección + +## Ejemplo +Uso básico: + +```typescript +const { data: filters, isLoading } = useFilters({ + chainId: 137, + collectionAddress: '0x1234...' +}); + +if (filters) { + console.log(`Found ${filters.length} filters`); + filters.forEach(filter => { + console.log(`${filter.name}: ${filter.values?.join(', ')}`); + }); +} +``` + +Con el filtrado del marketplace desactivado: + +```typescript +const { data: allFilters } = useFilters({ + chainId: 1, + collectionAddress: '0x5678...', + showAllFilters: true, // Bypass marketplace filter rules + query: { + enabled: Boolean(selectedCollection), + staleTime: 300000 // Cache for 5 minutes + } +}); +``` + +Excluir valores de propiedad para una carga más rápida: + +```typescript +const { data: filterNames } = useFilters({ +chainId: 137, +collectionAddress: collectionAddress, +excludePropertyValues: true, // Only get filter names, not values +query: { +enabled: Boolean(collectionAddress) +} +}) +``` \ No newline at end of file diff --git a/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder.mdx b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder.mdx new file mode 100644 index 00000000..0a7ba6ad --- /dev/null +++ b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder.mdx @@ -0,0 +1,44 @@ +--- +title: useFloorOrder +description: Hook para obtener el floor order de una colección. Recupera la orden (listing) con el precio más bajo disponible actualmente para cualquier token en la colección especificada desde el marketplace. +sidebarTitle: useFloorOrder +--- + +## Parámetros + +| Nombre | Tipo | Descripción | +| -------------------------- | ---------------------- | --------------------------------------------------------------------------------------- | +| `params.config` | `SdkConfig` | Parámetros de configuración | +| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) | +| `params.collectionAddress` | `string` | La dirección del contrato de la colección | +| `params.filter` | `OrdersFilter` | Criterios de filtro opcionales para los coleccionables | +| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) | + +## Devuelve +Resultado de la consulta que contiene los datos del floor order para la colección + +## Ejemplo +Uso básico: + +```typescript +const { data, isLoading } = useFloorOrder({ + chainId: 137, + collectionAddress: '0x...' +}); +``` + +Con filtros y opciones de consulta personalizadas: + +```typescript +const { data, isLoading } = useFloorOrder({ + chainId: 1, + collectionAddress: '0x...', + filter: { + minPrice: '1000000000000000000' // 1 ETH in wei + }, + query: { + refetchInterval: 30000, + enabled: hasCollectionAddress + } +}); +``` \ No newline at end of file diff --git a/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders.mdx b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders.mdx new file mode 100644 index 00000000..b8c40856 --- /dev/null +++ b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders.mdx @@ -0,0 +1,40 @@ +--- +title: useGetCountOfFilteredOrders +description: El hook useGetCountOfFilteredOrders retorna la cantidad de órdenes filtradas en una colección +sidebarTitle: useGetCountOfFilteredOrders +--- + +## Parámetros + +| Nombre | Tipo | Descripción | +| -------------------------- | ---------------------- | ------------------------------------------------------------------- | +| `params.chainId` | `number` | El ID de la cadena (por ejemplo, 1 para Ethereum, 137 para Polygon) | +| `params.collectionAddress` | `string` | La dirección del contrato de la colección | +| `params.config` | `SdkConfig` | Parámetros opcionales de configuración del SDK | +| `params.side` | `OrderSide` | El lado de la orden a contar (listing u oferta) | +| `params.filter` | `OrdersFilter` | Filtro opcional para las órdenes | +| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) | + +## Devuelve +Resultado de la consulta que contiene la cantidad de órdenes filtradas en una colección + +## Importar + +```typescript +import { useGetCountOfFilteredOrders } from "@0xsequence/marketplace-sdk/react"; +``` + +## Ejemplo +Uso básico: + +```typescript +const { data: countOfOrders } = useGetCountOfFilteredOrders({ + chainId, + collectionAddress, + side: OrderSide.listing, + filter: { + searchText, + properties: filterOptions, + } +}); +``` \ No newline at end of file diff --git a/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems.mdx b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems.mdx new file mode 100644 index 00000000..c34a277b --- /dev/null +++ b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems.mdx @@ -0,0 +1,37 @@ +--- +title: useGetCountOfPrimarySaleItems +description: El hook useGetCountOfPrimarySaleItems retorna la cantidad de ítems de venta primaria filtrados en una colección +sidebarTitle: useGetCountOfPrimarySaleItems +--- + +## Parámetros + +| Nombre | Tipo | Descripción | +| -------------------------- | ---------------------- | ------------------------------------------------------------------- | +| `params.chainId` | `number` | El ID de la cadena (por ejemplo, 1 para Ethereum, 137 para Polygon) | +| `params.collectionAddress` | `string` | La dirección del contrato de la colección | +| `params.config` | `SdkConfig` | Parámetros opcionales de configuración del SDK | +| `params.side` | `OrderSide` | El lado de la orden a contar (listing u oferta) | +| `params.filter` | `OrdersFilter` | Filtro opcional para las órdenes | +| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) | + +## Devuelve +Un resultado de consulta que contiene un objeto con una propiedad `count` que representa la cantidad de ítems de venta primaria filtrados en una colección. + +## Importar + +```typescript +import { useGetCountOfPrimarySaleItems } from "@0xsequence/marketplace-sdk/react"; +``` + +## Ejemplo +Uso básico: + +```typescript +const { data: countOfPrimarySalesItems } = useGetCountOfPrimarySaleItems({ + chainId: 1, + primarySaleContractAddress: "0x00" +}); + +console.log(countOfPrimarySalesItems?.count); +``` \ No newline at end of file diff --git a/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer.mdx b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer.mdx new file mode 100644 index 00000000..dca9f57d --- /dev/null +++ b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer.mdx @@ -0,0 +1,45 @@ +--- +title: useHighestOffer +description: Hook para obtener la oferta más alta de un coleccionable. Recupera la oferta más alta disponible actualmente para un token específico en una colección desde el marketplace. +sidebarTitle: useHighestOffer +--- + +## Parámetros + +| Nombre | Tipo | Descripción | +| -------------------------- | ---------------------- | --------------------------------------------------------------------------------------- | +| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) | +| `params.collectionAddress` | `string` | La dirección del contrato de la colección | +| `params.tokenId` | `string` | El ID del token dentro de la colección | +| `params.filter` | `OrderFilter` | Filtro opcional para las órdenes | +| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) | + +## Devuelve +Resultado de la consulta que contiene los datos de la oferta más alta o null si no existen ofertas + +## Ejemplo +Uso básico: + +```typescript +const { data, isLoading } = useHighestOffer({ + chainId: 137, + collectionAddress: '0x...', + tokenId: '1' +}); +``` + +Con opciones personalizadas de consulta: + +```typescript +const hasTokenId = true; + +const { data, isLoading } = useHighestOffer({ + chainId: 1, + collectionAddress: '0x...', + tokenId: '42', + query: { + refetchInterval: 15000, + enabled: hasTokenId + } +}); +``` \ No newline at end of file diff --git a/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections.mdx b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections.mdx new file mode 100644 index 00000000..04df82e8 --- /dev/null +++ b/es/sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections.mdx @@ -0,0 +1,50 @@ +--- +title: useListCollections +description: Hook para obtener colecciones desde la configuración del marketplace. Recupera todas las colecciones configuradas en el marketplace, con filtrado opcional por tipo de marketplace. Combina metadatos de la API de metadatos con la configuración del marketplace para proporcionar información completa de las colecciones. +sidebarTitle: useListCollections +--- + +## Parámetros + +| Nombre | Tipo | Descripción | +| -------------------------- | ------------------- | ------------------------------------------------------ | +| `params.config` | `SdkConfig` | Parámetros de configuración opcionales | +| `params.marketplaceConfig` | `MarketplaceConfig` | Parámetros opcionales de configuración del Marketplace | +| `params.cardType` | `CardType` | Filtro opcional por tipo de marketplace | +| `params.query` | `any` | Configuración opcional de React Query | + +## Devuelve +Resultado de la consulta que contiene un arreglo de colecciones con metadatos configurados en Sequence Builder + +## Importar + +```typescript +import { useCollection } from "@0xsequence/marketplace-sdk/react"; +``` + +## Ejemplo +Uso básico: + +```typescript +const { data: collections, isLoading } = useListCollections(); + +if (isLoading) return
Loading collections...
; + +return ( +
+ {collections?.map(collection => ( +
+ {collection.name} +
+ ))} +
+); +``` + +Filtrado por tipo de marketplace: + +```typescript +const { data: marketCollections } = useListCollections({ + cardType: 'market' +}); +``` \ No newline at end of file diff --git a/guides/guide-cards.json b/guides/guide-cards.json index 8e9f4519..37112e7a 100644 --- a/guides/guide-cards.json +++ b/guides/guide-cards.json @@ -1,5 +1,5 @@ { - "lastUpdated": "2025-12-04T11:16:33.409Z", + "lastUpdated": "2026-01-05T15:02:56.281Z", "totalCards": 7, "sections": [ { diff --git a/ja/guides/guide-cards.json b/ja/guides/guide-cards.json index 57b40cf3..6c19c902 100644 --- a/ja/guides/guide-cards.json +++ b/ja/guides/guide-cards.json @@ -1 +1 @@ -{"lastUpdated":"2025-12-04T11:16:33.409Z","totalCards":"7","sections":[{"title":"ゲーム開発者向け","cards":[{"title":"UnityとSequenceでモバイルゲームを構築する","img":"/images/unity/jellyforest-iphone.jpg","href":"/guides/jelly-forest-unity-guide","description":"Sequence Embedded Walletを内部的に活用し、統合マーケットプレイスやゲーム内通貨を備えた魅力的なiOS・Androidゲームの作り方を説明します。"},{"title":"Unreal Engineでゲームを構築する方法","img":"/images/guides/overview/unreal-ew-guide.th.png","href":"/guides/unreal-ew-guide","description":"SequenceのUnreal SDKを使って、Embedded Walletの情報表示、メッセージ署名、トランザクション送信を行いましょう。"},{"title":"AI生成報酬付きダンジョンクローラーゲームを作成する","img":"/images/guides/treasure-chest/dungeonMinter.th.png","href":"/guides/treasure-chest-guide","description":"このチュートリアルでは、AIで生成されたガチャアイテムをプレイヤーのユニバーサルウォレットに動的にミントする、ウェブベースの迷路ゲームを作成します。"},{"title":"TypescriptでWebGLゲームを構築する","img":"/images/aviator.th.jpg","href":"/guides/webgl-guide","description":"Sequence Embedded Walletとカスタムのゲーム内実績トークンを活用したウェブゲームデモを、ステップバイステップで作成できます。"},{"title":"ウェブショップでゲームアイテムを販売する","img":"/images/guides/overview/primary-sales.th.jpg","href":"/guides/primary-sales","description":"ゲーム成長を加速させるため、アイテムをプレイヤーに直接販売できます。本ガイドでは、ERC1155コントラクト由来のゲームアイテムを利用したウェブショップで、任意のカスタム通貨や既存通貨を使ってPrimary Saleコントラクトをデプロイする手順を説明します。"},{"title":"Unityでオンチェーンアイテムを購入する","img":"/images/guides/overview/unity-primary-sales.th.jpg","href":"/guides/unity-primary-sales","description":"このガイドでは、SequenceのUnity SDKを使ったPrimary Saleの作成方法を説明します。"},{"title":"ERC1155Packコントラクトの設定方法","img":"/images/guides/overview/packs.th.jpg","href":"/guides/packs","description":"このガイドでは、Sequence Builderを使ったERC1155Packコントラクトの設定方法について説明します。"}]}]} \ No newline at end of file +{"lastUpdated":"2026-01-05T15:02:56.281Z","totalCards":"7","sections":[{"title":"ゲーム開発者向け","cards":[{"title":"UnityとSequenceでモバイルゲームを構築する","img":"/images/unity/jellyforest-iphone.jpg","href":"/guides/jelly-forest-unity-guide","description":"Sequence Embedded Walletを内部的に活用し、統合マーケットプレイスやゲーム内通貨を備えた魅力的なiOS・Androidゲームの作り方を説明します。"},{"title":"Unreal Engineでゲームを構築する方法","img":"/images/guides/overview/unreal-ew-guide.th.png","href":"/guides/unreal-ew-guide","description":"SequenceのUnreal SDKを使って、Embedded Walletの情報表示、メッセージ署名、トランザクション送信を行いましょう。"},{"title":"AI生成報酬付きダンジョンクローラーゲームを作成する","img":"/images/guides/treasure-chest/dungeonMinter.th.png","href":"/guides/treasure-chest-guide","description":"このチュートリアルでは、AIで生成されたガチャアイテムをプレイヤーのユニバーサルウォレットに動的にミントする、ウェブベースの迷路ゲームを作成します。"},{"title":"TypescriptでWebGLゲームを構築する","img":"/images/aviator.th.jpg","href":"/guides/webgl-guide","description":"Sequence Embedded Walletとカスタムのゲーム内実績トークンを活用したウェブゲームデモを、ステップバイステップで作成できます。"},{"title":"ウェブショップでゲームアイテムを販売する","img":"/images/guides/overview/primary-sales.th.jpg","href":"/guides/primary-sales","description":"ゲーム成長を加速させるため、アイテムをプレイヤーに直接販売できます。本ガイドでは、ERC1155コントラクト由来のゲームアイテムを利用したウェブショップで、任意のカスタム通貨や既存通貨を使ってPrimary Saleコントラクトをデプロイする手順を説明します。"},{"title":"Unityでオンチェーンアイテムを購入する","img":"/images/guides/overview/unity-primary-sales.th.jpg","href":"/guides/unity-primary-sales","description":"このガイドでは、SequenceのUnity SDKを使ったPrimary Saleの作成方法を説明します。"},{"title":"ERC1155Packコントラクトの設定方法","img":"/images/guides/overview/packs.th.jpg","href":"/guides/packs","description":"このガイドでは、Sequence Builderを使ったERC1155Packコントラクトの設定方法について説明します。"}]}]} \ No newline at end of file diff --git a/ja/sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal.mdx b/ja/sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal.mdx new file mode 100644 index 00000000..dd18ef1f --- /dev/null +++ b/ja/sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal.mdx @@ -0,0 +1,35 @@ +--- +title: useTransferModal +description: 自分のアカウントから他のアカウントへNFTを送信するための関数を提供するフックです。 +sidebarTitle: useTransferModal +--- + +## 返り値 +自分のアカウントから他のアカウントへNFTの送信を開始するための `show` と `close` 関数を含むオブジェクトです。 + +## インポート + +```typescript +import { useTransferModal } from "@0xsequence/marketplace-sdk/react"; +``` + +## 例 +基本的な使い方： + +```typescript +const { show: showTransferModal } = useTransferModal(); + +return ( + +); +``` \ No newline at end of file diff --git a/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible.mdx b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible.mdx new file mode 100644 index 00000000..59dd8614 --- /dev/null +++ b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible.mdx @@ -0,0 +1,43 @@ +--- +title: useCountListingsForCollectible +description: 特定のコレクティブルの出品数を取得するフックです。指定したコレクティブルの有効な出品数をマーケットプレイスからカウントします。UIコンポーネントで出品数を表示する際などに便利です。 +sidebarTitle: useCountListingsForCollectible +--- + +## パラメータ + +| 名前 | 型 | 説明 | +| -------------------------- | ---------------------- | -------------------------------------- | +| `params.config` | `SdkConfig` | 設定パラメータ | +| `params.chainId` | `number` | チェーンID（数値で指定、例：Ethereumは1、Polygonは137） | +| `params.collectionAddress` | `string` | コレクションコントラクトのアドレス | +| `params.collectibleId` | `string` | 対象となるコレクティブル／トークンID | +| `params.filter` | `OrdersFilter` | 出品のためのオプションのフィルター条件 | +| `params.query` | `StandardQueryOptions` | オプションのReact Query設定（TanStack Query由来） | + +## 戻り値 +出品数を含むクエリ結果 + +## 例 +基本的な使い方： + +```typescript +const { data: listingCount, isLoading } = useCountListingsForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123' +}); +``` + +フィルターを使う場合： + +```typescript +const { data: filteredCount } = useCountListingsForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123', + filter: { + priceRange: { min: '1000000000000000000' } + } +}); +``` \ No newline at end of file diff --git a/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible.mdx b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible.mdx new file mode 100644 index 00000000..f8633078 --- /dev/null +++ b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible.mdx @@ -0,0 +1,43 @@ +--- +title: useCountOffersForCollectible +description: 特定のコレクティブルのオファー数を取得するフックです。指定したコレクティブルの有効なオファー数をマーケットプレイスからカウントします。UIコンポーネントでオファー数を表示する際などに便利です。 +sidebarTitle: useCountOffersForCollectible +--- + +## パラメータ + +| 名前 | 型 | 説明 | +| -------------------------- | ---------------------- | -------------------------------------- | +| `params.config` | `SdkConfig` | 設定パラメータ | +| `params.chainId` | `number` | チェーンID（数値で指定、例：Ethereumは1、Polygonは137） | +| `params.collectionAddress` | `string` | コレクションコントラクトのアドレス | +| `params.collectibleId` | `string` | 対象となるコレクティブル／トークンID | +| `params.filter` | `OrdersFilter` | オファーのためのオプションのフィルター条件 | +| `params.query` | `StandardQueryOptions` | オプションのReact Query設定（TanStack Query由来） | + +## 戻り値 +オファー数を含むクエリ結果 + +## 例 +基本的な使い方： + +```typescript +const { data: offerCount, isLoading } = useCountOffersForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123' +}); +``` + +フィルターを使う場合： + +```typescript +const { data: filteredCount } = useCountOffersForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123', + filter: { + priceRange: { min: '1000000000000000000' } + } +}); +``` \ No newline at end of file diff --git a/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency.mdx b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency.mdx new file mode 100644 index 00000000..e59c337b --- /dev/null +++ b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency.mdx @@ -0,0 +1,39 @@ +--- +title: useCurrency +description: マーケットプレイスから通貨情報を取得するフックです。指定したコントラクトアドレスの通貨について詳細情報を取得します。通貨データは可能な限り過去の通貨リスト呼び出しからキャッシュされます。 +sidebarTitle: useCurrency +--- + +## パラメータ + +| 名前 | 型 | 説明 | +| ------------------------ | ---------------------- | -------------------------------------- | +| `params.config` | `SdkConfig` | 設定パラメータ | +| `params.chainId` | `number` | チェーンID（数値で指定、例：Ethereumは1、Polygonは137） | +| `params.currencyAddress` | `string` | 通貨コントラクトアドレス | +| `params.query` | `StandardQueryOptions` | オプションのReact Query設定（TanStack Query由来） | + +## 戻り値 +通貨の詳細情報を含むクエリ結果 + +## 例 +基本的な使い方： + +```typescript +const { data, isLoading } = useCurrency({ + chainId: 137, + currencyAddress: '0x...' +}); +``` + +カスタムクエリオプションを使う場合： + +```typescript +const { data, isLoading } = useCurrency({ + chainId: 1, + currencyAddress: '0x...', + query: { + enabled: true + } +}); +``` \ No newline at end of file diff --git a/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters.mdx b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters.mdx new file mode 100644 index 00000000..04168a0a --- /dev/null +++ b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters.mdx @@ -0,0 +1,63 @@ +--- +title: useFilters +description: コレクションのメタデータフィルターを取得するフックです。メタデータサービスからコレクションのプロパティフィルターを取得し、マーケットプレイス固有のフィルター設定（除外ルールやカスタム順序など）にも対応しています。 +sidebarTitle: useFilters +--- + +## パラメータ + +| 名前 | 型 | 説明 | +| ------------------------------ | ---------------------- | --------------------------------------- | +| `params.config` | `SdkConfig` | 設定パラメータ | +| `params.chainId` | `number` | チェーンID（数値で指定、例：Ethereumは1、Polygonは137） | +| `params.collectionAddress` | `string` | フィルターを取得する対象コレクションのコントラクトアドレス | +| `params.showAllFilters` | `boolean` | すべてのフィルターを表示するか、マーケットプレイスのフィルタリングを適用するか | +| `params.excludePropertyValues` | `boolean` | レスポンスからプロパティ値を除外するかどうか | +| `params.query` | `StandardQueryOptions` | オプションのReact Query設定（TanStack Query由来） | + +## 戻り値 +コレクションのプロパティフィルターを含むクエリ結果 + +## 例 +基本的な使い方： + +```typescript +const { data: filters, isLoading } = useFilters({ + chainId: 137, + collectionAddress: '0x1234...' +}); + +if (filters) { + console.log(`Found ${filters.length} filters`); + filters.forEach(filter => { + console.log(`${filter.name}: ${filter.values?.join(', ')}`); + }); +} +``` + +マーケットプレイスのフィルタリングを無効にした場合： + +```typescript +const { data: allFilters } = useFilters({ + chainId: 1, + collectionAddress: '0x5678...', + showAllFilters: true, // Bypass marketplace filter rules + query: { + enabled: Boolean(selectedCollection), + staleTime: 300000 // Cache for 5 minutes + } +}); +``` + +高速読み込みのためプロパティ値を除外： + +```typescript +const { data: filterNames } = useFilters({ +chainId: 137, +collectionAddress: collectionAddress, +excludePropertyValues: true, // Only get filter names, not values +query: { +enabled: Boolean(collectionAddress) +} +}) +``` \ No newline at end of file diff --git a/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder.mdx b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder.mdx new file mode 100644 index 00000000..bfc7ca47 --- /dev/null +++ b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder.mdx @@ -0,0 +1,44 @@ +--- +title: useFloorOrder +description: コレクションのフロアオーダー（最安値の出品）を取得するフックです。指定したコレクション内で現在利用可能な最も安い出品情報をマーケットプレイスから取得します。 +sidebarTitle: useFloorOrder +--- + +## パラメータ + +| 名前 | 型 | 説明 | +| -------------------------- | ---------------------- | -------------------------------------- | +| `params.config` | `SdkConfig` | 設定パラメータ | +| `params.chainId` | `number` | チェーンID（数値で指定、例：Ethereumは1、Polygonは137） | +| `params.collectionAddress` | `string` | コレクションコントラクトのアドレス | +| `params.filter` | `OrdersFilter` | コレクティブルのためのオプションのフィルター条件 | +| `params.query` | `StandardQueryOptions` | オプションのReact Query設定（TanStack Query由来） | + +## 戻り値 +コレクションのフロアオーダーデータを含むクエリ結果 + +## 例 +基本的な使い方： + +```typescript +const { data, isLoading } = useFloorOrder({ + chainId: 137, + collectionAddress: '0x...' +}); +``` + +フィルターやカスタムクエリオプションを使う場合： + +```typescript +const { data, isLoading } = useFloorOrder({ + chainId: 1, + collectionAddress: '0x...', + filter: { + minPrice: '1000000000000000000' // 1 ETH in wei + }, + query: { + refetchInterval: 30000, + enabled: hasCollectionAddress + } +}); +``` \ No newline at end of file diff --git a/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders.mdx b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders.mdx new file mode 100644 index 00000000..ed427802 --- /dev/null +++ b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders.mdx @@ -0,0 +1,40 @@ +--- +title: useGetCountOfFilteredOrders +description: useGetCountOfFilteredOrdersフックは、コレクション内のフィルター済み注文数を返します。 +sidebarTitle: useGetCountOfFilteredOrders +--- + +## パラメータ + +| 名前 | 型 | 説明 | +| -------------------------- | ---------------------- | --------------------------------------- | +| `params.chainId` | `number` | チェーンID（例：Ethereum は 1、Polygon は 137 など） | +| `params.collectionAddress` | `string` | コレクションコントラクトのアドレス | +| `params.config` | `SdkConfig` | オプションのSDK設定パラメータ | +| `params.side` | `OrderSide` | カウント対象の注文サイド（出品またはオファー） | +| `params.filter` | `OrdersFilter` | 注文のためのオプションのフィルター | +| `params.query` | `StandardQueryOptions` | オプションのReact Query設定（TanStack Query由来） | + +## 戻り値 +コレクション内のフィルター済み注文数を含むクエリ結果 + +## インポート + +```typescript +import { useGetCountOfFilteredOrders } from "@0xsequence/marketplace-sdk/react"; +``` + +## 例 +基本的な使い方： + +```typescript +const { data: countOfOrders } = useGetCountOfFilteredOrders({ + chainId, + collectionAddress, + side: OrderSide.listing, + filter: { + searchText, + properties: filterOptions, + } +}); +``` \ No newline at end of file diff --git a/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems.mdx b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems.mdx new file mode 100644 index 00000000..ebeef76f --- /dev/null +++ b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems.mdx @@ -0,0 +1,37 @@ +--- +title: useGetCountOfPrimarySaleItems +description: useGetCountOfPrimarySaleItemsフックは、コレクション内のフィルター済み一次販売アイテム数を返します。 +sidebarTitle: useGetCountOfPrimarySaleItems +--- + +## パラメータ + +| 名前 | 型 | 説明 | +| -------------------------- | ---------------------- | --------------------------------------- | +| `params.chainId` | `number` | チェーンID（例：Ethereum は 1、Polygon は 137 など） | +| `params.collectionAddress` | `string` | コレクションコントラクトのアドレス | +| `params.config` | `SdkConfig` | オプションのSDK設定パラメータ | +| `params.side` | `OrderSide` | カウント対象の注文サイド（出品またはオファー） | +| `params.filter` | `OrdersFilter` | 注文のためのオプションのフィルター | +| `params.query` | `StandardQueryOptions` | オプションのReact Query設定（TanStack Query由来） | + +## 戻り値 +コレクション内のフィルター済み一次販売アイテム数を表す `count` プロパティを持つオブジェクトを含むクエリ結果。 + +## インポート + +```typescript +import { useGetCountOfPrimarySaleItems } from "@0xsequence/marketplace-sdk/react"; +``` + +## 例 +基本的な使い方： + +```typescript +const { data: countOfPrimarySalesItems } = useGetCountOfPrimarySaleItems({ + chainId: 1, + primarySaleContractAddress: "0x00" +}); + +console.log(countOfPrimarySalesItems?.count); +``` \ No newline at end of file diff --git a/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer.mdx b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer.mdx new file mode 100644 index 00000000..6fb3cf92 --- /dev/null +++ b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer.mdx @@ -0,0 +1,45 @@ +--- +title: useHighestOffer +description: コレクティブルの最高オファーを取得するフックです。指定したコレクション内の特定トークンに対して現在利用可能な最高額のオファーをマーケットプレイスから取得します。 +sidebarTitle: useHighestOffer +--- + +## パラメータ + +| 名前 | 型 | 説明 | +| -------------------------- | ---------------------- | -------------------------------------- | +| `params.chainId` | `number` | チェーンID（数値で指定、例：Ethereumは1、Polygonは137） | +| `params.collectionAddress` | `string` | コレクションコントラクトのアドレス | +| `params.tokenId` | `string` | コレクション内のトークンID | +| `params.filter` | `OrderFilter` | 注文のためのオプションのフィルター | +| `params.query` | `StandardQueryOptions` | オプションのReact Query設定（TanStack Query由来） | + +## 戻り値 +最高オファーデータ、またはオファーが存在しない場合はnullを含むクエリ結果 + +## 例 +基本的な使い方： + +```typescript +const { data, isLoading } = useHighestOffer({ + chainId: 137, + collectionAddress: '0x...', + tokenId: '1' +}); +``` + +カスタムクエリオプションを使う場合： + +```typescript +const hasTokenId = true; + +const { data, isLoading } = useHighestOffer({ + chainId: 1, + collectionAddress: '0x...', + tokenId: '42', + query: { + refetchInterval: 15000, + enabled: hasTokenId + } +}); +``` \ No newline at end of file diff --git a/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections.mdx b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections.mdx new file mode 100644 index 00000000..e5598558 --- /dev/null +++ b/ja/sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections.mdx @@ -0,0 +1,50 @@ +--- +title: useListCollections +description: マーケットプレイス設定からコレクションを取得するフックです。マーケットプレイスタイプによるオプションのフィルタリングも可能です。メタデータAPIの情報とマーケットプレイス設定を組み合わせて、コレクションの完全な情報を提供します。 +sidebarTitle: useListCollections +--- + +## パラメータ + +| 名前 | 型 | 説明 | +| -------------------------- | ------------------- | -------------------------- | +| `params.config` | `SdkConfig` | オプションの設定パラメータ | +| `params.marketplaceConfig` | `MarketplaceConfig` | オプションのマーケットプレイス設定パラメータ | +| `params.cardType` | `CardType` | マーケットプレイスタイプによるオプションのフィルター | +| `params.query` | `any` | オプションのReact Query設定 | + +## 戻り値 +Sequence Builderで設定されたメタデータ付きコレクションの配列を含むクエリ結果 + +## インポート + +```typescript +import { useCollection } from "@0xsequence/marketplace-sdk/react"; +``` + +## 例 +基本的な使い方： + +```typescript +const { data: collections, isLoading } = useListCollections(); + +if (isLoading) return
Loading collections...
; + +return ( +
+ {collections?.map(collection => ( +
+ {collection.name} +
+ ))} +
+); +``` + +マーケットプレイスタイプでフィルタリングする場合： + +```typescript +const { data: marketCollections } = useListCollections({ + cardType: 'market' +}); +``` \ No newline at end of file diff --git a/sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal.mdx b/sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal.mdx new file mode 100644 index 00000000..d1c40d15 --- /dev/null +++ b/sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal.mdx @@ -0,0 +1,37 @@ +--- +title: useTransferModal +description: Hook that provides functions to transfer NFTs from your account to another account +sidebarTitle: useTransferModal +--- + +## Return + +An object containing the `show` and `close` functions to initiate NFT transfers from your account to another account + +## Import + +```typescript +import { useTransferModal } from "@0xsequence/marketplace-sdk/react"; +``` + +## Example + +Basic usage: + +```typescript +const { show: showTransferModal } = useTransferModal(); + +return ( + +); +``` \ No newline at end of file diff --git a/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible.mdx b/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible.mdx new file mode 100644 index 00000000..e2e5b154 --- /dev/null +++ b/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible.mdx @@ -0,0 +1,45 @@ +--- +title: useCountListingsForCollectible +description: Hook to get the count of listings for a specific collectible Counts the number of active listings for a given collectible in the marketplace. Useful for displaying listing counts in UI components +sidebarTitle: useCountListingsForCollectible +--- + +## Parameters + +| Name | Type | Description | +|----------------------------|-----------------------------|----------------------------------------------------------------------------------------------| +| `params.config` | `SdkConfig` | Configuration parameters | +| `params.chainId` | `number` | The chain ID (must be a number, e.g., 1 for Ethereum, 137 for Polygon) | +| `params.collectionAddress` | `string` | The collection contract address | +| `params.collectibleId` | `string` | The specific collectible/token ID | +| `params.filter` | `OrdersFilter` | Optional filter criteria for listings | +| `params.query` | `StandardQueryOptions` | Optional React Query configuration (from TanStack Query) | + +## Returns + +Query result containing the count of listings + +## Example + +Basic usage: + +```typescript +const { data: listingCount, isLoading } = useCountListingsForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123' +}); +``` + +With filter: + +```typescript +const { data: filteredCount } = useCountListingsForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123', + filter: { + priceRange: { min: '1000000000000000000' } + } +}); +``` \ No newline at end of file diff --git a/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible.mdx b/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible.mdx new file mode 100644 index 00000000..f8f6e844 --- /dev/null +++ b/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible.mdx @@ -0,0 +1,44 @@ +--- +title: useCountOffersForCollectible +description: Hook to get the count of offers for a specific collectible Counts the number of active offers for a given collectible in the marketplace. Useful for displaying offer counts in UI components +sidebarTitle: useCountOffersForCollectible +--- + +## Parameters +| Name | Type | Description | +|----------------------------|-----------------------------|----------------------------------------------------------------------------------------------| +| `params.config` | `SdkConfig` | Configuration parameters | +| `params.chainId` | `number` | The chain ID (must be a number, e.g., 1 for Ethereum, 137 for Polygon) | +| `params.collectionAddress` | `string` | The collection contract address | +| `params.collectibleId` | `string` | The specific collectible/token ID | +| `params.filter` | `OrdersFilter` | Optional filter criteria for offers | +| `params.query` | `StandardQueryOptions` | Optional React Query configuration (from TanStack Query) | + +## Returns + +Query result containing the count of offers + +## Example + +Basic usage: + +```typescript +const { data: offerCount, isLoading } = useCountOffersForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123' +}); +``` + +With filter: + +```typescript +const { data: filteredCount } = useCountOffersForCollectible({ + chainId: 137, + collectionAddress: '0x...', + collectibleId: '123', + filter: { + priceRange: { min: '1000000000000000000' } + } +}); +``` \ No newline at end of file diff --git a/sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency.mdx b/sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency.mdx new file mode 100644 index 00000000..c2c62e42 --- /dev/null +++ b/sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency.mdx @@ -0,0 +1,40 @@ +--- +title: useCurrency +description: Hook to fetch currency details from the marketplace Retrieves detailed information about a specific currency by its contract address. The currency data is cached from previous currency list calls when possible +sidebarTitle: useCurrency +--- + +## Parameters + +| Name | Type | Description | +|----------------------------|-----------------------------|----------------------------------------------------------------------------------------------| +| `params.config` | `SdkConfig` | Configuration parameters | +| `params.chainId` | `number` | The chain ID (must be a number, e.g., 1 for Ethereum, 137 for Polygon) | +| `params.currencyAddress` | `string` | The currency contract address | +| `params.query` | `StandardQueryOptions` | Optional React Query configuration (from TanStack Query) | + +## Returns + +Query result containing currency details + +## Example + +Basic usage: +```typescript +const { data, isLoading } = useCurrency({ + chainId: 137, + currencyAddress: '0x...' +}); +``` + +With custom query options: + +```typescript +const { data, isLoading } = useCurrency({ + chainId: 1, + currencyAddress: '0x...', + query: { + enabled: true + } +}); +``` \ No newline at end of file diff --git a/sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters.mdx b/sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters.mdx new file mode 100644 index 00000000..cac1713a --- /dev/null +++ b/sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters.mdx @@ -0,0 +1,62 @@ +--- +title: useFilters +description: Hook to fetch metadata filters for a collection Retrieves property filters for a collection from the metadata service, with support for marketplace-specific filter configuration including exclusion rules and custom ordering +sidebarTitle: useFilters +--- + +## Parameters + +| Name | Type | Description | +|--------------------------------|-----------------------------|----------------------------------------------------------------------------------------------| +| `params.config` | `SdkConfig` | Configuration parameters | +| `params.chainId` | `number` | The chain ID (must be a number, e.g., 1 for Ethereum, 137 for Polygon) | +| `params.collectionAddress` | `string` | The collection contract address to fetch filters for | +| `params.showAllFilters` | `boolean` | Whether to show all filters or apply marketplace filtering | +| `params.excludePropertyValues` | `boolean` | Whether to exclude property values from the response | +| `params.query` | `StandardQueryOptions` | Optional React Query configuration (from TanStack Query) | + +## Returns + +Query result containing property filters for the collection + +## Example + +Basic usage: +```typescript +const { data: filters, isLoading } = useFilters({ + chainId: 137, + collectionAddress: '0x1234...' +}); + +if (filters) { + console.log(`Found ${filters.length} filters`); + filters.forEach(filter => { + console.log(`${filter.name}: ${filter.values?.join(', ')}`); + }); +} +``` + +With marketplace filtering disabled: +```typescript +const { data: allFilters } = useFilters({ + chainId: 1, + collectionAddress: '0x5678...', + showAllFilters: true, // Bypass marketplace filter rules + query: { + enabled: Boolean(selectedCollection), + staleTime: 300000 // Cache for 5 minutes + } +}); +``` + +Exclude property values for faster loading: +```typescript +const { data: filterNames } = useFilters({ +chainId: 137, +collectionAddress: collectionAddress, +excludePropertyValues: true, // Only get filter names, not values +query: { +enabled: Boolean(collectionAddress) +} +}) +``` diff --git a/sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder.mdx b/sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder.mdx new file mode 100644 index 00000000..97b27800 --- /dev/null +++ b/sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder.mdx @@ -0,0 +1,46 @@ +--- +title: useFloorOrder +description: Hook to fetch the floor order for a collection Retrieves the lowest priced order (listing) currently available for any token in the specified collection from the marketplace +sidebarTitle: useFloorOrder +--- + +## Parameters + +| Name | Type | Description | +|----------------------------|-----------------------------|----------------------------------------------------------------------------------------------| +| `params.config` | `SdkConfig` | Configuration parameters | +| `params.chainId` | `number` | The chain ID (must be a number, e.g., 1 for Ethereum, 137 for Polygon) | +| `params.collectionAddress` | `string` | The collection contract address | +| `params.filter` | `OrdersFilter` | Optional filter criteria for collectibles | +| `params.query` | `StandardQueryOptions` | Optional React Query configuration (from TanStack Query) | + +## Returns + +Query result containing the floor order data for the collection + +## Example + +Basic usage: + +```typescript +const { data, isLoading } = useFloorOrder({ + chainId: 137, + collectionAddress: '0x...' +}); +``` + +With filters and custom query options: + +```typescript +const { data, isLoading } = useFloorOrder({ + chainId: 1, + collectionAddress: '0x...', + filter: { + minPrice: '1000000000000000000' // 1 ETH in wei + }, + query: { + refetchInterval: 30000, + enabled: hasCollectionAddress + } +}); +``` \ No newline at end of file diff --git a/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders.mdx b/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders.mdx new file mode 100644 index 00000000..64cbd75e --- /dev/null +++ b/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders.mdx @@ -0,0 +1,42 @@ +--- +title: useGetCountOfFilteredOrders +description: The useGetCountOfFilteredOrders hook returns the number of filtered orders in a collection +sidebarTitle: useGetCountOfFilteredOrders +--- + +## Parameters + +| Name | Type | Description | +|----------------------------|-----------------------------|----------------------------------------------------------------------------------------------| +| `params.chainId` | `number` | The chain ID (e.g., 1 for Ethereum, 137 for Polygon) | +| `params.collectionAddress` | `string` | The collection contract address | +| `params.config` | `SdkConfig` | Optional SDK configuration parameters | +| `params.side` | `OrderSide` | The order side to count (listing or offer) | +| `params.filter` | `OrdersFilter` | Optional filter for the orders | +| `params.query` | `StandardQueryOptions` | Optional React Query configuration (from TanStack Query) | + +## Returns + +Query result containing a number of filtered orders in a collection + +## Import + +```typescript +import { useGetCountOfFilteredOrders } from "@0xsequence/marketplace-sdk/react"; +``` + +## Example + +Basic usage: + +```typescript +const { data: countOfOrders } = useGetCountOfFilteredOrders({ + chainId, + collectionAddress, + side: OrderSide.listing, + filter: { + searchText, + properties: filterOptions, + } +}); +``` \ No newline at end of file diff --git a/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems.mdx b/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems.mdx new file mode 100644 index 00000000..3d3c5526 --- /dev/null +++ b/sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems.mdx @@ -0,0 +1,39 @@ +--- +title: useGetCountOfPrimarySaleItems +description: The useGetCountOfPrimarySaleItems hook returns the number of filtered primary sale items in a collection +sidebarTitle: useGetCountOfPrimarySaleItems +--- + +## Parameters + +| Name | Type | Description | +|----------------------------|-----------------------------|----------------------------------------------------------------------------------------------| +| `params.chainId` | `number` | The chain ID (e.g., 1 for Ethereum, 137 for Polygon) | +| `params.collectionAddress` | `string` | The collection contract address | +| `params.config` | `SdkConfig` | Optional SDK configuration parameters | +| `params.side` | `OrderSide` | The order side to count (listing or offer) | +| `params.filter` | `OrdersFilter` | Optional filter for the orders | +| `params.query` | `StandardQueryOptions` | Optional React Query configuration (from TanStack Query) | + +## Returns + +A query result containing an object with a `count` property representing the number of filtered primary sale items in a collection. + +## Import + +```typescript +import { useGetCountOfPrimarySaleItems } from "@0xsequence/marketplace-sdk/react"; +``` + +## Example + +Basic usage: + +```typescript +const { data: countOfPrimarySalesItems } = useGetCountOfPrimarySaleItems({ + chainId: 1, + primarySaleContractAddress: "0x00" +}); + +console.log(countOfPrimarySalesItems?.count); +``` \ No newline at end of file diff --git a/sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer.mdx b/sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer.mdx new file mode 100644 index 00000000..41adb728 --- /dev/null +++ b/sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer.mdx @@ -0,0 +1,47 @@ +--- +title: useHighestOffer +description: Hook to fetch the highest offer for a collectible Retrieves the highest offer currently available for a specific token in a collection from the marketplace +sidebarTitle: useHighestOffer +--- + +## Parameters + +| Name | Type | Description | +|----------------------------|-----------------------------|----------------------------------------------------------------------------------------------| +| `params.chainId` | `number` | The chain ID (must be a number, e.g., 1 for Ethereum, 137 for Polygon) | +| `params.collectionAddress` | `string` | The collection contract address | +| `params.tokenId` | `string` | The token ID within the collection | +| `params.filter` | `OrderFilter` | Optional filter for orders | +| `params.query` | `StandardQueryOptions` | Optional React Query configuration (from TanStack Query) | + +## Returns + +Query result containing the highest offer data or null if no offers exist + +## Example + +Basic usage: + +```typescript +const { data, isLoading } = useHighestOffer({ + chainId: 137, + collectionAddress: '0x...', + tokenId: '1' +}); +``` + +With custom query options: + +```typescript +const hasTokenId = true; + +const { data, isLoading } = useHighestOffer({ + chainId: 1, + collectionAddress: '0x...', + tokenId: '42', + query: { + refetchInterval: 15000, + enabled: hasTokenId + } +}); +``` \ No newline at end of file diff --git a/sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections.mdx b/sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections.mdx new file mode 100644 index 00000000..a3b44ce0 --- /dev/null +++ b/sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections.mdx @@ -0,0 +1,52 @@ +--- +title: useListCollections +description: Hook to fetch collections from marketplace configuration Retrieves all collections configured in the marketplace, with optional filtering by marketplace type. Combines metadata from the metadata API with marketplace configuration to provide complete collection information. +sidebarTitle: useListCollections +--- + +## Parameters + +| Name | Type | Description | +|----------------------------|---------------------|-----------------------------------------------------| +| `params.config` | `SdkConfig` | Optional configuration parameters | +| `params.marketplaceConfig` | `MarketplaceConfig` | Optional Marketplace configuration parameters | +| `params.cardType` | `CardType` | Optional filter by marketplace type | +| `params.query` | `any` | Optional React Query configuration | + +## Returns + +Query result containing an array of collections with metadata configured in Sequence Builder + +## Import + +```typescript +import { useCollection } from "@0xsequence/marketplace-sdk/react"; +``` + +## Example + +Basic usage: + +```typescript +const { data: collections, isLoading } = useListCollections(); + +if (isLoading) return
Loading collections...
; + +return ( +
+ {collections?.map(collection => ( +
+ {collection.name} +
+ ))} +
+); +``` + +Filtering by marketplace type: + +```typescript +const { data: marketCollections } = useListCollections({ + cardType: 'market' +}); +``` \ No newline at end of file