Bắt đầu nhanh với Terra
Bắt đầu nhanh với Terra
Trong hướng dẫn bắt đầu nhanh này, chúng ta sẽ bắt đầu với một dự án Terra khởi đầu đơn giản và sau đó kết thúc bằng cách lập chỉ mục một số dữ liệu thực tế. Đây là cơ sở tuyệt vời để bắt đầu khi phát triển Dự án SubQuery của riêng bạn.
Nếu bạn đang tìm kiếm hướng dẫn cho Substrate/Polkadot, bạn có thể đọc Hướng dẫn bắt đầu nhanh cụ thể dành cho Substrate/Polkadot.
Sau khi hoàn thành xong hướng dẫn này, bạn sẽ có một dự án SubQuery đang hoạt động chạy trên nút SubQuery với điểm cuối GraphQL mà có thể truy vấn dữ liệu từ đó.
Nếu bạn chưa sẵn sàng, chúng tôi khuyên bạn nên tự làm quen với thuật ngữ được sử dụng trong SubQuery.
Mục tiêu của hướng dẫn bắt đầu nhanh này là điều chỉnh dự án khởi đầu tiêu chuẩn để bắt đầu lập chỉ mục tất cả các giao dịch từ Terra, chỉ mất 10-15 phút
Chuẩn bị
Môi trường phát triển địa phương
- Node: Cài đặt một phiên bản mới nhất của Node (ví dụ: phiên bản LTS).
- Docker: Hướng dẫn này sẽ yêu cầu sử dụng Docker
Cài đặt CLI SubQuery
Cài đặt SubQuery CLI tổng thể trên terminal của bạn bằng cách sử dụng NPM:
# NPM
npm install -g @subql/cli
Xin lưu ý rằng chúng tôi KHÔNG khuyến khích sử dụng yarn global để cài đặt @subql/cli do khả năng quản lý dependency kém có thể dẫn đến lỗi.
Sau khi cài đặt xong, bạn có thể chạy lệnh help để xem các lệnh có sẵn của CLI và cách sử dụng chúng
subql help
Khởi tạo Dự án khởi đầu SubQuery
Bên trong thư mục mà bạn muốn tạo một dự án SubQuery, hãy chạy lệnh sau để bắt đầu.
subql init
Bạn sẽ được hỏi một số câu hỏi khi dự án SubQuery được khởi tạo:
- Project Name: Tên dự án SubQuery của bạn
- Network Family: Mạng blockchain layer-1 mà dự án Subquery sẽ được phát triển để lập chỉ mục, dùng dấu mũi tên để di chuyển giữa các lựa chọn, trong bài hướng dẫn này, chúng ta sẽ sử dụng "Terra"
- Network: Mạng cụ thể mà dự án SubQuery này sẽ được phát triển để lập chỉ mục, dùng phím mũi tên để di chuyển giữa các lựa chọn, trong bài hướng dẫn này chúng ta sẽ dùng "Terra"
- Template: Chọn mẫu dự án SubQuery để bắt đầu phát triển, chúng tôi gợi ý bạn chọn "Starter project"
- Git repository (Tùy chọn): Cung cấp URL Git cho kho lưu trữ dự án SubQuery này (khi được lưu trữ trong SubQuery Explorer)
- RPC endpoint (Bắt buộc): Cung cấp URL HTTPS cho điểm cuối RPC đang chạy, sẽ được sử dụng mặc định cho dự án này. Nút RPC này phải là một nút lưu trữ (có trạng thái chuỗi đầy đủ). Đối với hướng dẫn này, chúng tôi sẽ sử dụng giá trị mặc định "https://terra-columbus-5.beta.api.onfinality.io"
- Authors (Bắt buộc): Nhập chủ sở hữu của dự án SubQuery này tại đây (ví dụ: tên bạn!)
- Description (Tùy chọn): Bạn có thể cung cấp một đoạn giới thiệu ngắn về dự án của mình, mô tả dự án chứa dữ liệu gì và người dùng có thể làm gì với dự án
- Version (Bắt buộc): Nhập số phiên bản tùy chỉnh hoặc sử dụng giá trị mặc định (
1.0.0) - License (Bắt buộc): Cung cấp giấy phép phần mềm cho dự án này hoặc chấp nhận mặc định (
Apache-2.0)
Sau khi quá trình khởi tạo hoàn tất, bạn sẽ thấy một thư mục có tên dự án của bạn đã được tạo bên trong thư mục. Nội dung của thư mục này phải giống với nội dung được liệt kê trong Cấu trúc thư mục.
Cuối cùng, trong thư mục dự án, chạy lệnh sau để cài đặt các phụ thuộc của dự án mới.
::: code-tabs @tab:active yarn shell cd PROJECT_NAME yarn install
Thực hiện các thay đổi trên dự án của bạn
Trong gói khởi đầu mà bạn vừa khởi tạo, chúng tôi đã cung cấp cấu hình tiêu chuẩn cho dự án của bạn. Bạn sẽ làm việc chủ yếu trên các tệp sau:
- Lược đồ GraphQL ở
schema.graphql - Tệp Kê khai dự án ở
project.yaml - Các chức năng ánh xạ trong thư mục
src/mappings/
Mục tiêu của hướng dẫn bắt đầu nhanh này là điều chỉnh dự án khởi đầu tiêu chuẩn để bắt đầu lập chỉ mục tất cả các giao dịch từ hợp đồng thông minh bLuna.
Cập nhật tệp lược đồ GraphQL của bạn
Tệp schema.graphql xác định các lược đồ GraphQL khác nhau. Do cách hoạt động của ngôn ngữ truy vấn GraphQL, về cơ bản tệp lược đồ chỉ ra hình dạng dữ liệu của bạn từ SubQuery. Đây là một nơi tuyệt vời để bắt đầu vì nó cho phép bạn xác định trước mục tiêu cuối cùng của mình.
Chúng ta sẽ cập nhật tệp schema.graphql để trông như sau
type Transfer @entity {
id: ID! # trường id luôn là bắt buộc và phải trông như thế này
txHash: String!
blockHeight: BigInt # Chiều cao khối của giao dịch
sender: String! # Tài khoản chuyển tiền được thực hiện từ
recipient: String! # Tài khoản chuyển tiền được thực hiện từ
amount: String! # Số tiền được chuyển
}
Quan trọng: Khi bạn thực hiện bất kỳ thay đổi nào đối với tệp lược đồ, hãy đảm bảo rằng bạn tạo lại thư mục types của mình. Thực hiện ngay bây giờ.
Bạn sẽ tìm thấy các model đã tạo trong thư mục /src/types/models. Để biết thêm thông tin về tệp schema.graphql, hãy xem tài liệu của chúng tôi trong Lược đồ Build/GraphQL
Cập nhật tệp kê khai dự án
Tệp Project Manifest (project.yaml) có thể được xem là điểm vào dự án của bạn và nó xác định hầu hết các thông tin chi tiết về cách SubQuery sẽ lập chỉ mục và chuyển đổi dữ liệu chuỗi.
Chúng tôi sẽ không thực hiện nhiều thay đổi đối với tệp kê khai vì tệp đã được thiết lập đúng cách, nhưng chúng tôi cần thay đổi trình xử lý của mình. Hãy nhớ rằng chúng tôi đang lên kế hoạch lập chỉ mục tất cả các giao dịch Terra, do đó, chúng tôi cần cập nhật phần datasources để trông như sau.
dataSources:
- kind: terra/Runtime
startBlock: 4724001 # Colombus-5 Starts at this height
mapping:
file: ./dist/index.js
handlers:
- handler: handleEvent
kind: terra/EventHandler
# this will trigger on all events that match the following smart contract filter condition
filter:
type: transfer
messageFilter:
type: /terra.wasm.v1beta1.MsgExecuteContract
values:
# We are subscribing to the bLuna smart contract (e.g. only transfer events from this contract)
contract: terra1j66jatn3k50hjtg2xemnjm8s7y8dws9xqa5y8w
Điều này có nghĩa là chúng ta sẽ chạy một hàm ánh xạ handleEvent mỗi khi có sự kiện transfer từ hợp đồng thông minh bLuna.
Để biết thêm thông tin về tệp Project Manifest (project.yaml), hãy xem tài liệu của chúng tôi trong Build/Manifest File
Thêm một hàm Ánh xạ
Các hàm ánh xạ xác định cách dữ liệu chuỗi được chuyển đổi thành các thực thể GraphQL được tối ưu hóa mà chúng ta đã xác định trước đó trong tệp schema.graphql.
Điều hướng đến hàm ánh xạ mặc định trong thư mục src/mappings . Bạn sẽ thấy ba hàm được xuất, handleBlock, handleEvent và handleCall. Bạn có thể xóa cả hai hàm handleBlock và handleCall, chúng tôi chỉ sử dụng hàm handleEvent.
Hàm handleEvent nhận dữ liệu sự kiện bất cứ khi nào sự kiện khớp với các bộ lọc mà chúng tôi chỉ định trước đó trong project.yaml của chúng tôi. Chúng tôi sẽ cập nhật nó để xử lý tất cả các sự kiện transfer và lưu chúng vào các thực thể GraphQL mà chúng tôi đã tạo trước đó.
Bạn có thể cập nhật hàm handleEvent như sau (lưu ý các import bổ sung):
import { TerraEvent } from "@subql/types-terra";
import { Transfer } from "../types";
import { MsgExecuteContract } from "@terra-money/terra.js";
export async function handleEvent(
event: TerraEvent<MsgExecuteContract>
): Promise<void> {
// Print debugging data from the event
// logger.info(JSON.stringify(event));
// Create the new transfer entity with a unique ID
const transfer = new Transfer(
`${event.tx.tx.txhash}-${event.msg.idx}-${event.idx}`
);
transfer.blockHeight = BigInt(event.block.block.block.header.height);
transfer.txHash = event.tx.tx.txhash;
for (const attr of event.event.attributes) {
switch (attr.key) {
case "sender":
transfer.sender = attr.value;
break;
case "recipient":
transfer.recipient = attr.value;
break;
case "amount":
transfer.amount = attr.value;
break;
default:
}
}
await transfer.save();
}
Hàm này đang nhận SubstrateEvent bao gồm dữ liệu truyền tải trên trọng tải. Chúng tôi trích xuất dữ liệu này và sau đó khởi tạo thực thể Transfer mới mà chúng tôi đã xác định trước đó trong tệp schema.graphql. Chúng tôi thêm thông tin bổ sung và sau đó sử dụng hàm .save() để lưu thực thể mới (SubQuery sẽ tự động lưu nó vào cơ sở dữ liệu).
Để biết thêm thông tin về các hàm ánh xạ, hãy xem tài liệu của chúng tôi trong Build/Mappings
Xây dựng dự án
Để chạy Dự án SubQuery mới của bạn trước tiên chúng tôi cần xây dựng công việc của mình. Chạy lệnh xây dựng từ thư mục gốc của dự án.
::: code-tabs @tab:active yarn shell yarn build @tab npm shell npm run-script build :::
Quan trọng: Bất cứ khi nào bạn thực hiện các thay đổi đối với các hàm ánh xạ của mình, bạn sẽ cần phải xây dựng lại dự án của mình
Chạy và truy vấn dự án của bạn
Chạy Dự án của bạn với Docker
Bất cứ khi nào bạn tạo một Dự án SubQuery mới, bạn nên chạy nó cục bộ trên máy tính của mình để kiểm tra nó trước. Cách dễ nhất để làm điều này là sử dụng Docker.
Tất cả cấu hình kiểm soát cách chạy node SubQuery được định nghĩa trong tệp docker-comp.yml. Đối với một dự án mới vừa được khởi tạo, bạn sẽ không cần phải thay đổi bất kỳ điều gì nhưng có thể đọc thêm về tệp và cài đặt trong phần Chạy dự án của chúng tôi
Trong thư mục dự án chạy lệnh sau:
::: code-tabs @tab:active yarn shell yarn start:docker @tab npm shell npm run-script start:docker :::
Có thể mất một chút thời gian để tải xuống các gói cần thiết (@subql/node, @subql/query, và Postgres) cho lần đầu tiên, nhưng bạn sẽ sớm thấy một node SubQuery đang chạy. Hãy kiên nhẫn ở bước này.
Truy vấn dự án của bạn
Mở trình duyệt của bạn và truy cập http://localhost:3000.
Bạn sẽ thấy một sân chơi GraphQL đang hiển thị trong explorer và các lược đồ đã sẵn sàng để truy vấn. Ở trên cùng bên phải của sân chơi, bạn sẽ tìm thấy nút Tài liệu sẽ mở bản vẽ tài liệu. Tài liệu này được tạo tự động và giúp bạn tìm thấy những thực thể và phương pháp nào bạn có thể truy vấn.
Đối với dự án khởi đầu SubQuery mới, bạn có thể thử truy vấn như sau để biết cách hoạt động của nó hoặc tìm hiểu thêm về ngôn ngữ Truy vấn GraphQL.
{
query {
transfers(first: 10, orderBy: ID_DESC) {
nodes {
id
txHash
amount
blockHeight
sender
recipient
}
}
}
}
Xuất bản Dự Án SubQuery của bạn
SubQuery cung cấp dịch vụ quản lý miễn phí nơi bạn có thể triển khai dự án mới của mình. Bạn có thể triển khai nó trên SubQuery Managed Service và truy vấn nó bằng cách sử dụng Explorer của chúng tôi.
Đọc hướng dẫn để xuất bản dự án mới của bạn lên SubQuery Projects
Bước tiếp theo
Xin chúc mừng, bạn hiện có một dự án SubQuery đang chạy cục bộ chấp nhận các yêu cầu API GraphQL để chuyển dữ liệu từ Luna.
Bây giờ bạn đã có cái nhìn sâu sắc về cách xây dựng một dự án SubQuery cơ bản, câu hỏi đặt ra là bắt đầu từ đâu? Nếu bạn cảm thấy tự tin, bạn có thể bắt đầu tìm hiểu thêm về ba tệp chính. Tệp kê khai, lược đồ GraphQL và tệp ánh xạ trong phần Phần Xây dựng của các tài liệu này.
Nếu không, hãy tiếp tục đến Phần Học viện của chúng tôi, nơi có các hội thảo, hướng dẫn và dự án mẫu chuyên sâu hơn. Ở đó, chúng ta sẽ xem xét các sửa đổi nâng cao hơn và chúng ta sẽ đi sâu hơn vào việc chạy các dự án SubQuery bằng cách chạy các dự án nguồn mở và sẵn có.
Cuối cùng, nếu bạn đang tìm kiếm các cách khác để chạy và xuất bản dự án của mình, Chạy & Phần xuất bản cung cấp thông tin chi tiết về tất cả các cách để chạy dự án SubQuery của bạn và các tính năng tổng hợp GraphQL và tính năng theo dõi.