Terra Быстрый Старт
Terra Быстрый Старт
В этом кратком руководстве мы начнем с простого начального проекта Terra, а затем закончим индексированием актуальных реальных данных. Это отличная основа для начала разработки собственного проекта SubQuery.
Если вам нужны руководства для Substrate/Polkadot, вы можете прочитать краткое руководство по использованию Substrate/Polkadot.
В конце этого руководства у вас будет рабочий проект SubQuery, запущенный на узле SubQuery с конечной точкой GraphQL, из которой вы можете запрашивать данные.
Если вы еще этого не сделали, мы предлагаем вам ознакомиться с терминологией , используемой в SubQuery.
Целью этого краткого руководства является адаптация стандартного начального проекта для начала индексации всех переводов из Terra, это займет всего 10-15 минут
Подготовка
Локальная среда разработки
- Node: современная (например, LTS-версия) установка Node.
- Docker: в этом руководстве будет использоваться Docker
Установите SubQuery CLI
Установите SubQuery CLI глобально на свой терминал с помощью NPM:
# NPM
npm install -g @subql/cli
Обратите внимание, что мы НЕ рекомендуем использовать yarn global для установки @subql/cli из-за плохого управления зависимостями, что может привести к ошибке в дальнейшем.
Затем вы можете запустить справку, чтобы увидеть доступные команды и варианты применения, предоставляемые CLI
помощь subql
Инициализируем Начальный Проект SubQuery
Внутри каталога, в котором вы хотите создать проект SubQuery, для начала просто выполните следующую команду:
subql init
По мере инициализации проекта SubQuery вам будут заданы определенные вопросы:
- Project Name: A name for your SubQuery project
- Network Family: Семейство сетей блокчейнов уровня 1, для индексирования которого будет разработан этот проект SubQuery, используйте клавиши со стрелками на клавиатуре, чтобы выбрать один из вариантов, в этом руководстве мы будем использовать "Terra"
- Network: Конкретная сеть, для индексации которой будет разработан этот проект SubQuery, используйте клавиши со стрелками на клавиатуре, чтобы выбрать один из вариантов, в этом руководстве мы будем использовать "Terra"
- Template: Выберите шаблон проекта SubQuery, который послужит отправной точкой для начала разработки. Мы предлагаем выбрать "Стартовый проект"
- Git repository (Опционально): Укажите URL-адрес Git для репозитория, в котором будет размещен этот проект SubQuery (при размещении в SubQuery Explorer)
- RPC endpoint (Обязательно): Укажите URL-адрес HTTPS для работающей конечной точки RPC, которая будет использоваться по умолчанию для этого проекта. Этот узел RPC должен быть архивным узлом (иметь состояние полной цепочки). В этом руководстве мы будем использовать значение по умолчанию "https://terra-columbus-5.beta.api.onfinality.io"
- Authors (Обязательно): Введите здесь владельца этого проекта SubQuery (например, ваше имя!)
- Description (Опционально): Вы можете предоставить короткий абзац о своем проекте, описывающий, какие данные он содержит и что пользователи могут с ним делать
- Version (Обязательно): Введите собственный номер версии или используйте версию по умолчанию (
1.0.0) - License (Обязательно): Предоставьте лицензию на программное обеспечение для этого проекта или примите лицензию по умолчанию (
Apache-2.0)
После завершения процесса инициализации вы должны увидеть, что внутри каталога создана папка с названием вашего проекта. Содержимое этого каталога должно совпадать с тем, что указано в Структуре каталогов.
Наконец, в каталоге проекта выполните следующую команду, чтобы установить зависимости нового проекта.
::: code-tabs @tab:active yarn shell cd PROJECT_NAME yarn install
Внесение изменений в ваш проект
В стартовом пакете, который вы только что инициализировали, мы предоставили стандартную конфигурацию для вашего нового проекта. В основном вы будете работать со следующими файлами:
- Схема GraphQL в
schema.graphql - Манифест проекта в
project.yaml - Функции сопоставления в каталоге src / mappings /
Целью этого краткого руководства является адаптация стандартного начального проекта для индексации всех переводов из смарт-контракта bLuna.
Обновление файла схемы GraphQL
Файл schema.graphql определяет различные схемы GraphQL. Из-за того, как работает язык запросов GraphQL, файл схемы по существу диктует форму ваших данных из SubQuery. Это отличное место для начала, потому что оно позволяет заранее определить конечную цель.
Мы собираемся обновить файл schema.graphql, чтобы он читался следующим образом
type Transfer @entity {
id: ID! # Поле id всегда обязательно и должно выглядеть так
txHash: String!
blockHeight: BigInt # Высота блока передачи
sender: String! # Счет, с которого осуществляются переводы
recipient: String! # Счет, на который осуществляются переводы
amount: String! Сумма, которая передается
Важно: когда вы вносите какие-либо изменения в файл schema, убедитесь, что вы заново создали каталог типов. Сделайте это сейчас.
Вы найдете сгенерированные модели в каталоге /src/types/models. Для получения дополнительной информации о файле schema.graphql ознакомьтесь с нашей документацией в разделе Build/GraphQL Schema
Обновление файла Манифеста Проекта
Файл манифеста проекта (project.yaml) можно рассматривать как точку входа в ваш проект, и он определяет большинство деталей того, как SubQuery будет индексировать и преобразовывать данные цепочки.
Мы не будем вносить много изменений в файл манифеста, поскольку он уже настроен правильно, но нам нужно изменить наши обработчики. Помните, что мы планируем индексировать все события передачи Terra, поэтому нам нужно обновить раздел источники данных, чтобы прочитать следующее.
dataSources:
- kind: terra/Runtime
startBlock: 4724001 # Колумб-5 Стартует на этой высоте
mapping:
file: ./dist/index.js
handlers:
- handler: handleEvent
kind: terra/EventHandler
# это будет срабатывать для всех событий, которые соответствуют следующему условию фильтра смарт-контракта
filter:
type: transfer
messageFilter:
type: /terra.wasm.v1beta1.MsgExecuteContract
values:
# Мы подписываемся на смарт-контракт bLuna (например, только перенос событий из этого контракта)
contract: terra1j66jatn3k50hjtg2xemnjm8s7y8dws9xqa5y8w
Это означает, что мы будем запускать функцию сопоставления handleEvent каждый раз, когда происходит событие transfer от смарт-контракта bLuna.
Дополнительные сведения о файле манифеста проекта (project.yaml) см. в нашей документации в разделе Build/Manifest File
Добавление функции сопоставления
Функции сопоставления определяют, как данные цепочки преобразуются в оптимизированные сущности GraphQL, которые мы ранее определили в файле schema.graphql.
Перейдите к функции сопоставления по умолчанию в каталоге src/mappings. Вы увидите три экспортированные функции: handleBlock, handleEvent и handleCall. Вы можете удалить обе функции handleBlock и handleCall, мы имеем дело только с функцией handleEvent.
Функция handleEvent получала данные о событиях всякий раз, когда событие соответствовало фильтрам, которые мы указали ранее в нашем project.yaml. Мы собираемся обновить его, чтобы он обрабатывал все события transfer и сохранял их в объектах GraphQL, которые мы создали ранее.
Вы можете обновить функцию handleEvent следующим образом (обратите внимание на дополнительный импорт):
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> {
// Печать отладочных данных из события
// logger.info(JSON.stringify(event));
// Создайте новый объект передачи с уникальным идентификатором
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();
}
Что мы здесь делаем? Получаем SubstrateEvent, который включает данные о передаче полезной нагрузки. Мы извлекаем эти данные, а затем создаем экземпляр нового объекта Transfer, который мы определили ранее в файле schema.graphql. Мы добавляем дополнительную информацию, а затем используем функцию .save() для сохранения нового объекта (SubQuery автоматически сохранит его в базе данных).
Для получения дополнительной информации о функциях сопоставления ознакомьтесь с нашей документацией в разделе Build/Mappings
Сборка проекта
Чтобы запустить ваш новый проект SubQuery, нам сначала нужно собрать нашу работу. Запустите команду сборки из корневого каталога проекта.
::: code-tabs @tab:active yarn shell yarn build @tab npm shell npm run-script build :::
Важно: всякий раз, когда вы вносите изменения в свои функции сопоставления, вам нужно будет пересобрать свой проект.
Запуск и запрос вашего проекта
Запустите свой проект с помощью Docker
Всякий раз, когда вы создаете новый проект подзапроса, вы всегда должны запускать его локально на своем компьютере, чтобы сначала протестировать его. Проще всего это сделать с помощью Docker.
Вся конфигурация, управляющая запуском узла SubQuery, определяется в этом файле docker-compose.yml. Для нового проекта, который был только что инициализирован, вам не нужно ничего здесь менять, но вы можете прочитать больше о файле и настройках в нашем разделе Запуск проекта
В каталоге проекта выполните следующую команду:
::: code-tabs @tab:active yarn shell yarn start:docker @tab npm shell npm run-script start:docker :::
Загрузка необходимых пакетов (@subql/node, @subql/query и Postgres) в первый раз может занять некоторое время, но вскоре вы увидите работающий узел SubQuery. Проявите терпение.
Отправьте запрос своему проекту
Откройте браузер и перейдите по адресу http://localhost:3000.
Вы должны увидеть, что в проводнике отображается игровая площадка GraphQL и схемы, которые готовы к запросу. В правом верхнем углу игровой площадки вы найдете кнопку _ Документы _, которая откроет розыгрыш документации. Эта документация создается автоматически и помогает вам найти, какие сущности и методы вы можете запрашивать.
Для нового начального проекта SubQuery вы можете попробовать следующий запрос, чтобы понять, как он работает, или узнать больше о языке запросов GraphQL.
{
query {
transfers(first: 10, orderBy: ID_DESC) {
nodes {
id
txHash
amount
blockHeight
sender
recipient
}
}
}
}
Опубликуйте свой проект SubQuery
SubQuery предоставляет бесплатный управляемый сервис, на котором вы можете развернуть свой новый проект. Вы можете развернуть его в SubQuery Managed Service и запросить его с помощью нашего Проводника.
Ознакомьтесь с руководством по публикации нового проекта в SubQuery Projects
Следующие шаги
Поздравляем, теперь у вас есть локально работающий проект SubQuery, который принимает запросы API GraphQL для передачи данных от bLuna.
Теперь, когда вы поняли, как создать базовый проект SubQuery, возникает вопрос: что дальше? Если вы чувствуете себя уверенно, вы можете перейти к более подробному изучению трех ключевых файлов. Файл манифеста, схема GraphQL и файл сопоставлений в разделе "Сборка" этой документации.
В противном случае перейдите в раздел Академия, где вы найдете более подробные семинары, учебные пособия и примеры проектов. Там мы рассмотрим более продвинутые модификации и более глубоко погрузимся в выполнение проектов SubQuery, запуская легкодоступные проекты и проекты с открытым исходным кодом.
Наконец, если вы ищете другие способы запуска и публикации своего проекта, наш Run & Publish Раздел содержит подробную информацию обо всех способах запуска вашего проекта SubQuery и других расширенных функциях агрегации и подписки GraphQL.