Déploiement en utilisant Subgraph Studio

Apprenez à déployer votre Subgraph dans Subgraph Studio.

Présentation de Subgraph Studio

Dans Subgraph Studio, vous pouvez faire ce qui suit:

• Afficher la liste des Subgraphs que vous avez créés
• Gérer, afficher 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éez votre Subgraph
• Déployez votre Subgraph à l’aide de Graph CLI
• Testez votre Subgraph dans l’environnement du terrain de jeu
• Intégrez votre Subgraph dans staging à l’aide de l’URL de requête de développement
• Publier votre Subgraph sur le The Graph Network
• Gérer votre facturation

Installer The Graph CLI

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.

Installation avec yarn

1yarn global add @graphprotocol/graph-cli

Installation avec npm

1npm install -g @graphprotocol/graph-cli

Commencer

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 de détails de votre Subgraph.
   • La clé de déploiement vous permet de publier vos Subgraphs ou de gérer vos clés API et la facturation. Elle est unique mais peut être régénérée si vous pensez qu’elle a été compromise.

Comment créer un subgraph dans Subgraph Studio

Compatibilité des subgraphs avec le réseau de The Graph

Pour être pris en charge par les Indexeurs sur The Graph Network, les Subgraph doivent indexer un réseau pris en charge. Pour une liste complète des fonctionnalités supportées et non supportées, consultez le repo Matrice de prise en charge des fonctionnalités⁠.

Initialisez votre Subgraph

Une fois que votre sous-graphe a été créé dans Subgraph Studio, vous pouvez initialiser son code la CLI à l’aide de cette commande :

1graph init <SUBGRAPH_SLUG>

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

Après avoir lancé graph init, il vous sera demandé d’entrer 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 du code de base pour commencer à travailler sur votre Subgraph. Vous pouvez ensuite finaliser votre Subgraph pour vous assurer qu’il fonctionne comme prévu.

Authentification The Graph

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

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

1graph auth <CLE_DE_DEPLOIEMENT>

Déploiement d’un Subgraph

Une fois que vous êtes prêt, vous pouvez déployer votre Subgraph dans Subgraph Studio.

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

1graph 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.

Tester votre Subgraph

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 de 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 du tableau de bord et rechercher les erreurs éventuelles de votre Subgraph.

Publiez votre subgraph

Pour publier votre Subgraph avec succès, consultez publier un Subgraph.

Versionning de votre subgraph avec le CLI

Si vous souhaitez mettre à jour votre Subgraph, vous pouvez procéder comme 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 que les Curateurs pourront commencer à signaler et que les Indexeurs pourront indexer.

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

Archivage automatique des versions de subgraphs

Chaque fois que vous déployez une nouvelle version de Subgraph dans Subgraph Studio, la version précédente est 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 archivée de votre Subgraph dans Subgraph Studio.