logos-storage/logos-storage-docs
1
0
Fork 0
mirror of https://github.com/logos-storage/logos-storage-docs.git synced 2026-01-04 14:23:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
logos-storage-docs/learn/using.md
yayguru 12346a25c1
Update using.md 
Spanish translation
2025-02-14 20:02:09 +01:00

14 KiB
Raw Blame History

outline
2
3

Usando Codex

Podemos interactuar con Codex usando la API REST. Este documento le mostrará varios ejemplos útiles.

Además, podemos consultar la UI de la App Codex.

El intérprete de línea de comandos en Linux/macOS y Windows funciona de forma ligeramente diferente, así que utilice los pasos para su sistema operativo.

Linux/macOS

Descripción General

  1. Debug
  2. Subir un archivo
  3. Descargar un archivo
  4. Datos Locales
  5. Crear disponibilidad de almacenamiento
  6. Comprar almacenamiento
  7. Ver el estado de la compra

Debug

na forma sencilla de comprobar que su nodo está activo y en funcionamiento e

curl http://localhost:8080/api/codex/v1/debug/info \
  -w '\n'

Esto devolverá una estructura JSON con mucha información sobre su nodo local. Contiene información de pares que puede ser útil para solucionar problemas de conexión.

Subir un archivo

[¡ATENCIÓN!] Una vez que sube un archivo a Codex, otros nodos de la red pueden descargarlo. Por favor, no suba nada a lo que no quiera que otros accedan, o, encripte apropiadamente sus datos primero.

curl -X POST \
  http://localhost:8080/api/codex/v1/data \
  -H 'Content-Type: application/octet-stream' \
  -w '\n' \
  -T <FILE>

Tras una subida exitosa, recibirá un CID. Esto puede ser utilizado para descargar el archivo desde cualquier nodo en la red.

[¡CONSEJO!] Está en el servidor de Discord de Codex? Publique su CID en el canal # 🛜 | share-cids , vea si otros pueden descargarlo. Codex no proporciona (¿todavía?) metadatos de archivos, así que, si quiere que otros puedan abrir su archivo, dígasles qué extensión deben darle.

Descargar un archivo

Cuando tenga un CID de datos que quiera descargar, puede usar los siguientes comandos:

# paste your CID from the previous step here between the quotes
CID="..."

curl "http://localhost:8080/api/codex/v1/data/${CID}/network/stream" \
  -o "${CID}.png"

Utilice la extensión correcta para el archivo descargado, porque Codex aún no almacena información de content-type o extensión.

Datos locales

Puede ver qué conjuntos de datos están siendo almacenados actualmente por su nodo:

curl http://localhost:8080/api/codex/v1/data \
  -w '\n'

Crear disponibilidad de almacenamiento

[¡ATENCIÓN!] Este paso requiere que Codex se haya iniciado con la opción prover .

Para empezar a vender espacio de almacenamiento a la red, debe configurar su nodo con el siguiente comando. Una vez configurado, el nodo supervisará las solicitudes de almacenamiento en cadena y celebrará automáticamente los contratos que cumplan con estas especificaciones. Para celebrar y mantener los contratos de almacenamiento, su nodo debe presentar pruebas de almacenamiento de conocimiento cero. El cálculo de estas pruebas aumentará el uso de CPU y RAM de Codex.

curl -X POST \
  http://localhost:8080/api/codex/v1/sales/availability \
  -H 'Content-Type: application/json' \
  -w '\n' \
  -d '{
    "totalSize": "8000000",
    "duration": "7200",
    "minPrice": "10",
    "maxCollateral": "10"
  }'

Para obtener descripciones de cada parámetro, consulte la especificación.

Comprar almacenamiento

Para comprar espacio de almacenamiento de la red, primero debe subir sus datos. Una vez que tenga el CID, utilice lo siguiente para crear una solicitud de almacenamiento.

Establezca su CID:

# paste your CID from the previous step here between the quotes
CID="..."
echo "CID: ${CID}"

A continuación, puede ejecutar:

curl -X POST \
  "http://localhost:8080/api/codex/v1/storage/request/${CID}" \
  -w '\n' \
  -d '{
    "duration": "3600",
    "reward": "1",
    "proofProbability": "5",
    "expiry": "1200",
    "nodes": 5,
    "tolerance": 2,
    "collateral": "1"
  }'

Para obtener descripciones de cada parámetro, consulte la especificación.

Si tiene éxito, esta solicitud devolverá un Purchase-ID.

Ver el estado de la compra

Usando un Purchase-ID, puede comprobar el estado de su contrato de solicitud de almacenamiento:

# pegue su PURCHASE_ID del paso anterior aquí entre las comillas
PURCHASE_ID="..."

Entonces:

curl "http://localhost:8080/api/codex/v1/storage/purchases/${PURCHASE_ID}" \
  -w '\n'

Esto mostrará información de estado y errores para su compra.

Estado Descripción
Pendiente La solicitud está esperando la confirmación de la cadena.
Enviado La solicitud está en la cadena. Los hosts ahora pueden intentar descargar los datos.
Iniciado Los hosts han descargado los datos y han proporcionado prueba de almacenamiento.
Fallido La solicitud se inició, pero (demasiados) hosts no proporcionaron la prueba de almacenamiento a tiempo. Aunque los datos pueden seguir estando disponibles en la red, a efectos de la compra se consideran perdidos.
Finalizado La solicitud se inició correctamente y la duración ha transcurrido.
Expirado (No suficientes) hosts han enviado una prueba de almacenamiento antes de que transcurriera la fecha de caducidad de la solicitud.
Erróneo Un desafortunado estado de cosas. El campo 'error' debería darle más información.

