docs: add v3.17.0 change log and update platform introduction - #1861
Conversation
- rename deprecation section to 版本功能变更说明, soften TiKV/Max wording to 不再维护 per the official release announcement - reorder deprecated items and fold tx-hash hardening into txpool bullet
- rewrite introduction.md with the latest official positioning: core features (200K TPS, domestic security, open source), 600+ applications, community stats as of end of 2025, community honors - refresh front-page index.rst, README.md and community.md accordingly - add links: 2025 industry application report, 2025 MVP list, certified partner list
There was a problem hiding this comment.
Pull request overview
This PR updates the Chinese 3.x documentation to reflect the v3.17.0 release: it adds the v3.17.0 change log/upgrade notes, updates download/version references in tutorials, and refreshes the platform/community positioning and related resource links.
Changes:
- Add v3.17.0 change log page and register it in the change-log index.
- Update tutorial download links and documentation “release” version to v3.17.0.
- Rewrite/refresh introduction, community, and README positioning and external reference links (2025 report/MVP/partner list).
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Updates application/community statistics and adds link to 2025 industry report. |
3.x/zh_CN/index.rst |
Refreshes homepage intro/community wording and stats. |
3.x/zh_CN/docs/tutorial/pro/installation.md |
Updates Pro BcosBuilder download version to v3.17.0. |
3.x/zh_CN/docs/tutorial/max/installation.md |
Updates Max BcosBuilder download version to v3.17.0. |
3.x/zh_CN/docs/tutorial/air/use_hsm.md |
Updates build_chain.sh download version to v3.17.0. |
3.x/zh_CN/docs/tutorial/air/storage_security.md |
Updates build_chain.sh download links (GitHub/Gitee) to v3.17.0. |
3.x/zh_CN/docs/tutorial/air/multihost.md |
Updates build_chain.sh download version to v3.17.0. |
3.x/zh_CN/docs/tutorial/air/build_chain.md |
Updates build_chain.sh download version to v3.17.0 and includes fallback download guidance. |
3.x/zh_CN/docs/quick_start/air_installation.md |
Updates build_chain.sh download links to v3.17.0. |
3.x/zh_CN/docs/introduction/introduction.md |
Rewrites platform introduction (features, applications, community honors/links). |
3.x/zh_CN/docs/introduction/change_log/index.rst |
Adds v3.17.x section and links to v3.17.0 release notes. |
3.x/zh_CN/docs/introduction/change_log/3_17_0.md |
New v3.17.0 change log page with upgrade/compatibility notes. |
3.x/zh_CN/docs/community/partner_list_new.md |
Adds link to latest certified partner list. |
3.x/zh_CN/docs/community.md |
Refreshes community intro and adds 2025 resource links. |
3.x/zh_CN/conf.py |
Updates Sphinx release string to v3.17.0. |
Suppressed comments (2)
3.x/zh_CN/docs/tutorial/pro/installation.md:55
- “网速太慢”的备用下载命令仍指向 v3.6.0,可能导致下载到与当前文档目标版本(v3.17.0)不一致的 BcosBuilder。建议备用命令也保持 v3.17.0。
# Note: 若网速太慢,可尝试如下命令下载部署脚本:
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.6.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz
3.x/zh_CN/docs/tutorial/max/installation.md:59
- “网速太慢”的备用下载命令仍指向 v3.6.0,可能导致下载到与当前文档目标版本(v3.17.0)不一致的 BcosBuilder。建议备用命令也保持 v3.17.0。
# Note: 若网速太慢,可尝试如下命令下载部署脚本:
curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.6.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| 需要升级的链的“数据兼容版本号([compatibility_version](#id5))”为如下版本时: | ||
|
|
||
| * 3.4.x ~ 3.16.x:数据完全兼容当前版本,直接替换二进制即可完成升级 | ||
| * 3.3.x、3.2.x、3.1.x、3.0.x:支持通过替换二进制进行灰度升级,若需使用当前版本的新特性,需升级数据兼容版本号,操作见[文档](#id5) |
| ```shell | ||
| # 下载建链脚本 | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.11.0/build_chain.sh && chmod u+x build_chain.sh | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.17.0/build_chain.sh && chmod u+x build_chain.sh | ||
|
|
||
| # Note: 若访问git网速太慢,可尝试如下命令下载建链脚本: | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.6.0/build_chain.sh && chmod u+x build_chain.sh |
| --- | ||
|
|
||
| FISCO BCOS是由深圳市金融区块链发展促进会(以下简称“金链盟”)开源工作组牵头研发的金融级、国产安全可控的区块链底层平台。作为最早开源的国产联盟链底层平台之一,FISCO BCOS于2017年面向全球开源。 | ||
| FISCO BCOS是金融区块链合作联盟(深圳)(简称"金链盟")开源工作组于2017年推出的国产安全可控区块链底层开源平台,致力于为数字经济时代提供可信基础设施,释放数据要素价值,助力产业数字化及Web3.0经济发展。 |
|
|
||
| # 下载Pro版区块链构建工具BcosBuilder | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.11.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.17.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz |
|
|
||
| # 下载区块链构建工具BcosBuilder | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.11.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.17.0/BcosBuilder.tgz && tar -xvf BcosBuilder.tgz |
morebtcg
left a comment
There was a problem hiding this comment.
v3.17.0 文档整体质量不错(bugfix 开关名称与代码 Features.h 逐一核对无误、兼容性声明与 GitHub Release 一致)。以下问题建议修复后合入。
| * **WASM / WBC-Liquid 合约执行**:`WITH_WASM` 编译选项及 WBC-Liquid 合约的部署与执行支持将在 v3.18.0 中移除;Solidity / EVM 合约不受影响 | ||
| * **网关 Redis 分布式限流**:节点配置 `config.ini` 中 `[flow_control]` 配置节的 `enable_distributed_ratelimit`、`enable_distributed_ratelimit_cache`、`distributed_ratelimit_cache_percent` 配置项及 `[redis]` 配置节将在 v3.18.0 中移除;节点本地限流(令牌桶)能力保持不变 | ||
| * **轻节点(Light Node)**:`WITH_LIGHTNODE` 编译选项及轻节点功能将在 v3.18.0 中移除 | ||
| * **TiKV 存储**:将移除 `WITH_TIKV` 编译选项,TiKV 分布式存储将在 v3.18.0 不再维护;RocksDB 存储保持不变 |
There was a problem hiding this comment.
小语病与措辞统一:“TiKV 分布式存储将在 v3.18.0 不再维护”建议改为“自 v3.18.0 起不再维护”;下一行 Max 的“将在 v3.18.0 中不再维护”同理。另外本节前三条用“移除”、TiKV/Max 用“不再维护”,两种措辞混用,建议在引言中说明二者的区别(移除编译选项/功能 vs 部署形态不再维护),避免用户误以为 TiKV 与 Max 在 3.18.0 会被直接删除。
|
|
||
| Max 版本是 FISCO BCOS v3.0 发布时主推的部署形态之一:将节点拆分为网关、RPC、共识/调度、执行、存储(TiKV)等独立微服务,期望通过存算分离与水平扩容支撑更大规模的业务。经过多个版本的实践与性能分析,我们确认这一架构的实际收益与其成本不匹配,决定不再维护。主要依据如下: | ||
|
|
||
| **性能上限没有提高,反而更低。** 区块链节点是强耦合系统:每个区块的处理都要经过共识、执行、落盘的同步交互,交易执行期间对合约状态的每次读写都要访问存储。Max 将这些进程内的函数调用拆成跨服务的网络 RPC,每次交互都增加了序列化与网络往返开销——执行与存储分离后,状态读写延迟从内存/本地磁盘量级上升到网络量级,直接拉低了单链吞吐上限。而共识本身要求所有节点全序执行同一批交易,拆分服务并不能把这条串行路径并行化。实测中,同等硬件规模下 Air 单进程节点的吞吐即达到或超过 Max 集群。 |
There was a problem hiding this comment.
“实测中,同等硬件规模下 Air 单进程节点的吞吐即达到或超过 Max 集群”是本节的核心决策依据,但没有附任何测试环境与数据。建议链接基准测试报告,或至少给出测试配置(硬件规格、节点数、TPS 数值、测试版本),否则读者无法验证,也容易被质疑。
|
|
||
| **运维成本明显更高。** Max 部署需要维护 Tars 框架与 TiKV 两套基础设施,多个服务组件需要版本对齐、独立监控与扩缩容,故障定位需要跨服务追踪;任一服务或中间件故障都会影响出块,故障面远大于单进程。 | ||
|
|
||
| **业界对微服务架构的反思与此一致。** 近年来多个大型工程团队公开回归单体架构:Amazon Prime Video 团队(2023)将音视频监控服务从分布式微服务/Serverless 架构改回单体进程,成本下降约 90%;Google 的 Service Weaver 论文(CIDR 2023)指出按微服务边界拆分部署带来性能与正确性成本,主张以模块化单体开发、按需部署;Segment(2018)也曾公开其从微服务回迁单体的实践。业界共识是:微服务解决的是**组织扩展性**问题(多团队独立开发、独立发布),而不是性能问题。区块链节点由单一团队交付、模块间强耦合、必须整体升级(共识要求所有节点行为一致),不具备从微服务拆分中获益的前提条件。 |
There was a problem hiding this comment.
出处核实:Google Service Weaver 的论文《Towards Modern Development of Cloud Applications》发表于 HotOS 2023,并非 CIDR 2023,请修正或核实。Prime Video(2023,成本下降约 90%)与 Segment(2018)的引用无误。
|
|
||
| ### 兼容版本 | ||
|
|
||
| 需要升级的链的“数据兼容版本号([compatibility_version](#id5))”为如下版本时: |
There was a problem hiding this comment.
#id5 是 Sphinx 按文档顺序自动分配的锚点,任何标题增删都会使其漂移,非常脆弱:以已上线的 3_11_0.md 为例,其中的 #id5 实际指向“实验功能”而非“兼容版本”(可打开线上页面验证)。本页恰好因标题数量使 #id5 落在“兼容版本”上,但未来一旦增删章节就会悄悄失效。建议改用显式锚点(如 MyST 的 {#compatibility-version} 语法或 RST label),并顺带修复旧文档中的同类链接。
| | bugfix_statestorage_hash_v3_17 | 状态存储哈希计算修正 | | ||
| | bugfix_nonce_ordering | Web3 EOA nonce 与块内交易顺序解耦 | | ||
|
|
||
| ### 实验功能 |
There was a problem hiding this comment.
本节只有模板化文字(与 3_11_0.md 相同),但 3_11_0.md 在模板后附有 feature 对照表,本节则没有列出任何与 v3.17.0 相关的实验功能;v3.17.0 Release Notes 中也未提到新增实验功能。建议删除本节,或补充 3.17.0 实际新增的实验功能清单,避免用户误以为 3.17.0 引入了新的实验功能。
| - 国家信息中心区块链服务网络(BSN)首个适配的国产联盟链底层平台 | ||
| - 首批通过北京国家金融科技认证中心"区块链技术产品国推认证" | ||
| - 国际标准化组织ISO《区块链与分布式账本技术 用例》中,4个中国用例有2个基于FISCO BCOS研发 | ||
| - 核心技术论文入选国际超算顶级学术会议SC23,为SC会议史上第一篇区块链性能优化学术论文 |
There was a problem hiding this comment.
“为SC会议史上第一篇区块链性能优化学术论文”是强断言,且荣誉列表各项均无出处链接,读者无法核验。建议补充 SC23 论文标题/DOI 链接(并确认断言与论文原文表述一致),同时为“2018年度深圳金融科技专项奖一等奖”补充官方公告出处。
|
|
||
| # 下载建链脚本 | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.11.0/build_chain.sh && chmod u+x build_chain.sh | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.17.0/build_chain.sh && chmod u+x build_chain.sh |
There was a problem hiding this comment.
发布状态风险:当前 GitHub 上 v3.17.0 仍是 Pre-release(Latest 仍为 v3.16.3),且该 release 的资产列表为空——按此链接下载 build_chain.sh 会直接 404(gitee 镜像同理)。建议待 release 资产上传并转正后再合并本 PR,或暂时指向有资产的版本。conf.py 的 release = 'v3.17.0' 也受同样问题影响。
| ```shell | ||
| # 下载建链脚本 | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.11.0/build_chain.sh && chmod u+x build_chain.sh | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.17.0/build_chain.sh && chmod u+x build_chain.sh |
There was a problem hiding this comment.
主链接已升到 v3.17.0,但紧随其后的“网速太慢”备用链接仍是 v3.6.0(tutorial/max/installation.md、tutorial/pro/installation.md 同样保留了 v3.6.0 备用链接)。备用链接版本过旧会让用户困惑,建议一并更新,并确认对应版本在 GitHub/gitee 上确有发布资产。
|
|
||
| # 下载开发部署工具build_chain | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.11.0/build_chain.sh && chmod u+x build_chain.sh | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.17.0/build_chain.sh && chmod u+x build_chain.sh |
There was a problem hiding this comment.
同一教程内版本不一致:上文 ./download_bin.sh -v 3.4.0 下载的是 3.4.0 节点二进制,而 build_chain.sh 已切到 v3.17.0,按此操作搭出的链会混用新旧版本。建议同步 download_bin.sh 的版本号。
| FISCO BCOS开源社区致力打造开放多元的开源联盟链生态,至今为止,开源社区汇聚超过10万名成员共建共治,发展成为最大最活跃的国产开源联盟链生态圈之一,其中涌现出诸多对社区建设、代码贡献的优秀社区成员。截止2023年,开源社区共认定63位MVP,这些优秀的贡献者或是将FISCO BCOS技术落地到各领域应用中,助力产业数字化,或是在多渠道布道,将开源社区精神传播到更远的地方。 | ||
| FISCO BCOS开源社区致力打造开放多元的开源生态。截至2025年底,开源社区已汇聚超5000家企业及机构、10万余名个人成员共建共治,发展为中国最具活力的区块链技术开源社区之一,其中涌现出诸多对社区建设、代码贡献的优秀社区成员。开源社区每年评选认定年度MVP(`2025年度MVP名单 <https://mp.weixin.qq.com/s/g1ZJZ8LXxgk9rexUg2a0Uw>`_),这些优秀的贡献者或是将FISCO BCOS技术落地到各领域应用中,助力产业数字化,或是在多渠道布道,将开源社区精神传播到更远的地方。 | ||
|
|
||
| .. image:: images/community/mvp_review_2023.png |
There was a problem hiding this comment.
下方配图仍是 mvp_review_2023.png(2023 年 MVP 评审照片),与新文案“截至2025年底”“2025年度MVP名单”不匹配,建议更新为 2025 年图片或移除该配图。
基于 FISCO-BCOS v3.17.0 tag 对 3.x 中文文档做全面对齐,修正错误、补齐缺失、 修复失效引用。所有事实性内容均以 v3.17.0 源码为准逐条核对。 修正错误: - feature/bugfix 开关清单:改正两个错误开关名(feature_balance_precompile -> feature_balance_precompiled,feature_policy1 -> feature_balance_policy1), 用错会导致 setSystemConfigByKey 失败 - 编译要求:cmake 最低版本 3.14 -> 3.28,与 CMakeLists.txt 一致 - web3_usage.md:修正绝对本地路径图片引用、过期的 compatibility_version 示例, 并将已解决事项的将来时表述改为完成态 - change_log/index.rst:toctree 条目 3.6.1.md -> 3_6_1.md,此前 v3.6.1 版本说明页始终无法从导航访问 - air/config.md:补充 rpc.enable_ssl(v3.12.0 起取代 disable_ssl), 修正 [storage].typs 拼写 补齐缺失: - 新增 v3.12.0 ~ v3.16.0 五篇版本说明,覆盖此前缺失的 18 个版本 - feature/bugfix 清单补齐至 15 个 feature 与 40 个 bugfix 开关, 默认开启版本依据 Features.cpp 的 upgradeRoadmap 逐条填写 - web3_usage.md 新增 44 个 JSON-RPC 方法说明表 - precompiled.md 新增 22 行系统合约与预编译地址表,并修正原有的 地址范围表述为 [0x1000, 0x20000) - air/config.md 补充 11 个默认生成但此前无文档的配置项, 新增 [web3_rpc] 与 [sync] 两节 - 为 Max 部署形态、轻节点、WBC-Liquid 相关文档添加 v3.18.0 弃用提示 修复引用: - 失效图片引用 80 -> 38(修复 Windows 反斜杠路径与相对层级错误) - 失效内部链接 54 -> 13 验证:Sphinx 构建通过,warning 数 914 -> 868。 剩余 38 张确实缺失的社区文章配图与 13 条指向 2.x 旧路径的链接保留未动, 需人工决策。
按 PR FISCO-BCOS#1861 的 review 意见修复,涉及 Copilot 与 morebtcg 提出的问题。 事实性修正: - Service Weaver 论文出处由 CIDR 2023 更正为 HotOS 2023,并补充 ACM DL 链接 (已核实:Proceedings of the 19th Workshop on Hot Topics in Operating Systems) - 「监管节点」并非 FISCO BCOS 的节点类型,改为「观察节点」,与本页已有的 「共识节点、观察节点、轻节点三种节点类型」表述一致 - 删除「为SC会议史上第一篇区块链性能优化学术论文」这一无出处的强断言, 并为 SC23 论文补充 ACM DL 链接 - 移除无数据支撑的「实测中,同等硬件规模下 Air 吞吐达到或超过 Max 集群」, 改为从前文机制推导的结论 - 简称「金链盟」的 ASCII 引号改为全角引号,与相邻全角括号一致 链接健壮性: - 全部 21 个版本说明页共 43 处 `](#id5)` 锚点改为指向 upgrade.md / feature_bugfix_list.md 源文件。#idN 是 Sphinx 对纯中文标题按文档顺序 分配的序号锚点,任何章节增删都会静默漂移(3_11_0.md 的 #id5 实际已 漂到「实验功能」) 版本一致性: - build_chain.sh 与 BcosBuilder.tgz 的备用下载链接由 v3.6.0 同步至 v3.17.0 (7 个文件 12 处);multihost 的 download_bin.sh 由 3.4.0 同步至 3.17.0 - console 与 bcos-c-sdk 属独立仓库、版本线不同,未随主仓版本改动 表述与内容: - 弃用说明中「将在 v3.18.0 不再维护」统一为「自 v3.18.0 起不再维护」, 并在引言中区分「移除」(编译选项与代码不再随版本发布)与「不再维护」 (代码保留但不再适配优化修复) - 实验功能小节补充说明 v3.17.0 未新增实验功能,并链接至完整的 feature 列表 - 移除首页与「截至2025年底」文案不匹配的 2023 年 MVP 配图 验证:Sphinx 构建通过,warning 数 868,与修复前持平;myst 引用失败数 18 未变化。
morebtcg
left a comment
There was a problem hiding this comment.
复查通过:上一轮意见已全部落实。
- 措辞:引言补充“移除/不再维护”定义,TiKV/Max 改为“自 v3.18.0 起不再维护”;
- Max 说明:删除无法核验的“实测”断言,改为定性论述;
- Service Weaver 出处已更正为 HotOS 2023 并附 ACM DOI;
#id5脆弱锚点已在 3_17_0 及全部历史 changelog 中替换为./upgrade.md显式链接,并补齐 3_12.0~3_16.0 changelog 页面;- 实验功能节注明“v3.17.0 未新增实验功能”并链接 feature_bugfix_list.md;
- “监管节点”改为“观察节点接入”,“横向扩展”已删除;SC23 论文附 DOI;
- build_chain/max/pro 备用下载链接统一 v3.17.0;multihost 的 download_bin 同步 3.17.0;首页 2023 MVP 配图已移除;
- 附带修复的图片路径与相对链接抽查无误。
无阻塞性问题,予以通过。两个非阻塞遗留项见行内评论。
|
|
||
| # 下载建链脚本 | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.11.0/build_chain.sh && chmod u+x build_chain.sh | ||
| curl -#LO https://github.com/FISCO-BCOS/FISCO-BCOS/releases/download/v3.17.0/build_chain.sh && chmod u+x build_chain.sh |
There was a problem hiding this comment.
非阻塞提醒:v3.17.0 release 目前仍是 Pre-release 且资产为空,文档合并后、资产上传前该下载链接会暂时 404。建议合并时机与发版流程同步(release 资产上传后再合入或同日处理)。
Summary
Documentation updates for the v3.17.0 release, in three commits:
Add v3.17.0 docs (
349f75d9): new change-log page3_17_0.mdcovering the security-hardening highlights, the deprecation notices (WASM/WBC-Liquid, gateway Redis distributed rate limiting, light node, TiKV, Max deployment form), the 7 new bugfix switches enabled with compatibility_version 3.17.0, and the upgrade guide; register it in the change-log index and refresh version references in the installation/tutorial pages.Align v3.17.0 wording with the release announcement (
7716f33e): rename the deprecation section to 版本功能变更说明, soften TiKV/Max wording to 不再维护, reorder the deprecated items, and fold the tx-hash hardening into the txpool bullet.Update platform introduction to the latest positioning (
8897bbee): rewriteintroduction.mdwith the latest official positioning (core features with 200K+ TPS, 600+ landed applications, community stats as of end of 2025, community honors); refresh the front page, README and community pages accordingly; add links to the 2025 industry application report, the 2025 MVP list and the certified partner list.