mirror of https://github.com/hyperledger/besu
An enterprise-grade Java-based, Apache 2.0 licensed Ethereum client https://wiki.hyperledger.org/display/besu
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
71 lines
3.7 KiB
71 lines
3.7 KiB
# Besu Ethereum Client
|
|
[![CircleCI](https://circleci.com/gh/hyperledger/besu/tree/main.svg?style=svg)](https://circleci.com/gh/hyperledger/besu/tree/main)
|
|
[![Documentation](https://img.shields.io/github/actions/workflow/status/hyperledger/besu-docs/publish-main-docs.yml?branch=main&label=docs)](https://github.com/hyperledger/besu-docs/actions/workflows/publish-main-docs.yml)
|
|
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3174/badge)](https://bestpractices.coreinfrastructure.org/projects/3174)
|
|
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/hyperledger/besu/blob/main/LICENSE)
|
|
[![Discord](https://img.shields.io/discord/905194001349627914?logo=Hyperledger&style=plastic)](https://discord.gg/hyperledger)
|
|
[![Twitter Follow](https://img.shields.io/twitter/follow/HyperledgerBesu)](https://twitter.com/HyperledgerBesu)
|
|
|
|
[Download](https://github.com/hyperledger/besu/releases)
|
|
|
|
Besu is an Apache 2.0 licensed, MainNet compatible, Ethereum client written in Java.
|
|
|
|
## Useful Links
|
|
|
|
* [Besu User Documentation]
|
|
* [Besu Issues]
|
|
* [Besu Wiki](https://lf-hyperledger.atlassian.net/wiki/spaces/BESU/)
|
|
* [How to Contribute to Besu](https://lf-hyperledger.atlassian.net/wiki/spaces/BESU/pages/22156850/How+to+Contribute)
|
|
* [Besu Roadmap & Planning](https://lf-hyperledger.atlassian.net/wiki/spaces/BESU/pages/22154278/Besu+Roadmap+Planning)
|
|
|
|
|
|
## Issues
|
|
|
|
Besu issues are tracked [in the github issues tab][Besu Issues].
|
|
See our [guidelines](https://lf-hyperledger.atlassian.net/wiki/spaces/BESU/pages/22154243/Issues) for more details on searching and creating issues.
|
|
|
|
If you have any questions, queries or comments, [Besu channel on Discord] is the place to find us.
|
|
|
|
|
|
## Besu Users
|
|
|
|
To install the Besu binary, follow [these instructions](https://besu.hyperledger.org/public-networks/get-started/install/binary-distribution).
|
|
|
|
## Besu Developers
|
|
|
|
* [Contributing Guidelines]
|
|
* [Coding Conventions](https://lf-hyperledger.atlassian.net/wiki/spaces/BESU/pages/22154259/Coding+Conventions)
|
|
* [Command Line Interface (CLI) Style Guide](https://lf-hyperledger.atlassian.net/wiki/spaces/BESU/pages/22154260/Besu+CLI+Style+Guide)
|
|
* [Besu User Documentation] for running and using Besu
|
|
|
|
|
|
### Development
|
|
|
|
Instructions for how to get started with developing on the Besu codebase. Please also read the
|
|
[wiki](https://lf-hyperledger.atlassian.net/wiki/spaces/BESU/pages/22154251/Pull+Requests) for more details on how to submit a pull request (PR).
|
|
|
|
* [Checking Out and Building](https://lf-hyperledger.atlassian.net/wiki/spaces/BESU/pages/22154264/Building+from+source)
|
|
* [Code Coverage](https://lf-hyperledger.atlassian.net/wiki/spaces/BESU/pages/22154288/Code+coverage)
|
|
* [Logging](https://lf-hyperledger.atlassian.net/wiki/spaces/BESU/pages/22154291/Logging) or the [Documentation's Logging section](https://besu.hyperledger.org/public-networks/how-to/monitor/logging)
|
|
|
|
|
|
## Release Notes
|
|
|
|
[Release Notes](CHANGELOG.md)
|
|
|
|
## Special thanks
|
|
|
|
YourKit for providing us with a free profiler open source license.
|
|
|
|
YourKit supports open source projects with innovative and intelligent tools
|
|
for monitoring and profiling Java and .NET applications.
|
|
YourKit is the creator of <a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>,
|
|
<a href="https://www.yourkit.com/.net/profiler/">YourKit .NET Profiler</a>,
|
|
and <a href="https://www.yourkit.com/youmonitor/">YourKit YouMonitor</a>.
|
|
|
|
![YourKit Logo](https://www.yourkit.com/images/yklogo.png)
|
|
|
|
[Besu Issues]: https://github.com/hyperledger/besu/issues
|
|
[Besu User Documentation]: https://besu.hyperledger.org
|
|
[Besu channel on Discord]: https://discord.gg/hyperledger
|
|
[Contributing Guidelines]: CONTRIBUTING.md
|
|
|