Skip to content

Commit 0df8841

Browse files
RichardIralagithub-actions[bot]
RichardIrala
and
github-actions[bot]
authored
Add new marketplace-sdk hooks documentation (#194)
* Add useTransferModal, useHighestOffer and useListCollections hooks to marketplace-sdk docs * Add new marketplace-sdk hooks documentation Added documentation pages for the following new hooks in the marketplace-sdk: useConfig, useCountListingsForCollectible, useCountOffersForCollectible, useCurrency, useFilters, useFloorOrder, useGetCountOfFilteredOrders and useGetCountOfPrimarySaleItems. * chore(i18n): update translations [en] Sync file structure, format locales. Branch: 194/merge * Remove useConfig hook from docs * Auto-update guide cards metadata [skip ci] * Delete useConfig hook from spanish docs * chore(i18n): update translations [en] Sync file structure, format locales. Branch: 194/merge * Remove useConfig hook from Japanese docs --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 4164087 commit 0df8841

34 files changed

Lines changed: 1347 additions & 5 deletions

‎docs.json‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,8 @@
400400
"sdk/web/marketplace-sdk/hooks/marketplace-actions/useBuyModal",
401401
"sdk/web/marketplace-sdk/hooks/marketplace-actions/useMakeOfferModal",
402402
"sdk/web/marketplace-sdk/hooks/marketplace-actions/useSellModal",
403-
"sdk/web/marketplace-sdk/hooks/marketplace-actions/useCancelOrder"
403+
"sdk/web/marketplace-sdk/hooks/marketplace-actions/useCancelOrder",
404+
"sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal"
404405
]
405406
},
406407
{
@@ -412,6 +413,10 @@
412413
"sdk/web/marketplace-sdk/hooks/marketplace-data/useListListingsForCollectible",
413414
"sdk/web/marketplace-sdk/hooks/marketplace-data/useListOffersForCollectible",
414415
"sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOfCollectables",
416+
"sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfFilteredOrders",
417+
"sdk/web/marketplace-sdk/hooks/marketplace-data/useGetCountOfPrimarySaleItems",
418+
"sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible",
419+
"sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible",
415420
"sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollectibles",
416421
"sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollectiblesPaginated",
417422
"sdk/web/marketplace-sdk/hooks/marketplace-data/useMarketplaceConfig",
@@ -421,7 +426,12 @@
421426
"sdk/web/marketplace-sdk/hooks/marketplace-data/useCollectionDetails",
422427
"sdk/web/marketplace-sdk/hooks/marketplace-data/useInventory",
423428
"sdk/web/marketplace-sdk/hooks/marketplace-data/useLowestListing",
424-
"sdk/web/marketplace-sdk/hooks/marketplace-data/useListPrimarySaleItems"
429+
"sdk/web/marketplace-sdk/hooks/marketplace-data/useListPrimarySaleItems",
430+
"sdk/web/marketplace-sdk/hooks/marketplace-data/useListCollections",
431+
"sdk/web/marketplace-sdk/hooks/marketplace-data/useHighestOffer",
432+
"sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder",
433+
"sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters",
434+
"sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency"
425435
]
426436
}
427437
]

‎es/guides/guide-cards.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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."}]}]}
1+
{"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."}]}]}

‎es/sdk/web/marketplace-sdk/hooks/marketplace-actions/useTransferModal.mdx‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: useTransferModal
3+
description: Hook que proporciona funciones para transferir NFTs desde su cuenta a otra cuenta
4+
sidebarTitle: useTransferModal
5+
---
6+
7+
## Retorno
8+
Un objeto que contiene las funciones `show` y `close` para iniciar transferencias de NFTs desde su cuenta a otra cuenta
9+
10+
## Importar
11+
12+
```typescript
13+
import { useTransferModal } from "@0xsequence/marketplace-sdk/react";
14+
```
15+
16+
## Ejemplo
17+
Uso básico:
18+
19+
```typescript
20+
const { show: showTransferModal } = useTransferModal();
21+
22+
return (
23+
<button
24+
onClick={() => {
25+
showTransferModal({
26+
collectionAddress: collectionAddress,
27+
chainId: collectionChainId,
28+
collectibleId: tokenId,
29+
});
30+
}}
31+
>
32+
Transfer
33+
</button>
34+
);
35+
```

