Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Consensys/teku
Open-source Ethereum consensus client written in Java
https://github.com/Consensys/teku
beacon-chain consensys eth2 eth2-clients ethereum hacktoberfest hacktoberfest2021 java proof-of-stake teku
Last synced: 3 months ago
JSON representation
Open-source Ethereum consensus client written in Java
- Host: GitHub
- URL: https://github.com/Consensys/teku
- Owner: Consensys
- License: apache-2.0
- Created: 2018-09-07T09:30:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T02:37:01.000Z (3 months ago)
- Last Synced: 2024-04-14T02:43:25.998Z (3 months ago)
- Topics: beacon-chain, consensys, eth2, eth2-clients, ethereum, hacktoberfest, hacktoberfest2021, java, proof-of-stake, teku
- Language: Java
- Homepage: https://consensys.io/teku
- Size: 505 MB
- Stars: 628
- Watchers: 35
- Forks: 243
- Open Issues: 148
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Security: SECURITY.md
- Governance: GOVERNANCE.md
Lists
- DeFi-Developer-Road-Map - Artemis - Java implementation of the Ethereum 2.0 Beacon Chain by PegaSys (Roadmap)
- best-of-crypto - GitHub - 5% open · ⏱️ 05.06.2024): (Smart Contract Platforms)
README
# teku
[](https://circleci.com/gh/Consensys/workflows/teku)
[](https://github.com/Consensys/teku/blob/master/LICENSE)
[](https://github.com/Consensys/teku/releases/latest)
[](https://discord.gg/7hPv2T6)
[](https://twitter.com/Teku_Consensys)
[](https://www.gitpoap.io/gh/ConsenSys/teku)
Teku is a Java implementation of the Ethereum 2.0 Beacon Chain. See the [Changelog](https://github.com/Consensys/teku/releases) for details of the latest releases and upcoming breaking changes.
## Useful links
* [Ethereum 2.0 Beacon Chain specification](https://github.com/ethereum/consensus-specs/blob/dev/specs/phase0/beacon-chain.md)
* [Teku user documentation](https://docs.teku.consensys.net/)
* [Teku REST API reference documentation](https://consensys.github.io/teku/)
* [Teku issues](https://github.com/Consensys/teku/issues)
* [Contribution guidelines](CONTRIBUTING.md)
* [Teku Changelog](https://github.com/Consensys/teku/releases)
## Teku users
See our [user documentation](https://docs.teku.consensys.net/).
Raise a [documentation issue](https://github.com/Consensys/doc.teku/issues) or get in touch in
the #teku channel on [Discord](https://discord.gg/7hPv2T6) if you've got questions or feedback.
## Teku developers
* [Contribution Guidelines](CONTRIBUTING.md)
* [Coding Conventions](https://wiki.hyperledger.org/display/BESU/Coding+Conventions)
## Binary Releases
Binary releases are available from the [releases page](https://github.com/Consensys/teku/releases).
Binary builds that track the latest changes on the master branch are available on
[Dockerhub](https://hub.docker.com/r/consensys/teku) using the `develop` version or as binary
downloads ([tar.gz format](https://artifacts.consensys.net/public/teku/raw/names/teku.tar.gz/versions/develop/teku-develop.tar.gz)
or [zip format](https://artifacts.consensys.net/public/teku/raw/names/teku.zip/versions/develop/teku-develop.zip)).
We recommend only using release versions for Mainnet, but `develop` builds are useful for testing
the latest changes on testnets.
Release notifications are available via:
* Sign up to our [release announcements](https://pages.consensys.net/teku-sign-up) email list (release and important announcements only, no marketing)
* Follow us on [Twitter](https://twitter.com/Teku_Consensys)
* `teku` in [Consensys Discord](https://discord.gg/7hPv2T6),
* Subscribe to release notifications on github for [teku](https://github.com/Consensys/teku)
## Build Instructions
### Install Prerequisites
* Java 17+
Note: Official builds of Teku are performed with Java 17.
Building on a more recent version of Java is supported, but the resulting build will not work on earlier versions of Java.
### Build and Dist
To create a ready to run distribution:
```shell script
git clone https://github.com/Consensys/teku.git
cd teku && ./gradlew distTar installDist
```
This produces:
- Fully packaged distribution in `build/distributions`
- Expanded distribution, ready to run in `build/install/teku`
### Build and Test
To build, clone this repo and run with `gradle`:
```shell script
git clone https://github.com/Consensys/teku.git
cd teku && ./gradlew
```
After a successful build, distribution packages are available in `build/distributions`.
### Other Useful Gradle Targets
| Target | Builds |
|-------------|---------------------------------------------------------|
| distTar | Full distribution in build/distributions (as `.tar.gz`) |
| distZip | Full distribution in build/distributions (as `.zip`) |
| installDist | Expanded distribution in `build/install/teku` |
| distDocker | The `consensys/teku` docker image |
## Code Style
We use Google's Java coding conventions for the project. To reformat code, run:
```shell script
./gradlew spotlessApply
```
Code style is checked automatically during a build.
## Testing
All the unit tests are run as part of the build, but can be explicitly triggered with:
```shell script
./gradlew test
```
## 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 YourKit Java Profiler,
YourKit .NET Profiler,
and YourKit YouMonitor.
