Skip to content

Commit

Permalink
v1.6.0 release notes (#2879)
Browse files Browse the repository at this point in the history
* add v1.6.0 release notes and move release notes from website.

* [k8s] Update k8s config to v1.6.0

* fixup

* fixup
  • Loading branch information
jolestar authored Sep 14, 2021
1 parent 977e904 commit 3365c7a
Show file tree
Hide file tree
Showing 77 changed files with 1,519 additions and 18 deletions.
18 changes: 9 additions & 9 deletions .github/workflows/release_asset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,12 @@ jobs:
asset_name: move-${{ matrix.platform }}
asset_content_type: application/octet-stream
- name: upload genesis-nft release asset
if: ${{ github.event_name == 'release'}}
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ github.event.release.upload_url }}
asset_path: ./target/release/genesis-nft-miner
asset_name: genesis-nft-miner-${{ matrix.platform }}
asset_content_type: application/octet-stream
if: ${{ github.event_name == 'release'}}
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ github.event.release.upload_url }}
asset_path: ./target/release/genesis-nft-miner
asset_name: genesis-nft-miner-${{ matrix.platform }}
asset_content_type: application/octet-stream
2 changes: 1 addition & 1 deletion kube/manifest/starcoin-barnard.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ spec:
starcoin/node-pool: seed-pool
containers:
- name: starcoin
image: starcoin/starcoin:v1.5.1
image: starcoin/starcoin:v1.6.0
imagePullPolicy: Always
command:
- bash
Expand Down
2 changes: 1 addition & 1 deletion kube/manifest/starcoin-main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ spec:
starcoin/node-pool: seed-pool
containers:
- name: starcoin
image: starcoin/starcoin:v1.5.1
image: starcoin/starcoin:v1.6.0
imagePullPolicy: Always
command:
- bash
Expand Down
2 changes: 1 addition & 1 deletion kube/manifest/starcoin-proxima.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ spec:
starcoin/node-pool: seed-pool
containers:
- name: starcoin
image: starcoin/starcoin:v1.5.1
image: starcoin/starcoin:v1.6.0
imagePullPolicy: Always
command:
- bash
Expand Down
7 changes: 7 additions & 0 deletions release-notes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

Run the follow commands:

```
gren changelog --generate -D prs -f changelogs/$version.md
```
22 changes: 22 additions & 0 deletions release-notes/v0.10.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: v0.10.0
weight: 18
---

StateDB and AccessPath refactor

<!--more-->

