diff --git a/README.md b/README.md index d187676e4ac..fe1c6ba4433 100644 --- a/README.md +++ b/README.md @@ -1,133 +1,20 @@ -

- - - - Nethermind - -

+# Fuse Nethermind Client -# Nethermind Ethereum client +This projects builds a customized version of the nethermind client with Fuse Network modifications. Those include the integrations with the Fuse SparkNet -[![Tests](https://github.com/nethermindeth/nethermind/actions/workflows/nethermind-tests.yml/badge.svg)](https://github.com/nethermindeth/nethermind/actions/workflows/nethermind-tests.yml) -[![Chat on Discord](https://img.shields.io/discord/629004402170134531?style=social&logo=discord)](https://discord.gg/GXJFaYk) -[![Follow us on Twitter](https://img.shields.io/twitter/follow/nethermindeth?style=social&label=Follow)](https://twitter.com/nethermindeth) -[![Ask on Discourse](https://img.shields.io/discourse/posts?style=social&label=Community&logo=discourse&server=https%3A%2F%2Fcommunity.nethermind.io)](https://community.nethermind.io/c/nethermind-client) -[![GitPOAPs](https://public-api.gitpoap.io/v1/repo/NethermindEth/nethermind/badge)](https://www.gitpoap.io/gh/NethermindEth/nethermind) +Since 08.2022 Fuse moved from OE client to Nethermind. To bootstrap your own Fuse (Spark) node on Nethermind client you could use `quickstart.sh` script. -Nethermind is a high-performance, highly configurable Ethereum execution client built on .NET that runs on Linux, Windows, and macOS and supports Clique, Aura, and Ethash. With breakneck sync speeds and support for external plugins, it provides reliable access to rich on-chain data thanks to a high-performance JSON-RPC interface and node health monitoring with Grafana and Seq. +## Nethermind Documentation -## Documentation +Nethermind documentation is available at [docs.nethermind.io](https://docs.nethermind.io). CLI documentation is available at [docs.nethermind.io/.../ethereum-client](https://docs.nethermind.io/nethermind/ethereum-client/configuration). -Nethermind documentation is available at [docs.nethermind.io](https://docs.nethermind.io). +## Starting nethermind node for Fuse mainnet or Spartk testmet -### Supported networks +Please refere to [quickstart.sh guide](https://github.com/fuseio/fuse-network/tree/master/nethermind) -**`Mainnet`** **`Goerli`** **`Sepolia`** **`Holesky`** **`Gnosis (xDai)`** **`Chiado`** **`Energy Web`** **`Volta`** +## Branches -## Download and run - -Release builds are available on the [Releases page](https://github.com/nethermindeth/nethermind/releases) and at [downloads.nethermind.io](https://downloads.nethermind.io). - -### On Linux - -#### Prerequisites - -- #### Ubuntu / Debian - - ```sh - sudo apt-get install libsnappy-dev - ``` - -- #### CentOS / Fedora - - ```sh - sudo dnf install -y snappy - sudo ln -s `find /usr/lib64/ -type f -name "libbz2.so.1*"` /usr/lib64/libbz2.so.1.0 - ``` - -#### Install using PPA - -1. `sudo add-apt-repository ppa:nethermindeth/nethermind` \ - If command not found: `sudo apt-get install software-properties-common` -2. `sudo apt-get install nethermind` -3. `nethermind -c mainnet` - -### On Windows - -#### Prerequisites - -In some cases, [Visual C++ Redistributable](https://aka.ms/vcredist) may need an update: - -``` -winget install Microsoft.VCRedist.2015+.x64 -``` - -#### Install using Windows Package Manager - -1. `winget install nethermind` -2. `nethermind -c mainnet` - -### On macOS - -#### Install using Homebrew - -1. `brew tap nethermindeth/nethermind` -2. `brew install nethermind` -3. `nethermind -c mainnet` - -## Docker image - -The official Docker images of Nethermind are available on [Docker Hub](https://hub.docker.com/r/nethermind/nethermind). - -### Get the digest of the Docker image - -In case of any Docker image need to be updated in the repository, you can update the digest of these images as follows: - -```sh -docker inspect --format='{{index .RepoDigests 0}}' -``` - -The output should show the image digest, and then you can copy that to the `FROM` tag in the Dockerfile. - -## Building from source - -### Prerequisites - -Install [.NET SDK](https://dotnet.microsoft.com/en-us/download) - -### Clone the repository - -```sh -git clone --recursive https://github.com/nethermindeth/nethermind.git -``` - -### Build and run - -```sh -cd nethermind/src/Nethermind/Nethermind.Runner -dotnet run -c release -- -c mainnet -``` - -### Test - -```sh -cd nethermind/src/Nethermind - -# Run Nethermind tests: -dotnet test Nethermind.sln -c release - -# Run Ethereum Foundation tests: -dotnet test EthereumTests.sln -c release -``` - -## Contributing - -BEFORE you start work on a feature or fix, please read and follow our [contribution guide](https://github.com/nethermindeth/nethermind/blob/master/CONTRIBUTING.md) to help avoid any wasted or duplicate effort. - -## Security - -If you believe you have found a security vulnerability in our code, please report it to us as described in our [security policy](SECURITY.md). - -## License - -Nethermind is an open-source software licensed under the [LGPL-3.0](https://github.com/nethermindeth/nethermind/blob/master/LICENSE-LGPL). +- **upstream:** Sync point with [Nethermind's](https://github.com/NethermindEth/nethermind) latest updates. +- **master:** Contains the latest stable changes. +- **production:** Dedicated to stable versions deployed on the Fuse mainne. +- **alpha:** A space for developing and testing new features and experiments on the Spark testnet.