diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 7a6cf4b9a0..1c9ea7eb37 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,8 +1,3 @@ -# To get started with Dependabot version updates, you'll need to specify which -# package ecosystems to update and where the package manifests are located. -# Please see the documentation for all configuration options: -# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file - version: 2 updates: - package-ecosystem: "cargo" diff --git a/CHANGELOG.md b/CHANGELOG.md index 0fd6a59148..99235680f8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,45 @@ +## OpenEthereum v3.4.0 + +This release is based on the last stable version, v3.3.5, and serves as a maintenance +update with various improvements, security patches, and enhancements. Key highlights +include the introduction of JSON logging support, migration to _Rust Version 1.79_ +and several security fixes. + +Enhancements + +* Introduced JSON logging +* Added debug configurations for VSCode Debugging +* Prepared code coverage tool _cargo-tarpaulin_ +* Added quality-of-life scripts for building, testing, and running the client +* Add testing support for Leopold PoA blockchain + +DevOps + +* Upgraded Rust to Version 1.79 by fixing runtime `mio` errors and resolving IPv6 discovery issues in test cases +* Migrated the Docker base image to a scratch image with static linking, optimizing for minimal size and security +* Activate Dependabot for automatic dependency updates + +Cleanup + +* Migrated to using the `substrate-bn` crate from crates.io instead of the GitHub repository +* Added a development profile without optimizations for faster compilation times +* Resolved several compiler warnings in new Rust Version +* Updated `num-bigint` and related types for future compatibility + +Security fixes + +* Removed the deprecated `failure` crate, replacing it with daemonize to mitigate critical vulnerabilities +* Updated `crossbeam-deque` and `crossbeam-utils` to version 0.8.20 to fix data race vulnerabilities +* Bumped the `time` crate to address a segmentation fault issue +* Updated `regex` and related dependencies to resolve a denial-of-service vulnerability +* Applied further minor version upgrades to dependencies to ensure better security +* Update Dockerfiles for more security + +Bug fixes + +* Resolved issues with test case in version 1.79.0 +* Fix build for alpine images + ## OpenEthereum v3.3.5 Enhancements: diff --git a/MAINTENANCE.md b/MAINTENANCE.md new file mode 100644 index 0000000000..1c54e59f73 --- /dev/null +++ b/MAINTENANCE.md @@ -0,0 +1,33 @@ +# Setup Development Environment [Ubuntu 20.04.6 LTS] + +This fork of OpenEthereum project is developed and tested under Ubuntu. +The current state will not work under macOS and Windows is not tested. + +## Install Tools + +```shell +curl https://sh.rustup.rs -sSf | sh +export PATH=$PATH:$HOME/.cargo/bin +``` + +```shell +sudo apt update +``` + +```shell +sudo apt upgrade +``` + +```shell +sudo apt install yasm +``` + +```shell +sudo apt install tree +```` + +## Select Rust Version + +```shell +./scripts/setup-rust-1.79.sh +``` diff --git a/SETUP.md b/SETUP.md deleted file mode 100644 index 6989e7e2e9..0000000000 --- a/SETUP.md +++ /dev/null @@ -1,51 +0,0 @@ -# Setup Tools [Ubuntu 20.04.6 LTS] (Focal Fossa) - -## Install Tools (once) - -```shell -curl https://sh.rustup.rs -sSf | sh -export PATH=$PATH:$HOME/.cargo/bin -sudo apt update -sudo apt upgrade -sudo apt install yasm -```` - -## Select Rust Version - -```shell -./scripts/setup-rust-1.79.sh -``` - -## Build Artifacts - -Build all artifacts for testing. - -```shell -./scripts/build-artifacts.sh -``` - -## Setup for Leopold (Staging) Tests - -### Two Secret Files will be needed - -Change your secrets to get a unique identity. - -```shell -cd .testing/environment/staging/secrets -echo "123" > AccountMnemonic -echo "456" > NetworkMnemonic -``` - -### Create secrets based on mnemonics - -```shell -cd .testing -./secrets_generation.sh -./setup_folders.sh -``` - -### Start Leopold Node - -```shell -./scripts/test-leopold.sh -``` diff --git a/docs/CHANGELOG-3.3.6.md b/docs/CHANGELOG-3.3.6.md deleted file mode 100644 index 02402b0a06..0000000000 --- a/docs/CHANGELOG-3.3.6.md +++ /dev/null @@ -1,14 +0,0 @@ -## OpenEthereum v3.4.0 - -OpenEthereum 3.4.0 is a release based on v3.3.5 which is the last stable version known of the client. -It is a pure maintenance release without new features. The not used project content like CLI tools -will be removed. - -Bug fixes: -* n.a. - -Enhancements: -* n.a. - -DevOps: -* upgrade Rust to current version diff --git a/docs/CHANGELOG-3.4.md b/docs/CHANGELOG-3.4.md deleted file mode 100644 index 04b2d90abb..0000000000 --- a/docs/CHANGELOG-3.4.md +++ /dev/null @@ -1,35 +0,0 @@ -## OpenEthereum v3.4.0 - -This release is based on the last stable version, v3.3.6, and serves as a maintenance update with various improvements, security patches, and enhancements. Key highlights include the introduction of JSON logging support, migration to _Rust Version 1.79_ and several security fixes. - -### Enhancements - -- Introduced JSON logging as `feature`. -- Added debug configurations for VSCode Debugging. -- Prepared code coverage tool `cargo-tarpaulin`. -- Added quality-of-life scripts for building, testing, and running the client. - -### DevOps - -- Upgraded Rust to Version 1.79 by fixing runtime `mio` errors and resolving IPv6 discovery issues in test cases. -- Migrated the Docker base image to a scratch image with static linking, optimizing for minimal size and security. -- Activate Dependabot for automatic dependency updates. - -### Cleanup - -- Migrated to using the `substrate-bn` crate from crates.io instead of the GitHub repository. -- Added a development profile without optimizations for faster compilation times. -- Resolved several compiler warnings in new Rust Version. -- Updated `num-bigint` and related types for future compatibility. - -### Security fixes - -- Removed the deprecated `failure` crate, replacing it with daemonize to mitigate critical vulnerabilities. -- Updated `crossbeam-deque` and `crossbeam-utils` to version 0.8.20 to fix data race vulnerabilities. -- Bumped the `time` crate to address a segmentation fault issue. -- Updated `regex` and related dependencies to resolve a denial-of-service vulnerability. -- Applied further minor version upgrades to dependencies to ensure better security... - -### Bug fixes - -- Resolved issues with test case in version 1.79.