‎es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountListingsForCollectible.mdx‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: useCountListingsForCollectible
3+
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.
4+
sidebarTitle: useCountListingsForCollectible
5+
---
6+
7+
## Parámetros
8+
9+
| Nombre | Tipo | Descripción |
10+
| -------------------------- | ---------------------- | --------------------------------------------------------------------------------------- |
11+
| `params.config` | `SdkConfig` | Parámetros de configuración |
12+
| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) |
13+
| `params.collectionAddress` | `string` | La dirección del contrato de la colección |
14+
| `params.collectibleId` | `string` | El ID específico del coleccionable/token |
15+
| `params.filter` | `OrdersFilter` | Criterios de filtro opcionales para los listings |
16+
| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) |
17+
18+
## Devuelve
19+
Resultado de la consulta que contiene la cantidad de listings
20+
21+
## Ejemplo
22+
Uso básico:
23+
24+
```typescript
25+
const { data: listingCount, isLoading } = useCountListingsForCollectible({
26+
chainId: 137,
27+
collectionAddress: '0x...',
28+
collectibleId: '123'
29+
});
30+
```
31+
32+
Con filtro:
33+
34+
```typescript
35+
const { data: filteredCount } = useCountListingsForCollectible({
36+
chainId: 137,
37+
collectionAddress: '0x...',
38+
collectibleId: '123',
39+
filter: {
40+
priceRange: { min: '1000000000000000000' }
41+
}
42+
});
43+
```

‎es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCountOffersForCollectible.mdx‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: useCountOffersForCollectible
3+
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.
4+
sidebarTitle: useCountOffersForCollectible
5+
---
6+
7+
## Parámetros
8+
9+
| Nombre | Tipo | Descripción |
10+
| -------------------------- | ---------------------- | --------------------------------------------------------------------------------------- |
11+
| `params.config` | `SdkConfig` | Parámetros de configuración |
12+
| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) |
13+
| `params.collectionAddress` | `string` | La dirección del contrato de la colección |
14+
| `params.collectibleId` | `string` | El ID específico del coleccionable/token |
15+
| `params.filter` | `OrdersFilter` | Criterios de filtro opcionales para las ofertas |
16+
| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) |
17+
18+
## Devuelve
19+
Resultado de la consulta que contiene la cantidad de ofertas
20+
21+
## Ejemplo
22+
Uso básico:
23+
24+
```typescript
25+
const { data: offerCount, isLoading } = useCountOffersForCollectible({
26+
chainId: 137,
27+
collectionAddress: '0x...',
28+
collectibleId: '123'
29+
});
30+
```
31+
32+
Con filtro:
33+
34+
```typescript
35+
const { data: filteredCount } = useCountOffersForCollectible({
36+
chainId: 137,
37+
collectionAddress: '0x...',
38+
collectibleId: '123',
39+
filter: {
40+
priceRange: { min: '1000000000000000000' }
41+
}
42+
});
43+
```

‎es/sdk/web/marketplace-sdk/hooks/marketplace-data/useCurrency.mdx‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: useCurrency
3+
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.
4+
sidebarTitle: useCurrency
5+
---
6+
7+
## Parámetros
8+
9+
| Nombre | Tipo | Descripción |
10+
| ------------------------ | ---------------------- | --------------------------------------------------------------------------------------- |
11+
| `params.config` | `SdkConfig` | Parámetros de configuración |
12+
| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) |
13+
| `params.currencyAddress` | `string` | La dirección del contrato de la moneda |
14+
| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) |
15+
16+
## Devuelve
17+
Resultado de la consulta que contiene los detalles de la moneda
18+
19+
## Ejemplo
20+
Uso básico:
21+
22+
```typescript
23+
const { data, isLoading } = useCurrency({
24+
chainId: 137,
25+
currencyAddress: '0x...'
26+
});
27+
```
28+
29+
Con opciones personalizadas de consulta:
30+
31+
```typescript
32+
const { data, isLoading } = useCurrency({
33+
chainId: 1,
34+
currencyAddress: '0x...',
35+
query: {
36+
enabled: true
37+
}
38+
});
39+
```

