@acala-network/acala-transfers-subql 中文文档教程

Question

SubQuery - Starter Package

Starter Package 是一个示例，您可以将其用作开发 SubQuery 项目的起点。 SubQuery 包定义了 SubQuery 将从 Substrate 区块链索引哪些数据，以及它将如何存储这些数据。

Preparation

Environment

• Typescript 是编译项目和定义类型所必需的。

• SubQuery CLI 和生成的项目都具有依赖关系，并且需要 Node。

Install the SubQuery CLI

使用 NPM 在您的终端上全局安装 SubQuery CLI：

npm install -g @subql/cli

运行帮助以查看 CLI 提供的可用命令和用法

subql help

Initialize the starter package

在您要创建 SubQuery 项目的目录中，只需将 project-name 替换为您的项目name 并运行命令：

subql init --starter project-name

然后你应该看到目录中已经创建了一个包含你的项目名称的文件夹，你可以将其用作项目的起点。 这些文件应该与 目录结构 中的相同。

最后，在项目目录下，运行以下命令安装所有依赖项。

yarn install

Configure your project

在启动包中，我们提供了一个简单的项目配置示例。 您将主要处理以下文件：

• The Manifest in project.yaml
• The GraphQL Schema in schema.graphql
• The Mapping functions in src/mappings/ directory

有关如何编写子查询的更多信息， 查看我们关于定义子查询的文档部分

Code generation

为了索引您的子查询项目，必须先构建您的项目。 在项目目录下运行此命令。

yarn codegen

Build the project

为了将您的 SubQuery 项目部署到我们的托管服务，必须在上传前打包您的配置。 从项目的根目录运行 pack 命令将自动生成一个 your-project-name.tgz 文件。

yarn build

Indexing and Query

Run required systems in docker

在项目目录下运行以下命令：

docker-compose pull && docker-compose up

Query the project

打开浏览器并前往 http://localhost:3000。

最后，您应该会在资源管理器中看到一个 GraphQL playground 以及准备查询的模式。

对于subql-starter项目，您可以尝试使用以下代码进行查询，感受一下它的工作原理。

{
  query{
    starterEntities(first:10){
      nodes{
        field1,
        field2,
        field3
      }
    }
  }
}