Docs
⌘ K

8 分钟

部署到子图工作室

以下是将子图部署到Subgraph Studio步骤。

注意：当您部署子图时，您将它推送到子图工作室，在那里您将能够测试它。 重要的是要记住部署与发布不一样。当你发布一个Subgraph时，你发布它是一个链。

子图工作室概述

在 Subgraph Studio, 您可以做以下操作：

  • 查看您创建的子图列表
  • 用于管理、查看详细信息和可视化特定子图状态的部分
  • 为特定子图创建和管理 API 密钥
  • 将您的 API 密钥限制在指定的域名，并且只允许某些索引人与它们查询
  • 编写子图
  • 使用 The GraphCLI 部署你的子图
  • 在播放环境中测试你的子图
  • 使用开发查询 URL 整合你的子图
  • 将你的子图发布到 The Graph的去中心化网络
  • 管理您的账单

安装The Graph CLI

部署前，您必须安装 The Graph CLI。

你必须安装Node.js⁠和你选择的包管理器 (npm or pnpm) 才能使用Graph CLI。检查最新的⁠CLI版本。

使用 yarn 安装

yarn global add @graphprotocol/graph-cli

使用 npm 安装

npm install -g @graphprotocol/graph-cli

开始

  1. 打开 Subgraph Studio。
  2. 连接您的钱包以登录。
    • 您可以通过Metamask、Coinbase Wallet 、WalletConnect或安全做到这一点。
  3. 登录后，您唯一的部署密钥将显示在您的子图详细信息页面上。
    • 一旦您登录，您将在您的账户主页上看到您唯一的部署密钥。这将允许您发布您的子图或管理您的 API 密钥以及计费。您将拥有一个惟一的部署密钥，如果您认为该密钥已被破坏，则可以重新生成该密钥。

重要：您需要 API 密钥查询子图

如何在子图工作室中创建子图

How to Deploy a Subgraph - A Step-By-Step Walkthrough

欲了解更多书面详情，请查看快速启动。

子图与The Graph网络的兼容性

为了得到The Graph网络上的索引人支持，子图必须对[支持的网络]（/supported-networks/）进行索引。有关支持和不支持功能的完整列表，请查看功能支持列表⁠回购。

初始化你的子图

一旦你的子图在子图工作室中被创建，你可以用这个命令初始化子图代码：

graph init <SUBGRAPH_SLUG>

您可以在SubgraStudio的Subgra详细信息页面找到<SUBGRAPH_SLUG>值，查看下面的图像：

Subgraph Studio - Slug

运行graph init后，您将被要求输入合约地址、网络和您想要查询的ABI。 这将在您的本地机器上生成一个新文件夹，带有一些基本代码来开始在您的Subgraph上工作。 然后你可以完成你的子图，确保它按预期工作。

Graph 认证

在将你的子图部署到子图工作室之前，你需要在 CLI 内登入你的账户。要做到这一点，您将需要您的部署密钥，您可以在您的子图详细信息页面找到。

然后，使用下面的命令从 CLI 进行身份验证：

graph auth <DEPLOY KEY>

部署子图

一旦你准备好了，你可以将你的子图部署到子图工作室。

部署一个 CLI 的子图，推送它到工作室，在那里你可以测试它并更新元数据。 此操作不会将你的子图发布到去中心化的网络。

使用下面的 CLI 命令来部署您的子图：

graph deploy <SUBGRAPH_SLUG>

在运行此命令后，CLI将要求一个版本标签。

  • 强烈建议使用semver⁠ 进行版本控制，如0.0.1。尽管如此，您可以自由选择任何字符串作为版本，比如：v1，version1，asdf。
  • 这些标签将在Graph Explorer中可见，并可由策展人用来决定是否要在这个版本上发出信号，所以要明智地选择它们。

测试子图

部署后，你可以测试你的子图(在SubgraStudio或在你自己的应用中，使用部署查询 URL)， 部署另一个版本，更新元数据，并在你准备就绪时发布到 Graph Explorer。

使用子图工作室检查仪表板上的日志，并查找您的子图中的任何错误。

发布子图

要成功发布您的子图，请审阅发布子图。

使用 CLI 对子图进行版本控制

如果你想要更新子图，可以做以下操作：

  • 你可以使用 CLI 部署一个新版本到 Studio (现在它只是私密的)。
  • 一旦你对它满意，你可以发布你的新部署到 Graph Explorer。
  • 此操作将创建你的Subgra新版本，策展人可以开始发信号，索引人可以索引。

您也可以在不发布新版本的情况下更新子图形元数据。 您可以在 Studio 中更新您的子图详细信息(在个人资料图片、名称、描述等下)。 通过在 Graph Explorer 中检查名为 Updetails 的选项。 如果选中此项， 在浏览器中，将生成更新Subgraph 详细信息的在线交易，无需发布一个新版本的安装。

注意：发布新版Subgraph 到网络相关的费用。 除了交易费外，您还必须在自动迁移信号上为策展税提供部分资金。 如果策展人没有在Subgraph 上签名，您不能发布新版本。 欲了解更多信息，请阅读更多的 here。

子图版本的自动归档

每当您在Subgraph Studio中部署新的子图版本时，都会归档以前的版本。 存档版本不会被索引/同步，因此无法查询。 您可以在 Studio UI 中取消存档子图的存档版本。 请注意，部署到Studio的以前版本的未发布子图将被自动存档。

注意：部署到Studio的未发布的子图的以前版本将被自动归档。

Subgraph Studio - 取消归档