OpenZeppelin Subgraphs 项目教程

1. 项目的目录结构及介绍

OpenZeppelin Subgraphs 项目的目录结构如下：

openzeppelin-subgraphs/
├── configs/
├── docs/
├── generated/
├── scripts/
├── src/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── netlify.toml
├── package-lock.json
├── package.json

目录介绍

• configs/: 包含项目的配置文件，用于定义要索引的合约和模块。
• docs/: 包含项目的文档文件。
• generated/: 包含生成的图表模式和子图配置文件。
• scripts/: 包含用于构建和部署子图的脚本。
• src/: 包含子图的数据源和模板。
• .gitignore: Git 忽略文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证（MIT 许可证）。
• README.md: 项目介绍和使用说明。
• netlify.toml: Netlify 配置文件。
• package-lock.json: npm 依赖锁定文件。
• package.json: npm 项目配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 package.json 中的脚本部分。以下是一些关键的启动脚本：

{
  "scripts": {
    "build": "npx graph-compiler --config configs/sample.json --include node_modules/@openzeppelin/subgraphs/src/datasources --export-schema --export-subgraph",
    "deploy": "npx graph deploy --node https://api.thegraph.com/deploy/ --ipfs https://api.thegraph.com/ipfs/ your-subgraph-name"
  }
}

脚本介绍

• build: 用于编译子图，生成模式文件和子图配置文件。
• deploy: 用于部署子图到 The Graph 网络。

3. 项目的配置文件介绍

项目的配置文件位于 configs/ 目录下，例如 configs/sample.json。以下是一个示例配置文件的内容：

{
  "output": "generated/sample",
  "chain": "mainnet",
  "datasources": [
    {
      "address": "0xA3B26327482312f70E077aAba62336f7643e41E1",
      "startBlock": 11633151,
      "module": [
        "erc20",
        "accesscontrol"
      ]
    },
    {
      "address": "0xB1C52075b276f87b1834919167312221d50c9D16",
      "startBlock": 9917641,
      "module": "erc721"
    },
    {
      "address": "0x799DAa22654128d0C64d5b79eac9283008158730",
      "startBlock": 9917642,
      "module": "erc721"
    },
    {
      "address": "0xC76A18c78B7e530A165c5683CB1aB134E21938B4",
      "startBlock": 9917639,
      "module": "erc721"
    }
  ]
}

配置文件介绍

• output: 生成的文件输出目录。
• chain: 目标区块链网络（例如 mainnet）。
• datasources: 要索引的合约数据源列表。
  • address: 合约地址。
  • startBlock: 开始索引的区块号（可选）。
  • module: 要索引的合约模块（例如 erc20, accesscontrol）。

通过以上配置文件，可以定义要索引的合约和模块，并