Skip to content

Commit adbbe9f

Browse files
github-actions[bot]RichardIrala
authored andcommitted
chore(i18n): update translations [en]
Sync file structure, format locales. Branch: 194/merge
1 parent 73c6506 commit adbbe9f

22 files changed

Lines changed: 936 additions & 0 deletions
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+
```
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: useConfig
3+
description: Obtiene la configuración del SDK del marketplace desde el contexto del proveedor. Este hook proporciona acceso a la configuración principal del SDK que se pasó al MarketplaceSdkProvider. Incluye endpoints de API, configuraciones de cadenas y otros ajustes generales del SDK necesarios para los componentes e hooks hijos.
4+
sidebarTitle: useConfig
5+
---
6+
7+
## Devuelve
8+
El objeto completo de configuración del SDK desde el contexto del proveedor
9+
10+
## Ejemplo
11+
Uso básico:
12+
13+
```typescript
14+
const config = useConfig();
15+
console.log(config.marketplaceApiUrl);
16+
console.log(config.projectId);
17+
```
18+
19+
Uso de la configuración para llamadas a la API:
20+
21+
```typescript
22+
const config = useConfig();
23+
24+
const response = await fetch(`${config.marketplaceApiUrl}/collections`, {
25+
headers: {
26+
'X-Project-ID': config.projectId
27+
}
28+
});
29+
```
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+
```
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+
```
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+
```
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+
```
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+
```
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: useGetCountOfFilteredOrders
3+
description: El hook useGetCountOfFilteredOrders retorna la cantidad de órdenes filtradas en una colección
4+
sidebarTitle: useGetCountOfFilteredOrders
5+
---
6+
7+
## Parámetros
8+
9+
| Nombre | Tipo | Descripción |
10+
| -------------------------- | ---------------------- | ------------------------------------------------------------------- |
11+
| `params.chainId` | `number` | El ID de la cadena (por ejemplo, 1 para Ethereum, 137 para Polygon) |
12+
| `params.collectionAddress` | `string` | La dirección del contrato de la colección |
13+
| `params.config` | `SdkConfig` | Parámetros opcionales de configuración del SDK |
14+
| `params.side` | `OrderSide` | El lado de la orden a contar (listing u oferta) |
15+
| `params.filter` | `OrdersFilter` | Filtro opcional para las órdenes |
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 órdenes filtradas en una colección
20+
21+
## Importar
22+
23+
```typescript
24+
import { useGetCountOfFilteredOrders } from "@0xsequence/marketplace-sdk/react";
25+
```
26+
27+
## Ejemplo
28+
Uso básico:
29+
30+
```typescript
31+
const { data: countOfOrders } = useGetCountOfFilteredOrders({
32+
chainId,
33+
collectionAddress,
34+
side: OrderSide.listing,
35+
filter: {
36+
searchText,
37+
properties: filterOptions,
38+
}
39+
});
40+
```
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: useGetCountOfPrimarySaleItems
3+
description: El hook useGetCountOfPrimarySaleItems retorna la cantidad de ítems de venta primaria filtrados en una colección
4+
sidebarTitle: useGetCountOfPrimarySaleItems
5+
---
6+
7+
## Parámetros
8+
9+
| Nombre | Tipo | Descripción |
10+
| -------------------------- | ---------------------- | ------------------------------------------------------------------- |
11+
| `params.chainId` | `number` | El ID de la cadena (por ejemplo, 1 para Ethereum, 137 para Polygon) |
12+
| `params.collectionAddress` | `string` | La dirección del contrato de la colección |
13+
| `params.config` | `SdkConfig` | Parámetros opcionales de configuración del SDK |
14+
| `params.side` | `OrderSide` | El lado de la orden a contar (listing u oferta) |
15+
| `params.filter` | `OrdersFilter` | Filtro opcional para las órdenes |
16+
| `params.query` | `StandardQueryOptions` | Configuración opcional de React Query (de TanStack Query) |
17+
18+
## Devuelve
19+
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.
20+
21+
## Importar
22+
23+
```typescript
24+
import { useGetCountOfPrimarySaleItems } from "@0xsequence/marketplace-sdk/react";
25+
```
26+
27+
## Ejemplo
28+
Uso básico:
29+
30+
```typescript
31+
const { data: countOfPrimarySalesItems } = useGetCountOfPrimarySaleItems({
32+
chainId: 1,
33+
primarySaleContractAddress: "0x00"
34+
});
35+
36+
console.log(countOfPrimarySalesItems?.count);
37+
```

0 commit comments

Comments
 (0)