Cosmos Schnellstart
Cosmos Schnellstart
In dieser Schnellstartanleitung beginnen wir mit einem einfachen Cosmos-Starterprojekt im Juno-Netzwerk und schließen dann mit der Indizierung einiger echter Daten ab. Dies ist eine hervorragende Basis, um mit der Entwicklung Ihres eigenen SubQuery-Projekts zu beginnen.
Wenn Sie nach Anleitungen für Substrat/Polkadot suchen, können Sie die Substrat/Polkadot-spezifische Kurzanleitung lesen.
Am Ende dieses Handbuchs haben Sie ein funktionierendes SubQuery-Projekt, das auf einer SubQuery-Node mit einem GraphQL-Endpunkt ausgeführt wird, von dem Sie Daten abfragen können.
Falls noch nicht geschehen, empfehlen wir Ihnen, sich mit der Terminologie vertraut zu machen, die in SubQuery verwendet wird.
Das Ziel dieser Schnellstartanleitung besteht darin, das standardmäßige Starterprojekt so anzupassen, dass mit der Indizierung aller Stimmen zum Terra Developer Fund (der auch zu SubQuery beigetragen hat) von Cosmos begonnen werden kann. Dies sollte nur 10–15 Minuten dauern
Den endgültigen Code dieses Projekts können Sie hier unter https://github.com/jamesbayly/juno-terra-developer-fund-votes einsehen
Vorbereitung
Lokale Entwicklungsumgebung
- Node: Eine moderne (z. B. die LTS-Version) Installation von Node.
- Docker: Für dieses Tutorial wird Docker benötigt
Installieren Sie die SubQuery-CLI
Installieren Sie die SubQuery-CLI mithilfe von NPM global auf Ihrem Terminal:
# NPM
npm install -g @subql/cli
Bitte beachten Sie, dass wir NICHT die Verwendung von yarn global für die Installation von @subql/cli empfehlen, da die Abhängigkeitsverwaltung schlecht ist, was zu einer Fehler auf der ganzen Linie.
Sie können dann help ausführen, um die verfügbaren Befehle und die Nutzung anzuzeigen, die von der CLI bereitgestellt werden
subql help
Initialisieren Sie das SubQuery-Starterprojekt
Cosmos wird noch nicht in der Befehlszeilenschnittstelle von SubQuery (subql) unterstützt, um mit Juno-Clone oder Fork des Starter-Projekts zu beginnen.
Nachdem der Initialisierungsprozess abgeschlossen ist, sollten Sie sehen, dass ein Ordner mit Ihrem Projektnamen im Verzeichnis erstellt wurde. Der Inhalt dieses Verzeichnisses sollte mit dem identisch sein, was in der Verzeichnisstruktur aufgeführt ist.
Führen Sie zuletzt im Projektverzeichnis den folgenden Befehl aus, um die Abhängigkeiten des neuen Projekts zu installieren.
::: code-tabs @tab:active yarn shell cd PROJECT_NAME yarn install
Änderungen an Ihrem Projekt vornehmen
Im Startpaket, das Sie gerade initialisiert haben, haben wir eine Standardkonfiguration für Ihr neues Projekt bereitgestellt. Sie werden hauptsächlich an den folgenden Dateien arbeiten:
- Das GraphQL-Schema in
schema.graphql - Das Projektmanifest in
project.yaml - Die Mapping-Funktionen im Verzeichnis
src/mappings/directory
Das Ziel dieser Schnellstartanleitung ist es, das Standard-Starterprojekt so anzupassen, dass mit der Indizierung aller Übertragungen aus dem bLuna-Smart-Vertrag begonnen werden kann.
Aktualisierung Ihrer GraphQL-Schemadatei
Die Datei schema.graphql definiert die verschiedenen GraphQL-Schemas. Aufgrund der Funktionsweise der GraphQL-Abfragesprache bestimmt die Schemadatei im Wesentlichen die Form Ihrer Daten aus SubQuery. Es ist ein großartiger Ausgangspunkt, da es Ihnen ermöglicht, Ihr Endziel im Voraus zu definieren.
Wir werden die Datei schema.graphql so aktualisieren, dass sie wie folgt lautet, damit wir alle Stimmen für den Terra Developer Fund indizieren können.
type Vote @entity {
id: ID! # id-Feld ist immer erforderlich und muss so aussehen
blockHeight: BigInt!
voter: String! # Die Adresse, die abgestimmt hat
proposalID: BigInt! # Die Angebots-ID
vote: Boolean! # Ob sie für die Unterstützung oder Ablehnung des Vorschlags gestimmt haben
}
Wichtig: Wenn Sie Änderungen an der Schemadatei vornehmen, stellen Sie bitte sicher, dass Sie Ihr Typenverzeichnis neu generieren. Tun Sie dies jetzt.
Sie finden die generierten Modelle im Verzeichnis /src/types/models. Weitere Informationen zur Datei schema.graphql finden Sie in unserer Dokumentation unter Build/GraphQL Schema
Aktualisierung der Projektmanifestdatei
Die Projektmanifestdatei (project.yaml) kann als Einstiegspunkt Ihres Projekts angesehen werden und definiert die meisten Details darüber, wie SubQuery die Chaindaten indiziert und umwandelt.
Wir werden nicht viele Änderungen an der Manifestdatei vornehmen, da sie bereits korrekt eingerichtet wurde, aber wir müssen unsere Handler ändern. Denken Sie daran, dass wir planen, alle Stimmen für den Terra Developer Fund zu indizieren. Das bedeutet, dass wir uns Nachrichten ansehen werden, die den Vertragsaufruf vote verwenden, wir müssen den Abschnitt datasources aktualisieren, um Folgendes zu lesen.
dataSources:
- kind: cosmos/Runtime
startBlock: 3246370 # Der Block, als der erste Vorschlag in diesem Fonds erstellt wurde
Kartierung:
file: "./dist/index.js"
handlers:
- handler: handleTerraDeveloperFund
kind: cosmos/MessageHandler
filter:
type: "/cosmwasm.wasm.v1.MsgExecuteContract"
# Filtern Sie nur nach Nachrichten mit dem Aufruf der Abstimmungsfunktion
contractCall: "vote" # Der Name der aufgerufenen Vertragsfunktion
values: # Dies ist der spezifische Smart Contract, den wir abonnieren
Vertrag:"juno1lgnstas4ruflg0eta394y8epq67s4rzhg5anssz3rc5zwvjmmvcql6qps2"
Das bedeutet, dass wir jedes Mal eine handleTerraDeveloperFund-Zuordnungsfunktion ausführen, wenn eine vote-Nachricht vom intelligenten Vertrag Terra Developer Fund eingeht.
Weitere Informationen zur Projektmanifestdatei (project.yaml) finden Sie in unserer Dokumentation unter Build-/Manifestdatei
Mapping Funktion hinzufügen
Zuordnungsfunktionen definieren, wie Chaindaten in die optimierten GraphQL-Entitäten umgewandelt werden, die wir zuvor in der Datei schema.graphql definiert haben.
Navigieren Sie zur Standardzuordnungsfunktion im Verzeichnis src/mappings. Sie sehen vier exportierte Funktionen, handleBlock, handleEvent, handleMessage und handleTransaction. Da wir es nur mit Nachrichten zu tun haben, können Sie alles außer der Funktion handleMessage löschen.
Die Funktion handleMessage hat Ereignisdaten empfangen, wenn das Ereignis mit den Filtern übereinstimmt, die wir zuvor in unserer project.yaml angegeben haben. Wir werden es aktualisieren, um alle vote-Nachrichten zu verarbeiten und sie in der zuvor erstellten GraphQL-Entität zu speichern.
Sie können die Funktion handleMessage wie folgt aktualisieren (beachten Sie die zusätzlichen Importe und die Umbenennung der Funktion):
import { Vote } from "../types";
import { CosmosMessage } from "@subql/types-cosmos";
export async function handleTerraDeveloperFund(
message: CosmosMessage
): Promise<void> {
// logger.info(JSON.stringify(message));
// Example vote https://www.mintscan.io/juno/txs/EAA2CC113B3EC79AE5C280C04BE851B82414B108273F0D6464A379D7917600A4
const voteRecord = new Vote(`${message.tx.hash}-${message.idx}`);
voteRecord.blockHeight = BigInt(message.block.block.header.height);
voteRecord.voter = message.msg.sender;
voteRecord.proposalID = message.msg.msg.vote.proposal_id;
voteRecord.vote = message.msg.msg.vote.vote === "yes";
await voteRecord.save();
}
Dadurch wird eine CosmosMessage empfangen, die Nachrichtendaten in der Nutzlast enthält. Wir extrahieren diese Daten und instanziieren dann eine neue Entität Vote, die wir zuvor in der Datei schema.graphql definiert haben. Wir fügen zusätzliche Informationen hinzu und verwenden dann die Funktion .save(), um die neue Entität zu speichern (SubQuery speichert diese automatisch in der Datenbank).
Weitere Informationen zu Mapping-Funktionen finden Sie in unserer Dokumentation unter Build/Mappings
Erstellen Sie das Projekt
Um Ihr neues SubQuery-Projekt auszuführen, müssen wir zuerst unsere Arbeit erstellen. Führen Sie den Build-Befehl im Stammverzeichnis des Projekts aus.
::: code-tabs @tab:active yarn shell yarn build @tab npm shell npm run-script build :::
Wichtig: Wenn Sie Änderungen an Ihren Zuordnungsfunktionen vornehmen, müssen Sie Ihr Projekt neu erstellen
Ihr Projekt ausführen und abfragen
Führen Sie Ihr Projekt mit Docker aus
Wann immer Sie ein neues SubQuery-Projekt erstellen, sollten Sie es immer lokal auf Ihrem Computer ausführen, um es zuerst zu testen. Der einfachste Weg, dies zu tun, ist die Verwendung von Docker.
Die gesamte Konfiguration, die steuert, wie ein SubQuery-Node ausgeführt wird, ist in dieser docker-compose.yml-Datei definiert. Für ein neues Projekt, das gerade initialisiert wurde, müssen Sie hier nichts ändern, aber Sie können mehr über die Datei und die Einstellungen in unserem Abschnitt Ein Projekt ausführen lesen
Führen Sie im Projektverzeichnis den folgenden Befehl aus:
::: code-tabs @tab:active yarn shell yarn start:docker @tab npm shell npm run-script start:docker :::
Es kann einige Zeit dauern, die erforderlichen Pakete herunterzuladen (@subql/node,
@subql/query und Postgres) zum ersten Mal, aber bald werden Sie einen laufenden SubQuery-Knoten sehen. Seien Sie hier bitte geduldig.
Fragen Sie Ihr Projekt ab
Öffnen Sie Ihren Browser und gehen Sie zu http://localhost:3000.
Sie sollten sehen, dass im Explorer ein GraphQL-Playground angezeigt wird und die Schemas, die zur Abfrage bereit sind. Oben rechts auf dem Playground finden Sie eine Schaltfläche Dokumente, die eine Dokumentationsverlosung öffnet. Diese Dokumentation wird automatisch generiert und hilft Ihnen zu finden, welche Entitäten und Methoden Sie abfragen können.
Für ein neues SubQuery-Starterprojekt können Sie die folgende Abfrage ausprobieren, um einen Eindruck davon zu bekommen, wie sie funktioniert, oder mehr über die GraphQL-Abfragesprache erfahren.
query {
votes(
first: 5
orderBy: BLOCK_HEIGHT_DESC # filter: {proposalID: {equalTo: "4"}}
) {
nodes {
id
blockHeight
voter
vote
}
}
}
Den endgültigen Code dieses Projekts können Sie hier unter https://github.com/jamesbayly/juno-terra-developer-fund-votes einsehen
Veröffentlichen Sie Ihr SubQuery-Projekt
SubQuery bietet einen kostenlosen verwalteten Dienst, wenn Sie Ihr neues Projekt bereitstellen können. Sie können es in SubQuery-Projekten bereitstellen und mit unserem Explorer abfragen.
Lesen Sie die Anleitung zum Veröffentlichen Ihres neuen Projekts in SubQuery's Managed Service
Weitere Schritte
Herzlichen Glückwunsch, Sie haben jetzt ein lokal ausgeführtes SubQuery-Projekt, das GraphQL-API-Anforderungen für die Übertragung von Daten von bLuna akzeptiert.
Nachdem Sie nun einen Einblick in die Erstellung eines grundlegenden SubQuery-Projekts erhalten haben, stellt sich die Frage, wie es weitergehen soll. Wenn Sie sich sicher fühlen, können Sie mehr über die drei Schlüsseldateien erfahren. Die Manifestdatei, das GraphQL-Schema und die Zuordnungsdatei im Build-Abschnitt dieser Dokumentation.
Fahren Sie andernfalls mit unserem Academy-Bereich fort, wo Sie ausführlichere Workshops, Tutorials und Beispielprojekte finden. Dort sehen wir uns fortgeschrittenere Modifikationen an und tauchen tiefer in die Ausführung von SubQuery-Projekten ein, indem wir leicht verfügbare und Open-Source-Projekte ausführen.
Wenn Sie schließlich nach weiteren Möglichkeiten zum Ausführen und Veröffentlichen Ihres Projekts suchen, ist unser Run & Der Abschnitt „Veröffentlichen“ enthält detaillierte Informationen zu allen Möglichkeiten zum Ausführen Ihres SubQuery-Projekts und zu anderen erweiterten GraphQL-Aggregations- und Abonnementfunktionen.