Panduan Memulai Cepat Cosmos
Panduan Memulai Cepat Cosmos
Dalam panduan mulai Cepat ini, kita akan memulai dengan proyek awal Cosmos sederhana di Jaringan Juno dan kemudian menyelesaikannya dengan mengindeks beberapa data nyata yang sebenarnya. Ini adalah dasar yang sangat baik untuk memulai ketika mengembangkan Proyek SubQuery Anda sendiri.
Jika Anda mencari panduan untuk Substrat/Polkadot, Anda dapat membaca Panduan memulai cepat khusus Cosmos.
Di akhir panduan ini, Anda akan memiliki proyek SubQuery yang berjalan pada node SubQuery dengan titik akhir GraphQL tempat dimana Anda dapat membuat kueri data.
Jika Anda belum melakukannya, sebaiknya Anda membiasakan diri dengan terminologi yang digunakan di SubQuery.
Tujuan dari panduan memulai cepat ini adalah untuk mengadaptasi proyek awal standar untuk mulai mengindeks semua suara di Terra Developer Fund (yang juga berkontribusi pada SubQuery) dari Cosmos, hanya membutuhkan waktu 10-15 menit
Anda dapat melihat kode akhir proyek ini di https://github.com/jamesbayly/juno-terra-developer-fund-votes
Persiapan
Lingkungan Pengembangan Lokal
Pasang CLI SubQuery
Instal SubQuery CLI secara global di terminal Anda dengan menggunakan NPM:
# NPM
npm install -g @subql/cli
Harap dicatat bahwa kami JANGAN mendorong penggunaan yarn global untuk menginstal @subql/cli karena manajemen ketergantungannya yang buruk yang dapat menyebabkan kesalahan di lini depan.
Anda kemudian dapat menjalankan bantuan untuk melihat perintah dan penggunaan yang tersedia yang disediakan oleh CLI
bantuan subql
Inisialisasi Proyek Pemula SubQuery
Cosmos belum didukung di CLI SubQuery (subql), untuk memulai dengan kloning Juno atau fork proyek pemula.
Setelah proses inisialisasi selesai, Anda akan melihat folder dengan nama proyek Anda telah dibuat di dalam direktori. Isi direktori ini harus identik dengan apa yang tercantum dalam Struktur Direktori.
Terakhir, di bawah direktori proyek, jalankan perintah berikut untuk menginstal dependensi proyek baru.
::: code-tabs @tab:active yarn shell cd PROJECT_NAME yarn install
Membuat Perubahan pada Proyek Anda
Dalam package awal yang baru saja Anda inisialisasi, kami telah menyediakan konfigurasi standar untuk proyek baru Anda. Anda terutama akan mengerjakan file-file berikut:
- Skema GraphQL di
schema.graphql - Manifes Proyek di
project.yaml - Fungsi Pemetaan di direktori
src/mappings/
Tujuan dari panduan memulai cepat ini adalah untuk mengadaptasi proyek awal standar untuk mulai mengindeks semua transfer dari Polkadot.
Memperbarui File Skema GraphQL Anda
schema.graphql file mendefinisikan berbagai skema GraphQL. Karena cara kerja bahasa kueri GraphQL, file skema pada dasarnya menentukan bentuk data Anda dari SubQuery. Ini adalah tempat yang bagus untuk memulai karena memungkinkan Anda untuk menentukan tujuan akhir Anda di depan.
Kami akan memperbarui file schema.graphql agar terbaca sebagai berikut sehingga kami dapat mengindeks semua suara di Terra Developer Fund.
type Vote @entity {
id: ID! # id field selalu diperlukan dan harus terlihat seperti ini
blockHeight: BigInt!
voter: String! # Alamat yang memilih
proposalID: BigInt! # ID proposal
vote: Boolean! # Jika mereka memilih untuk mendukung atau menolak proposal
}
Penting: Saat Anda membuat perubahan apa pun pada file skema, pastikan Anda membuat ulang direktori tipe Anda. Lakukan ini sekarang.
Anda akan menemukan model yang dihasilkan di direktori /src/types/models. Untuk informasi lebih lanjut tentang file schema.graphql, lihat dokumentasi kami di bawah Build/GraphQL Schema
Memperbarui File Manifes Proyek
File Projek Manifest (project.yaml) dapat dilihat sebagai titik masuk proyek Anda dan ini mendefinisikan sebagian besar detail tentang bagaimana SubQuery akan mengindeks dan mengubah data rantai.
Kami tidak akan melakukan banyak perubahan pada file manifes karena sudah diatur dengan benar, tetapi kami perlu mengubah penangan kami. Ingat kami berencana untuk mengindeks semua suara di Terra Developer Fund. Ini berarti bahwa kita akan melihat pesan yang menggunakan panggilan kontrak vote, kita perlu memperbarui bagian sumber data untuk membaca berikut ini.
dataSources:
- kind: cosmos/Runtime
startBlock: 3246370 # The block when the first proposal in this fund was created
mapping:
file: "./dist/index.js"
handlers:
- handler: handleTerraDeveloperFund
kind: cosmos/MessageHandler
filter:
type: "/cosmwasm.wasm.v1.MsgExecuteContract"
# Filter to only messages with the vote function call
contractCall: "vote" # The name of the contract function that was called
values: # This is the specific smart contract that we are subscribing to
contract: "juno1lgnstas4ruflg0eta394y8epq67s4rzhg5anssz3rc5zwvjmmvcql6qps2"
Ini berarti kami akan menjalankan fungsi pemetaan handleTerraDeveloperFund setiap kali ada pesan suara dari kontrak pintar Terra Developer Fund.
Untuk informasi selengkapnya tentang file Project Manifest (project.yaml), lihat dokumentasi kami di Build/Manifest File
Tambahkan Fungsi Pemetaan
Fungsi pemetaan menentukan bagaimana data rantai diubah menjadi entitas GraphQL yang dioptimalkan yang sebelumnya telah kita definisikan dalam file schema.graphql.
Navigasikan ke fungsi pemetaan default di direktori src/mappings. Anda akan melihat empat fungsi yang diekspor, handleBlock, handleEvent, handleMessage, dan handleTransaction. Karena kita hanya berurusan dengan pesan, Anda dapat menghapus semua hal selain fungsi handleMessage.
Fungsi handleLog menerima data peristiwa setiap kali peristiwa cocok dengan filter yang kami tentukan sebelumnya di project.yaml kami. Kami akan memperbaruinya untuk memproses semua persetujuan log transaksi dan menyimpannya ke entitas GraphQL yang kami buat sebelumnya.
Anda dapat memperbarui fungsi handleLog sebagai berikut (perhatikan impor tambahan):
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();
}
Apa yang dilakukan adalah menerima SubstrateEvent yang mencakup transfer data pada payload. Kami mengekstrak data ini dan kemudian membuat instance entitas Transfer baru yang kami definisikan sebelumnya di file schema.graphql. Kami menambahkan informasi tambahan dan kemudian menggunakan fungsi .save() untuk menyimpan entitas baru (SubQuery akan secara otomatis menyimpan ini ke database).
Untuk informasi lebih lanjut tentang fungsi pemetaan, lihat dokumentasi kami di bawah Build/Mappings
Bangun Proyek
Untuk menjalankan Proyek SubQuery baru Anda, pertama-tama kita perlu membangun pekerjaan kita. Jalankan perintah build dari direktori root proyek.
::: code-tabs @tab:active yarn shell yarn build @tab npm shell npm run-script build :::
Penting: Setiap kali Anda membuat perubahan pada fungsi pemetaan, Anda harus membangun kembali proyek Anda
Menjalankan dan Menanyakan Proyek Anda
Jalankan Proyek Anda dengan Docker
Setiap kali Anda membuat Proyek SubQuery baru, Anda harus selalu menjalankannya secara lokal di komputer Anda untuk mengujinya terlebih dahulu. Cara termudah untuk melakukannya adalah dengan menggunakan Docker.
Semua konfigurasi yang mengontrol bagaimana node SubQuery dijalankan didefinisikan dalam file docker-compose.yml ini. Untuk proyek baru yang baru saja diinisialisasi, Anda tidak perlu mengubah apa pun di sini, tetapi Anda dapat membaca lebih lanjut tentang file dan pengaturannya di Jalankan bagian Proyek
Di bawah direktori proyek jalankan perintah berikut:
::: code-tabs @tab:active yarn shell yarn start:docker @tab npm shell npm run-script start:docker :::
Mungkin perlu beberapa saat untuk mengunduh paket yang diperlukan (@subql/node,
@subql/query</7 >, dan Postgres) untuk pertama kalinya tetapi segera Anda akan melihat node SubQuery yang sedang berjalan. Sabar pada proses di sini.
Kueri Proyek Anda
Buka browser Anda dan buka http://localhost:3000.
Anda akan melihat taman bermain GraphQL ditampilkan di explorer dan skema yang siap untuk kueri. Di kanan atas taman bermain, Anda akan menemukan tombol Dokumen yang akan membuka undian dokumentasi. Dokumentasi ini dibuat secara otomatis dan membantu Anda menemukan entitas dan metode apa yang dapat Anda kueri.
Untuk proyek pemula SubQuery baru, Anda dapat mencoba kueri berikut untuk mengetahui cara kerjanya atau pelajari lebih lanjut tentang bahasa Kueri GraphQL.
query {
votes(
first: 5
orderBy: BLOCK_HEIGHT_DESC # filter: {proposalID: {equalTo: "4"}}
) {
nodes {
id
blockHeight
voter
vote
}
}
}
Anda dapat melihat kode akhir proyek ini di https://github.com/jamesbayly/juno-terra-developer-fund-votes
Publikasikan Proyek SubQuery Anda
SubQuery menyediakan layanan terkelola gratis saat Anda dapat menerapkan proyek baru Anda. Anda dapat menerapkannya ke Proyek SubQuery dan menanyakannya menggunakan Explorer kami.
Baca panduan untuk memublikasikan proyek baru Anda ke Proyek SubQuery
Langkah selanjutnya
Selamat, Anda sekarang memiliki proyek SubQuery yang berjalan secara lokal yang menerima permintaan GraphQL API untuk mentransfer data dari bLuna.
Sekarang setelah Anda memiliki wawasan tentang cara membangun proyek SubQuery dasar, pertanyaannya adalah dari mana dari sini? Jika Anda merasa percaya diri, Anda dapat mempelajari lebih lanjut tentang tiga file utama. File manifes, skema GraphQL, dan file pemetaan di bawah bagian Build dari dokumen ini.
Jika tidak, lanjutkan ke bagian Akademi kami di mana terdapat lokakarya, tutorial, dan contoh proyek yang lebih mendalam. Di sana kita akan melihat modifikasi yang lebih canggih, dan kita akan menyelami lebih dalam dalam menjalankan proyek SubQuery dengan menjalankan proyek yang tersedia dan open source.
Terakhir, jika Anda mencari lebih banyak cara untuk menjalankan dan memublikasikan proyek Anda, Jalankan & Bagian Publikasikan memberikan informasi mendetail tentang semua cara untuk menjalankan proyek SubQuery Anda dan fitur agregasi dan langganan GraphQL lanjutan lainnya.