Docs
⌘ K

2 minutes

Dev Container Substreams

Développez votre premier projet avec Substreams Dev Container.

C’est quoi un Dev Container?

C’est un outil qui vous aide à construire votre premier projet. Vous pouvez l’utiliser à distance via les codespaces Github ou localement en clonant la repo de départ de substreams⁠.

Dans le Dev Container, la commande substreams init met en place un projet Substreams généré par le code, ce qui vous permet de construire facilement un subgraph ou une solution basée sur SQL pour le traitement des données.

Prérequis

  • S’assurer que Docker et VS Code sont à jour.

Dans le Dev Container, vous pouvez soit construire ou importer votre propre substreams.yaml et associer des modules dans le chemin minimal, soit opter pour les chemins Substreams générés automatiquement. Ensuite, lorsque vous exécutez le Substreams Build, il génère les fichiers Protobuf.

Options

  • Minimal : Vous démarre avec le bloc brut .proto et nécessite du développement. Ce chemin est destiné aux utilisateurs expérimentés.
  • Non-Minimal : Extrait les données filtrées en utilisant les caches spécifiques au réseau et les Protobufs provenant des modules de base correspondants (maintenus par l’équipe StreamingFast). Ce chemin génère un Substreams fonctionnel dès sa sortie de la boîte.

Pour partager votre travail avec la communauté, publiez votre .spkg sur Substreams registry⁠ en utilisant :

  • substreams registry login
  • substreams registry publish

Note : Si vous rencontrez des problèmes dans le Dev Container, utilisez la commande help pour accéder aux outils de dépannage.

Construire un sink pour votre projet

Vous pouvez configurer votre projet pour qu’il interroge des données soit par l’intermédiaire d’un subgraph, soit directement à partir d’une base de données SQL :

  • Subgraph : Exécutez substreams codegen subgraph. Cela génère un projet avec un fichier de base schema.graphql et mappings.ts. Vous pouvez les personnaliser pour définir des entités basées sur les données extraites par Substreams. Pour plus de configurations, voir Documentation Subgraph sink⁠.
  • SQL : Exécutez substreams codegen sql pour les requêtes basées sur SQL. Pour plus d’informations sur la configuration d’un sink SQL, consultez la documentation SQL⁠.

Options de déploiement

Pour déployer un subgraph, vous pouvez soit exécuter le graph-node localement en utilisant la commande deploy-local, soit le déployer dans Subgraph Studio en utilisant la commande deploy qui se trouve dans le fichier package.json.

Erreurs courantes

  • Lors d’une exécution locale, assurez-vous de vérifier que tous les conteneurs Docker sont sains en lançant la commande dev-status.
  • Si vous avez mis le mauvais bloc de départ lors de la génération de votre projet, naviguez jusqu’à substreams.yaml pour changer le numéro de bloc, puis relancez substreams build.