How to Use Subgraph Studio

Reading time: 6 min

Benvenuti nel vostro nuovo launchpad👩🏽‍🚀

Subgraph Studio is your place to build and create subgraphs, add metadata, and publish them to the new decentralized Explorer (more on that here).

What you can do in Subgraph Studio:

• Creare un subgraph attraverso UI di Studio
• Distribuire un subgraph usando la CLI
• Pubblicare un subgraph con UI di Studio
• Testarlo nel playground
• Integrarlo in staging utilizzando la query URL
• Creare e gestire le chiavi API per specifici subgraph

Here in Subgraph Studio, you have full control over your subgraphs. Not only can you test your subgraphs before you publish them, but you can also restrict your API keys to specific domains and only allow certain Indexers to query from their API keys.

Eseguire query dei subgraph genera tariffe di query, utilizzate per ricompensare gli Indexer del Graph Network. Se siete sviluppatori di dapp o di subgraph, lo Studio vi consentirà di costruire subgraph migliori per alimentare le query della vostra comunità. Lo Studio è composto da 5 parti principali:

• Il controllo dell'account utente
• Un elenco di subgraph creati dall'utente
• Una sezione per gestire, visualizzare i dettagli e lo stato di uno specifico subgraph
• Una sezione per gestire le chiavi API di cui si ha bisogno per eseguire query di un subgraph
• Una sezione per gestire la fatturazione

1. Sign in with your wallet - you can do this via MetaMask, WalletConnect, Coinbase Wallet or Safe.
2. Una volta effettuato l'accesso, nella pagina iniziale del vostro account vedrete la vostra chiave di distribuzione unica. Questo vi permetterà di pubblicare i vostri subgraph o di gestire le chiavi API e la fatturazione. Avrete una chiave di distribuzione unica che può essere rigenerata se pensate che sia stata compromessa.

In order to be supported by Indexers on The Graph Network, subgraphs must:

• Indicizzare una rete supportata
• Non deve utilizzare nessuna delle seguenti funzioni:
  • ipfs.cat e ipfs.map
  • Errori non fatali
  • Grafting

Altre funzionalità e reti saranno aggiunte gradualmente a The Graph Network.

After you have created your subgraph, you will be able to deploy it using the CLI, or command-line interface. Deploying a subgraph with the CLI will push the subgraph to the Studio where you’ll be able to test subgraphs using the playground. This will eventually allow you to publish to the Graph Network. For more information on CLI setup, check this out (psst, make sure you have your deploy key on hand). Remember, deploying is not the same as publishing. When you deploy a subgraph, you just push it to the Studio where you’re able to test it. Versus, when you publish a subgraph, you are publishing it on-chain.

Se si desidera testare il proprio subgraph prima di pubblicarlo nella rete, è possibile farlo nel Subgraph Playground o guardare i log. I log di Subgraph vi diranno dove il vostro subgraph fallisce nel caso in cui lo faccia.

Siete arrivati fin qui - complimenti!

In order to publish your subgraph successfully, you’ll need to go through the following steps outlined in this section.

Date un'occhiata anche al video qui sotto:

Remember, while you’re going through your publishing flow, you’ll be able to push to either Arbitrum One or Arbitrum Sepolia. If you’re a first-time subgraph developer, we highly suggest you start with publishing to Arbitrum Sepolia, which is free to do. This will allow you to see how the subgraph will work in Graph Explorer and will allow you to test curation elements.

Gli Indexer devono inviare i record obbligatori di Proof of Indexing a partire da uno specifico hash del blocco. Poiché la pubblicazione di un subgraph è un'azione eseguita on-chain, ricordate che la transazione può richiedere fino a qualche minuto. L'indirizzo utilizzato per pubblicare il contratto sarà l'unico in grado di pubblicare versioni future. Scegliete con attenzione!

I subgraph con segnale di curation vengono mostrati agli Indexer in modo che possano essere indicizzati sulla rete decentralizzata. È possibile pubblicare i subgraph e il segnale in un'unica transazione, il che consente di coniare il primo segnale di curation sul subgraph e di risparmiare sui costi del gas. Aggiungendo il proprio segnale a quelli forniti successivamente dai curatori, il subgraph avrà anche maggiori possibilità di servire le query.

Ora che il subgraph è stato pubblicato, vediamo come gestirlo regolarmente. Si noti che non è possibile pubblicare il subgraph sulla rete se la sincronizzazione non è riuscita. Questo di solito è dovuto alla presenza di bug nel subgraph - i log vi diranno dove si trovano questi problemi!

Developers might want to update their subgraph, for a variety of reasons. When this is the case, you can deploy a new version of your subgraph to the Studio using the CLI (it will only be private at this point) and if you are happy with it, you can publish this new deployment to Graph Explorer. This will create a new version of your subgraph that curators can start signaling on and Indexers will be able to index this new version.

Up until recently, developers were forced to deploy and publish a new version of their subgraph to the Explorer to update the metadata of their subgraphs. Now, developers can update the metadata of their subgraphs without having to publish a new version. Developers can update their subgraph details in the Studio (under the profile picture, name, description, etc) by checking an option called Update Details in Graph Explorer. If this is checked, an on-chain transaction will be generated that updates subgraph details in the Explorer without having to publish a new version with a new deployment.

Si noti che la pubblicazione di una nuova versione di un subgraph nella rete comporta dei costi. Oltre alle commissioni di transazione, gli sviluppatori devono anche finanziare una parte della tassa di curation sul segnale di auto-migrazione. Non è possibile pubblicare una nuova versione del proprio subgraph se i curator non l'hanno segnalata. Per ulteriori informazioni sui rischi della curation, si legga qui.

Whenever you deploy a new subgraph version in Subgraph Studio, the previous version will be archived. Archived versions won't be indexed/synced and therefore cannot be queried. You can unarchive an archived version of your subgraph in the Studio UI. Please note that previous versions of non-published subgraphs deployed to the Studio will be automatically archived.