使用SubQuery索引Moonbeam¶

概览¶

SubQuery是一个数据聚合层，在Layer 1区块链（例如Moonbeam和波卡）和DApp之间运行。这项服务解锁区块链数据并转换至可查询状态，以便能够在直观的应用程序中使用。这允许DApp开发者聚焦于核心用例和前端，无需在构建为处理数据的自定义后端上浪费时间。

SubQuery支持索引任意Moonbeam网络的以太坊虚拟机（EVM）和Substrate数据。使用SubQuery关键优势是您能够通过单一项目和工具跨Moonbeam的EVM和Substrate代码来灵活收集查询数据，随后使用GraphQL查询该数据。

举例而言，除Substrate数据源外，SubQuery还能够筛选并查询EVM日志和交易。相比较其他索引工具，SubQuery引入更多高级筛选功能，允许筛选非合约交易、交易发送者、合约和索引日志参数，因此开发者能够构建各种满足他们特定数据需求的项目。

本教程将引导您学习如何创建在Moonbeam上索引ERC-20转移和批准的SubQuery项目。具体来说，本教程将涵盖索引Transfer事件和approve函数的调用。

此处提供的信息仅供参考，由第三方提供。 Moonbeam文档网站(https://docs.moonbeam.network/)上列出和描述的任何项目与Moonbeam立场无关。

查看先决条件¶

在本教程的后半部分，您可以选择将项目部署到本地运行的SubQuery节点。为此，您需要先在您的系统安装以下内容：

• Docker
• Docker Compose

创建一个项目¶

首先，您将需要创建一个SubQuery项目。您可以选择为Moonbeam、Moonriver或Moonbase Alpha创建项目。在本教程中，我们将选择Moonbeam创建项目。

一般来说，您将需要：

1. 全网安装SubQuery CLI：

   npm install -g @subql/cli
   

   注意事项

   截至本教程撰写时，所用版本为1.3.1。

2. 使用以下命令初始化您的SubQuery项目：

   subql init PROJECT_NAME
   

3. 随后，根据提示完成一系列问题：

   1. 关于Select a network，您可以选择Substrate

      

   2. 系统将提示您Select a network（选择网络）。截至本教程撰写时，Moonriver是唯一选项。您可以继续操作，选择Moonriver，这也同样适用于Moonbeam和Moonbase Alpha

      

   3. 随后，系统将提示您Select a template project（选择一个示例项目）。您可以选择EVM启动项目或从git端点创建一个项目。本教程将基于Moonriver EVM启动项目操作，您可以选择moonriver-evm-starter

      

   4. 这将为您复制启动项目，随后根据提示回答一些额外的问题。您可以直接按回车键输入默认值或者根据需求输入自定义值

      

4. 这将为您的SubQuery项目自动创建一个目录。您只需要从项目目录中安装依赖项：

   cd PROJECT_NAME && yarn install
   

初始化设置完成后，您将拥有一个包含以下文件（以及其他文件）的基础SubQuery项目：

• project.yaml —— Manifest File，作为项目的入口点
• schema.graphql —— GraphQL Schema，定义数据形状。模板包括Transaction 和Approval实体
• src/mappings/mappingHandlers.ts —— 导出Mapping函数，用于定义如何将链数据转换为架构中定义的GraphQL实体
• src/chaintypes.ts —— 专为Moonbeam导出链的类型，便于索引Moonbeam数据
• erc20.abi.json —— 包含标准ERC-20接口的ABI的JSON文件，将用于筛选ERC-20转移和批准数据

如果您查看package.json文件，您将会发现chaintypes已经导出在该文件中。如果未发现此情况，或者您正在扩展现有Substrate项目以添加Moonbeam网络支持，您将需要包含以下代码段：

"exports": {
    "chaintypes": "src/chaintypes.ts"
}

更新网络配置¶

您将需要在project.yaml文件中更新network配置。chainId字段处可用于输入您想要索引的网络创世哈希。

要在Moonbeam或Moonriver网络上测试本指南中的示例，您可以从受支持的网络端点提供商之一获取您自己的端点和API密钥。

每个网络的network配置如下所示：

network:
chainId: '0xfe58ea77779b7abda7da4ec526d14db9b1e9cd40a217c34892af80a9b332b76d'
endpoint: 'INSERT_RPC_API_ENDPOINT'
dictionary: 'https://api.subquery.network/sq/subquery/moonbeam-dictionary'
chaintypes:
  file: ./dist/chaintypes.js

network:
chainId: '0x401a1f9dca3da46f5c4091016c8a2f26dcea05865116b286f60f668207d1474b'
endpoint: 'INSERT_RPC_API_ENDPOINT'
dictionary: 'https://api.subquery.network/sq/subquery/moonriver-dictionary'
chaintypes:
  file: ./dist/chaintypes.js

network:
chainId: '0x91bc6e169807aaa54802737e1c504b2577d4fafedd5a02c10293b1cd60e39527'
endpoint: 'https://rpc.api.moonbase.moonbeam.network'
dictionary: 'https://api.subquery.network/sq/subquery/moonbase-alpha-dictionary'
chaintypes:
  file: ./dist/chaintypes.js

Moonbeam自定义数据源¶

您也需要更新project.yaml文件中的dataSources配置。数据源定义将被筛选以及抓取的数据，另外也定义了要应用的数据转换的映射函数，以及其处理程序的位置。

SubQuery已经创建了专门用来和Moonbeam Frontier实现一起工作的数据处理器。这允许您参照处理器使用的特定ABI源以解析参数和事件来源或者调用的智能合约地址。概括来说，SubQuery作为中间件，能够提供额外筛选和数据转换。如果您使用的是示例模板，则Frontier EVM处理器已注入依赖项。如果您使用的是scratch，请确保您运行以下命令安装：

yarn add @subql/frontier-evm-processor

如果您使用的是示例模板，您将看到ERC-20 ABI已经显示在dataSources.processor.options下面。Solarbeam (SOLAR) token在Moonriver上的地址已经罗列出来。在本示例中，您可以在Moonbeam上使用Wrapped GLMR (WGLMR) token的地址：0xAcc15dC74880C9944775448304B263D191c6077F。

在dataSources配置中的字段可以拆分为以下几个部分：

• kind —— 必填，指定自定义Moonbeam数据处理器
• startBlock —— 指定开始索引数据的区块
• processor.file —— 必填，引用数据处理器代码所在的文件
• processor.options —— 包含指定Frontier EVM处理器的处理器选项，包括处理器用于解析参数的abi，以及合约事件来源或调用的address
• assets —— 外部资产ABI文件的对象
• mapping —— 映射规范。这包括映射条目的路径、映射函数以及任何其他映射筛选器所对应的处理器类型

GraphQL架构¶

在schema.graphql文件中，您可以更新该文件以包含一个Transaction和Approval实体。关于交易事件和批准调用将会在本教程后半部分讲述。

type Transaction @entity {
  id: ID! # Transaction hash
  value: BigInt!
  to: String!
  from: String!
  contractAddress: String!
}

type Approval @entity {
  id: ID! # Transaction hash
  value: BigInt!
  owner: String!
  spender: String!
  contractAddress: String!
}

要生成架构文件中定义的所需GraphQL模型，您可以运行以下命令：

yarn codegen

这些模型将在下一部分介绍映射处理器中使用。

映射处理器¶

映射规范包含定义链数据如何转换的映射函数。

示例模板包含两个映射函数，可在src/mappings/mappingHandlers.ts目录下方找到。这些映射函数将转换成您定义的GraphQL实体。两个处理器如下所示：

• Event handler —— 用于捕获新的区块发出特定事件的信息。由于该函数会在任意时间的事件发出时被调用，您可以使用映射筛选器来只处理您需要的事件。这可以改善性能并减少索引次数
• Call handler —— 用于捕获特定extrinsics的信息

在一般的SubQuery项目中，传递给handleEvent映射函数的事件是SubstrateEvent。同样地，传递给handleCall映射函数的extrinsic是SubstrateExtrinsic。但在Moonbeam上，您的映射函数将收到FrontierEvmEvent和FrontierEvmCall。两者建立在Ether的TransactionResponse或者Log种类的基础上。

在本示例中，FrontierEvmEvent将用于处理和筛选Transfer事件，FrontierEvmCall将用于处理和筛选approve函数调用。您可根据自己的需求自行添加处理器。

随后，映射处理器将出现在project.yaml manifest文件dataSources配置的下。您可以为您的每个处理器创建一个mapping.handlers.handler配置。handleMoonbeamEvent和handleMoonbeamCall处理器已包含在示例模板中。

在Moonbeam上调整WGLMR token的模板之前，您将需要将mapping.handlers.handler.filter下方的from字段设置为WGLMR合约地址：

mapping:
  file: './dist/index.js'
  handlers:
    - handler: handleMoonbeamEvent
      kind: substrate/FrontierEvmEvent
      filter:
        topics:
          - Transfer(address indexed from,address indexed to,uint256 value)
          - null
          - null
          - null
    - handler: handleMoonbeamCall
      kind: substrate/FrontierEvmCall
      filter:
        function: approve(address to,uint256 value)
        from: '0xAcc15dC74880C9944775448304B263D191c6077F'

部署项目¶

要部署您的项目至SubQuery管理的服务器，您必须在上传前构建您的配置。您可以通过运行以下代码完成配置：

yarn build

接下来，使用Docker发布您的项目至SubQuery项目或本地运行一个SubQuery节点。为此，您可以运行以下命令：

docker-compose pull && docker-compose up

启动您的数据库和同步节点可能会需要一些时间，但最终您将看到您的节点开始生产区块。

现在您可以打开浏览器输入http://localhost:3000查询您的项目，在该页面，您将找到GraphQL playground。在playground的右上角，点击Docs按钮可以打开文档。该文档自动生成，可协助寻找您可查询的实体或者函数。

恭喜您！现在您已经拥有一个接受GraphQL API查询的Moonbeam SubQuery项目！请注意，根据您所配置的初始区块，索引Moonbeam可能需要几天时间。

示例项目¶

如需查看与上述创建类似的在Moonriver上构建的完整示例项目，请至live Moonriver EVM Starter Project on the SubQuery Explorer，或者在SubQuery Explorer上查看其他项目。

如您有任何问题，您可查阅SubQuery documentation for Substrate EVM Support页面，或者在SubQuery Discord的#technical-support频道联系SubQuery团队。

Moonbuilders教程¶

SubQuery于2021年12月参加了Moonbuilders workshop，向大家展示了如何创建一个简单的SubQuery项目。您可以自行尝试生成范本项目。