Windows

Descripción General

  1. Debug
  2. Subir un archivo
  3. Descargar un archivo
  4. Datos locales
  5. Crear disponibilidad de almacenamiento
  6. Comprar almacenamiento
  7. Ver el estado de la compra

Debug

Una forma sencilla de comprobar que su nodo está activo y en funcionamiento es:

curl http://localhost:8080/api/codex/v1/debug/info

Esto devolverá una estructura JSON con mucha información sobre su nodo local. Contiene información de pares que puede ser útil para solucionar problemas de conexión.

Subir un archivo

[¡ATENCIÓN!] Una vez que sube un archivo a Codex, otros nodos de la red pueden descargarlo. Por favor, no suba nada a lo que no quiera que otros accedan, o, encripte apropiadamente sus datos primero.

curl -X POST ^
  http://localhost:8080/api/codex/v1/data ^
  -H "Content-Type: application/octet-stream" ^
  -T <FILE>

Tras una subida exitosa, recibirá un CID. Esto puede ser utilizado para descargar el archivo desde cualquier nodo en la red.

[¡CONSEJO!] Está en el servidor de Discord de Codex? Publique su CID en el canal # 🛜 | share-cids, vea si otros pueden descargarlo. Codex no proporciona (¿todavía?) metadatos de archivos, así que, si quiere que otros puedan abrir su archivo, dígasles qué extensión deben darle.

Descargar un archivo

Cuando tenga un CID de datos que quiera descargar, puede usar los siguientes comandos:

:: pegue su CID del paso anterior aquí entre las comillas
set CID="..."

curl "http://localhost:8080/api/codex/v1/data/%CID%/network/stream" ^
  -o "%CID%.png"

Utilice la extensión correcta para el archivo descargado, porque Codex aún no almacena información de content-type o extensión.

Datos locales

Puede ver qué conjuntos de datos están siendo almacenados actualmente por su nodo:

curl http://localhost:8080/api/codex/v1/data

Crear disponibilidad de almacenamiento

[¡ATENCIÓN!] Este paso requiere que Codex se haya iniciado con la opción prover .

Para empezar a vender espacio de almacenamiento a la red, debe configurar su nodo con el siguiente comando. Una vez configurado, el nodo supervisará las solicitudes de almacenamiento en cadena y celebrará automáticamente los contratos que cumplan con estas especificaciones. Para celebrar y mantener los contratos de almacenamiento, su nodo debe presentar pruebas de almacenamiento de conocimiento cero. El cálculo de estas pruebas aumentará el uso de CPU y RAM de Codex.

curl -X POST ^
  http://localhost:8080/api/codex/v1/sales/availability ^
  -H "Content-Type: application/json" ^
  -d "{""totalSize"": ""8000000"", ""duration"": ""7200"", ""minPrice"": ""10"", ""maxCollateral"": ""10""}"

Para obtener descripciones de cada parámetro, consulte la especificación.

Comprar almacenamiento

Para comprar espacio de almacenamiento de la red, primero debe subir sus datos. Una vez que tenga el CID, utilice lo siguiente para crear una solicitud de almacenamiento.

Establezca su CID:

:: paste your CID from the previous step here between the quotes
set CID="..."
echo CID: %CID%

A continuación, puede ejecutar:

curl -X POST ^
  "http://localhost:8080/api/codex/v1/storage/request/%CID%" ^
  -H "Content-Type: application/json" ^
  -d "{""duration"": ""3600"",""reward"": ""1"", ""proofProbability"": ""5"", ""expiry"": ""1200"", ""nodes"": 5, ""tolerance"": 2, ""collateral"": ""1""}"

Para obtener descripciones de cada parámetro, consulte la especificación.

Si tiene éxito, esta solicitud devolverá un Purchase-ID.

Ver el estado de la compra

Usando un Purchase-ID, puede comprobar el estado de su contrato de solicitud de almacenamiento:

:: pegue su PURCHASE_ID del paso anterior aquí entre las comillas
set PURCHASE_ID="..."

Entonces:

curl "http://localhost:8080/api/codex/v1/storage/purchases/%PURCHASE_ID%"

Esto mostrará información de estado y errores para su compra.

Estado Descripción
Pendiente La solicitud está esperando la confirmación de la cadena.
Enviado La solicitud está en la cadena. Los hosts ahora pueden intentar descargar los datos.
Iniciado Los hosts han descargado los datos y han proporcionado prueba de almacenamiento.
Fallido La solicitud se inició, pero (demasiados) hosts no proporcionaron la prueba de almacenamiento a tiempo. Aunque los datos pueden seguir estando disponibles en la red, a efectos de la compra se consideran perdidos.
Finalizado La solicitud se inició correctamente y la duración ha transcurrido.
Expirado (No suficientes) hosts han enviado una prueba de almacenamiento antes de que transcurriera la fecha de caducidad de la solicitud.
Erróneo Un desafortunado estado de cosas. El campo 'error' debería darle más información.

Problemas conocidos

  1. Añadimos una nueva línea a las llamadas a la API para obtener una salida más legible, consulte [rest] Add line ending on responses #771 para obtener más detalles.