配置文件

... 2022-8-10 大约 9 分钟

# 配置文件

project.yaml清单文件可以看作是项目的入口点,它定义了关于 SubQuery 如何索引和转换链数据的大部分细节。

该清单文件可以是 YAML 或 JSON 格式。 在本文档中,我们将在所有示例中使用 YAML 格式。 下面是project.yaml文件的标准示例。

# 从 v0.0.1 迁移到 v0.2.0

如果你有一个 specVersion v0.0.1 的项目,你可以使用subql migrate来快速迁移。 查看这里 了解更多信息

网络 中:

  • 需要新的 **** 基因哈希 字段有助于识别正在使用的链。
  • 对于 v0.2.0 及以上,如果您正在引用自定义链,您可以引用外部 chainype 文件

数据源 下:

  • 可以直接链接映射处理器的 index.js 条目。 默认情况下,此 index.js 将从 索引生成。 ts 在构建过程中。
  • 数据源现在可以是常规运行时的数据源或 自定义数据源

# CLI 选项

默认情况下,CLI 将生成 spec verison v0.2.0 的 SubQuery 项目。 这种行为可以通过运行 subql init --specversion 0.0而被覆盖。 PROJECT_NAME, 尽管不推荐这个项目,因为它将来不会被 SubQuery 托管服务支持

subql migrate 可以在一个现有的项目中运行,将项目清单迁移到最新版本。

USAGE $subql init [PROJECTNAME]

ARGUMENTS 给出起始项目名称

选项 Description
-f, --force
-l, --location=location 要创建项目的本地文件夹
--install-dependencies 同时安装依赖项
--npm 强制使用 NPM 而不是 yarn,只能使用 install-dependencies 标志
--specVersion=0.0.1 0.2.0 [默认:0.2.0]

# 概述

# 顶级视图

