From aed8d86d4b47855e9245d68d6ec2b81b7cf6bae4 Mon Sep 17 00:00:00 2001 From: dustinxie Date: Thu, 30 May 2024 22:12:18 -0700 Subject: [PATCH] release v1.14.1 (#277) --- README.md | 16 ++++---- README_CN.md | 16 ++++---- README_CN_testnet.md | 14 +++---- README_testnet.md | 14 +++---- changelog/v1.14.1-release-note.md | 68 +++++++++++++++++++++++++++++++ 5 files changed, 98 insertions(+), 30 deletions(-) create mode 100644 changelog/v1.14.1-release-note.md diff --git a/README.md b/README.md index 1ca1133..85d742a 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Here are the software versions we use: -- MainNet: v1.14.0 +- MainNet: v1.14.1 ## Join TestNet To start and run a testnet node, please click [**Join Testnet**](https://github.com/iotexproject/iotex-bootstrap/blob/master/README_testnet.md) @@ -30,7 +30,7 @@ This is the recommended way to start an IoTeX node 1. Pull the docker image: ``` -docker pull iotex/iotex-core:v1.14.0 +docker pull iotex/iotex-core:v1.14.1 ``` 2. Set the environment with the following commands: @@ -45,9 +45,9 @@ mkdir -p $IOTEX_HOME/data mkdir -p $IOTEX_HOME/log mkdir -p $IOTEX_HOME/etc -curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.0/config_mainnet.yaml > $IOTEX_HOME/etc/config.yaml -curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.0/genesis_mainnet.yaml > $IOTEX_HOME/etc/genesis.yaml -curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.0/trie.db.patch > $IOTEX_HOME/data/trie.db.patch +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.1/config_mainnet.yaml > $IOTEX_HOME/etc/config.yaml +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.1/genesis_mainnet.yaml > $IOTEX_HOME/etc/genesis.yaml +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.1/trie.db.patch > $IOTEX_HOME/data/trie.db.patch ``` 3. Edit `$IOTEX_HOME/etc/config.yaml`, look for `externalHost` and `producerPrivKey`, uncomment the lines and fill in your external IP and private key. If you leave `producerPrivKey` empty, your node will be assgined with a random key. @@ -87,7 +87,7 @@ docker run -d --restart on-failure --name iotex \ -v=$IOTEX_HOME/log:/var/log:rw \ -v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \ -v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \ - iotex/iotex-core:v1.14.0 \ + iotex/iotex-core:v1.14.1 \ iotex-server \ -config-path=/etc/iotex/config_override.yaml \ -genesis-path=/etc/iotex/genesis.yaml @@ -107,7 +107,7 @@ docker run -d --restart on-failure --name iotex \ -v=$IOTEX_HOME/log:/var/log:rw \ -v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \ -v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \ - iotex/iotex-core:v1.14.0 \ + iotex/iotex-core:v1.14.1 \ iotex-server \ -config-path=/etc/iotex/config_override.yaml \ -genesis-path=/etc/iotex/genesis.yaml \ @@ -128,7 +128,7 @@ Same as [Join MainNet](#mainnet) step 2 ``` git clone https://github.com/iotexproject/iotex-core.git cd iotex-core -git checkout v1.14.0 +git checkout v1.14.1 // optional export GOPROXY=https://goproxy.io diff --git a/README_CN.md b/README_CN.md index 8574a03..26f9c53 100644 --- a/README_CN.md +++ b/README_CN.md @@ -18,7 +18,7 @@ 以下是当前我们使用的软件版本： -- 主网：v1.14.0 +- 主网：v1.14.1 ## 加入测试网 如果你要启动节点加入测试网，请点击[**加入测试网**](https://github.com/iotexproject/iotex-bootstrap/blob/master/README_CN_testnet.md) @@ -30,7 +30,7 @@ 1. 提取(pull) docker镜像 ``` -docker pull iotex/iotex-core:v1.14.0 +docker pull iotex/iotex-core:v1.14.1 ``` 2. 使用以下命令设置运行环境 @@ -45,9 +45,9 @@ mkdir -p $IOTEX_HOME/data mkdir -p $IOTEX_HOME/log mkdir -p $IOTEX_HOME/etc -curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.0/config_mainnet.yaml > $IOTEX_HOME/etc/config.yaml -curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.0/genesis_mainnet.yaml > $IOTEX_HOME/etc/genesis.yaml -curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.0/trie.db.patch > $IOTEX_HOME/data/trie.db.patch +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.1/config_mainnet.yaml > $IOTEX_HOME/etc/config.yaml +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.1/genesis_mainnet.yaml > $IOTEX_HOME/etc/genesis.yaml +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.1/trie.db.patch > $IOTEX_HOME/data/trie.db.patch ``` 3. 编辑 `$IOTEX_HOME/etc/config.yaml`, 查找 `externalHost` 和 `producerPrivKey`, 取消注释行并填写您的外部 IP 和私钥。如果`producerPrivKey`放空，你的节点将被分配一个随机密钥。 @@ -84,7 +84,7 @@ docker run -d --restart on-failure --name iotex \ -v=$IOTEX_HOME/log:/var/log:rw \ -v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \ -v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \ - iotex/iotex-core:v1.14.0 \ + iotex/iotex-core:v1.14.1 \ iotex-server \ -config-path=/etc/iotex/config_override.yaml \ -genesis-path=/etc/iotex/genesis.yaml @@ -102,7 +102,7 @@ docker run -d --restart on-failure --name iotex \ -v=$IOTEX_HOME/log:/var/log:rw \ -v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \ -v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \ - iotex/iotex-core:v1.14.0 \ + iotex/iotex-core:v1.14.1 \ iotex-server \ -config-path=/etc/iotex/config_override.yaml \ -genesis-path=/etc/iotex/genesis.yaml \ @@ -122,7 +122,7 @@ docker run -d --restart on-failure --name iotex \ ``` git clone https://github.com/iotexproject/iotex-core.git cd iotex-core -git checkout v1.14.0 +git checkout v1.14.1 // optional export GOPROXY=https://goproxy.io diff --git a/README_CN_testnet.md b/README_CN_testnet.md index f0a369d..96596b9 100644 --- a/README_CN_testnet.md +++ b/README_CN_testnet.md @@ -17,7 +17,7 @@ 以下是当前我们使用的软件版本： -- 测试网：v1.14.0 +- 测试网：v1.14.1 **Note** 如果你要启动节点加入主网，请点击[**加入主网**](https://github.com/iotexproject/iotex-bootstrap/blob/master/README_CN.md) @@ -29,7 +29,7 @@ 1. 提取(pull) docker镜像 ``` -docker pull iotex/iotex-core:v1.14.0 +docker pull iotex/iotex-core:v1.14.1 ``` 2. 使用以下命令设置运行环境 @@ -44,8 +44,8 @@ mkdir -p $IOTEX_HOME/data mkdir -p $IOTEX_HOME/log mkdir -p $IOTEX_HOME/etc -curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.0/config_testnet.yaml > $IOTEX_HOME/etc/config.yaml -curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.0/genesis_testnet.yaml > $IOTEX_HOME/etc/genesis.yaml +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.1/config_testnet.yaml > $IOTEX_HOME/etc/config.yaml +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.1/genesis_testnet.yaml > $IOTEX_HOME/etc/genesis.yaml ``` 3. 编辑 `$IOTEX_HOME/etc/config.yaml`, 查找 `externalHost` 和 `producerPrivKey`, 取消注释行并填写您的外部 IP 和私钥。如果`producerPrivKey`放空，你的节点将被分配一个随机密钥。 @@ -82,7 +82,7 @@ docker run -d --restart on-failure --name iotex \ -v=$IOTEX_HOME/log:/var/log:rw \ -v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \ -v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \ - iotex/iotex-core:v1.14.0 \ + iotex/iotex-core:v1.14.1 \ iotex-server \ -config-path=/etc/iotex/config_override.yaml \ -genesis-path=/etc/iotex/genesis.yaml @@ -100,7 +100,7 @@ docker run -d --restart on-failure --name iotex \ -v=$IOTEX_HOME/log:/var/log:rw \ -v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \ -v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \ - iotex/iotex-core:v1.14.0 \ + iotex/iotex-core:v1.14.1 \ iotex-server \ -config-path=/etc/iotex/config_override.yaml \ -genesis-path=/etc/iotex/genesis.yaml \ @@ -120,7 +120,7 @@ docker run -d --restart on-failure --name iotex \ ``` git clone https://github.com/iotexproject/iotex-core.git cd iotex-core -git checkout v1.14.0 +git checkout v1.14.1 // optional export GOPROXY=https://goproxy.io diff --git a/README_testnet.md b/README_testnet.md index 4c2ca7b..d9d6086 100644 --- a/README_testnet.md +++ b/README_testnet.md @@ -18,7 +18,7 @@ Here are the software versions we use: -- TestNet: v1.14.0 +- TestNet: v1.14.1 **Note** To start and run a mainnet node, please click [**Join Mainnet**](https://github.com/iotexproject/iotex-bootstrap/blob/master/README.md) @@ -29,7 +29,7 @@ This is the recommended way to start an IoTeX node 1. Pull the docker image: ``` -docker pull iotex/iotex-core:v1.14.0 +docker pull iotex/iotex-core:v1.14.1 ``` 2. Set the environment with the following commands: @@ -44,8 +44,8 @@ mkdir -p $IOTEX_HOME/data mkdir -p $IOTEX_HOME/log mkdir -p $IOTEX_HOME/etc -curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.0/config_testnet.yaml > $IOTEX_HOME/etc/config.yaml -curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.0/genesis_testnet.yaml > $IOTEX_HOME/etc/genesis.yaml +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.1/config_testnet.yaml > $IOTEX_HOME/etc/config.yaml +curl https://raw.githubusercontent.com/iotexproject/iotex-bootstrap/v1.14.1/genesis_testnet.yaml > $IOTEX_HOME/etc/genesis.yaml ``` 3. Edit `$IOTEX_HOME/etc/config.yaml`, look for `externalHost` and `producerPrivKey`, uncomment the lines and fill in your external IP and private key. If you leave `producerPrivKey` empty, your node will be assgined with a random key. @@ -85,7 +85,7 @@ docker run -d --restart on-failure --name iotex \ -v=$IOTEX_HOME/log:/var/log:rw \ -v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \ -v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \ - iotex/iotex-core:v1.14.0 \ + iotex/iotex-core:v1.14.1 \ iotex-server \ -config-path=/etc/iotex/config_override.yaml \ -genesis-path=/etc/iotex/genesis.yaml @@ -105,7 +105,7 @@ docker run -d --restart on-failure --name iotex \ -v=$IOTEX_HOME/log:/var/log:rw \ -v=$IOTEX_HOME/etc/config.yaml:/etc/iotex/config_override.yaml:ro \ -v=$IOTEX_HOME/etc/genesis.yaml:/etc/iotex/genesis.yaml:ro \ - iotex/iotex-core:v1.14.0 \ + iotex/iotex-core:v1.14.1 \ iotex-server \ -config-path=/etc/iotex/config_override.yaml \ -genesis-path=/etc/iotex/genesis.yaml \ @@ -126,7 +126,7 @@ Same as [Join TestNet](#testnet) step 2 ``` git clone https://github.com/iotexproject/iotex-core.git cd iotex-core -git checkout v1.14.0 +git checkout v1.14.1 // optional export GOPROXY=https://goproxy.io diff --git a/changelog/v1.14.1-release-note.md b/changelog/v1.14.1-release-note.md new file mode 100644 index 0000000..4275808 --- /dev/null +++ b/changelog/v1.14.1-release-note.md @@ -0,0 +1,68 @@ +# v1.14.1 Release Note + +## Summary +v1.14.1 is the first maintenance release after the latest release v1.14.0. It +comes with enhancements across various components such as blockdao, staking, +API. Also, ioctl commandline tool has a fresh upgrade that supports two new +powerful functions: ioID and w3bstream. The ioID function enables seamless +integration and management of decentralized identities on the IoTeX blockchain. +The w3bstream functions allows for efficient management of w3bstream project +on the chain, from project creation, device registration, to message operation +and prover management. + +## Bug Fix and Performance Improvements: +1. bumped go version to 1.21 +2. Resolved an issue where the blockdao process could become unresponsive while +checking the indexer. This fix ensures that the node process can receive the +break signal and exit if needed. +3. Fixed an issue where the response ID type in the JSON-RPC API did not match +the request type. This ensures consistency and reliability in web3js API. +4. Enhanced the deserialization process when retrieving block receipts, resulting +in faster access and improved overall performance of the blockdao component. +5. Fixed wrong cache for API readState at tip height, now the cache always returns +most accurate and latest result. + +## New Features and Enhancements +1. Added endorsement details to the bucket fetch APIs, providing more comprehensive +information for stakeholders and improving transparency within the staking process. +2. Implemented rate limiting for the WebSocket API to prevent abuse and ensure +fair usage. This enhancement protects the network from potential overload and +improves service stability. +3. Enabled the ToEthTx function for grantReward action, allowing it to be processed +as an Ethereum-compatible transaction. This improvement facilitates interoperability +and expands the utility of the IoTeX blockchain. +4. Added 2 new commands `ioid` and `ws` to ioctl commandline tool. Enables the ioID +management and w3bstream project functions. + +## Upgrade Priority +v1.14.1 does not have a hardfork, but contains several bug fixes, performance +improvements, and new feature enhancements. All delegate nodes and API nodes are +recommended to upgrade to v1.14.1 in order to provide the best up-to-date service + +| Node type | Action | +| ---------- | ------------ | +| Delegate | Recommended | +| Fullnode | Not required | +| API node | Recommended | + +## Important Commits (not a complete list) +1. [ioctl] Add CandidateEndorsement and CandidateActivate action [#4194](https://github.com/iotexproject/iotex-core/pull/4194) +2. [blockdao] Fix program unstopable when blockdao is checking indexer [#4217](https://github.com/iotexproject/iotex-core/pull/4217) +3. [blockdao] Optimize derialization when retrieving receipts [#4221](https://github.com/iotexproject/iotex-core/pull/4221) +4. [staking] Add endorsement info in bucket fetch apis [#4207](https://github.com/iotexproject/iotex-core/pull/4207) +5. [api] Support for tracer and tracerConfig in debug_traceTransaction API [#4216](https://github.com/iotexproject/iotex-core/pull/4216) +6. [api] fix JsonRPC api response id type doesn't match request type [#4168](https://github.com/iotexproject/iotex-core/pull/4168) +7. [api] Add ratelimit for websocket API [#4031](https://github.com/iotexproject/iotex-core/pull/4031) +8. [action] Add grantReward ToEthTx() [#4047](https://github.com/iotexproject/iotex-core/pull/4047) +9. [api] Fix wrong cache for api readState at tip height [#4253](https://github.com/iotexproject/iotex-core/pull/4253) +10. feat(wsctl): add project configuration cmd [#4195](https://github.com/iotexproject/iotex-core/pull/4195) +11. [ioctl]: update ws project format [#4224](https://github.com/iotexproject/iotex-core/pull/4224) +12. feat(ioctl/ws): sync latest w3bstream contract abis and generate go code [#4279](https://github.com/iotexproject/iotex-core/pull/4279) +13. [ioctl][ws][#2] add w3bstream contracts address configurations [#4280](https://github.com/iotexproject/iotex-core/pull/4280) +14. [ioctl][ws][#3] project sub command to support interaction with ws contracts [#4281](https://github.com/iotexproject/iotex-core/pull/4281) +15. [ioctl][ws][#4] prover sub commands to support interaction with ws contracts [#4282](https://github.com/iotexproject/iotex-core/pull/4282) +16. [ioctl][ws][#5] project device sub commands to support interaction with ws contracts [#4283](https://github.com/iotexproject/iotex-core/pull/4283) +17. [ioctl][ioid][#1] ioid sub commands [#4284](https://github.com/iotexproject/iotex-core/pull/4284) +18. [ioctl][ws] update ws default value [#4285](https://github.com/iotexproject/iotex-core/pull/4285) + +