Перейти к основному содержанию

Запуск SubQuery локально

SubQuery TeamОколо 3 мин

Запуск SubQuery локально

В этом руководстве описано, как запустить локальный узел SubQuery на вашей инфраструктуре, который включает в себя как индексатор, так и службу запросов. Не хотите беспокоиться о создании собственной инфраструктуры SubQuery? SubQuery provides a Managed Serviceopen in new window to the community for free. Следуйте нашему руководству по публикации, чтобы узнать, как загрузить свой проект в SubQuery Managed Serviceopen in new window.

Использование Docker

Альтернативным решением является запуск Docker Container, определенного файлом docker-compose.yml. Для нового проекта, который был только что инициализирован, вам не нужно будет ничего менять.

В каталоге проекта выполните следующую команду:

docker-compose pull && docker-compose up

Примечание Для первой загрузки необходимых пакетов ([`@subql/node`](https://www.npmjs.com/package/@subql/node), [`@subql/query`](https://www.npmjs.com/package/@subql/query) и Postgres) может потребоваться некоторое время, но вскоре вы увидите работающий узел SubQuery. :::

Запуск индексатора (subql/node)

Требования:

  • База данных Postgresopen in new window (версия 12 или выше). Пока узел SubQuery индексирует блокчейн, извлеченные данные хранятся во внешнем экземпляре базы данных.

Узел SubQuery - это реализация, которая извлекает данные блокчейна на основе Substrate/Polkadot в соответствии с проектом SubQuery и сохраняет их в базе данных Postgres.

If you are running your project locally using subql-node or subql-node-<network>, make sure you enable the pg_extension btree_gist

You can run the following SQL query:

CREATE EXTENSION IF NOT EXISTS btree_gist;

Установка

# NPM
npm install -g @subql/node

Please note that we **DO NOT** encourage the use of `yarn global` due to its poor dependency management which may lead to an errors down the line. :::

После установки вы можете запустить узел с помощью следующей команды:

subql-node <command>

Key Commands

The following commands will assist you to complete the configuration of a SubQuery node and begin indexing. Чтобы узнать больше, вы всегда можете выполнить команду --help.

Укажите путь к локальному проекту

subql-node -f your-project-path

Connect to database

export DB_USER=postgres
export DB_PASS=postgres
export DB_DATABASE=postgres
export DB_HOST=localhost
export DB_PORT=5432
subql-node -f your-project-path

В зависимости от конфигурации вашей базы данных Postgres (например, другой пароль базы данных), убедитесь также, что индексатор (subql/node) и служба запросов (subql/query) могут установить соединение с ней.

Укажите файл конфигурации

subql-node -c your-project-config.yml

This will point the query node to a manifest file which can be in YAML or JSON format.

Change the block fetching batch size

subql-node -f your-project-path --batch-size 200

Result:
[IndexerManager] fetch block [203, 402]
[IndexerManager] fetch block [403, 602]

Когда индексатор впервые индексирует цепочку, выборка отдельных блоков значительно снижает производительность. Увеличение размера пакета для регулировки количества извлекаемых блоков уменьшит общее время обработки. Текущий размер пакета по умолчанию - 100.

Запуск в локальном режиме

subql-node -f your-project-path --local

For debugging purposes, users can run the node in local mode. При переключении на локальную модель будут созданы таблицы Postgres в схеме по умолчанию public.

Если локальный режим не используется, будет создана новая схема Postgres с исходным subquery_ и соответствующими таблицами проекта.

Проверка состояния вашего узла

Существует 2 конечные точки, которые вы можете использовать для проверки и мониторинга состояния работоспособности узла SubQuery.

  • Конечная точка проверки работоспособности, которая возвращает простой ответ 200.
  • Конечная точка метаданных, которая включает дополнительную аналитику вашего работающего узла SubQuery.

Добавьте это к базовому URL-адресу вашего узла SubQuery. Например, http: // localhost: 3000 / meta вернет:

{
    "currentProcessingHeight": 1000699,
    "currentProcessingTimestamp": 1631517883547,
    "targetHeight": 6807295,
    "bestHeight": 6807298,
    "indexerNodeVersion": "0.19.1",
    "lastProcessedHeight": 1000699,
    "lastProcessedTimestamp": 1631517883555,
    "uptime": 41.151789063,
    "polkadotSdkVersion": "5.4.1",
    "apiConnected": true,
    "injectedApiConnected": true,
    "usingDictionary": false,
    "chain": "Polkadot",
    "specName": "polkadot",
    "genesisHash": "0x91b171bb158e2d3848fa23a9f1c25182fb8e20313b2c1eb49219da7a70ce90c3",
    "blockTime": 6000
}

http: // localhost: 3000 / health вернет HTTP 200 в случае успеха.

Если индексатор неисправен, будет возвращена ошибка 500. Это часто можно увидеть при загрузке узла.

{
    "status": 500,
    "error": "Indexer is not healthy"
}

Если используется неправильный URL, будет возвращена ошибка 404 not found.

{
"statusCode": 404,
"message": "Cannot GET /healthy",
"error": "Not Found"
}

Отладка вашего проекта

Используйте инспектор узловopen in new window для выполнения следующей команды.

node --inspect-brk <path to subql-node> -f <path to subQuery project>

Например:

node --inspect-brk /usr/local/bin/subql-node -f ~/Code/subQuery/projects/subql-helloworld/
Debugger listening on ws://127.0.0.1:9229/56156753-c07d-4bbe-af2d-2c7ff4bcc5ad
For help, see: https://nodejs.org/en/docs/inspector
Debugger attached.

Затем откройте инструменты разработчика Chrome , перейдите в Source > Filesystem, добавьте свой проект в рабочую область и начните отладку. Для получения дополнительной информации посмотрите Как отладить проект SubQuery.

Запуск службы запросов (subql / query)

Установка

# NPM
npm install -g @subql/query

::: риски Обратите внимание, что мы ** НЕ** поощряем использование yarn global из-за его плохого управления зависимостями, что может в дальнейшем привести к ошибкам. :::

Запуск службы Запросов

export DB_HOST=localhost
subql-query --name <project_name> --playground

Убедитесь, что имя проекта совпадает с именем проекта при инициализации проекта. Также проверьте правильность переменных среды.

После успешного запуска службы subql-query откройте браузер и перейдите по следующему пути: http://localhost:3000. Вы должны увидеть площадку GraphQL, отображаемую в проводнике, и схему, готовую для запросов.