创建新的 SubQuery 项目

SubQuery Team大约 2 分钟

创建新的 SubQuery 项目

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

SubQuery 示例

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

  1. 使用 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

示例

SubQuery directory structure

代码生成

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

yarn 编码器

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

创建项目

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

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

console.log 方法不再受支持。 相反, Logger 模块已被注入到类型中,这意味着我们可以支持一个可以接受不同日志级别的logger。

logger.info('Info level message');
logger.debug('Debugger level message');
logger.warn('Warning level message');

要使用 logger.infologger.warn,只需将行放入您的映射文件。

logging.info

要使用 logger.debug, 需要一个额外的标记。 将 --log-level=debug 添加到您的命令行。

如果您正在运行一个docker容器,请将此行添加到您的 docker-compose.yaml 文件中。

logging.debug

现在您应该可以在终端屏幕上看到新的日志记录。

logging.debug