From aa5a2a61d8a857c5dc8ad42785c6a31e79acadf7 Mon Sep 17 00:00:00 2001 From: shawn_shaw Date: Wed, 8 Jan 2025 00:41:57 +0800 Subject: [PATCH 01/32] Add a language switcher in README.md file. And create a README_zh_CN.md file that is a Cinnese translation copy of README.md. Signed-off-by: shawn_shaw --- README.md | 4 + README_zh_CN.md | 348 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 352 insertions(+) create mode 100644 README_zh_CN.md diff --git a/README.md b/README.md index 6123bdcd69..b5ef9179a7 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,10 @@ Hyperledger FireFly is the first open source Supernode: a complete stack for ent The FireFly API for digital assets, data flows, and blockchain transactions makes it radically faster to build production-ready apps on popular chains and protocols. +## Language switcher for FireFly README.md + * en [ENGLISH](./README.md) + * zh_CN [简体中文](./README_zh_CN.md) + ## Start using Hyperledger FireFly The best place to learn about FireFly is in the [documentation](https://hyperledger.github.io/firefly). diff --git a/README_zh_CN.md b/README_zh_CN.md new file mode 100644 index 0000000000..cc983890c6 --- /dev/null +++ b/README_zh_CN.md @@ -0,0 +1,348 @@ +# Hyperledger FireFly + +[![codecov](https://codecov.io/gh/hyperledger/firefly/branch/main/graph/badge.svg?token=QdEnpMqB1G)](https://codecov.io/gh/hyperledger/firefly) +[![Go Report Card](https://goreportcard.com/badge/github.com/hyperledger/firefly)](https://goreportcard.com/report/github.com/hyperledger/firefly) +[![FireFy Documentation](https://img.shields.io/static/v1?label=FireFly&message=documentation&color=informational)](https://hyperledger.github.io/firefly//) +![build](https://github.com/hyperledger/firefly/actions/workflows/docker_main.yml/badge.svg?branch=main) +[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7826/badge)](https://www.bestpractices.dev/projects/7826) + +![Hyperledger FireFly](./images/hyperledger_firefly_logo.png) + +Hyperledger FireFly 是HyperLedger出品的首款开源超级节点：企业构建和拓展一个安全的Web3应用的全栈式解决方案。 + +FireFly 的数字资产、数据流和区块链交易上的API能够让企业能够在众多流行区块链和各种流行协议迅速构建起开箱即用的应用。 + +## FireFly README.md 文件语言选择 + * en [ENGLISH](./README.md) + * zh_CN [简体中文](./README_zh_CN.md) + +## 开始使用 Hyperledger FireFly + +学习使用FireFly的最佳方式: [文档](https://hyperledger.github.io/firefly). + +在这里你能够找到 [开始指引](https://hyperledger.github.io/firefly/latest/gettingstarted/), +在文档的指导下，你几分钟就可以在你的本地机器上运行起来FireFly超级节点。 + +你的本地机器将会安装上: + +FireFly CLI | FireFly Explorer UI | FireFly Sandbox | +:----------------------------:|:-----------------------------------:|:----------------:| +[![CLI](./images/firefly_cli.png)](https://hyperledger.github.io/firefly/latest/gettingstarted/firefly_cli/#install-the-firefly-cli) | [![UI](./images/firefly_explorer.png)](https://github.com/hyperledger/firefly-ui) | [![Sandbox](./images/firefly_sandbox.png)](https://hyperledger.github.io/firefly/latest/gettingstarted/sandbox/#use-the-sandbox) | + +## 与FireFly社区取得联系 + +- [加入我们的 Discord](https://discord.gg/hyperledger) + +## 技术架构 + +Hyperledger FireFly 有着插件式的微服务架构。FireFly的所有服务都是插件式的，例如区块链技术、token ERC标准、自定义智能合约甚至到事件分发层以及私有数据库都是可插拔的。 + +假如你在FireFly的技术架构图中还未发现你喜爱的区块链技术，你也不必担心。FireFly提供了清晰明确的方式可以让你去拓展，从而避免你花费大量时间去重新构建你自己的区块链应用程序。 + +[![Hyperledger FireFly 技术架构图](./doc-site/docs/images/firefly_architecture_overview.jpg)](https://raw.githubusercontent.com/kaleido-io/firefly/main/doc-site/docs/images/firefly_architecture_overview.jpg) + +## 开始向 Hyperledger FireFy 产生贡献 + +你有很多种方式可以对 Hyperledger FireFly 项目产生贡献，无论你的技术栈是前端、后端或者全栈。 + +点击 [贡献指引](https://hyperledger.github.io/firefly/latest/contributors/)， **欢迎!**. + +## 其他项目库 + +你当前处在“核心”库中，这是一个用Go语言编写的和有着托管API服务器和中央协调引擎的库。在这里你可找到用各种语言（TypeScript、Java以及其他重量级运行环境组件）编写的插件式微服务组件。 + +你可能感兴趣的其他项目包含着微服务组件、用户体验、控制台和样例的库如下 + +> 提示：只罗列开源库和插件 + +### 区块链连接 + +- Transaction Manager - https://github.com/hyperledger/firefly-transaction-manager +- RLP & ABI encoding, KeystoreV3 utilities and secp256k1 signer runtime - https://github.com/hyperledger/firefly-signer +- FFCAPI reference connector for EVM Chains - https://github.com/hyperledger/firefly-evmconnect + - Public EVM compatible chains: Learn more in the [documentation](https://hyperledger.github.io/firefly) +- Permissioned Ethereum connector - https://github.com/hyperledger/firefly-ethconnect + - Private/permissioned: Hyperledger Besu / Quorum +- Hyperledger Fabric connector - https://github.com/hyperledger/firefly-fabconnect +- Tezos connector - https://github.com/hyperledger/firefly-tezosconnect +- Corda connector starter: https://github.com/hyperledger/firefly-cordaconnect + - CorDapp specific customization is required + +### Token 标准 + +- Tokens ERC20/ERC721 - https://github.com/hyperledger/firefly-tokens-erc20-erc721 +- Tokens ERC1155 - https://github.com/hyperledger/firefly-tokens-erc1155 + +### 私有数据总线连接 + +- HTTPS Data Exchange - https://github.com/hyperledger/firefly-dataexchange-https + +### 开发者生态系统 + +- Command Line Interface (CLI) - https://github.com/hyperledger/firefly-cli +- Explorer UI - https://github.com/hyperledger/firefly-ui +- Node.js SDK - https://github.com/hyperledger/firefly-sdk-nodejs +- Sandbox / Exerciser - https://github.com/hyperledger/firefly-sandbox +- Samples - https://github.com/hyperledger/firefly-samples +- FireFly Performance CLI: https://github.com/hyperledger/firefly-perf-cli +- Helm Charts for Deploying to Kubernetes: https://github.com/hyperledger/firefly-helm-charts + +## FireFly 核心代码层级结构 + +``` +┌──────────┐ ┌───────────────┐ +│ cmd ├──┤ firefly [Ff]│ - 控制台接入 +└──────────┘ │ │ - 父级上下文创建 + │ │ - 信号控制 + └─────┬─────────┘ + │ +┌──────────┐ ┌─────┴─────────┐ - HTTP 监听 (Gorilla mux) +│ internal ├──┤ api [As]│ * TLS (SSL), CORS 配置等. +└──────────┘ │ server │ * 同一端口上的 WS 升级 + │ │ - REST 路由定义 + └─────┬─────────┘ * 仅限简单的路由逻辑，所有处理均推迟到协调器 + │ + ┌─────┴─────────┐ - REST 路由定义框架 + │ openapi [Oa]│ * 标准化 Body，Path，Query， Filter 语义 + │ spec | - OpenAPI 3.0 (Swagger) 生成器 + └─────┬─────────┘ * 包括 Swagger. UI + │ + ┌─────┴─────────┐ - WebSocket 服务器 + │ [Ws]│ * 开发者友好型的基于JSON的业务应用程序开发 + │ websockets │ * 可靠的顺序传递 + └─────┬─────────┘ * _Event interface [Ei] 支持集成其他计算框架/传输层_ + │ + ┌─────┴─────────┐ - 监听数据库事件改变的拓展接口 + │ admin [Ae]│ * 对于搭建核心服务外的微服务拓展应用可用 + │ events | * 可用于事务管理组件 + └─────┬─────────┘ * 特定对象类型过滤 + │ + ┌─────┴─────────┐ - 核心数据类型 + │ fftypes [Ft]│ * 用于 API 和序列化 + │ │ * 通过路由定义，APIs 可以实现隐藏输入属性 + └─────┬─────────┘ + │ + ┌─────┴─────────┐ - 核心运行时环境服务器，初始化和拥有以下的实例: + │ [Or]│ * Components：特性实现 + ┌───────┬───┤ orchestrator │ * Plugins：可插拔设施服务 + │ │ │ │ - 向路由暴露行为 + │ │ └───────────────┘ * 所有的API调用将会在这里开始处理 + │ │ + │ Components: 引擎里的组件将会做重量级的任务 + │ │ + │ │ ┌───────────────┐ - 通过跨链技术整合区块链智能合约逻辑 + │ ├───┤ contract [Cm]│ * 为智能合约生成 OpenAPI 3 / Swagger 定义，并且传播到网络中 + │ │ │ manager │ * 为了本地区块链事件管理监听, 并且路由这些应用事件 + │ │ └───────────────┘ * 转化 to/from 本地区块链接口 (ABI etc.) 和 FireFly Interface [FFI] 格式 + │ │ + │ │ ┌───────────────┐ - 维护整个网络的视图 + │ ├───┤ network [Nm]│ * 集成网络权限 [NP] 插件 + │ │ │ map │ * 集成广播插件 + │ │ └───────────────┘ * 控制成员身份、节点身份、签名身份的层级 + │ │ + │ │ ┌───────────────┐ - 广播数据给所有网络中的成员 + │ ├───┤ broadcast [Bm]│ * 实现批量组件的分发 + │ │ │ manager | * 集成 共享存储接口 [Ss] 插件 + │ │ └───────────────┘ * 集成区块链接口 [Bi] 插件 + │ │ + │ │ ┌───────────────┐ - 发送私有数据给网络中的成员 + │ ├───┤ private [Pm]│ * 实现批处理组件的调度器 + │ │ │ messaging | * 集成数据交换 [Dx] 插件 + │ │ └──────┬────────┘ * 消息可以通过区块链固定或者排序，或者仅发送 + │ │ │ + │ │ ┌──────┴────────┐ - 有着数据隔离的区块链或者成员群组 + │ │ │ group [Gm]│ * 集成数据交换 [Dx] 插件 + │ │ │ manager │ * 集成区块链接口 [Bi] 插件 + │ │ └───────────────┘ + │ │ + │ │ ┌───────────────┐ - 私有数据管理和验证 + │ ├───┤ data [Dm]│ * 实现批量组件的调度器 + │ │ │ manager │ * 集成数据交换 [Dx] 插件 + │ │ └──────┬────────┘ * 集成区块链接口 [Bi] 插件 + │ │ │ + │ │ ┌──────┴────────┐ - JSON数据语法管理和验证 (架构可以拓展到XML或者其他) + │ │ │ json [Jv]│ * 站内和站外消息的JSON语法管理和验证 + │ │ │ validator │ * 语法传播 + │ │ └──────┬────────┘ * 集成广播插件 + │ │ │ + │ │ ┌──────┴────────┐ - 可通过ID或者hash寻址的二进制数据存储 + │ │ │ blobstore [Bs]│ * 集成数据交换 [Dx] 插件 + │ │ │ │ * 对数据进行hash化处理, 并且在blob存储中维护负载引用的映射 + │ │ └───────────────┘ * 集成区块链接口 [Bi] 插件 + │ │ + │ │ ┌───────────────┐ - 从共享存储中下载 + │ ├───┤ shared [Sd]│ * 并行异步下载 + │ │ │ download │ * 弹性重试和异步恢复 + │ │ └───────────────┘ * 完成后通知事件聚合器 + │ │ + │ │ ┌───────────────┐ + │ ├───┤ identity [Im] │ - 跨组件中心化身份管理服务 + │ │ │ manager │ * 解决API输入 identity + key 组合 (短名称, 格式等) + │ │ │ │ * 解决将已注册的链上签名返回身份 + │ │ └───────────────┘ * 集成区块链接口和可插拔身份接口（待定） + │ │ + │ │ ┌───────────────┐ - 通过插件跟踪对外部组件执行的所有操作 + │ ├───┤ operation [Om]│ * 以输入、输出更新数据库 + │ │ │ manager │ * 提供跨插件的一致性重试语义 + │ │ └───────────────┘ + │ │ + │ │ ┌───────────────┐ - 私有数据管理和验证 + │ ├───┤ event [Em]│ * 实现批量组件的调度器 + │ │ │ manager │ * 集成数据交换 [Dx] 插件 + │ │ └──────┬────────┘ * 集成区块链接口 [Bi] 插件 + │ │ │ + │ │ ┌──────┴────────┐ - 控制外部数据接收 + │ │ │ [Ag]│ * 集成数据交换 [Dx] 插件 + │ │ │ aggregator │ * 集成共享数据接口 [Ss] 插件 + │ │ │ │ * 集成区块链接口 [Bi] 插件 + │ │ │ │ - 确保只有所有数据都可用时有效事件才会被分发 + │ │ └──────┬────────┘ * 上下文感知，避免“全局阻塞”场景的出现 + │ │ │ + │ │ ┌──────┴────────┐ - 订阅管理 + │ │ │ [Sm]│ * 创建和管理订阅 + │ │ │ subscription │ * 创建和管理订阅 + │ │ │ manager │ * 发消息到事件匹配逻辑 + │ │ └──────┬────────┘ + │ │ │ + │ │ ┌──────┴────────┐ - 管理事件到已连接应用的传递 + │ │ │ event [Ed]│ * 集成数据交换 [Dx] 插件 + │ │ │ dispatcher │ * 集成区块链接口 [Bi] 插件 + │ │ └───────────────┘ + │ │ + │ │ ┌───────────────┐ - Token 创建、传输的初始化、索引和协同 + │ ├───┤ asset [Am]│ * 可替代 Token: 数字化价值/结算 (coins) + │ │ │ manager │ * 不可替代 tokens: NFTs / globally uniqueness / digital twins + │ │ └───────────────┘ * 交易历史的全索引 + │ │ [REST/WebSockets] + │ │ ┌─────┴─────────────┐ ┌──────────┐ ┌─ + │ │ │ ERC-20 / ERC-721 ├───┤ ERC-1155 ├───┤ 创建 token 连接器的简单框架 + │ │ └───────────────────┘ └──────────┘ └─ + │ │ + │ │ ┌───────────────┐ + │ ├───┤ sync / [Sa] │ - 同步、异步桥接 + │ │ │ async bridge │ * 提供同步请求、应答APIs + │ │ │ │ * 转换为底层事件驱动API + │ │ └───────────────┘ + │ │ + │ │ ┌───────────────┐ - 聚合报文和数据，并汇总hash值以进行固定 + │ ├───┤ batch [Ba]│ * 可插拔调度器 + │ │ │ manager │ - 数据库和主线API处理分离 + │ │ │ │ * 有关主动、主动排序的更多信息，请参考架构图 + │ │ └──────┬────────┘ - 管理批处理器的创建 + │ │ │ + │ │ ┌──────┴────────┐ - 短暂的代理启动以按需组装批次 + │ │ │ batch [Bp]│ * 与作者+消息类型耦合 + │ │ │ processor │ - 批量构建100多条信息以实现高效固定 + │ │ │ │ * 聚合消息和数据，并汇总hash值以进行固定 + │ │ └───────────────┘ - 配置失效后自动关闭 + │ ... 更多待定 + │ +Plugins: 每个插件都包含一个Go shim，以及一个远程代理微服务运行环境(有需要的话) + │ + │ ┌───────────────┐ - 区块链接口 + ├───────────┤ [Bi]│ * 交易提交 - 包括签名秘钥管理 + │ │ blockchain │ * 事件监听 + │ │ interface │ * 标准化操作，和自定义链上耦合 + │ └─────┬─────────┘ + │ │ + │ ├─────────────────────┬───────────────────┬-───────────────────┐ + │ ┌─────┴─────────┐ ┌───────┴───────┐ ┌───────┴────────┐ ┌───────┴────────┐ + │ │ ethereum │ │ fabric │ │ corda/cordapps │ │ tezos │ + │ └─────┬─────────┘ └───────────────┘ └────────────────┘ └────────────────┘ + │ [REST/WebSockets] + │ ┌─────┴────────────────────┐ ┌────────────────────────┐ ┌─ + │ │ transaction manager [Tm] ├───┤ Connector API [ffcapi] ├───┤ 构建区块链连接器的简单框架 + │ └──────────────────────────┘ └────────────────────────┘ └─ + │ + │ ┌───────────────┐ - Token 接口 + ├───────────┤ tokens [Ti]│ * 标准化的核心概念：token pools，transfers，approvals + │ │ interface │ * 可插拔的跨 token 标准 + │ └───────────────┘ * 通过微服务连接器针对自定义 token 标准的简单实现方式的支持 + │ [REST/WebSockets] + │ ┌─────┴─────────────┐ ┌──────────┐ ┌─ + │ │ ERC-20 / ERC-721 ├───┤ ERC-1155 ├───┤ 构建 token 连接器的简单框架 + │ └───────────────────┘ └──────────┘ └─ + │ + │ ┌───────────────┐ - P2P 内容寻址文件系统 + ├───────────┤ shared [Si]│ * 负载 上传 / 下载 + │ │ storage │ * 有效的负载参考管理 + │ │ interface │ + │ └─────┬─────────┘ + │ │ + │ ├───────── ... 可拓展至任意共享存储系统，可供所有成员访问 + │ ┌─────┴─────────┐ + │ │ ipfs │ + │ └───────────────┘ + │ + │ ┌───────────────┐ - 私有数据交换 + ├───────────┤ data [Dx]│ * Blob 存储 + │ │ exchange │ * 私有加密消息传递 + │ └─────┬─────────┘ * 加密文件传输 + │ │ + │ ├─────────────────────┬────────── ... 可拓展至任意私有数据交换技术 + │ ┌─────┴─────────┐ ┌───────┴───────┐ + │ │ https / MTLS │ │ Kaleido │ + │ └───────────────┘ └───────────────┘ + │ + │ ┌───────────────┐ - API 认证和认证接口 + ├───────────┤ api auth [Aa]│ * 验证加密凭证 (OpenID Connect id token JWTs etc.) + │ │ │ * 提取 API/user 身份 (用于身份接口映射) + │ └─────┬─────────┘ * 细粒度 API 访问控制的执行点 + │ │ + │ ├─────────────────────┬────────── ... 可拓展到任意单点登录技术 + │ ┌─────┴─────────┐ ┌───────┴───────┐ + │ │ apikey │ │ jwt │ + │ └───────────────┘ └───────────────┘ + │ + │ ┌───────────────┐ - 数据库集成 + ├───────────┤ database [Di]│ * 创建, 读取, 更新, 删除 (CRUD) 操作 + │ │ interface │ * 过滤和更新定义接口 + │ └─────┬─────────┘ * 迁移和索引 + │ │ + │ ├───────── ... 可拓展至任意NoSql (CouchDB / MongoDB etc.) + │ ┌─────┴─────────┐ + │ │ sqlcommon │ + │ └─────┬─────────┘ + │ ├───────────────────────┬───────── ... 可拓展至其他SQL数据库 + │ ┌─────┴─────────┐ ┌───────┴────────┐ + │ │ postgres │ │ sqlite3 │ + │ └───────────────┘ └────────────────┘ + │ + │ ┌───────────────┐ - 将核心事件引擎连接至外部框架和应用 + ├───────────┤ event [Ei]│ * 支持长周期 (可持续的) 和短暂的事件订阅 + │ │ interface │ * 批量、过滤，所有的传输都会在核心区域进行处理 + │ └─────┬─────────┘ * 接口支持连接输入 (websocket) 和连接输出 (代理运行环境插件) 插件 + │ │ + │ ├───────────────────────┬────────── ... 可拓展至其他的事件总线 (Kafka, NATS, AMQP etc.) + │ ┌─────┴─────────┐ ┌───────┴────────┐ + │ │ websockets │ │ webhooks │ + │ └───────────────┘ └────────────────┘ + │ ... 更多待定 + + 额外的工具类框架 + ┌───────────────┐ - REST API 客户端 + │ rest [Re]│ * 提供便利性和日志 + │ client │ * 标准的认证, 配置和重试逻辑 + └───────────────┘ * 构建和重试 + + ┌───────────────┐ - WebSocket 客户端 + │ wsclient [Wc]│ * 提供便利性和日志 + │ │ * 标准化认证，配置和重连逻辑 + └───────────────┘ * 构建于 Gorilla WebSockets + + ┌───────────────┐ - 翻译框架 + │ i18n [In]│ * 所有翻译内容必须要添加到 `en_translations.json` - 用 `FF10101` 作为 key + │ │ * 错误会被打包, `error` 包内提供了额外的特性 (堆栈等.) + └───────────────┘ * 也支持描述翻译, 例如 OpenAPI 描述 + + ┌───────────────┐ - 日志框架 + │ log [Lo]│ * 日志框架 (logrus) 集成了上下文标签 + │ │ * 上下文贯穿整个代码，用于传递API调用上下文以及日志上下文 + └───────────────┘ * 样例: 所有的API调用都有着可追溯ID, 以及时长 + + ┌───────────────┐ - 配置 + │ config [Co]│ * 基于日志框架的文件和环境变量 (viper) + │ │ * 主要配置key全部集中定义 + └───────────────┘ * 插件通过返回其配置结构进行集成 (JSON 标签) + +``` From b11017dbd5c167cebc5e1c0a42a8c62991354bbe Mon Sep 17 00:00:00 2001 From: shawn_shaw Date: Wed, 8 Jan 2025 15:07:44 +0800 Subject: [PATCH 02/32] translated doc-site's README.md file into Simplified Chinese Signed-off-by: shawn_shaw --- doc-site/README_zh_CN.md | 73 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 doc-site/README_zh_CN.md diff --git a/doc-site/README_zh_CN.md b/doc-site/README_zh_CN.md new file mode 100644 index 0000000000..e3da7dab48 --- /dev/null +++ b/doc-site/README_zh_CN.md @@ -0,0 +1,73 @@ +# Hyperledger FireFly 文档站 + +此目录基于 [Hyperledger 文档模板](https://github.com/hyperledger-labs/documentation-template)。 该文档使用 MkDocs ( 文档在 [mkdocs.org](https://www.mkdocs.org) ) 和 Material 的主题 (文档在[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/))。 Material 主题给 MkDocs 添加了一系列的主题，让 Hyperledger 的代码库具有采取这些主题 [Insiders](https://squidfunk.github.io/mkdocs-material/insiders/) 的能力. + +[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/ +[Mike]: https://github.com/jimporter/mike + +## 前置条件 + +需要以下工具去测试这些文档和升级已发布的站点: + +- A Bash shell +- git +- Python 3 +- [Material for Mkdocs] 主题. +- 用于发布到 gh-pages 的 [Mike] MkDocs 插件。 + - 非本地使用，但是需要在 `mkdocs.yml` 文件引用到， 并且在将站点部署到 gh-pages 的时候使用到。 + +### git + +`git` 可以本地安装，你可以在 [Install Git Guide from GitHub](https://github.com/git-guides/install-git) 找到安装指引。 + +### Python 3 + +`Python 3` 可以本地安装，你可以在 [Python Getting Started guide](https://www.python.org/about/gettingstarted/) 找到安装指引。 + +### 虚拟环境 + +为了避免在你的本机环境上存在 python 安装的冲突，安装一个 python 虚拟环境是值得推荐的。这也能避免你在计算机上全局安装这个项目的依赖。 + + +```bash +cd doc-site +python3 -m venv venv +source venv/bin/activate +``` + +### Mkdocs + +Mkdocs 相关的内容也可以在本地安装，正如 [Material for Mkdocs] 指引所说。以下是简短的、针对具体版本的安装说明： + + +```bash +pip install -r requirements.txt +``` + +### 确认安装 + +为了确认安装的 `mkdocs` 生效， 你可以运行 `mkdocs --help` 看看有没有生成帮助文档。 + +## 一些有用的 MkDocs 命令 + +以下是 `mkdocs` 可以使用的命令: + +- `mkdocs serve` - 启动一个动态刷新的文档服务器。 +- `mkdocs build` - 构建这个文档站点。 +- `mkdocs -h` - 打印帮助信息和退出。 + +## 添加内容 + +以下是在这个文档站中添加内容的基本流程： + +- 在 `docs` 文件夹创建一个新的 markdown 文档。 +- 将新文件添加到目录中 ( `mkdocs.yml` 文件 的 `nav` 标签 ) + +如果你使用这个模板去生成你自己的文档， 请点击 [自定义指引](./docs/index.md). + +## 代码库布局 + + mkdocs.yml # 配置文件。 + docs/ + index.md # 文档主页。 + ... # 其他 markdown 页面，图片和文件。 From dc7974c5533ef50ec2c884de994f0868de15aa5a Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Thu, 9 Jan 2025 21:45:26 +0800 Subject: [PATCH 03/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index cc983890c6..7e9ba745db 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -12,9 +12,7 @@ Hyperledger FireFly 是HyperLedger出品的首款开源超级节点：企业构 FireFly 的数字资产、数据流和区块链交易上的API能够让企业能够在众多流行区块链和各种流行协议迅速构建起开箱即用的应用。 -## FireFly README.md 文件语言选择 - * en [ENGLISH](./README.md) - * zh_CN [简体中文](./README_zh_CN.md) +[ENGLISH](./README.md) | [简体中文](./README_zh_CN.md) ## 开始使用 Hyperledger FireFly From c200ea250973c695db244ef766bb894ac152ff9d Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Thu, 9 Jan 2025 21:46:43 +0800 Subject: [PATCH 04/32] Update README.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b5ef9179a7..0178901338 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,8 @@ Hyperledger FireFly is the first open source Supernode: a complete stack for ent The FireFly API for digital assets, data flows, and blockchain transactions makes it radically faster to build production-ready apps on popular chains and protocols. -## Language switcher for FireFly README.md - * en [ENGLISH](./README.md) - * zh_CN [简体中文](./README_zh_CN.md) + +[ENGLISH](./README.md) | [简体中文](./README_zh_CN.md) ## Start using Hyperledger FireFly From fdb1a9267d22e17f6fdd0a2f1e16dfa51290c415 Mon Sep 17 00:00:00 2001 From: shawn_shaw Date: Thu, 9 Jan 2025 22:03:17 +0800 Subject: [PATCH 05/32] add switcher in doc-site's readme file Signed-off-by: shawn_shaw --- doc-site/README.md | 2 ++ doc-site/README_zh_CN.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/doc-site/README.md b/doc-site/README.md index dc16945bc3..ed5336a896 100644 --- a/doc-site/README.md +++ b/doc-site/README.md @@ -5,6 +5,8 @@ This directory is based on the [Hyperledger documentation template](https://gith [Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/ [Mike]: https://github.com/jimporter/mike +[ENGLISH](./README.md) | [简体中文](./README_zh_CN.md) + ## Prerequisites To test the documents and update the published site, the following tools are needed: diff --git a/doc-site/README_zh_CN.md b/doc-site/README_zh_CN.md index e3da7dab48..d452a6cab1 100644 --- a/doc-site/README_zh_CN.md +++ b/doc-site/README_zh_CN.md @@ -5,6 +5,8 @@ [Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/ [Mike]: https://github.com/jimporter/mike +[ENGLISH](./README.md) | [简体中文](./README_zh_CN.md) + ## 前置条件 需要以下工具去测试这些文档和升级已发布的站点: From d5dc9a0b5d282287ce5bf6d66ba19930cd32d902 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Fri, 10 Jan 2025 22:55:19 +0800 Subject: [PATCH 06/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 7e9ba745db..1e6252f59b 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -8,7 +8,7 @@ ![Hyperledger FireFly](./images/hyperledger_firefly_logo.png) -Hyperledger FireFly 是HyperLedger出品的首款开源超级节点：企业构建和拓展一个安全的Web3应用的全栈式解决方案。 +Hyperledger FireFly 是首款开源的超级节点：一个安全的企业级的构建和拓展Web3应用的全栈式解决方案。 FireFly 的数字资产、数据流和区块链交易上的API能够让企业能够在众多流行区块链和各种流行协议迅速构建起开箱即用的应用。 From 64a85db2982dd1bcc227699b8630a9832311a728 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Fri, 10 Jan 2025 22:56:04 +0800 Subject: [PATCH 07/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 1e6252f59b..e1225752ab 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -10,7 +10,7 @@ Hyperledger FireFly 是首款开源的超级节点：一个安全的企业级的构建和拓展Web3应用的全栈式解决方案。 -FireFly 的数字资产、数据流和区块链交易上的API能够让企业能够在众多流行区块链和各种流行协议迅速构建起开箱即用的应用。 +FireFly 提供的数字资产、数据流和区块链交易的 API，使企业能够快速在流行的区块链链技术和协议上构建生产就绪的应用程序。 [ENGLISH](./README.md) | [简体中文](./README_zh_CN.md) From 29e21380b45e332d1d4a5ca8b2a8f2b86eb9f3a8 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Fri, 10 Jan 2025 22:56:20 +0800 Subject: [PATCH 08/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index e1225752ab..267ec13386 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -16,7 +16,7 @@ FireFly 提供的数字资产、数据流和区块链交易的 API，使企业 ## 开始使用 Hyperledger FireFly -学习使用FireFly的最佳方式: [文档](https://hyperledger.github.io/firefly). +了解FireFly的最佳方式请参照 [文档](https://hyperledger.github.io/firefly)。 在这里你能够找到 [开始指引](https://hyperledger.github.io/firefly/latest/gettingstarted/), 在文档的指导下，你几分钟就可以在你的本地机器上运行起来FireFly超级节点。 From 757390ebf0b86411e763305414df2389f013cc54 Mon Sep 17 00:00:00 2001 From: shawn_shaw Date: Fri, 10 Jan 2025 23:19:34 +0800 Subject: [PATCH 09/32] docs: Let the change of doc-site be excluded from the PR Signed-off-by: shawn_shaw --- doc-site/README.md | 2 -- doc-site/README_zh_CN.md | 75 ---------------------------------------- 2 files changed, 77 deletions(-) delete mode 100644 doc-site/README_zh_CN.md diff --git a/doc-site/README.md b/doc-site/README.md index ed5336a896..dc16945bc3 100644 --- a/doc-site/README.md +++ b/doc-site/README.md @@ -5,8 +5,6 @@ This directory is based on the [Hyperledger documentation template](https://gith [Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/ [Mike]: https://github.com/jimporter/mike -[ENGLISH](./README.md) | [简体中文](./README_zh_CN.md) - ## Prerequisites To test the documents and update the published site, the following tools are needed: diff --git a/doc-site/README_zh_CN.md b/doc-site/README_zh_CN.md deleted file mode 100644 index d452a6cab1..0000000000 --- a/doc-site/README_zh_CN.md +++ /dev/null @@ -1,75 +0,0 @@ -# Hyperledger FireFly 文档站 - -此目录基于 [Hyperledger 文档模板](https://github.com/hyperledger-labs/documentation-template)。 该文档使用 MkDocs ( 文档在 [mkdocs.org](https://www.mkdocs.org) ) 和 Material 的主题 (文档在[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/))。 Material 主题给 MkDocs 添加了一系列的主题，让 Hyperledger 的代码库具有采取这些主题 [Insiders](https://squidfunk.github.io/mkdocs-material/insiders/) 的能力. - -[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/ -[Mike]: https://github.com/jimporter/mike - -[ENGLISH](./README.md) | [简体中文](./README_zh_CN.md) - -## 前置条件 - -需要以下工具去测试这些文档和升级已发布的站点: - -- A Bash shell -- git -- Python 3 -- [Material for Mkdocs] 主题. -- 用于发布到 gh-pages 的 [Mike] MkDocs 插件。 - - 非本地使用，但是需要在 `mkdocs.yml` 文件引用到， 并且在将站点部署到 gh-pages 的时候使用到。 - -### git - -`git` 可以本地安装，你可以在 [Install Git Guide from GitHub](https://github.com/git-guides/install-git) 找到安装指引。 - -### Python 3 - -`Python 3` 可以本地安装，你可以在 [Python Getting Started guide](https://www.python.org/about/gettingstarted/) 找到安装指引。 - -### 虚拟环境 - -为了避免在你的本机环境上存在 python 安装的冲突，安装一个 python 虚拟环境是值得推荐的。这也能避免你在计算机上全局安装这个项目的依赖。 - - -```bash -cd doc-site -python3 -m venv venv -source venv/bin/activate -``` - -### Mkdocs - -Mkdocs 相关的内容也可以在本地安装，正如 [Material for Mkdocs] 指引所说。以下是简短的、针对具体版本的安装说明： - - -```bash -pip install -r requirements.txt -``` - -### 确认安装 - -为了确认安装的 `mkdocs` 生效， 你可以运行 `mkdocs --help` 看看有没有生成帮助文档。 - -## 一些有用的 MkDocs 命令 - -以下是 `mkdocs` 可以使用的命令: - -- `mkdocs serve` - 启动一个动态刷新的文档服务器。 -- `mkdocs build` - 构建这个文档站点。 -- `mkdocs -h` - 打印帮助信息和退出。 - -## 添加内容 - -以下是在这个文档站中添加内容的基本流程： - -- 在 `docs` 文件夹创建一个新的 markdown 文档。 -- 将新文件添加到目录中 ( `mkdocs.yml` 文件 的 `nav` 标签 ) - -如果你使用这个模板去生成你自己的文档， 请点击 [自定义指引](./docs/index.md). - -## 代码库布局 - - mkdocs.yml # 配置文件。 - docs/ - index.md # 文档主页。 - ... # 其他 markdown 页面，图片和文件。 From 68cd4050c2e0c321a72d9e74db196f6f39838e36 Mon Sep 17 00:00:00 2001 From: shawn_shaw Date: Sat, 11 Jan 2025 00:04:30 +0800 Subject: [PATCH 10/32] docs: fixed translation err Signed-off-by: shawn_shaw --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 267ec13386..45e50ce824 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -10,7 +10,7 @@ Hyperledger FireFly 是首款开源的超级节点：一个安全的企业级的构建和拓展Web3应用的全栈式解决方案。 -FireFly 提供的数字资产、数据流和区块链交易的 API，使企业能够快速在流行的区块链链技术和协议上构建生产就绪的应用程序。 +FireFly 提供的数字资产、数据流和区块链交易的 API，使企业能够快速在流行的区块链技术和协议上构建生产就绪的应用程序。 [ENGLISH](./README.md) | [简体中文](./README_zh_CN.md) From 77f429e84ccb2195a6c2c83e53a07c7b0fe69c48 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Sat, 11 Jan 2025 00:21:18 +0800 Subject: [PATCH 11/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 45e50ce824..b8975f6bf4 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -18,24 +18,24 @@ FireFly 提供的数字资产、数据流和区块链交易的 API，使企业 了解FireFly的最佳方式请参照 [文档](https://hyperledger.github.io/firefly)。 -在这里你能够找到 [开始指引](https://hyperledger.github.io/firefly/latest/gettingstarted/), -在文档的指导下，你几分钟就可以在你的本地机器上运行起来FireFly超级节点。 +您可以在这里找到我们的 [入门指南](https://hyperledger.github.io/firefly/latest/gettingstarted/), +通过该指南将帮助您在几分钟内在本地机器上运行起来一个FireFly超级节点网络的开发环境。 -你的本地机器将会安装上: +您的开发环境将包括: FireFly CLI | FireFly Explorer UI | FireFly Sandbox | :----------------------------:|:-----------------------------------:|:----------------:| [![CLI](./images/firefly_cli.png)](https://hyperledger.github.io/firefly/latest/gettingstarted/firefly_cli/#install-the-firefly-cli) | [![UI](./images/firefly_explorer.png)](https://github.com/hyperledger/firefly-ui) | [![Sandbox](./images/firefly_sandbox.png)](https://hyperledger.github.io/firefly/latest/gettingstarted/sandbox/#use-the-sandbox) | -## 与FireFly社区取得联系 +## 加入社区 - [加入我们的 Discord](https://discord.gg/hyperledger) ## 技术架构 -Hyperledger FireFly 有着插件式的微服务架构。FireFly的所有服务都是插件式的，例如区块链技术、token ERC标准、自定义智能合约甚至到事件分发层以及私有数据库都是可插拔的。 +Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议、ERC代币标准、自定义智能合约，还是事件分发层以及私有数据库，一切都可以插件化。 -假如你在FireFly的技术架构图中还未发现你喜爱的区块链技术，你也不必担心。FireFly提供了清晰明确的方式可以让你去拓展，从而避免你花费大量时间去重新构建你自己的区块链应用程序。 +因此，即使您所需要的区块链技术目前还没有相对应的支持，您也不必担心。插件化的设计大大降低了添加更多的区块链技术的难度，避免你花费大量时间去重新构建不同区块链技术之间可以复用的基础设施。 [![Hyperledger FireFly 技术架构图](./doc-site/docs/images/firefly_architecture_overview.jpg)](https://raw.githubusercontent.com/kaleido-io/firefly/main/doc-site/docs/images/firefly_architecture_overview.jpg) From cc0db8cdd5eef58d38f2ca0a02ba73bbb8c455a4 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Sat, 11 Jan 2025 00:23:57 +0800 Subject: [PATCH 12/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index b8975f6bf4..cdf8d39a00 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -39,19 +39,19 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 [![Hyperledger FireFly 技术架构图](./doc-site/docs/images/firefly_architecture_overview.jpg)](https://raw.githubusercontent.com/kaleido-io/firefly/main/doc-site/docs/images/firefly_architecture_overview.jpg) -## 开始向 Hyperledger FireFy 产生贡献 +## 开始为 Hyperledger FireFly 做贡献 -你有很多种方式可以对 Hyperledger FireFly 项目产生贡献，无论你的技术栈是前端、后端或者全栈。 +无论您是前端、后端，还是全栈开发者，这里都有适合您的贡献机会。 -点击 [贡献指引](https://hyperledger.github.io/firefly/latest/contributors/)， **欢迎!**. +请查看我们的 [贡献者指南](https://hyperledger.github.io/firefly/latest/contributors/)，**欢迎加入**！ -## 其他项目库 +## 其他存储库 -你当前处在“核心”库中，这是一个用Go语言编写的和有着托管API服务器和中央协调引擎的库。在这里你可找到用各种语言（TypeScript、Java以及其他重量级运行环境组件）编写的插件式微服务组件。 +您当前所在的是“核心”存储库，用Go语言编写，包含了API服务器和中央编排引擎。本库还提供多种插件接口，用于支持使用 TypeScript 和 Java 等语言编写的微服务连接器以及其他关键运行组件。 -你可能感兴趣的其他项目包含着微服务组件、用户体验、控制台和样例的库如下 +以下是您可能感兴趣的各个微服务组件、用户经验、CLI 和应用示例的存储库。 -> 提示：只罗列开源库和插件 +> 注意：以下仅列出了开源存储库和插件 ### 区块链连接 From e3ed9545ae9747fcb4325d5945ffb02be11704a9 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Sat, 11 Jan 2025 00:28:51 +0800 Subject: [PATCH 13/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index cdf8d39a00..c49af5a979 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -55,16 +55,16 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 ### 区块链连接 -- Transaction Manager - https://github.com/hyperledger/firefly-transaction-manager -- RLP & ABI encoding, KeystoreV3 utilities and secp256k1 signer runtime - https://github.com/hyperledger/firefly-signer -- FFCAPI reference connector for EVM Chains - https://github.com/hyperledger/firefly-evmconnect - - Public EVM compatible chains: Learn more in the [documentation](https://hyperledger.github.io/firefly) -- Permissioned Ethereum connector - https://github.com/hyperledger/firefly-ethconnect - - Private/permissioned: Hyperledger Besu / Quorum -- Hyperledger Fabric connector - https://github.com/hyperledger/firefly-fabconnect -- Tezos connector - https://github.com/hyperledger/firefly-tezosconnect -- Corda connector starter: https://github.com/hyperledger/firefly-cordaconnect - - CorDapp specific customization is required +- Transaction Manager （区块链交易管理组件）- https://github.com/hyperledger/firefly-transaction-manager +- RLP & ABI 编码, Keystore V3实用工具 和 secp256k1 签名运行时 - https://github.com/hyperledger/firefly-signer +- 通用型以太坊区块链的参考连接器 - https://github.com/hyperledger/firefly-evmconnect + - EVM兼容公链: 请参见[文档](https://hyperledger.github.io/firefly) +- 针对许可制以太坊区块链的连接器 - https://github.com/hyperledger/firefly-ethconnect + - 私有/许可制区块链: Hyperledger Besu / Quorum +- Hyperledger Fabric连接器 - https://github.com/hyperledger/firefly-fabconnect +- Tezos连接器 - https://github.com/hyperledger/firefly-tezosconnect +- Corda连接器示例: https://github.com/hyperledger/firefly-cordaconnect + - 使用该连接器，需要对 CorDapp 进行定制化开发 ### Token 标准 From 2bba2b4379644cff0aa2c9c430b6de1078d7a2b4 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Sat, 11 Jan 2025 00:30:43 +0800 Subject: [PATCH 14/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index c49af5a979..cb9dda6550 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -66,10 +66,10 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 - Corda连接器示例: https://github.com/hyperledger/firefly-cordaconnect - 使用该连接器，需要对 CorDapp 进行定制化开发 -### Token 标准 +### 代币标准 -- Tokens ERC20/ERC721 - https://github.com/hyperledger/firefly-tokens-erc20-erc721 -- Tokens ERC1155 - https://github.com/hyperledger/firefly-tokens-erc1155 +- ERC20/ERC721 代币 - https://github.com/hyperledger/firefly-tokens-erc20-erc721 +- ERC1155 代币 - https://github.com/hyperledger/firefly-tokens-erc1155 ### 私有数据总线连接 From 7f1b399dccce71fad5556f142ed559165adab458 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Sat, 11 Jan 2025 00:31:08 +0800 Subject: [PATCH 15/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index cb9dda6550..6997396536 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -73,7 +73,7 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 ### 私有数据总线连接 -- HTTPS Data Exchange - https://github.com/hyperledger/firefly-dataexchange-https +- HTTPS 数据交换组件 - https://github.com/hyperledger/firefly-dataexchange-https ### 开发者生态系统 From e36d1bf4dfea2016d4ceb01ad5bc2044710330b0 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Sat, 11 Jan 2025 00:33:55 +0800 Subject: [PATCH 16/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 6997396536..376510b566 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -77,13 +77,13 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 ### 开发者生态系统 -- Command Line Interface (CLI) - https://github.com/hyperledger/firefly-cli -- Explorer UI - https://github.com/hyperledger/firefly-ui +- 命令行界面 (CLI) - https://github.com/hyperledger/firefly-cli +- 图形用户界面 - https://github.com/hyperledger/firefly-ui - Node.js SDK - https://github.com/hyperledger/firefly-sdk-nodejs -- Sandbox / Exerciser - https://github.com/hyperledger/firefly-sandbox -- Samples - https://github.com/hyperledger/firefly-samples -- FireFly Performance CLI: https://github.com/hyperledger/firefly-perf-cli -- Helm Charts for Deploying to Kubernetes: https://github.com/hyperledger/firefly-helm-charts +- 沙盒/测试工具 - https://github.com/hyperledger/firefly-sandbox +- 示例 - https://github.com/hyperledger/firefly-samples +- FireFly 性能测试 CLI: https://github.com/hyperledger/firefly-perf-cli +- 部署到Kubernetes的示例Helm Charts: https://github.com/hyperledger/firefly-helm-charts ## FireFly 核心代码层级结构 From a34751163578fba2254edd5e57560093927e42b0 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:35:44 +0800 Subject: [PATCH 17/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 376510b566..e05ed025d6 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -89,9 +89,9 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 ``` ┌──────────┐ ┌───────────────┐ -│ cmd ├──┤ firefly [Ff]│ - 控制台接入 +│ cmd ├──┤ firefly [Ff]│ - CLI入口 └──────────┘ │ │ - 父级上下文创建 - │ │ - 信号控制 + │ │ - 信号处理 └─────┬─────────┘ │ ┌──────────┐ ┌─────┴─────────┐ - HTTP 监听 (Gorilla mux) From 889b175df8329ca4935325c643dd9b81cac9044a Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:38:25 +0800 Subject: [PATCH 18/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index e05ed025d6..9a491df316 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -94,11 +94,11 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ - 信号处理 └─────┬─────────┘ │ -┌──────────┐ ┌─────┴─────────┐ - HTTP 监听 (Gorilla mux) +┌──────────┐ ┌─────┴─────────┐ - HTTP 监听器 (Gorilla mux) │ internal ├──┤ api [As]│ * TLS (SSL), CORS 配置等. └──────────┘ │ server │ * 同一端口上的 WS 升级 │ │ - REST 路由定义 - └─────┬─────────┘ * 仅限简单的路由逻辑，所有处理均推迟到协调器 + └─────┬─────────┘ * 只负责简单的路由逻辑，所有处理逻辑交由orchestrator │ ┌─────┴─────────┐ - REST 路由定义框架 │ openapi [Oa]│ * 标准化 Body，Path，Query， Filter 语义 From 9dc7603c0a5653da9a8b1e352b6be8be654d8f9e Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:45:30 +0800 Subject: [PATCH 19/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 9a491df316..a1e690174f 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -102,7 +102,7 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ ┌─────┴─────────┐ - REST 路由定义框架 │ openapi [Oa]│ * 标准化 Body，Path，Query， Filter 语义 - │ spec | - OpenAPI 3.0 (Swagger) 生成器 + │ spec | - 生成 OpenAPI 3.0 (Swagger) 文档 └─────┬─────────┘ * 包括 Swagger. UI │ ┌─────┴─────────┐ - WebSocket 服务器 From 19a6d8629103cf06b5bce30ea2371571b88f34d0 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:50:11 +0800 Subject: [PATCH 20/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index a1e690174f..fa79ba183e 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -106,9 +106,9 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 └─────┬─────────┘ * 包括 Swagger. UI │ ┌─────┴─────────┐ - WebSocket 服务器 - │ [Ws]│ * 开发者友好型的基于JSON的业务应用程序开发 - │ websockets │ * 可靠的顺序传递 - └─────┬─────────┘ * _Event interface [Ei] 支持集成其他计算框架/传输层_ + │ [Ws]│ * 为业务应用开发提供开发者友好的 JSON 协议 + │ websockets │ * 可靠的有序事件传递 + └─────┬─────────┘ * _Event interface [Ei] 支持集成其他计算框架/传输方式_ │ ┌─────┴─────────┐ - 监听数据库事件改变的拓展接口 │ admin [Ae]│ * 对于搭建核心服务外的微服务拓展应用可用 From a5a9a6e92008653fec9228c6caef9f755def762b Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:53:41 +0800 Subject: [PATCH 21/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index fa79ba183e..4632479ffe 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -111,9 +111,9 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 └─────┬─────────┘ * _Event interface [Ei] 支持集成其他计算框架/传输方式_ │ ┌─────┴─────────┐ - 监听数据库事件改变的拓展接口 - │ admin [Ae]│ * 对于搭建核心服务外的微服务拓展应用可用 - │ events | * 可用于事务管理组件 - └─────┬─────────┘ * 特定对象类型过滤 + │ admin [Ae]│ * 用于构建外部运行的微服务扩展核心功能 + │ events | * 被 Transaction Manager 组件使用 + └─────┬─────────┘ * 支持特定对象类型过滤 │ ┌─────┴─────────┐ - 核心数据类型 │ fftypes [Ft]│ * 用于 API 和序列化 From 58dab061650b0053869741b0d5cc74e80916ebee Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:58:00 +0800 Subject: [PATCH 22/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 4632479ffe..8025dd6fd7 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -117,7 +117,7 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ ┌─────┴─────────┐ - 核心数据类型 │ fftypes [Ft]│ * 用于 API 和序列化 - │ │ * 通过路由定义，APIs 可以实现隐藏输入属性 + │ │ * API 可通过路由定义对输入字段进行屏蔽 └─────┬─────────┘ │ ┌─────┴─────────┐ - 核心运行时环境服务器，初始化和拥有以下的实例: From 89d51e79e379baae565612592bc2e109d2a97b09 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:03:33 +0800 Subject: [PATCH 23/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 8025dd6fd7..31d4e7a9da 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -121,7 +121,7 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 └─────┬─────────┘ │ ┌─────┴─────────┐ - 核心运行时环境服务器，初始化和拥有以下的实例: - │ [Or]│ * Components：特性实现 + │ [Or]│ * Components：功能组件 ┌───────┬───┤ orchestrator │ * Plugins：可插拔设施服务 │ │ │ │ - 向路由暴露行为 │ │ └───────────────┘ * 所有的API调用将会在这里开始处理 From 3ad2468903d96530c6d82bf8cad56eccb70b4093 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:05:04 +0800 Subject: [PATCH 24/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 31d4e7a9da..a6ae1479f0 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -122,7 +122,7 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ ┌─────┴─────────┐ - 核心运行时环境服务器，初始化和拥有以下的实例: │ [Or]│ * Components：功能组件 - ┌───────┬───┤ orchestrator │ * Plugins：可插拔设施服务 + ┌───────┬───┤ orchestrator │ * Plugins：可插拔的基础设施服务 │ │ │ │ - 向路由暴露行为 │ │ └───────────────┘ * 所有的API调用将会在这里开始处理 │ │ From fb88537d91992be57d99ebdfd6560e5f91295073 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:11:54 +0800 Subject: [PATCH 25/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index a6ae1479f0..3793cdcf88 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -123,7 +123,7 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 ┌─────┴─────────┐ - 核心运行时环境服务器，初始化和拥有以下的实例: │ [Or]│ * Components：功能组件 ┌───────┬───┤ orchestrator │ * Plugins：可插拔的基础设施服务 - │ │ │ │ - 向路由暴露行为 + │ │ │ │ - 向路由层提供处理逻辑 │ │ └───────────────┘ * 所有的API调用将会在这里开始处理 │ │ │ Components: 引擎里的组件将会做重量级的任务 From 4c4cb68c69b7476cbd006cef1679bff94a6fa516 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:14:13 +0800 Subject: [PATCH 26/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 3793cdcf88..d8ee289797 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -126,7 +126,7 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ │ │ - 向路由层提供处理逻辑 │ │ └───────────────┘ * 所有的API调用将会在这里开始处理 │ │ - │ Components: 引擎里的组件将会做重量级的任务 + │ Components: 包含主要功能的处理逻辑 │ │ │ │ ┌───────────────┐ - 通过跨链技术整合区块链智能合约逻辑 │ ├───┤ contract [Cm]│ * 为智能合约生成 OpenAPI 3 / Swagger 定义，并且传播到网络中 From edf894cf8305cf69d8a75ec5b129bbc39d3bf2ab Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:17:29 +0800 Subject: [PATCH 27/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index d8ee289797..0d3481e70f 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -128,10 +128,10 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ │ Components: 包含主要功能的处理逻辑 │ │ - │ │ ┌───────────────┐ - 通过跨链技术整合区块链智能合约逻辑 + │ │ ┌───────────────┐ - 跨链技术智能合约逻辑的整合 │ ├───┤ contract [Cm]│ * 为智能合约生成 OpenAPI 3 / Swagger 定义，并且传播到网络中 - │ │ │ manager │ * 为了本地区块链事件管理监听, 并且路由这些应用事件 - │ │ └───────────────┘ * 转化 to/from 本地区块链接口 (ABI etc.) 和 FireFly Interface [FFI] 格式 + │ │ │ manager │ * 管理原生区块链事件监听，并将其路由到应用事件 + │ │ └───────────────┘ * 负责在原生区块链接口 (ABI 等) 和 FireFly Interface [FFI] 格式之间的转换 │ │ │ │ ┌───────────────┐ - 维护整个网络的视图 │ ├───┤ network [Nm]│ * 集成网络权限 [NP] 插件 From 6677ecb6b05ba926f61e28e527ed56f4a8cca0cd Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 13:33:39 +0800 Subject: [PATCH 28/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 0d3481e70f..4bea518a1c 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -136,7 +136,7 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ ┌───────────────┐ - 维护整个网络的视图 │ ├───┤ network [Nm]│ * 集成网络权限 [NP] 插件 │ │ │ map │ * 集成广播插件 - │ │ └───────────────┘ * 控制成员身份、节点身份、签名身份的层级 + │ │ └───────────────┘ * 处理成员身份、节点身份和签名身份的层次结构 │ │ │ │ ┌───────────────┐ - 广播数据给所有网络中的成员 │ ├───┤ broadcast [Bm]│ * 实现批量组件的分发 From 1739c070450680eb3d946062dd8895a5de40b7c0 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 13:39:08 +0800 Subject: [PATCH 29/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 4bea518a1c..1eb67da6e2 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -140,8 +140,8 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ │ │ ┌───────────────┐ - 广播数据给所有网络中的成员 │ ├───┤ broadcast [Bm]│ * 实现批量组件的分发 - │ │ │ manager | * 集成 共享存储接口 [Ss] 插件 - │ │ └───────────────┘ * 集成区块链接口 [Bi] 插件 + │ │ │ manager | * 与 shared storage 接口 [Ss] 插件的集成 + │ │ └───────────────┘ * 与blockchain interface接口 [Bi] 插件的集成 │ │ │ │ ┌───────────────┐ - 发送私有数据给网络中的成员 │ ├───┤ private [Pm]│ * 实现批处理组件的调度器 From 1f405148eeb314f73d12ea90dd8dde74c47e6461 Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 13:41:55 +0800 Subject: [PATCH 30/32] Update README_zh_CN.md Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 1eb67da6e2..6e70d249d3 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -134,8 +134,8 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ └───────────────┘ * 负责在原生区块链接口 (ABI 等) 和 FireFly Interface [FFI] 格式之间的转换 │ │ │ │ ┌───────────────┐ - 维护整个网络的视图 - │ ├───┤ network [Nm]│ * 集成网络权限 [NP] 插件 - │ │ │ map │ * 集成广播插件 + │ ├───┤ network [Nm]│ * 与 network permissioning [NP] 插件的集成 + │ │ │ map │ * 与广播插件的集成 │ │ └───────────────┘ * 处理成员身份、节点身份和签名身份的层次结构 │ │ │ │ ┌───────────────┐ - 广播数据给所有网络中的成员 From 0e281b122f5798c0e5b3bd28c625b99b983b023c Mon Sep 17 00:00:00 2001 From: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:41:10 +0800 Subject: [PATCH 31/32] Apply suggestions from code review Co-authored-by: Chengxuan Xing Signed-off-by: shawn_shaw <44858084+Shawn-Shaw-x@users.noreply.github.com> --- README_zh_CN.md | 82 ++++++++++++++++++++++++------------------------- 1 file changed, 41 insertions(+), 41 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 6e70d249d3..114dfc8894 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -145,43 +145,43 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ │ │ ┌───────────────┐ - 发送私有数据给网络中的成员 │ ├───┤ private [Pm]│ * 实现批处理组件的调度器 - │ │ │ messaging | * 集成数据交换 [Dx] 插件 + │ │ │ messaging | * 与 data exchange [Dx] 插件的集成 │ │ └──────┬────────┘ * 消息可以通过区块链固定或者排序，或者仅发送 │ │ │ - │ │ ┌──────┴────────┐ - 有着数据隔离的区块链或者成员群组 - │ │ │ group [Gm]│ * 集成数据交换 [Dx] 插件 - │ │ │ manager │ * 集成区块链接口 [Bi] 插件 + │ │ ┌──────┴────────┐ - 有着隔离的数据和区块链的各方群组 + │ │ │ group [Gm]│ * 与 data exchange [Dx] 插件的集成 + │ │ │ manager │ * 与 blockchain interface [Bi] 插件的集成 │ │ └───────────────┘ │ │ │ │ ┌───────────────┐ - 私有数据管理和验证 │ ├───┤ data [Dm]│ * 实现批量组件的调度器 - │ │ │ manager │ * 集成数据交换 [Dx] 插件 - │ │ └──────┬────────┘ * 集成区块链接口 [Bi] 插件 + │ │ │ manager │ * 与 data exchange [Dx] 插件的集成 + │ │ └──────┬────────┘ * 与 blockchain interface [Bi] 插件的集成 │ │ │ - │ │ ┌──────┴────────┐ - JSON数据语法管理和验证 (架构可以拓展到XML或者其他) + │ │ ┌──────┴────────┐ - JSON 数据模式管理与验证（架构可扩展到 XML 等） │ │ │ json [Jv]│ * 站内和站外消息的JSON语法管理和验证 - │ │ │ validator │ * 语法传播 - │ │ └──────┬────────┘ * 集成广播插件 + │ │ │ validator │ * 模式传播 + │ │ └──────┬────────┘ * 与广播插件集成 │ │ │ │ │ ┌──────┴────────┐ - 可通过ID或者hash寻址的二进制数据存储 - │ │ │ blobstore [Bs]│ * 集成数据交换 [Dx] 插件 + │ │ │ blobstore [Bs]│ * 与 data exchange [Dx] 插件的集成 │ │ │ │ * 对数据进行hash化处理, 并且在blob存储中维护负载引用的映射 - │ │ └───────────────┘ * 集成区块链接口 [Bi] 插件 + │ │ └───────────────┘ * 与 blockchain interface [Bi] 插件的集成 │ │ - │ │ ┌───────────────┐ - 从共享存储中下载 + │ │ ┌───────────────┐ - 负责共享存储内容的下载 │ ├───┤ shared [Sd]│ * 并行异步下载 - │ │ │ download │ * 弹性重试和异步恢复 - │ │ └───────────────┘ * 完成后通知事件聚合器 + │ │ │ download │ * 可靠的重试和宕机恢复 + │ │ └───────────────┘ * 完成后通知事件aggregator │ │ │ │ ┌───────────────┐ │ ├───┤ identity [Im] │ - 跨组件中心化身份管理服务 - │ │ │ manager │ * 解决API输入 identity + key 组合 (短名称, 格式等) - │ │ │ │ * 解决将已注册的链上签名返回身份 + │ │ │ manager │ * 解析API输入的身份和密钥组合（例如短名称、格式化等） + │ │ │ │ * 将注册的链上签名密钥映射回身份 │ │ └───────────────┘ * 集成区块链接口和可插拔身份接口（待定） │ │ - │ │ ┌───────────────┐ - 通过插件跟踪对外部组件执行的所有操作 - │ ├───┤ operation [Om]│ * 以输入、输出更新数据库 - │ │ │ manager │ * 提供跨插件的一致性重试语义 + │ │ ┌───────────────┐ - 记录通过插件对外部组件执行的所有操作 + │ ├───┤ operation [Om]│ * 更新数据库中的输入/输出 + │ │ │ manager │ * 为插件提供一致的重试语义 │ │ └───────────────┘ │ │ │ │ ┌───────────────┐ - 私有数据管理和验证 @@ -189,11 +189,11 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ │ manager │ * 集成数据交换 [Dx] 插件 │ │ └──────┬────────┘ * 集成区块链接口 [Bi] 插件 │ │ │ - │ │ ┌──────┴────────┐ - 控制外部数据接收 + │ │ ┌──────┴────────┐ - 处理传入的外部数据 │ │ │ [Ag]│ * 集成数据交换 [Dx] 插件 │ │ │ aggregator │ * 集成共享数据接口 [Ss] 插件 │ │ │ │ * 集成区块链接口 [Bi] 插件 - │ │ │ │ - 确保只有所有数据都可用时有效事件才会被分发 + │ │ │ │ - 确保只有所有数据都就绪时有效事件才会被分发 │ │ └──────┬────────┘ * 上下文感知，避免“全局阻塞”场景的出现 │ │ │ │ │ ┌──────┴────────┐ - 订阅管理 @@ -208,8 +208,8 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ └───────────────┘ │ │ │ │ ┌───────────────┐ - Token 创建、传输的初始化、索引和协同 - │ ├───┤ asset [Am]│ * 可替代 Token: 数字化价值/结算 (coins) - │ │ │ manager │ * 不可替代 tokens: NFTs / globally uniqueness / digital twins + │ ├───┤ asset [Am]│ * 支持同质化代币（如数字货币） + │ │ │ manager │ * 支持非同质化代币： NFTs / globally uniqueness / digital twins │ │ └───────────────┘ * 交易历史的全索引 │ │ [REST/WebSockets] │ │ ┌─────┴─────────────┐ ┌──────────┐ ┌─ @@ -222,23 +222,23 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ │ │ * 转换为底层事件驱动API │ │ └───────────────┘ │ │ - │ │ ┌───────────────┐ - 聚合报文和数据，并汇总hash值以进行固定 + │ │ ┌───────────────┐ - 聚合报文和数据，并生成哈希用于上链 │ ├───┤ batch [Ba]│ * 可插拔调度器 - │ │ │ manager │ - 数据库和主线API处理分离 - │ │ │ │ * 有关主动、主动排序的更多信息，请参考架构图 - │ │ └──────┬────────┘ - 管理批处理器的创建 + │ │ │ manager │ - 数据库和主线API处理解耦 + │ │ │ │ * 有关active/active排序的更多信息，请参考架构图 + │ │ └──────┬────────┘ - 管理批处理器实例的创建 │ │ │ - │ │ ┌──────┴────────┐ - 短暂的代理启动以按需组装批次 + │ │ ┌──────┴────────┐ - 根据需求启动的短生命周期代理 │ │ │ batch [Bp]│ * 与作者+消息类型耦合 - │ │ │ processor │ - 批量构建100多条信息以实现高效固定 - │ │ │ │ * 聚合消息和数据，并汇总hash值以进行固定 - │ │ └───────────────┘ - 配置失效后自动关闭 + │ │ │ processor │ - 批量构建100多条信息以优化上链性能 + │ │ │ │ * 聚合消息和数据，并生成哈希用于上链 + │ │ └───────────────┘ - 在配置的空闲时间后自动关闭 │ ... 更多待定 │ -Plugins: 每个插件都包含一个Go shim，以及一个远程代理微服务运行环境(有需要的话) +Plugins: 每个插件都包含一个Go shim，以及一个远程代理微服务运行环境(如有需要) │ │ ┌───────────────┐ - 区块链接口 - ├───────────┤ [Bi]│ * 交易提交 - 包括签名秘钥管理 + ├───────────┤ [Bi]│ * 交易提交 - 包括签名密钥管理 │ │ blockchain │ * 事件监听 │ │ interface │ * 标准化操作，和自定义链上耦合 │ └─────┬─────────┘ @@ -252,13 +252,13 @@ Plugins: 每个插件都包含一个Go shim，以及一个远程代理微服务 │ │ transaction manager [Tm] ├───┤ Connector API [ffcapi] ├───┤ 构建区块链连接器的简单框架 │ └──────────────────────────┘ └────────────────────────┘ └─ │ - │ ┌───────────────┐ - Token 接口 + │ ┌───────────────┐ - 代币接口 ├───────────┤ tokens [Ti]│ * 标准化的核心概念：token pools，transfers，approvals - │ │ interface │ * 可插拔的跨 token 标准 - │ └───────────────┘ * 通过微服务连接器针对自定义 token 标准的简单实现方式的支持 + │ │ interface │ * 可插拔的跨代币标准 + │ └───────────────┘ * 通过微服务连接器针对自定义代币标准的简单实现方式的支持 │ [REST/WebSockets] │ ┌─────┴─────────────┐ ┌──────────┐ ┌─ - │ │ ERC-20 / ERC-721 ├───┤ ERC-1155 ├───┤ 构建 token 连接器的简单框架 + │ │ ERC-20 / ERC-721 ├───┤ ERC-1155 ├───┤ 构建代币连接器的简单框架 │ └───────────────────┘ └──────────┘ └─ │ │ ┌───────────────┐ - P2P 内容寻址文件系统 @@ -274,8 +274,8 @@ Plugins: 每个插件都包含一个Go shim，以及一个远程代理微服务 │ │ ┌───────────────┐ - 私有数据交换 ├───────────┤ data [Dx]│ * Blob 存储 - │ │ exchange │ * 私有加密消息传递 - │ └─────┬─────────┘ * 加密文件传输 + │ │ exchange │ * 私有安全消息传递 + │ └─────┬─────────┘ * 安全的文件传输 │ │ │ ├─────────────────────┬────────── ... 可拓展至任意私有数据交换技术 │ ┌─────┴─────────┐ ┌───────┴───────┐ @@ -283,7 +283,7 @@ Plugins: 每个插件都包含一个Go shim，以及一个远程代理微服务 │ └───────────────┘ └───────────────┘ │ │ ┌───────────────┐ - API 认证和认证接口 - ├───────────┤ api auth [Aa]│ * 验证加密凭证 (OpenID Connect id token JWTs etc.) + ├───────────┤ api auth [Aa]│ * 验证安全凭据 (OpenID Connect id token JWTs etc.) │ │ │ * 提取 API/user 身份 (用于身份接口映射) │ └─────┬─────────┘ * 细粒度 API 访问控制的执行点 │ │ @@ -326,7 +326,7 @@ Plugins: 每个插件都包含一个Go shim，以及一个远程代理微服务 ┌───────────────┐ - WebSocket 客户端 │ wsclient [Wc]│ * 提供便利性和日志 │ │ * 标准化认证，配置和重连逻辑 - └───────────────┘ * 构建于 Gorilla WebSockets + └───────────────┘ * 基于 Gorilla WebSockets ┌───────────────┐ - 翻译框架 │ i18n [In]│ * 所有翻译内容必须要添加到 `en_translations.json` - 用 `FF10101` 作为 key From ede90d21370006d0e50f1331bbcaa33c3bea1d90 Mon Sep 17 00:00:00 2001 From: Chengxuan Xing Date: Thu, 30 Jan 2025 12:53:09 +0000 Subject: [PATCH 32/32] proof reading Signed-off-by: Chengxuan Xing --- README_zh_CN.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README_zh_CN.md b/README_zh_CN.md index 114dfc8894..6315982e77 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -10,15 +10,15 @@ Hyperledger FireFly 是首款开源的超级节点：一个安全的企业级的构建和拓展Web3应用的全栈式解决方案。 -FireFly 提供的数字资产、数据流和区块链交易的 API，使企业能够快速在流行的区块链技术和协议上构建生产就绪的应用程序。 +FireFly 提供的数字资产、数据流和区块链交易API，使企业能够快速在流行的区块链技术和协议上构建生产就绪的应用程序。 [ENGLISH](./README.md) | [简体中文](./README_zh_CN.md) ## 开始使用 Hyperledger FireFly -了解FireFly的最佳方式请参照 [文档](https://hyperledger.github.io/firefly)。 +了解FireFly的最佳方式请参照[文档](https://hyperledger.github.io/firefly)。 -您可以在这里找到我们的 [入门指南](https://hyperledger.github.io/firefly/latest/gettingstarted/), +您可以在这里找到我们的[入门指南](https://hyperledger.github.io/firefly/latest/gettingstarted/), 通过该指南将帮助您在几分钟内在本地机器上运行起来一个FireFly超级节点网络的开发环境。 您的开发环境将包括: @@ -43,7 +43,7 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 无论您是前端、后端，还是全栈开发者，这里都有适合您的贡献机会。 -请查看我们的 [贡献者指南](https://hyperledger.github.io/firefly/latest/contributors/)，**欢迎加入**！ +请查看我们的[贡献者指南](https://hyperledger.github.io/firefly/latest/contributors/)，**欢迎加入**！ ## 其他存储库 @@ -55,7 +55,7 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 ### 区块链连接 -- Transaction Manager （区块链交易管理组件）- https://github.com/hyperledger/firefly-transaction-manager +- Transaction Manager（区块链交易管理组件）- https://github.com/hyperledger/firefly-transaction-manager - RLP & ABI 编码, Keystore V3实用工具 和 secp256k1 签名运行时 - https://github.com/hyperledger/firefly-signer - 通用型以太坊区块链的参考连接器 - https://github.com/hyperledger/firefly-evmconnect - EVM兼容公链: 请参见[文档](https://hyperledger.github.io/firefly) @@ -140,8 +140,8 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ │ │ ┌───────────────┐ - 广播数据给所有网络中的成员 │ ├───┤ broadcast [Bm]│ * 实现批量组件的分发 - │ │ │ manager | * 与 shared storage 接口 [Ss] 插件的集成 - │ │ └───────────────┘ * 与blockchain interface接口 [Bi] 插件的集成 + │ │ │ manager | * 与 shared storage [Ss] 插件的集成 + │ │ └───────────────┘ * 与blockchain interface [Bi] 插件的集成 │ │ │ │ ┌───────────────┐ - 发送私有数据给网络中的成员 │ ├───┤ private [Pm]│ * 实现批处理组件的调度器 @@ -186,13 +186,13 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ │ │ ┌───────────────┐ - 私有数据管理和验证 │ ├───┤ event [Em]│ * 实现批量组件的调度器 - │ │ │ manager │ * 集成数据交换 [Dx] 插件 - │ │ └──────┬────────┘ * 集成区块链接口 [Bi] 插件 + │ │ │ manager │ * 与 data exchange [Dx] 插件的集成 + │ │ └──────┬────────┘ * 与 blockchain interface [Bi] 插件的集成 │ │ │ │ │ ┌──────┴────────┐ - 处理传入的外部数据 - │ │ │ [Ag]│ * 集成数据交换 [Dx] 插件 - │ │ │ aggregator │ * 集成共享数据接口 [Ss] 插件 - │ │ │ │ * 集成区块链接口 [Bi] 插件 + │ │ │ [Ag]│ * 与 data exchange [Dx] 插件的集成 + │ │ │ aggregator │ * 与 shared storage [Ss] 插件的集成 + │ │ │ │ * 与 blockchain interface [Bi] 插件的集成 │ │ │ │ - 确保只有所有数据都就绪时有效事件才会被分发 │ │ └──────┬────────┘ * 上下文感知，避免“全局阻塞”场景的出现 │ │ │ @@ -203,8 +203,8 @@ Hyperledger FireFly 拥有可插拔的微服务架构。无论是区块链协议 │ │ └──────┬────────┘ │ │ │ │ │ ┌──────┴────────┐ - 管理事件到已连接应用的传递 - │ │ │ event [Ed]│ * 集成数据交换 [Dx] 插件 - │ │ │ dispatcher │ * 集成区块链接口 [Bi] 插件 + │ │ │ event [Ed]│ * 与 data exchange [Dx] 插件的集成 + │ │ │ dispatcher │ * 与 blockchain interface [Bi] 插件的集成 │ │ └───────────────┘ │ │ │ │ ┌───────────────┐ - Token 创建、传输的初始化、索引和协同