Kick-start your next Besu plugin!
Do you want to create a Besu plugin super fast? This template will help you get started!
What is included:
- generate fat
JARsto distribute the plugin with ease. - easily check if all the various Besu dependencies are up to date.
- ensure a consistent coding style with auto-formatting.
Whilst this project is mainly geared towards Kotlin it can still be used with plain old Java.
Bundled Gradle plugins:
ShadowJar- For creating fatJARs.Ktlint- For automatic formatting of Kotlin code.Gradle Versions Plugin- Determine which dependencies have updates
Simply fork this repository and start hacking away!
Below is a summary of some useful gradle tasks that you will have at your disposal:
| Target | Description |
|---|---|
| assemble | Full JAR file in build/distributions as .jar. |
| assembleDist | Creates .zip and .tar archives of the distribution contents. |
| distZip | Full JAR file distribution in build/distributions as .zip. |
| distTar | Full JAR file distribution in build/distributions as .tar. |
| ktlintFormat | Formats automatically the code. |
| dependencyUpdates | Check if all dependencies are up to date. |
| tasks | Display all available tasks. |
We welcome any kind of contribution or support to this project but before to do so:
- Make sure you have read the contribution guide for more details on how to submit a good PR (pull request).
Also, we are not only limited to technical contributions. Things that make us happy are:
- Add a GitHub Star to the project.
- Tweet about this project.
- Write a review or tutorial.
We have published other Besu plugins:
Also, have a look at our Awesome Besu list to find more useful stuff!
Besu Plugin Starter has been developed initially by °41North.
If you think this project would be useful for your use case and want to talk more about it you can reach out to us via
our contact form or by sending an email to [email protected]. We try to respond within 48 hours and look forward to hearing from you.
Besu Plugin Starter is free and open-source software licensed under the Apache 2.0 License.