跳至主要內容

Terra 快速开始

SubQuery Team大约 9 分钟

Terra 快速开始

在这个快速入门指南中，我们将从一个简单的启动项目开始，然后通过索引一些实际数据来完成。 这是开发您自己的 SubQuery 项目的良好基础。

如果您正在寻找 Terra 指南，您可以阅读 Terra 特定的快速启动指南。

在本指南的最后，您将拥有一个在 SubQuery 节点上运行的可工作 的 SubQuery 项目，该节点具有一个可以从中查询数据的 GraphQL 端点。

如果您还没有准备好进一步学习，我们建议您熟悉 SubQuery 中所使用的 terminology。

这个快速入门指南的目的是调整标准的启动项目，开始对 Polkadot 的所有转移进行索引，它应该只需要 10-15 分钟

准备

本地开发环境

安装 SubQuery CLI

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

# NPM
npm install -g @subql/cli

请注意，我们不鼓励使用yarn global来安装@subql/cli，因为它的依赖性管理不好，可能会导致下一步的错误。

然后，您可以运行帮助以查看 CLI 提供的可用命令和用法。

subql help

初始化 Starter SubQuery 项目

在你想创建 SubQuery 项目的目录中，只需运行以下命令就可以开始了。

subql init

在初始化 SubQuery project 时，您会被问到一些问题：

  • Project Name: A name for your SubQuery project
  • 网络。这个 SubQuery 项目将开发的区块链网络索引，使用键盘上的方向键从选项中选择，对于本指南，我们将使用*"Polkadot"*。
  • 网络。这个 SubQuery 项目将开发的区块链网络索引，使用键盘上的方向键从选项中选择，对于本指南，我们将使用*"Polkadot"*。
  • 模板。选择一个子查询项目模板，为开始开发提供一个起点，我们建议选择*"启动项目"*。
  • Git 仓库（可选）。提供一个 Git URL，这个 SubQuery 项目将被托管在一个 Repo 中（当托管在 SubQuery Explorer 中）。
  • RPC 端点（需要）。提供一个运行中的 RPC 端点的 HTTPS URL，该端点将被默认用于该项目。 此 RPC 节点必须是归档节点 (具有完整链状态)。 在本指南中，我们将使用默认值*"https://polkadot.api.onfinality.io"*。
  • 作者（必填）。在此输入该子查询项目的所有者（例如，你的名字！）。
  • 描述（可选）。你可以提供一个关于你的项目的简短段落，描述它包含什么数据以及用户可以用它做什么。
  • 版本 (必填)：输入一个自定义版本号或使用默认版本(1.0.0)
  • 许可证(必填)：提供此项目的软件许可或接受默认设置(Apache-2.0)

在初始化过程完成后，您应该看到目录内创建了一个项目名称的文件夹。 此目录的内容应该与 Directory Structure 中列出的内容完全相同。

最后，在项目目录下，运行以下命令来安装新项目的依赖关系。

::: code-tabs @tab:active yarn shell cd PROJECT_NAME yarn install @tab npm shell cd PROJECT_NAME npm install :::

正在对您的项目进行更改

在您刚刚初始化的启动包， 我们为您的新项目提供了标准配置。 您将主要处理下列文件：

  1. 在 schema.graphql中的 GraphQL Schema
  2. project.yaml 中的项目清单
  3. src/mappings/ 目录中的映射函数

本快速入门指南的目的是调整标准的启动项目，以开始对 Polkadot 的所有转移进行索引。

更新你的 GraphQL Schema 文件

schema.graphql 文件定义了各种 GraphQL 模式。 遵循 GraphQL 查询语言的工作方式，模式文件基本上决定了您从 SubQuery 获取数据的格式。 这是一个很好的开始，因为它允许你在前面定义你的最终目标。

我们将更新 schema.graphql 文件如下所示：

type Transfer @entity {
  id: ID! type Example @entity {
  id: ID! # id 字段总是必需的，必须像这样定义
  name: String! # 这是必填字段
  address: String # 这是一个可选字段
}
  块高度: BigInt # 传输
  发送者的块高度: 字符串! # 从
  到字符串的转账账户！ # 从
  到字符串的转账账户！ # 转移的金额
}

重要提示：当您对模式文件做任何更改时， 请确保使用命令 yarn codegen 来重新生成你的类型目录。 现在就做。

cd PROJECT_NAME # Yarn yarn install # NPM npm install 您将主要处理以下文件：

  • 在 project.yaml. 欲了解更多关于 schema.graphql 文件的信息，请参阅 Build/GraphQL Schema

更新 Project Manifest 文件

Projet Manifest（project.yaml）文件可以被看作是你项目的入口，它定义了 SubQuery 如何索引和转换链数据的大部分细节。

我们不会对清单文件做许多更改，因为它已经正确设置了，但我们需要更改处理程序。 请记住，我们正计划对所有 Polkadot 传输进行索引，因此，我们需要更新datasources部分，使之成为以下内容。

数据源:
  - 类型: terra/Runtime
    startBlock: 4724001 # Colombus-5 在此高度开始
    映射:
      文件: 距离/index。 s
      处理器：
        - 处理器：处理事件
          类型：terra/EventHandler
          # 这将触发所有符合以下智能合同过滤条件的事件
          过滤器：
            类型：传输
            messageFilter：
              类型：/terra。 如需通过，请填写。 sgExecuteContract
              值：
                # 我们正在订阅bLuna 智能合同 (e). 。只能从该合同转移事件。)
                合同：terra1j66jatn3k50hjtg2xemnjm8s7y8dws9xqa5y8w

