oceanprotocol/subgraph

ocean-subgraph

概述

ocean-subgraph是Ocean Protocol的子图实现，用于索引和查询Ocean Protocol在***上的相关数据。该子图已部署在Ocean Protocol合约所支持的所有网络中，提供GraphQL接口供开发者和用户查询数据NFT、订单、用户等实体信息。

核心功能与特性

• 多网络支持：部署于主网、Polygon、BSC、Moonriver、Energy Web、Mumbai等多个网络
• 数据实体索引：索引数据NFT、订单、用户等核心实体
• GraphQL接口：提供灵活的查询能力，支持按时间戳排序、筛选特定用户等操作
• 开发友好：支持本地开发环境（Barge）和实时网络部署

使用场景

• Ocean Protocol DApp开发：获取链上数据NFT、订单等信息
• 数据分析：统计用户订单数量、数据资产分布等链上数据
• 链上监控：实时跟踪Ocean Protocol生态系统活动

使用方法

快速开始

该子图已部署在以下网络，可直接通过GraphQL接口访问：

• v4.subgraph.mainnet.oceanprotocol.com
• v4.subgraph.polygon.oceanprotocol.com
• v4.subgraph.bsc.oceanprotocol.com
• v4.subgraph.moonriver.oceanprotocol.com
• v4.subgraph.energyweb.oceanprotocol.com
• v4.subgraph.mumbai.oceanprotocol.com

示例查询

所有数据NFT

graphql
{
  nfts(orderBy: createdTimestamp, orderDirection: desc, first: 1000) {
    id
    symbol
    name
    creator
    createdTimestamp
  }
}

注意：子图最多可返回1000条数据

每个用户的总订单数

graphql
{
  users(first: 1000) {
    id
    totalOrders
  }
}

特定用户的总订单数

graphql
{
  user(id: $user) {
    id
    totalOrders
  }
}

注意：所有ETH地址（如上述示例中的$user）需以小写字符串形式传入

所有订单

graphql
{
  orders(orderBy: createdTimestamp, orderDirection: desc, first: 1000){
    amount
    datatoken {
      id
    }
    consumer {
      id
    }
    payer {
      id
    }
  }
}

注意：子图最多可返回1000条数据

在Barge上开发

1. 克隆Barge并在另一个终端中运行：

bash
git clone https://github.com/oceanprotocol/barge.git
cd barge
./start_ocean.sh --with-thegraph

如果之前已克隆Barge，请通过git pull确保使用最新版本。

2. 返回主终端，克隆仓库并安装依赖：

bash
git clone https://github.com/oceanprotocol/ocean-subgraph/
cd ocean-subgraph
npm i

3. 设置智能合约地址文件路径：

bash
export ADDRESS_FILE="${HOME}/.ocean/ocean-contracts/artifacts/address.json"

4. 生成子图：

bash
node ./scripts/generatenetworkssubgraphs.js barge
npm run codegen

5. 部署子图：

bash
npm run create:local
npm run deploy:local

• 或者，可运行npm run quickstart:barge快速启动，该命令会合并步骤4-5。

本地graph-node将运行在：[***]

部署到实时网络

1. 克隆仓库并安装依赖：

bash
git clone https://github.com/oceanprotocol/ocean-subgraph/
cd ocean-subgraph
npm i

2. 生成并部署到Rinkeby测试网：

bash
npm run quickstart:rinkeby

测试

注意：npm run test命令当前因https://github.com/***/graph-ts/issues/113%E6%97%A0%E6%B3%95%E6%AD%A3%E5%B8%B8%E5%B7%A5%E4%BD%9C%E3%80%82

要在本地运行集成测试，先按照上述说明启动Barge，然后在ocean-subgraph文件夹中运行：

bash
export ADDRESS_FILE="${HOME}/.ocean/ocean-contracts/artifacts/address.json"
npm run test-integration

代码风格

可从项目根目录使用以下命令进行代码检查和格式化：

bash
# 使用eslint检查所有js文件
npm run lint

# 使用prettier自动格式化所有js和css文件
npm run format

发布

发布采用半自动化管理，从干净的main分支运行以下命令，根据语义化版本控制更新版本：

bash
npm run release

该命令将：

• 更新package.json和package-lock.json中的项目版本
• 从提交消息自动生成和更新CHANGELOG.md
• 创建Git标签
• 提交并推送所有更改
• 创建带有提交消息描述的GitHub发布
• Git标签推送将触发Travis执行npm发布

执行GitHub发布步骤需要导出GitHub个人访问令牌为GITHUB_TOKEN，https://github.com/release-it/release-it#github-releases

部署

部署ocean-subgraph到本地运行的graph-node（指向主网）：

bash
npm run codegen

# 部署
npm run create:local
npm run deploy:local

要部署到Rinkeby或Ropsten测试网：

bash
# Rinkeby
npm run create:local-rinkeby
npm run deploy:local-rinkeby

# Ropsten
npm run create:local-ropsten
npm run deploy:local-ropsten

编辑事件处理程序代码后运行npm run deploy:local时需注意：

• 如果代码没有更改，部署将失败
• 若部署持续失败：
  • 停止docker-compose运行（docker-compose down或Ctrl+C）
  • 删除/docker/data中的ipfs和postgres文件夹（rm -rf ./docker/data/*）
  • 运行docker-compose up重启graph-node、ipfs和postgres
  • 运行npm run create:local创建ocean-subgraph
  • 运行npm run deploy:local部署ocean-subgraph

要部署到Ocean运行的远程节点之一，可进行端口转发，上述:local命令将照常工作。

许可证

Copyright ((C)) 2023 Ocean Protocol Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   [***]

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.