oceanprotocol/provider-py

Provider

数据服务提供者的REST API

镜像概述和主要用途

Provider是Ocean Protocol技术栈的一部分，提供数据服务的REST API。该组件功能完整，当前为BETA版本。其核心作用是作为数据服务的中间层，管理数据访问流程，确保数据交易的安全性和合规性。

核心功能和特性

主要功能

• 唯一能够访问用户数据的组件
• 在链上执行买家权限和支付检查
• 发布过程中加密URL和元数据
• 数据集下载或计算任务启动时解密URL
• 通过流式传输数据提供资产访问（从不直接暴露URL）
• 提供计算服务（连接到C2D环境）
• 通常由数据提供者运行

技术栈

• Python Flask HTTP服务器

使用场景和适用范围

Provider适用于以下场景：

• 数据提供者需要安全管理其数据资产的访问
• 确保数据交易符合链上权限和支付要求
• 提供数据下载和计算服务，同时保护原始数据URL不被泄露
• 集成到Ocean Protocol生态系统中，作为数据服务的核心中间件

使用方法和配置说明

本地启动服务器

快速启动

使用rinkeby网络和远程元数据存储实例（[***]

bash
git clone git@github.com:oceanprotocol/provider.git
cd provider/

python3 -m venv venv
source venv/bin/activate

pip install -r requirements_dev.txt
cp .env.example .env

flask run --port=8030

详细步骤

1. 克隆仓库

bash
git clone git@github.com:oceanprotocol/provider.git
cd provider/

2. 虚拟环境（可选）

建议在本地运行前设置虚拟环境：

bash
virtualenv venv -p python3.8
# 或：python -m venv venv
source venv/bin/activate

3. 安装依赖

安装所有必要依赖：

bash
pip install -r requirements_dev.txt

4. 依赖项

元数据存储（Aquarius）：选择以下任一方式：

• 本地运行Aquarius，详见 https://github.com/oceanprotocol/aquarius
• 指向远程实例，如 https://aquarius.marketplace.dev-ocean.com。此时需在 config.ini 文件中用相应URL替换 aquarius.url 选项。

***网络：选择以下任一方式：

• 运行ganache-cli
• 指向rinkeby测试网或其他***网络

确保Ocean合约（https://github.com/oceanprotocol/contracts%EF%BC%89%E5%B7%B2%E9%83%A8%E7%BD%B2%E5%88%B0%E6%89%80%E9%80%89%E7%BD%91%E7%BB%9C%E3%80%82%E5%9C%A8 config.ini 文件中用正确的网络URL更新 network 选项（目前必须是URL，未来将支持简单网络名称如mainnet）。

5. 启动Provider服务器

在 .env 文件中添加相应环境变量，示例如下：

FLASK_APP=ocean_provider/run.py
PROVIDER_ADDRESS=你的以太坊地址
PROVIDER_PRIVATE_KEY=私钥或包含chain_id到私钥对的字典字符串
PROVIDER_FEE_TOKEN=用于收取费用的ERC20代币地址或包含chain_id到代币地址对的字典字符串

你可能还需要设置 FLASK_ENV=development。然后运行：

bash
flask run --port=8030

有关端点和负载的详细信息，请参考 API.md 文件。

环境变量

• REQUEST_RETRIES：定义文件下载的重试次数（考虑网络故障和连接问题），默认为1（一次尝试，无重试）
• RBAC_SERVER_URL：定义RBAC权限服务器的URL，默认为None（无特殊权限）
• PRIVATE_PROVIDER：若设置，会在RBAC请求中添加"providerAccess": "private"键值对
• REDIS_CONNECTION：定义Redis连接URL，默认为None（无Redis连接时使用SQLite数据库）
• TEST_PRIVATE_KEY1 和 TEST_PRIVATE_KEY2：发布者和消费者测试用的***私钥
• OPERATOR_SERVICE_URL：定义与C2D的连接
• LOG_CFG 和 LOG_LEVEL：分别定义日志文件位置和日志级别
• IPFS_GATEWAY：定义用于解析URL的IPFS网关
• ARWEAVE_GATEWAY：定义用于解析Arweave交易ID的Arweave网关
• AUTHORIZED_DECRYPTERS：允许解密链数据的授权地址列表，用于限制访问（如自定义Aquarius实例），默认为空（允许所有解密者）
• USE_CHAIN_PROOF 或 USE_HTTP_PROOF：设置保存下载证明信息的机制。若USE_CHAIN_PROOF为真值，证明将发送到链上；USE_HTTP_PROOF需配置接受POST请求的HTTP端点
• MAX_CHECKSUM_LENGTH：定义需要校验和的文件最大长度，若文件大小超过此值，则不计算校验和

提交前准备

若你是贡献者，请确保使用 pre-commit install 命令安装预提交钩子。这将确保提交前代码导入已排序且格式正确。我们使用 black、isort 和 flake8 保持代码整洁。

还可使用 licenseheaders -t .copyright.tmpl -x venv 命令为提交添加许可证头（将"venv"替换为本地虚拟环境路径）。此选项不作为预提交钩子，因为执行时间较长。

版本控制和发布

要发布Provider的新版本，请遵循 发布流程 中描述的步骤。