Field v0.0.1 v0.2.0 Description
specVersion String String 0.0.10.2.0 - 清单文件的 spec 版本
name String String 项目名称
version String String 项目版本
description String String 项目描述
repository String String 项目的 Git 仓库地址
schema String Schema Spec GraphQL schema 文件的位置
network [Network Spec](#network Spec) Network Spec 要索引的网络详情
dataSources [DataSource Spec](#dataSource Spec) DataSource Spec

# Schema 说明

Field v0.0.1 v0.2.0 Description
file String String GraphQL schema 文件的位置

# Network Spec

Field v0.0.1 v0.2.0 Description
genesisHash String String 网络起源哈希值
endpoint String String network.endpoint定义要索引的区块链的 wss 或 ws 端点-必须是完整的存档节点。 您可以免费从 Onfinality (opens new window) 检索所有传送端点的终点
dictionary String String network.dictionary可选地提供全链字典的 HTTP 端点以加快处理-了解 SubQuery 字典的工作方式
chaintypes String {file:String} 链式文件路径,接受 .json.yaml 格式

# Datasource 说明

DataSources 定义要过滤和提取的数据以及要应用的数据转换的映射函数处理程序的位置。

Field v0.0.1 v0.2.0 Description
name String String 数据源名称
kind substrate/Runtime substrate/Runtime, substrate/CustomDataSource 我们支持默认底层运行时间的数据类型,如块、事件和额外(调用)。
从 v0.2.0,我们支持自定义运行时间的数据,例如智能合约。
startBlock Integer Integer 这将更改您的索引开始块,设置此更高以跳过最初的块,减少数据
mapping Mapping Spec Mapping Spec
filter network-filters String 通过网络端点速度名称筛选要执行的数据源

# Mapping Spec

Field v0.0.1 v0.2.0 Description
file String String 映射条目路径
handlers & filters Default handlers and filters Default handlers and filters,
Custom handlers and filters
列出所有 映射函数 及其相应的处理类型,并添加附加映射筛选器。

对于自定义运行时映射处理程序,请查看 自定义数据源

# 数据来源和映射

在本节中,我们将谈论默认的底层运行时间及其映射。 下面是一个示例:

dataSources:
  - kind: substrate/Runtime # Indicates that this is default runtime
    startBlock: 1 # This changes your indexing start block, set this higher to skip initial blocks with less data
    mapping:
      file: dist/index.js # Entry path for this mapping
1
2
3
4
5

# 映射处理器和过滤器

下表将说明不同处理程序支持的筛选器。

当您只使用具有适当映射过滤器的事件和呼叫处理程序时,您的子查询项目将会更加有效。

处理程序 支持的过滤器:
BlockHandler specVersion
EventHandler module,method
CallHandler module,method ,success

过滤器映射是一个非常有用的选项,是用决定哪些块、事件或外部程序将触发映射的过滤器。

映射函数只处理满足筛选条件的传入数据。 映射筛选的选项是可选状态,但我们推荐使用,因为它可以显著减少 SubQuery 项目处理的数据量,并提高索引性能。

# Example filter from callHandler
filter:
  module: balances
  method: Deposit
  success: true
1
2
3
4
5
  • 模块和方法过滤器支持所有基于 SubQery 的平行链。
  • 过滤器的成功运行需要一个布尔值,用于根据外部对象的成功状态进行过滤。
  • specVersion过滤器指定板块的规格版本范围。 以下示例将描述如何设置版本范围。
filter:
  specVersion: [23, 24]   # Index block with specVersion in between 23 and 24 (inclusive).
  specVersion: [100]      # Index block with specVersion greater than or equal 100.
  filter:
  specVersion: [23, 24]   # Index block with specVersion in between 23 and 24 (inclusive).
  specVersion: [100]      # Index block with specVersion greater than or equal 100.
  specVersion: [null, 23] # Index block with specVersion less than or equal 23.
1
2
3
4
5
6
7

# 自定义链

# Network Spec

当连接到不同的 Polkadot parachain,甚至一个自定义的底层链时, 您需要编辑此清单的 网络 Spec 部分。

genesisHash 必须始终是自定义网络第一个块的哈希。 您可以通过到 PolkadotJS (opens new window) 并在 block 0 中寻找散列(见下面的图像)来轻松地退出。

创世区块哈希

此外,您将需要更新 个端点network.endpoint定义要索引的区块链的 wss 或 ws 端点-必须是完整的存档节点。 您可以免费从 Onfinality (opens new window) 检索所有传送端点的终点

# Chain 类型

你可以通过在中添加链类型来索引自定义链中的数据。

我们支持 Substrate 运行模式所使用的额外类型, 类型别名类型Bundle, 类型链, 和 类型Spec 也被支持。

在 v0.2.0 示例中, network. hainintypes 指向一个包含所有自定义类型的文件。 这是一个标准的链规格文件,用 声明此区块链支持的特定类型。 son.yaml 格式。

自定义数据源提供了特定于网络的功能,使处理数据更容易。

network:
  chainpypes:
    file: ./dist/types.js # 将在 yarn 运行后生成
1
2
3

关于使用后缀名 .ts.js 的链式文件的规范:

下面是一个 .ts 链类型文件的示例:

# 自定义数据源

自定义数据源提供网络特定功能,使得处理数据变得更容易。 它们充当中间件,可以提供额外的过滤和数据转换 一个很好的例子就是对 EVM 的支持,拥有一个自定义的 EVM 数据源处理器意味着你可以在 EVM 级别进行过滤(例如过滤合约方法或日志),数据被转换成熟悉以太坊生态系统的结构,并使用 ABIs 解析参数

自定义数据源可以与普通数据源一起使用 以下是受支持的自定义数据源列表

Kind Supported Handlers Filters Description
substrate/Moonbeam substrate/MoonbeamEvent, substrate/MoonbeamCall See filters under each handlers Provides easy interaction with EVM transactions and events on Moonbeams networks

< < 11 >网络过滤器/ 11 >

网络过滤器仅适用于 manifest 规范 v0.0.1. . 通常用户会创建一个 SubQuery,并希望在他们的测试网和主网环境中重用它(例如 Polkadot 和 Kusama)。 在不同的网络环境之间,一些设置可能会发生变化(例如索引起始块)。 因此,我们允许用户为每个数据源定义不同的细节,这意味着一个子查询项目仍然可以在多个网络中使用。

用户可以在 上添加一个 过滤器 数据源 来决定在每个网络上运行哪个数据源。 在不同的网络环境之间,一些设置可能会发生变化(例如索引起始块)。 因此,我们允许用户为每个数据源定义不同的细节,这意味着一个子查询项目仍然可以在多个网络中使用。

用户可以在 上添加一个 过滤器 数据源 来决定在每个网络上运行哪个数据源。

下方示例是 Polkadot 和 Kusama 网络中不同的数据源。

上次编辑于: 2022年8月10日 00:49