这意味着我们将运行一个 处理事件 映射功能，每次从 bLuna 智能合约进行 传输 事件。

关于 Project Manifest（project.yaml）文件的更多信息，请查看我们在Build/Manifest File下的文档。

添加 Mapping Function

Mapping functions 定义了如何将链式数据转化为我们之前在schema.graphql文件中定义的优化的 GraphQL 实体。

导航到src/mappings目录下的默认映射函数。 你会看到三个导出的函数, handleBlock, handleEvent, 和 handleCall。 你可以同时删除handleBlock和handleCall函数，我们只处理handleEvent函数。

handleEvent函数接收事件数据，只要事件符合我们之前在project.yaml中指定的过滤器。 我们将更新它以处理所有balances.Transfer事件，并将它们保存到我们先前创建的 GraphQL 实体中。

你可以将handleEvent函数更新为以下内容（注意额外的导入）。

import { TerraEvent } from "@subql/types-terra";
import { Transfer } from "../types";
import { MsgExecuteContract } from "@terra-money/terra.js";

export async function handleEvent(
  event: TerraEvent<MsgExecuteContract>
): Promise<void> {
  // Print debugging data from the event
  // logger.info(JSON.stringify(event));

  // Create the new transfer entity with a unique ID
  const transfer = new Transfer(
    `${event.tx.tx.txhash}-${event.msg.idx}-${event.idx}`
  );
  transfer.blockHeight = BigInt(event.block.block.block.header.height);
  transfer.txHash = event.tx.tx.txhash;
  for (const attr of event.event.attributes) {
    switch (attr.key) {
      case "sender":
        transfer.sender = attr.value;
        break;
      case "recipient":
        transfer.recipient = attr.value;
        break;
      case "amount":
        transfer.amount = attr.value;
        break;
      default:
    }
  }
  await transfer.save();
}

这正在做的是接收一个 SubstrateEvent，其中包括有效载荷的传输数据。 我们提取这些数据，然后实例化一个新的Transfer实体，我们之前在schema.graphql文件中定义了这个实体。 我们添加额外的信息，然后使用.save()函数来保存新的实体（SubQuery 将自动将其保存到数据库）。

关于映射函数的更多信息，请查看我们在Build/Mappings下的文档。

生成项目

为了运行您的新的 SubQuery 项目，我们首先需要建立我们的工作。 从项目的根目录运行构建命令。

::: code-tabs @tab:active yarn shell yarn build @tab npm shell npm run-script build :::

重要的是：每当你对你的映射函数进行修改时，你就需要重建你的项目。

运行和查询你的项目</6

用 Docker 运行你的项目</7

当你创建一个新的 SubQuery 项目时，你应该总是在你的计算机上运行它，首先测试它。 最简单的方法是使用 Docker。

控制 SubQuery 节点运行方式的所有配置都在这个docker-compose.yml文件中定义。 对于一个刚刚启动的新项目，你不需要改变这里的任何东西，但你可以在我们的运行项目部分阅读更多关于文件和设置的信息。

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

::: code-tabs @tab:active yarn shell yarn start:docker @tab npm shell npm run-script start:docker :::

下载所需软件包可能需要一些时间(@subql/节点open in new window, @subql/quiryopen in new window, and Postgress) 首次，但很快你会看到一个运行中的 SubQuery 节点。 请耐心等待。

查询您的项目

打开浏览器并前往 http://localhost:3000open in new window。

您应该会看到 GraphQL playground 显示在资源管理器中，其模式是准备查询。 在 Playground 的右上角，您会找到一个Docs按钮，该按钮将打开文档绘图。 该文档是自动生成的，可帮助您查找实体和方法。

对于一个新的 SubQuery 入门项目，您可以尝试以下查询以了解其工作原理，或者 了解更多关于 GraphQL 查询语言的信息。

{
  query {
    transfers(first: 10, orderBy: AMOUNT_DESC) {
      nodes {
        id
        amount
        blockNumber
        from
        to
      }
    }
  }
}

发布您的 SubQuery 项目

当您可以部署新项目时，SubQuery 提供免费管理服务。 您可以将其部署到 SubQuery 项目open in new window 并使用我们的 Exploreropen in new window 进行查询。

阅读向 SubQuery 项目发布您的新项目

后续步骤

恭喜，您现在有一个本地运行的 SubQuery 项目，该项目接受 GraphQL API 对示例数据的请求。

现在你已经深入了解了如何建立一个基本的 SubQuery 项目，问题是要从哪里开始？ 如果你感到有信心，你可以跳到更多关于三个关键文件的学习。 这些文档的 构建部分下的清单文件，GraphQL schema 和映射文件。

不然的话，继续我们的 学院部分 ，因为那里有更多的深度讲习班、教程和示例。 我们将在这里查看更高级的修改，我们将通过运行随时可用和开源项目来深入细致地运行 SubQuery 项目。

最后，如果你正在寻找更多的方法来运行和发布你的项目，我们的 Run & Publish section提供了关于运行你的 SubQuery 项目和其他高级 GraphQL 聚合和订阅功能的所有方法的详细信息。