‎es/sdk/web/marketplace-sdk/hooks/marketplace-data/useFilters.mdx‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: useFilters
3+
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.
4+
sidebarTitle: useFilters
5+
---
6+
7+
## Parámetros
8+
9+
| Nombre | Tipo | Descripción |
10+
| ------------------------------ | ---------------------- | --------------------------------------------------------------------------------------- |
11+
| `params.config` | `SdkConfig` | Parámetros de configuración |
12+
| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) |
13+
| `params.collectionAddress` | `string` | La dirección del contrato de la colección para obtener los filtros |
14+
| `params.showAllFilters` | `boolean` | Indica si se deben mostrar todos los filtros o aplicar el filtrado del marketplace |
15+
| `params.excludePropertyValues` | `boolean` | Indica si se deben excluir los valores de propiedad de la respuesta |
16+
| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) |
17+
18+
## Devuelve
19+
Resultado de la consulta que contiene los filtros de propiedades para la colección
20+
21+
## Ejemplo
22+
Uso básico:
23+
24+
```typescript
25+
const { data: filters, isLoading } = useFilters({
26+
chainId: 137,
27+
collectionAddress: '0x1234...'
28+
});
29+
30+
if (filters) {
31+
console.log(`Found ${filters.length} filters`);
32+
filters.forEach(filter => {
33+
console.log(`${filter.name}: ${filter.values?.join(', ')}`);
34+
});
35+
}
36+
```
37+
38+
Con el filtrado del marketplace desactivado:
39+
40+
```typescript
41+
const { data: allFilters } = useFilters({
42+
chainId: 1,
43+
collectionAddress: '0x5678...',
44+
showAllFilters: true, // Bypass marketplace filter rules
45+
query: {
46+
enabled: Boolean(selectedCollection),
47+
staleTime: 300000 // Cache for 5 minutes
48+
}
49+
});
50+
```
51+
52+
Excluir valores de propiedad para una carga más rápida:
53+
54+
```typescript
55+
const { data: filterNames } = useFilters({
56+
chainId: 137,
57+
collectionAddress: collectionAddress,
58+
excludePropertyValues: true, // Only get filter names, not values
59+
query: {
60+
enabled: Boolean(collectionAddress)
61+
}
62+
})
63+
```

‎es/sdk/web/marketplace-sdk/hooks/marketplace-data/useFloorOrder.mdx‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: useFloorOrder
3+
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.
4+
sidebarTitle: useFloorOrder
5+
---
6+
7+
## Parámetros
8+
9+
| Nombre | Tipo | Descripción |
10+
| -------------------------- | ---------------------- | --------------------------------------------------------------------------------------- |
11+
| `params.config` | `SdkConfig` | Parámetros de configuración |
12+
| `params.chainId` | `number` | El ID de la cadena (debe ser un número, por ejemplo, 1 para Ethereum, 137 para Polygon) |
13+
| `params.collectionAddress` | `string` | La dirección del contrato de la colección |
14+
| `params.filter` | `OrdersFilter` | Criterios de filtro opcionales para los coleccionables |
15+
| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) |
16+
17+
## Devuelve
18+
Resultado de la consulta que contiene los datos del floor order para la colección
19+
20+
## Ejemplo
21+
Uso básico:
22+
23+
```typescript
24+
const { data, isLoading } = useFloorOrder({
25+
chainId: 137,
26+
collectionAddress: '0x...'
27+
});
28+
```
29+
30+
Con filtros y opciones de consulta personalizadas:
31+
32+
```typescript
33+
const { data, isLoading } = useFloorOrder({
34+
chainId: 1,
35+
collectionAddress: '0x...',
36+
filter: {
37+
minPrice: '1000000000000000000' // 1 ETH in wei
38+
},
39+
query: {
40+
refetchInterval: 30000,
41+
enabled: hasCollectionAddress
42+
}
43+
});
44+
```

0 commit comments

Comments
 (0)