Déploiement en utilisant Subgraph Studio

Reading time: 5 min

Apprenez à déployer votre subgraph sur Subgraph Studio.

Dans Subgraph Studio, vous pouvez faire ce qui suit:

• Voir une liste des subgraphs que vous avez créés
• Gérer, voir les détails et visualiser l'état d'un subgraph spécifique
• Créez et gérez vos clés API pour des subgraphs spécifiques
• Limitez vos clés API à des domaines spécifiques et autorisez uniquement certains Indexers à les utiliser pour effectuer des requêtes
• Créer votre subgraph
• Déployer votre subgraph en utilisant The Graph CLI
• Tester votre subgraph dans l'environnement de test
• Intégrer votre subgraph en staging en utilisant l'URL de requête du développement
• Publier votre subgraph sur The Graph Network
• Gérer votre facturation

Avant de déployer, vous devez installer The Graph CLI.

Vous devez avoir Node.js et un gestionnaire de packages de votre choix (npm, yarn ou pnpm) installés pour utiliser The Graph CLI. Vérifiez la version la plus récente de l'outil CLI.

npm install -g @graphprotocol/graph-cli

npm install -g @graphprotocol/graph-cli

1. Ouvrez Subgraph Studio.
2. Connectez votre portefeuille pour vous connecter.
   • Vous pouvez le faire via MetaMask, Coinbase Wallet, WalletConnect ou Safe.
3. Après vous être connecté, votre clé de déploiement unique sera affichée sur la page des détails de votre subgraph.
   • La clé de déploiement vous permet de publier vos subgraphs ou de gérer vos clés d'API et votre facturation. Elle est unique mais peut être régénérée si vous pensez qu'elle a été compromise.

Pour être pris en charge par les Indexeurs sur The Graph Network, les subgraphs doivent :

• Indexer un réseau pris en charge
• Ne doit utiliser aucune des fonctionnalités suivantes :
  • ipfs.cat & ipfs.map
  • Erreurs non fatales
  • La greffe

Une fois que votre subgraph a été créé dans Subgraph Studio, vous pouvez initialiser son code via la CLI en utilisant cette commande :

graph init <SUBGRAPH_SLUG>

Vous pouvez trouver la valeur <SUBGRAPH_SLUG> sur la page des détails de votre subgraph dans Subgraph Studio, voir l'image ci-dessous :

Après avoir exécuté la commande graph init, ilvous sera demandé de saisir l'adresse du contrat, le réseau, et un ABI que vous souhaitez interroger. Cela générera un nouveau dossier sur votre machine locale avec quelques codes de base pour commencer à travailler sur votre subgraph. Vous pouvez ensuite finaliser votre subgraph pour vous assurer qu'il fonctionne comme prévu.

Avant de pouvoir déployer votre subgraph sur Subgraph Studio, vous devez vous connecter à votre compte via la CLI. Pour le faire, vous aurez besoin de votre clé de déploiement, que vous pouvez trouver sur la page des détails de votre subgraph.

Ensuite, utilisez la commande suivante pour vous authentifier depuis la CLI :

graph auth <DEPLOY KEY>

Une fois prêt, vous pouvez déployer votre subgraph sur Subgraph Studio.

Utilisez la commande CLI suivante pour déployer votre subgraph :

graph deploy <SUBGRAPH_SLUG>

Après avoir exécuté cette commande, la CLI demandera une étiquette de version.

• Il est fortement recommandé d'utiliser semver pour le versionnage, comme 0.0.1. Cela dit, vous êtes libre de choisir n'importe quelle chaîne de caractère comme version telle que v1, version1 ou asdf.
• Les étiquettes que vous créez seront visibles dans Graph Explorer et pourront être utilisées par les Curateurs pour décider s'ils veulent signaler sur une version spécifique ou non, donc choisissez-les judicieusement.

Après le déploiement, vous pouvez tester votre subgraph (soit dans Subgraph Studio, soit dans votre propre application, avec l'URL de requête du déploiement), déployer une autre version, mettre à jour les métadonnées, et publier sur Graph Explorer lorsque vous êtes prêt.

Utilisez Subgraph Studio pour vérifier les journaux (logs) sur le tableau de bord et rechercher les erreurs éventuelles de votre subgraph.

Pour publier votre subgraph avec succès, consultez la page publier un subgraph.

Si vous souhaitez mettre à jour votre subgraph, vous pouvez faire ce qui suit :

• Vous pouvez déployer une nouvelle version dans Studio en utilisant la CLI (cette version sera privée à ce stade).
• Une fois que vous en êtes satisfait, vous pouvez publier votre nouveau déploiement sur Graph Explorer.
• Cette action créera une nouvelle version de votre subgraph sur laquelle les Curateurs pourront commencer à signaler et que les Indexeurs pourront indexer.

Vous pouvez également mettre à jour les métadonnées de votre subgraph sans publier une nouvelle version. Vous pouvez mettre à jour les détails de votre subgraph dans Studio (sous la photo de profil, le nom, la description, etc.) en cochant une option appelée Update Details dans Graph Explorer. Si cette option est cochée, une transaction sera générée sur la blockchain (on-chain) pour mettre à jour les détails du subgraph dans Explorer sans avoir à publier une nouvelle version avec un nouveau déploiement.

Chaque fois que vous déployez une nouvelle version de subgraph dans Subgraph Studio, la version précédente sera archivée. Les versions archivées ne seront pas indexées/synchronisées et ne pourront donc pas être interrogées. Vous pouvez désarchiver une version de votre subgraph dans Subgraph Studio.