Ejemplos de CLI

Esta práctica demuestra cómo interactuar con la API de contenido en una terminal. Usaremos la instancia de la Fundación Decentraland en peer.decentraland.org, y todo lo que necesitas es la curl herramienta de línea de comandos.

Puedes usar httpie o formatear las respuestas con jq para obtener JSON más legibles con cada solicitud. En esta guía, mostraremos documentos formateados para mayor claridad.

Esto es lo que haremos:

1. Consultar el estado del content server.

2. Localiza y descarga una instantánea con una lista de entities.

3. Obtén el manifiesto de una Entity.

4. Descarga uno de los archivos de la Entity.

Empecemos consultando el estado del servidor usando /about:

curl "https://peer.decentraland.org/about"

{
  "healthy": true,
  "content": {
    "healthy": true,
    "version": "6.5.0",
  },
  // ... más información del servidor (feature flags, versiones, rutas, etc.)
}

Parece que el servidor está en línea y funcionando normalmente ("healthy": true), y nos está dando información sobre la versión que implementa para cada conjunto de funciones, además de algunas opciones de configuración de la instancia.

Nos interesa descargar contenido, así que exploremos los disponibles instantáneas para hacernos con algunos identificadores a través de /content/snapshots.

curl "https://peer.decentraland.org/content/snapshots"

[
  {
    "hash": "bafybeia6qoum64psaooiqo3f45i6hykfwx723uc236waub3gng2naof224",
    "timeRange": {
      "initTimestamp": 1689120000000,
      "endTimestamp": 1689206400000
    },
    "replacedSnapshotHashes": [],
    "numberOfEntities": 981,
    "generationTimestamp": 1689219353866
  },
  // ... más archivos de instantáneas
]

Cada elemento del array describe un instantánea. Vamos a conseguir una hash y descargar el archivo desde el /content/contents endpoint.

curl "https://peer.decentraland.org/content/contents/bafybeia6qoum64psaooiqo3f45i6hykfwx723uc236waub3gng2naof224" > snapshot

Puedes experimentar con instantáneas más grandes, como en el ejemplo avanzado de Python. Para probar esto de forma interactiva, probablemente quieras una de las más pequeñas.

Podemos comprobar que descargamos el archivo correcto en un formato que conocemos, mirando la primera línea:

head -n1 snapshot

### instantánea JSON de Decentraland

¡Genial! Ahora tenemos un resumen local de todas las entities que se capturaron en esa instantánea. Tomemos la primera de la lista (la segunda línea del archivo), una perfil:

tail -n+2 snapshot | head -n1 

{
  "entityId": "bafkreif7hjremkxlvixyxoxnoo7bdcnf7qqp245sjb2pag2nk3n6o6yc4c",
  "entityType": "profile",
  "pointers": [
    "0x271cdb3b1c792c336c4b2bdc52c4f415d0046b92"
  ],
  "authChain": [
    // Ver https://docs.decentraland.org/contributor/auth/authchain/
  ],
  "entityTimestamp": 1689120135624
}

Como las instantáneas expiran y las entities se reemplazan, los identificadores de este artículo no funcionarán. Sigue el ejemplo en tu línea de comandos para obtener IDs de archivo reales y activos.

Esta es información que podríamos guardar. Usaremos el entityId para descargar el manifiesto JSON de la Entity, pero conservar el pointer listado es una buena idea si queremos localizar esta Entity y cualquier versión actualizada en el futuro.

También tenemos el cadena de autenticación utilizado para firmar esta Entity, y podríamos validar las firmas listadas para verificar la autenticidad de cualquier archivo relacionado que descarguemos.

Vamos a hacernos con el manifiesto de la Entity. Recuerda, el entityId es el identificador de archivo que necesitamos, y podemos usar el /content/contents endpoint de nuevo:

curl "https://peer.decentraland.org/content/contents/bafkreigcreq7rv6b2wf4zc4fsnif43ziwb4q46v4qhsewpf7gbsyxew3om"

{
  "version": "v3",
  "type": "profile",
  "pointers": [
    "0x273cdb3b1c791c336c4b2bcc52c4f415d0046b91"
  ],
  "timestamp": 1689120135624,
  "content": [
    {
      "file": "body.png",
      "hash": "bafybeibzaqkirz7fk474xvyhurho5xviphs7anawaceb6gscuigia4x33u"
    },
    // ...más archivos
  ],
  "metadata": {
    // ... avatares y otra información
  }
}

Esta perfil Entity contiene toda la información que World Explorers usa para renderizar y animar a un jugador. Si nos interesa obtener uno de los files empaquetados, podemos seguir usando el /content/contents endpoint.

Si miramos el contenido campo, podemos ver el hash del archivo llamado internamente body.png. Vamos a obtenerlo:

curl "https://peer.decentraland.org/content/contents/bafybeibzaqkirz7fk474xvyhurho5xviphs7anawaceb6gscuigia4x33u" > body.png

Podemos abrir este png archivo en un visor de imágenes o navegador web, y echar un vistazo al trabajo del autor. ¡Genial!