[statedb] StateDB and AccessPath refactor [#1932](https://github.com/starcoinorg/starcoin/pull/1932)
[vm] upgrade vm to version 0105 [#1926](https://github.com/starcoinorg/starcoin/pull/1926)
[stdlib] add block reward event [#1915](https://github.com/starcoinorg/starcoin/pull/1915)
[stdlib] set min time for two phase upgrade [#1922](https://github.com/starcoinorg/starcoin/pull/1922)
[hash] change hash prefix to STARCOIN [#1939](https://github.com/starcoinorg/starcoin/pull/1939)
[chain & network] Keep BlockInfo in ChainStatus and switch in network handshake [#1943](https://github.com/starcoinorg/starcoin/pull/1943)
[network] Upgrade libp2p to 0.33.0 [#1921](https://github.com/starcoinorg/starcoin/pull/1921)
[pow]Add extra field to block header && block number to subscribe mint block [#1942](https://github.com/starcoinorg/starcoin/pull/1942)
[rpc] Chain rpc improve [#1938](https://github.com/starcoinorg/starcoin/pull/1938)
[rpc] add account change password api [#1927](https://github.com/starcoinorg/starcoin/pull/1927)
[config] config refactor [#1925](https://github.com/starcoinorg/starcoin/pull/1925)
[tools] fix x tool unavailability [#1940](https://github.com/starcoinorg/starcoin/pull/1940)

22 changes: 22 additions & 0 deletions release-notes/v0.10.0.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: v0.10.0
weight: 18
---

重构 StateDB 和 AccessPath

<!--more-->

[statedb] 重构 StateDB 和 AccessPath [#1932](https://github.com/starcoinorg/starcoin/pull/1932)
[vm] 虚拟机升级到 v0105 [#1926](https://github.com/starcoinorg/starcoin/pull/1926)
[stdlib] 增加区块奖励事件 [#1915](https://github.com/starcoinorg/starcoin/pull/1915)
[stdlib] 增设两阶段提交最小时间间隔 [#1922](https://github.com/starcoinorg/starcoin/pull/1922)
[hash] 将哈希前缀改为 STARCOIN [#1939](https://github.com/starcoinorg/starcoin/pull/1939)
[chain & network] 在 ChainStatus 中保存 BlockInfo 并在网络握手时切换 [#1943](https://github.com/starcoinorg/starcoin/pull/1943)
[network] 升级 libp2p 到 v0.33.0 [#1921](https://github.com/starcoinorg/starcoin/pull/1921)
[pow] 在区块头中增加额外字段来订阅 mint block [#1942](https://github.com/starcoinorg/starcoin/pull/1942)
[rpc] 改进 Chain rpc [#1938](https://github.com/starcoinorg/starcoin/pull/1938)
[rpc] 增加 account change password api [#1927](https://github.com/starcoinorg/starcoin/pull/1927)
[config] 重构 config [#1925](https://github.com/starcoinorg/starcoin/pull/1925)
[tools] 修复 coverage 工具 [#1940](https://github.com/starcoinorg/starcoin/pull/1940)

21 changes: 21 additions & 0 deletions release-notes/v0.10.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: v0.10.1
weight: 19
---

Refactor BlockHeader and module compatibility check, optimize tx propagation

<!--more-->

[rpc] add gas_price and account_sign_message api [#2008](https://github.com/starcoinorg/starcoin/pull/2008)
[types] refactor BlockHeader [#2014](https://github.com/starcoinorg/starcoin/pull/2014)
[types] improve BlockHeaderExtra deserialization [#2013](https://github.com/starcoinorg/starcoin/pull/2013)
[types] review hash compatibility and add test [#2004](https://github.com/starcoinorg/starcoin/pull/2004)
[vm] refactor module compatibility check [#1993](https://github.com/starcoinorg/starcoin/pull/1993)
[vm] refactor gas schedule [#1947](https://github.com/starcoinorg/starcoin/pull/1947)
[stress] made a detailed stress test plan and improved stress tool [#1992](https://github.com/starcoinorg/starcoin/pull/1992)
[network] optimize tx propagation [#1990](https://github.com/starcoinorg/starcoin/pull/1990)
[sync] use new peer while sync [#1991](https://github.com/starcoinorg/starcoin/pull/1991)
[chain] optimize uncle block verification [#1984](https://github.com/starcoinorg/starcoin/pull/1984)
[ci] config node selector for halley & proxima pod [#1999](https://github.com/starcoinorg/starcoin/pull/1999)
[ci] deploy halley to kubernetes [#1987](https://github.com/starcoinorg/starcoin/pull/1987)
21 changes: 21 additions & 0 deletions release-notes/v0.10.1.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: v0.10.1
weight: 19
---

重构 BlockHeader 以及Module 兼容性检查, 优化交易广播

<!--more-->

[rpc] 增加 gas_price 和 account_sign_message 接口 [#2008](https://github.com/starcoinorg/starcoin/pull/2008)
[types] 重构 BlockHeader [#2014](https://github.com/starcoinorg/starcoin/pull/2014)
[types] 改进 BlockHeaderExtra 反序列化 [#2013](https://github.com/starcoinorg/starcoin/pull/2013)
[types] 梳理哈希兼容性并添加测试 [#2004](https://github.com/starcoinorg/starcoin/pull/2004)
[vm] 重构 Module 兼容性检查 [#1993](https://github.com/starcoinorg/starcoin/pull/1993)
[vm] 重构 gas 调度器 [#1947](https://github.com/starcoinorg/starcoin/pull/1947)
[stress] 制定详细压测计划并改进压测工具 [#1992](https://github.com/starcoinorg/starcoin/pull/1992)
[network] 优化交易广播 [#1990](https://github.com/starcoinorg/starcoin/pull/1990)
[sync] 同步时使用新的更优 peer 代替老 peer [#1991](https://github.com/starcoinorg/starcoin/pull/1991)
[chain] 优化叔块校验 [#1984](https://github.com/starcoinorg/starcoin/pull/1984)
[ci] 为 halley 和 proxima pod 配置结点选择器 [#1999](https://github.com/starcoinorg/starcoin/pull/1999)
[ci] 通过 kubernetes 部署 halley [#1987](https://github.com/starcoinorg/starcoin/pull/1987)
25 changes: 25 additions & 0 deletions release-notes/v0.3.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: v0.3.1
weight: 1
---

Epoch and Uncle Block mechanism are introduced.

<!--more-->

1. Epoch and Uncle Block mechanism are introduced, the difficulty of PoW can be dynamically adjusted according to the Uncle Block rate.
2. The `Package` transaction type is introduced, which supports batch deployment of multiple Modules with initialization scripts.
3. Stabilization of Token module and issuance mechanism, the value of Token is changed from u64 to u128, which can support larger total amount and higher accuracy.
4. Implementation of Transaction fee distribution contracts.
5. Stdlib added SortedLinkedList, Math, BitOperators modules.
6. The BlockReword contract was refactored to accommodate Epoch and Uncle Block mechanisms.
7. Module upgrade mechanism is provided, and developers can customize the strategy of contract upgrade. Module upgrade compatibility check is implemented to ensure compatibility with the old version when upgrading.
8. Refactor Genesis to implement Genesis transaction via Package transaction. Simplify Genesis Account, retaining only 0x1 Genesis account.
9. Introduced the network rpc framework to simplify the implementation of the rpc interface on p2p networks.
10. Introduce Move's coverage tool to count stdlib's test coverage.
11. Simplify Node configuration and unify command line parameter format.
12. move-vm bump to 821ac69a5e3ff3e323601c355d8de42f957d9c26 (July 14) .
13. libp2p bump to 0.22.
14. rust tool chain bump to 1.44.1.

For a full rundown of the changes please consult the Starcoin 0.3.0 [release milestone](https://github.com/starcoinorg/starcoin/milestone/8)
25 changes: 25 additions & 0 deletions release-notes/v0.3.1.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: v0.3.1
weight: 1
---

引入Epoch 以及叔块机制。

<!--more-->

1. 引入 Epoch 以及叔块机制,PoW 出块难度可以根据叔块率来动态调整。
2. 引入 `Package` 交易类型,支持批量部署多个 Module 以及附带初始化脚本。
3. Token 模块以及发行机制的稳定化,Token 的值从 u64 改为 u128,可以支持更大的总量以及更高的精度。
4. 实现了 Transaction fee 的分发合约。
5. Stdlib 增加了 SortedLinkedList,Math,BitOperators 模块。
6. 重构了 BlockReword 合约,以适应 Epoch 以及叔块机制。
7. 提供了 Module 升级机制,开发者可以自定义合约升级的策略。实现了升级 Module 的兼容性检查,保证升级时和旧的版本兼容。
8. 重构 Genesis,通过 Package 交易实现 Genesis 交易。简化 Genesis Account,只保留 0x1 一个 Genesis account。
9. 引入 network rpc 框架,简化 p2p 网络上的 rpc 接口实现。
10. 引入 Move 的覆盖率工具,统计 stdlib 的测试覆盖率。
11. 简化 Node 配置以及统一命令行参数格式。
12. move-vm bump to 821ac69a5e3ff3e323601c355d8de42f957d9c26 (July 14) .
13. libp2p bump to 0.22.
14. rust tool chain bump to 1.44.1.

更详细的变更列表请参看 [release milestone](https://github.com/starcoinorg/starcoin/milestone/8)
29 changes: 29 additions & 0 deletions release-notes/v0.4.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: v0.4.1
weight: 2
---

Refactor and stabilize the basic data types and Stdlib.

<!--more-->

1. Refactor and stabilize the basic data types, Block, Transaction, etc.
2. Add ChainID in the transaction to distinguish the transactions of different chain networks.
3. Add Gas TokenCode in transactions, in preparation for supporting any Token as Gas in the future.
4. Improve the expiration mechanism of transactions.
5. Rebuild and stabilize Stdlib.
6. Refactor VM and VM error handling.
7. Fix the Token Type Determination bug in Token Module, and use TokenCode to mark the Token Type, such as: 0x1::STC::STC.
8. Clean up and stabilize P2P network messages.
9. Restructure and implement Fast Sync.
10. Fix some bugs in the uncle block.
11. Refactor the cli, rename the wallet command to account, and implement the off-chain data storage and query of account.
12. Introduce Move prover, prepare for Stdlib to implement formal proof.
13. Improve the unit test coverage of Stdlib to 80%.
14. Refactoring and improving the integration testing framework.
15. Refactor and stabilize node configuration.
16. Refactor block rewards, Epoch's tuning algorithm, and STC's distribution strategy.
17. move-vm bump to 9eadc565466d3db3a2b6b4f38c3fea78dcddc372 (July 29) .
18. rust tool chain bump to 1.45.0.

For a full rundown of the changes please consult the Starcoin 0.4 [release milestone](https://github.com/starcoinorg/starcoin/milestone/9)
29 changes: 29 additions & 0 deletions release-notes/v0.4.1.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: v0.3.1
weight: 2
---

稳定化基本类型以及 Stdlib。

<!--more-->

1. 重构以及稳定化基本数据类型,Block,Transaction 等。
2. 交易中增加 ChainID 用于区分不同网络的交易。
3. 交易中增加 Gas TokenCode, 为未来支持任意 Token 作为 Gas 做准备。
4. 完善交易的过期机制。
5. 重构以及稳定化 Stdlib。
6. 重构 VM 以及 VM 的错误处理。
7. 修复 Token 合约的 Token 类型判断 bug,统一使用 TokenCode 来标记 Token 类型,比如: 0x1::STC::STC。
8. 清理以及稳定化 P2P 网络消息。
9. 重构以及完善 Fast Sync。
10. 修复叔块的若干 Bug。
11. 重构 cli,将 wallet 命令重命名为 account,实现了 account 的 off-chain 数据存储和检索。
12. 引入 Move prover,为 Stdlib 实现形式化证明做准备。
13. 提升 Stdlib 单元测试覆盖率到 80%。
14. 重构以及完善集成测试框架。
15. 重构以及稳定化节点配置。
16. 重构了区块奖励, Epoch 的调整算法,以及 STC 的发行策略。
17. move-vm bump to 9eadc565466d3db3a2b6b4f38c3fea78dcddc372 (July 29) .
18. rust tool chain bump to 1.45.0.

更详细的变更列表请参看 [release milestone](https://github.com/starcoinorg/starcoin/milestone/9)
17 changes: 17 additions & 0 deletions release-notes/v0.4.2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: v0.4.2
weight: 3
---

Account and State command enhancement.

<!--more-->

1. Enhance the Account command.
2. Enhance the State command and support ResourceView.
3. Add the command epoch_info_by_number to support querying EpochInfo by block number.
4. Fix the bug of block time verification.
5. Fix the bug of block stop after block produce error.
6. Refactor the logic of initializing Storage via Genesis.
7. Refactor the error handling during Node startup.
8. move-vm bump to fb0724ca39edc9afc8c697d1183d562880433d8e (Aug 11) .
17 changes: 17 additions & 0 deletions release-notes/v0.4.2.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: v0.4.2
weight: 3
---

Account 和 State 命令增强.

<!--more-->

1. 增强 Account 命令。
2. 增强 State 命令,支持 ResourceView。
3. 增加 epoch_info_by_number 命令,支持根据区块查询 EpochInfo。
4. 修复区块时间校验的 bug。
5. 修复出块错误后出块停止的 bug。
6. 重构通过 Genesis 初始化 Storage 的逻辑。
7. 重构 Node 启动过程中的错误处理机制。
8. move-vm bump to fb0724ca39edc9afc8c697d1183d562880433d8e (Aug 11) .
12 changes: 12 additions & 0 deletions release-notes/v0.4.3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: v0.4.3
weight: 4
---

Sync bug fix.
<!--more-->

1. Fix the bug of fast sync mode.
2. Fix the bug of finding common ancestor block during sync, add filtering condition based on difficulty.


10 changes: 10 additions & 0 deletions release-notes/v0.4.3.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: v0.4.3
weight: 4
---

同步 Bug 修复。
<!--more-->

1. 修复快速同步模式的 bug.
2. 修复同步过程中查找共同祖先的 bug,增加根据难度过滤的条件。
16 changes: 16 additions & 0 deletions release-notes/v0.4.4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: v0.4.4
weight: 5
---

Stdlib adds Spec validation logic for 80% coverage.

<!--more-->

1. Synchronization feature adds random peer selection policy, optimizes BeginSync events.
2. Accumulator optimizes the algorithm of get_leaf_node, replacing the return value by Option.
3. Stdlib adds Spec validation logic for 80% coverage.
4. Proptest framework implements block, transaction and other basic component validation.
5. Generator client-side sdk generation tool , currently supports python, java, cpp and other languages.
6. Coverage report include integration test and Codecov/Benchmark action support manual trigger.
7. Refactor chain error code.
16 changes: 16 additions & 0 deletions release-notes/v0.4.4.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: v0.4.4
weight: 5
---

Stdlib 增加 Spec 形式化验证,覆盖率达到80%.

<!--more-->

1. 同步功能增加随机选peer的策略,优化BeginSync事件.
2. 累加器优化get_node算法,替换返回值类型为Option.
3. Stdlib增加Spec验证逻辑,覆盖率达到80%.
4. Proptest实现block、transaction等基础组件的验证.
5. Generator客户端sdk生成工具,目前支持了python、java、cpp等语言。
6. 持续集成功能增强:包括代码覆盖率检查涵盖了集成测试,代码覆盖率检查和基准测试支持手工触发。
7. 重构Chain完成第一阶段:error code统一.
15 changes: 15 additions & 0 deletions release-notes/v0.4.5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: v0.4.5
weight: 6
---

Refactor uncle block and open block, create_block_template and implement service registry.

<!--more-->

1. Refactor uncle block and open block, create_block_template.
2. Benchmark add chain test, includes block query and apply functions.
3. Stdlib fix module name order, and adds Spec validation of Block, Account, Token, etc.
4. Implement service registry, all services are started by default, may specify that some services should not be started.
5. Command Line Tools add a generator command for generate config and data.

15 changes: 15 additions & 0 deletions release-notes/v0.4.5.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: v0.4.5
weight: 6
---

重构叔块、Open block,create_block_template模块以及服务注册器实现。

<!--more-->

1. 重构叔块、Open block,create_block_template模块。
2. 基准测试增加了chain相关测试,包括块块查询和apply功能。
3. Stdlib修正模块名称顺序,并增加Block、Account、Token等Spec验证。
4. 实现服务注册器功能,默认启动所有服务,可定制部分服务不启动。
5. 命令行工具增加generator命令,用于生成配置和block数据。

Loading

0 comments on commit 3365c7a

Please sign in to comment.