Skip to content

Commit

Permalink
CBC-924 Cleanup Code and Documentation
Browse files Browse the repository at this point in the history
- update CHANGELOG.md
  • Loading branch information
MarkusSprunck committed Oct 23, 2024
1 parent f9b3ed0 commit e232da9
Show file tree
Hide file tree
Showing 6 changed files with 75 additions and 105 deletions.
5 changes: 0 additions & 5 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
42 changes: 42 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
33 changes: 33 additions & 0 deletions MAINTENANCE.md
Original file line number Diff line number Diff line change
@@ -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
```
51 changes: 0 additions & 51 deletions SETUP.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/CHANGELOG-3.3.6.md

This file was deleted.

35 changes: 0 additions & 35 deletions docs/CHANGELOG-3.4.md

This file was deleted.

0 comments on commit e232da9

Please sign in to comment.