oceanprotocol/brizo

https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png]([***]

Brizo

帮助数据发布者提供扩展数据服务（如存储和计算）。 oceanprotocol.com

"🏄‍♀️🌊 Brizo是古希腊女神，被称为水手和渔民的保护者。她主要受到德洛斯岛女性的崇拜，她们会用小船摆放食物供品。Brizo也是一位擅长解读梦境的先知。"

![Travis (.com)]([] ![Codacy coverage]([] ![PyPI]([***]

🐲🦑 注意：此项目处于Alpha阶段，可能会遇到问题。如果遇到问题，请提交新的Issue：https://github.com/oceanprotocol/brizo/issues%E3%80%82 🦑🐲

目录

• 功能特点
• 本地运行（开发和测试）
• API文档
• 配置说明
• Compute-to-Data设置
• 依赖项
• 代码风格
• 测试
• 调试
• 版本更新
• 许可证

功能特点

在Ocean生态系统中，Brizo是由数据发布者执行的技术组件，用于提供扩展数据服务（如存储和计算）。Brizo作为发布者生态的一部分，包含与基础设施（最初是云，也可以是本地部署）交互的凭据。

主要功能包括：

• 数据访问：通过/services/consume端点，数据集文件会流式返回给用户，而不暴露实际URL。
• 计算到数据：通过/services/compute端点，计算算法会通过计算提供者的服务操作器端点远程执行。

详细功能可参考Brizo API文档。

本地运行（开发和测试）

如果您想贡献Brizo的开发，可以按照以下步骤操作（生产环境运行需另行配置）：

克隆仓库

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

设置虚拟环境

bash
virtualenv venv -p python3.6
source venv/bin/activate 

安装依赖

bash
pip install -r requirements_dev.txt

运行依赖服务（使用Barge）

bash
git clone git@github.com:oceanprotocol/barge.git
cd barge
bash start_ocean.sh --no-brizo --no-commons

Barge是Ocean Docker Compose文件的仓库，start_ocean.sh --no-brizo会启动Ocean项目所需的服务（不含Brizo实例）。更多信息请参考https://github.com/oceanprotocol/barge%E3%80%82

启动Brizo

使用Flask（HTTP）

bash
export FLASK_APP=brizo/run.py
export CONFIG_FILE=config.ini
./scripts/wait_for_migration_and_extract_keeper_artifacts.sh
export PROVIDER_ADDRESS="您的以太坊地址"
# 设置以下任一变量
export PROVIDER_KEY="私钥"
export PROVIDER_ENCRYPTED_KEY="密钥文件中的加密JSON"
export PROVIDER_KEYFILE="您的以太坊地址"
# 如果使用PROVIDER_KEYFILE或PROVIDER_ENCRYPTED_KEY，需设置密码
export PROVIDER_PASSWORD="解密密钥的密码"

flask run --port=8030

使用Gunicorn（HTTPS）

首先生成测试证书：

bash
openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 365
# Common Name（CN）填写localhost

编辑config.ini：

ini
brizo.url = https://localhost:8030

启动Gunicorn：

bash
gunicorn --certfile cert.pem --keyfile key.pem -b 0.0.0.0:8030 -w 1 brizo.run:app

API文档

启动Brizo后，可访问API文档：

bash
https://127.0.0.1:8030/api/v1/docs

也可参考官方文档：Brizo API文档。

配置说明

Brizo优先从环境变量CONFIG_FILE指定的路径加载配置，否则使用config.ini。部分配置可通过环境变量覆盖。

配置文件 sections

[keeper-contracts]

用于设置与keeper节点的连接和加载合约 artifacts。

[resources]

配置：

• 默认元数据存储（Aquarius）URI
• 默认Brizo URI
• 计算服务的操作器服务URI

[***]

发布者可在此配置第三方服务凭据（如Azure Storage）。Brizo支持以下存储类型：

• Azure Storage：URL包含"core.windows.net"
• Amazon S3：URL以"s3://"开头
• IPFS：URL以"ipfs://"开头
• 本地存储：其他可解析的URL

Azure Storage配置

在config.ini的[osmosis]部分设置：

ini
[osmosis]
azure.account.name = <Azure存储账户名>
azure.account.key = <Azure存储账户密钥>
azure.resource_group = <Azure资源组>
azure.location = <Azure区域>
azure.client.id = <Azure应用ID>
azure.client.secret = <Azure应用密钥>
azure.tenant.id = <Azure租户ID>
azure.subscription.id = <Azure订阅ID>
azure.share.input = compute
azure.share.output = output

也可通过环境变量覆盖：AZURE_ACCOUNT_NAME、AZURE_ACCOUNT_KEY等。

Amazon S3配置

无需在config.ini中设置，凭据存储在其他位置，参考Amazon S3教程。

IPFS配置

设置环境变量IPFS_GATEWAY（默认值：[***]

本地存储配置

无需特殊设置，只需确保文件URL可被Brizo解析，参考本地存储教程。

Compute-to-Data设置

支持计算到数据功能需：

1. 设置操作器服务URI：
   • 在config.ini的[resources]部分设置operator_service.url
   • 或环境变量OPERATOR_SERVICE_URL
2. 将提供者***地址添加到操作器服务的已知提供者列表（仅接受已知提供者的签名请求）
3. 部署操作器服务、引擎和Kubernetes基础设施，参考https://github.com/oceanprotocol/operator-service%E3%80%82

依赖项

Brizo依赖以下Ocean库：

• https://github.com/oceanprotocol/common-utils-py%EF%BC%9AOcean%E7%BB%84%E4%BB%B6%E4%BA%A4%E4%BA%92%E7%9A%84%E9%80%9A%E7%94%A8%E5%87%BD%E6%95%B0%E5%92%8C%E6%95%B0%E6%8D%AE%E7%BB%93%E6%9E%84
• https://github.com/oceanprotocol/keeper-py-lib%EF%BC%9A%E5%A4%84%E7%90%86keeper%E4%BA%A4%E4%BA%92
• https://github.com/oceanprotocol/secret-store-client-py%EF%BC%9A%E5%8A%A0%E5%AF%86/%E8%A7%A3%E5%AF%86%E6%95%B0%E6%8D%AE%E9%9B%86URL
• https://github.com/oceanprotocol/***-azure-driver%EF%BC%9AAzure%E8%B5%84%E4%BA%A7%E8%AE%BF%E9%97%AE
• https://github.com/oceanprotocol/***-aws-driver%EF%BC%9AAWS%E8%B5%84%E4%BA%A7%E8%AE%BF%E9%97%AE
• https://github.com/oceanprotocol/***-on-premise-driver%EF%BC%9A%E6%9C%AC%E5%9C%B0%E8%B5%84%E4%BA%A7%E8%AE%BF%E9%97%AE

代码风格

参考Ocean的Python开发指南：

• https://github.com/oceanprotocol/dev-ocean/blob/master/doc/development/python-developer-guide.md
• https://github.com/oceanprotocol/dev-ocean/blob/master/doc/development/python-style-guide.md

测试

通过Travis自动执行测试（配置在.travis.yaml），使用tox和pytest框架。

调试

使用PyCharm调试Brizo：

1. 克隆Barge仓库
2. 运行Barge（不含Brizo）：bash start_ocean.sh --no-brizo --no-commons --local-nile-node
3. PyCharm设置：Settings > Project Settings > Python Debugger，勾选"Gevent Compatible"
4. 配置调试器：Run > Edit Configurations，添加新配置（Python类型），设置脚本路径为brizo/run.py，工作目录为项目根目录
5. 设置环境变量（如CONFIG_FILE=config.ini、Azure凭据等）
6. 设置断点并开始调试

版本更新

使用bumpversion.sh脚本更新版本，参数为major/minor/patch：

bash
./bumpversion.sh patch

许可证

text
Copyright 2018 Ocean Protocol Foundation Ltd.

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.