创建新的 SubQuery 项目

2021-11-24 大约 3 分钟

# 创建新的 SubQuery 项目

快速开始 指南, 我们快速地演示了一个DEMO,让您知道什么是SubQuery以及它是如何运作的。 在这里,我们将进一步了解创建项目流程及后续所需使用的关键文件的流程。

# SubQuery 示例

以下一些示例将假定您在 快速启动 部分中成功初始化了启动器包。 从这个启动程序包,我们会走过标准进程来定制和执行您的 SubQuery 项目。

  1. 您可以使用 subql init --specversion 0.2.0 PROJECT_NAME 初始化您的项目。 也可以使用旧的 spec 版本 subql init PROJECT_NAME
  2. 更新清单文件(个项目。 aml) 以包含关于您的 blockchain 以及您将要映射的实体的信息 - 查看 清单文件
  3. 在您的架构中创建 GraphQL 实体(架构)。 定义您要提取和持续查询的数据形状的 rapphql- 参见 GraphQL Schema
  4. 添加所有映射函数 (eg 映射处理器。 s) 您想要调用来将链式数据转换为您已定义的 GraphQL 实体 - 查看 映射
  5. 生成,构建, 并发布代码到 SubQuery 项目 (或在您自己的本地节点中运行) - 在我们的快速启动指南中查看 运行并查询您的启动项目

# 目录结构

下面的map提供了运行 init 命令时子查询项目的目录结构概览。

- project-name
  L package.json
  L project.yaml
  L README.md
  L schema.graphql
  L tsconfig.json
  L docker-compose.yml
  L src
    L index.ts
    L mappings
      L mappingHandlers.ts
  L .gitignore
1
2
3
4
5
6
7
8
9
10
11
12

示例

SubQuery directory structure

# 代码生成

每当您更改您的 GraphQL 实体时,您必须通过以下命令重新生成您的类型目录。

yarn 编码器
1

这将创建一个新的目录(或更新现有的目录) src/type 其中包含您之前在 scheme 中定义的每个类型生成的实体类别。 rapphql 这些类别提供了安全类型实体加载, 读取并写入实体字段 - 在 GraphQL Schema 中查看更多关于此进程的信息。

# 创建项目

为了在本地托管的 SubQuery 节点上运行您的SubQuery 项目,您需要首先构建您的项目。

从项目的根目录运行构建命令。

上次编辑于: 2021年11月24日 02:27