Panduan Memulai Cepat Polkadot
Panduan Memulai Cepat Polkadot
Dalam panduan memulai cepat ini, kita akan memulai dengan proyek pemula Substrat/Polkadot sederhana dan kemudian menyelesaikannya dengan mengindeks beberapa data nyata yang sebenarnya. Ini adalah dasar yang sangat baik untuk memulai ketika mengembangkan Proyek Subkueri Substrat/Polkadot Anda sendiri.
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 pemula standar untuk mulai mengindeks semua transfer dari Polkadot, hanya membutuhkan waktu 10-15 menit
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 ke bawah garis.
Anda kemudian dapat menjalankan bantuan untuk melihat perintah dan penggunaan yang tersedia yang disediakan oleh CLI:
bantuan subql
Inisialisasi Proyek Pemula SubQuery
Di dalam direktori tempat Anda ingin membuat proyek SubQuery, cukup jalankan perintah berikut untuk memulai.
subql init
Anda akan ditanyai pertanyaan tertentu saat proyek SubQuery diinisialisasi:
- Nama Proyek: Nama untuk proyek SubQuery Anda
- Jaringan: Jaringan blockchain yang akan diindeks oleh proyek SubQuery ini. Gunakan tombol panah untuk memilih dari opsi yang tersedia. Untuk panduan ini, kami akan menggunakan "Substrat"
- Jaringan: Jaringan blockchain yang akan diindeks oleh proyek SubQuery ini. Gunakan tombol panah untuk memilih dari opsi yang tersedia. Untuk panduan ini, kami akan menggunakan "Polkadot"
- Template: Pilih template proyek SubQuery yang akan memberikan titik awal untuk memulai pengembangan. Sebaiknya pilih proyek "subql-starter".
- Titik akhir RPC: Berikan URL HTTPS ke titik akhir RPC yang sedang berjalan yang akan digunakan secara default untuk proyek ini. Anda dapat dengan cepat mengakses titik akhir publik untuk jaringan Polkadot yang berbeda atau bahkan membuat simpul khusus pribadi Anda sendiri menggunakan OnFinality atau cukup gunakan titik akhir Polkadot default. Node RPC ini harus berupa node arsip (memiliki status rantai penuh). Untuk panduan ini kami akan menggunakan nilai default "https://polkadot.api.onfinality.io"
- Repositori Git: Berikan URL Git ke repo tempat proyek SubQuery ini akan dihosting (ketika dihosting di SubQuery Explorer) atau terima default yang disediakan.
- Penulis: Masukkan pemilik proyek SubQuery ini di sini (mis. nama Anda!) atau terima default yang disediakan.
- Deskripsi: Berikan paragraf singkat tentang proyek Anda yang menjelaskan data apa yang dikandungnya dan apa yang dapat dilakukan pengguna dengannya atau menerima default yang disediakan.
- Versi: Masukkan nomor versi khusus atau gunakan default (
1.0.0) - Lisensi: Berikan lisensi perangkat lunak untuk proyek ini atau terima default (
Apache-)
Setelah proses inisialisasi selesai, Anda akan melihat bahwa folder dengan nama proyek Anda telah dibuat di dalam direktori. Isi direktori ini harus sama 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
Pada paket starter yang baru saja diinisialisasi, telah disediakan konfigurasi standar. 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:
type Transfer @entity {
id: ID! # id bidang selalu diperlukan dan harus terlihat seperti ini
amount: BigInt # Jumlah yang ditransfer
blockNumber: BigInt # Ketinggian blok transfer
from: Account! # Dari akun mana transfer dilakukan
to: Account! # Rekening yang ditransfer ke
}
Penting: Saat Anda membuat perubahan apa pun pada file skema, pastikan Anda membuat ulang direktori tipe Anda.
Anda akan menemukan model yang dihasilkan di /src/types/models directory. 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.
File manifes telah diatur dengan benar, tetapi kita perlu mengubah penangan kita. Ingat kami berencana untuk mengindeks semua transfer Polkadot, sebagai hasilnya, kami perlu memperbarui bagian sumber data untuk membaca yang berikut ini:
dataSources:
- kind: substrate/Runtime
startBlock: 1
mapping:
file: ./dist/index.js
handlers:
- handler: handleEvent
kind: substrate/EventHandler
filter:
module: balances
method: Transfer
Ini berarti kita akan menjalankan fungsi pemetaan handleEvent setiap kali ada peristiwa balances.Transfer.
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 tiga fungsi yang diekspor, handleBlock, handleEvent, dan handleCall. Anda dapat menghapus fungsi handleBlock dan handleCall, kita hanya berurusan dengan fungsi handleEvent.
Fungsi handleEvent menerima data peristiwa setiap kali peristiwa cocok dengan filter yang kami tentukan sebelumnya di project.yaml kami. Kita akan memperbaruinya untuk memproses semua balances.Transfer event dan menyimpannya ke entitas GraphQL yang kita buat sebelumnya.
Anda dapat memperbarui fungsi handleEvent sebagai berikut (perhatikan impor tambahan):
import { SubstrateEvent } from "@subql/types";
import { Transfer } from "../types";
import { Balance } from "@polkadot/types/interfaces";
export async function handleTransfer(event: SubstrateEvent): Promise<void> {
// Dapatkan data dari event
// Peristiwa balances.transfer memiliki muatan berikut \[from, to, value\]
// logger.info(JSON.stringify(event));
const from = event.event.data[0];
const to = event.event.data[1];
const amount = event.event.data[2];
// Buat entitas transfer baru
const transfer = new Transfer(
`${event.block.block.header.number.toNumber()}-${event.idx}`
);
transfer.blockNumber = event.block.block.header.number.toBigInt();
transfer.from = from.toString();
transfer.to = to.toString();
transfer.amount = (amount as Balance).toBigInt();
await transfer.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, and Postgres) untuk pertama kalinya tetapi segera Anda akan melihat node SubQuery yang sedang berjalan.
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, coba kueri berikut untuk memahami cara kerjanya atau pelajari lebih lanjut tentang bahasa Kueri GraphQL.
{
query {
transfers(first: 10, orderBy: AMOUNT_DESC) {
nodes {
id
amount
blockNumber
from
to
}
}
}
}
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 transfer data.
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.