Cómo Usar el Subgraph Studio
Bienvenido a tu nuevo punto de partida 👩🏽🚀
El Subgraph Studio es tu lugar para construir y crear subgrafos, añadir metadatos y publicarlos en el nuevo Explorer descentralizado (más sobre esto aquí).
Lo que puedes hacer en el Subgraph Studio:
- Crear un subgrafo a través de la UI de Studio
- Deployar un subgrafo usando el CLI
- Publicar un subgrafo con la UI de Studio
- Realizar una prueba en el Playground
- Integrarlo en el staging usando la URL de consulta
- Crear y gestionar sus claves API para subgrafos específicos
Aquí, en Subgraph Studio, tienes control total sobre tus subgrafos. No solo puedes probar tus subgrafos antes de publicarlos, sino que también puedes restringir tus claves API a dominios específicos y solo permitir que ciertos Indexadores realicen consultas desde tus claves de API.
Consultar subgrafos genera tarifas de consulta, que se utilizan para recompensar a los Indexadores en The Graph Network. Si eres un desarrollador de dapps o un desarrollador de subgrafos, Studio te permitirá crear mejores subgrafos para potenciar tus consultas o las de tu comunidad. El Studio se compone de 5 partes principales:
- Los controles de tu cuenta de usuario
- Una lista de los subgrafos que has creado
- Una sección para gestionar, ver los detalles y visualizar el estado de un subgrafo específico
- Una sección para gestionar las claves de la API que necesitarás para consultar un subgrafo
- Una sección para gestionar tu facturación
- Inicia sesión con tu wallet - puedes hacerlo a través de MetaMask o WalletConnect
- Una vez que te registres, verás tu clave única de deploy en la página de inicio de tu cuenta. Esto te permitirá publicar tus subgrafos o gestionar tus claves API + facturación. Tendrás una clave de deploy única que se puede volver a generar si crees que ha sido comprometida.
The Graph Network aún no es capaz de soportar todas las fuentes de datos & features disponibles en el Servicio Alojado. Para que los Indexadores de la red los admitan, los subgrafos deben:
- Indexa una red soportada
- No debe utilizar ninguna de las siguientes funciones:
- ipfs.cat & ipfs.map
- Errores no fatales
- Grafting
Se añadirán más funciones & redes a The Graph Network de forma gradual.
Después de haber creado tu subgrafo, podrás deployarlo usando la CLI, o interfaz de línea de comandos. El deploy de un subgrafo con la CLI empujará el subgrafo al Studio donde podrás probar los subgrafos usando el Playground. Esto te permitirá eventualmente publicar en The Graph Network. Para más información sobre la configuración de la CLI, mira esto (asegúrate de tener tu clave de deploy a mano). Recuerda que deployar no es lo mismo que publicar. Cuando deployas un subgrafo, sólo lo empujas al Studio donde puedes probarlo. En cambio, cuando publicas un subgrafo, lo estás publicando on-chain.
Si quieres probar tu subgrafo antes de publicarlo en la red, puedes hacerlo en el Subgraph Playground o mirar tus registros. Los registros de subgrafo te dirán dónde falla tu subgrafo en el caso de que lo haga.
¡Has llegado hasta aquí, felicidades!
Para publicar correctamente tu subgrafo, deberás seguir los siguientes pasos descritos en este blog.
También puedes ver el resumen en video a continuación:
Recuerda que, mientras sigues los pasos de publicación, podrás publicar en la red principal (mainnet) o en Goerli. Si eres un desarrollador de subgrafos por primera vez, te recomendamos encarecidamente que comiences publicando en Goerli, lo cual es gratis. Esto te permitirá ver cómo funcionará el subgrafo en The Graph Explorer y te permitirá probar elementos de curación.
Los indexadores deben presentar registros obligatorios de prueba de indexación a partir de un hash de bloque específico. Debido a que la publicación de un subgrafo es una acción realizada on-chain, recuerda que la transacción puede tardar algunos minutos en procesarse. Cualquier dirección que uses para publicar el contrato será la única que pueda publicar versiones futuras. ¡Elige sabiamente!
Los subgrafos con señal de curación se muestran a los Indexadores para que puedan ser indexados en la red descentralizada. Puedes publicar los subgrafos y la señal en una sola transacción, lo que te permite acuñar la primera señal de curación en el subgrafo y ahorrar en costes de gas. Al añadir tu señal a la señal proporcionada posteriormente por los Curadores, tu subgrafo también tendrá una mayor probabilidad de servir finalmente a las consultas.
Ahora que has publicado tu subgrafo, veamos cómo lo vas a gestionar de forma regular. Ten en cuenta que no puedes publicar tu subgrafo en la red si ha fallado la sincronización. Esto se debe normalmente a que el subgrafo tiene errores - ¡los registros te dirán dónde están esos problemas!
Los desarrolladores pueden querer actualizar su subgrafo, por una variedad de razones. Cuando este sea el caso, puedes deployar una nueva versión de tu subgrafo en Studio mediante la CLI (solo será privado en este momento) y, si estás satisfecho con él, puedes publicar este nuevo deploy en The Graph Explorer. Esto creará una nueva versión de tu subgrafo que los Curadores pueden comenzar a señalar y los Indexadores podrán indexar esta nueva versión.
Hasta hace poco, los desarrolladores se veían obligados a deployar y publicar una nueva versión de su subgrafo en el Explorer para actualizar los metadatos de sus subgrafos. Ahora, los developers pueden actualizar los metadatos de sus subgrafos sin tener que publicar una nueva versión. Los developers pueden actualizar los detalles de sus subgrafos en el Studio (bajo la imagen del perfil, el nombre, la descripción, etc.) marcando una opción llamada Update Details en el Graph Explorer. Si se marca esta opción, se generará una transacción on-chain que actualiza los detalles del subgrafo en el Explorer sin tener que publicar una nueva versión con un nuevo deploy.
Hay que tener en cuenta que la publicación de una nueva versión de un subgrafo en la red tiene un coste. Además de las tarifas de transacción, los desarrolladores también deben financiar una parte de la tarifa de curación de la señal de auto-migración. No puedes publicar una nueva versión de tu subgrafo si los curadores no han señalado sobre él. Para más información sobre los riesgos de la curación, lee más aquí.
Cada vez que se realiza un deploy una nueva versión del subgrafo en Subgraph Studio, la versión anterior se archiva. Las versiones archivadas no serán indexadas/sincronizadas y por lo tanto no podrán ser consultadas. Puedes desarchivar una versión archivada de tu subgrafo en la UI de Studio. Ten en cuenta que las versiones anteriores de los subgrafos no publicados deployados en Studio se archivarán automáticamente.
