mirror of
https://github.com/vacp2p/linea-besu.git
synced 2026-01-08 20:47:59 -05:00
Migrating Pantheon to Besu (#1945)
Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>
This commit is contained in:
Joshua Fernandes
@@ -1,5 +1,5 @@
|
||||
Pantheon user documentation was moved to as separate repository to help manage versions and releases.
|
||||
Besu user documentation was moved to as separate repository to help manage versions and releases.
|
||||
|
||||
If you want to contribute to the doc site, make a pull request against https://github.com/PegaSysEng/doc.pantheon
|
||||
If you want to contribute to the doc site, make a pull request against https://github.com/hyperledger/besu-docs
|
||||
|
||||
The generated doc website is at https://docs.pantheon.pegasys.tech/
|
||||
The generated doc website is at https://besu.hyperledger.org/
|
||||
@@ -1,4 +1,4 @@
|
||||
description: Code review guidelines for Pantheon developers
|
||||
description: Code review guidelines for Besu developers
|
||||
<!--- END of page meta data -->
|
||||
|
||||
All changes must be code reviewed. For non-approvers this is obvious, since
|
||||
@@ -16,7 +16,7 @@ and say so in a reply to the PR. Only the primary approver of a change should
|
||||
actually do the merge, except in rare cases (e.g. they are unavailable in a
|
||||
reasonable timeframe).
|
||||
|
||||
If a PR has gone 2 work days without an approver emerging, please ask on [Pantheon Gitter]
|
||||
If a PR has gone 2 work days without an approver emerging, please ask on [Besu Rocketchat]
|
||||
|
||||
## Attribution
|
||||
|
||||
@@ -24,4 +24,4 @@ This Document was adapted by the following:
|
||||
- Kubernetes collab.md, available at [kub collab]
|
||||
|
||||
[kub collab]: https://raw.githubusercontent.com/kubernetes/community/master/contributors/devel/collab.md
|
||||
[Pantheon Gitter]: https://gitter.im/PegaSysEng/pantheon
|
||||
[Besu Rocketchat]: https://chat.hyperledger.org/channel/besu
|
||||
@@ -10,13 +10,13 @@ this project.
|
||||
| Role | Responsibilities | Defined by |
|
||||
| -----| ---------------- | ---------- |
|
||||
| Everyone | none | anybody with a belly button
|
||||
| Member | everyone who contributes - code or otherwise | Pantheon GitHub org member
|
||||
| Member | everyone who contributes - code or otherwise | Besu GitHub org member
|
||||
| Approver | approve accepting contributions | write permissions on master
|
||||
| Project Manager | management of the project | PegaSys
|
||||
| Project Sponsor | contribute developer resources | PegaSys
|
||||
| Open Source Circle | OSS support | PegaSys
|
||||
| Project Evangelist | promote the project | PegaSys
|
||||
| Benevolent Dictator | decision tie-breaker | PegaSys
|
||||
| Project Manager | management of the project | Hyperledger
|
||||
| Project Sponsor | contribute developer resources | Hyperledger
|
||||
| Open Source Circle | OSS support | Hyperledger
|
||||
| Project Evangelist | promote the project | Hyperledger
|
||||
| Benevolent Dictator | decision tie-breaker | Hyperledger
|
||||
|
||||
## Everyone
|
||||
Any person from the public is able to access the code. The standard permissions grant the ability to view the code, view open bugs, access the wiki, download binaries, view CI results and comment on pull requests.
|
||||
@@ -47,9 +47,9 @@ issues and PRs assigned to them.
|
||||
- Authoring or reviewing PRs on GitHub
|
||||
- Filing or commenting on issues on GitHub
|
||||
- Contributing to community discussions (e.g. meetings, Slack, email discussion forums, Stack Overflow)
|
||||
- Subscribed to [pantheon-dev@pegasys.tech]
|
||||
- Joined [Pantheon Gitter]
|
||||
- Browsed [Pantheon Wiki]
|
||||
- Subscribed to [besu-dev@pegasys.tech]
|
||||
- Joined [Besu Rocketchat]
|
||||
- Browsed [Besu Wiki]
|
||||
- Have read the [contributor guide]
|
||||
- Signed ICLA, as described in [CLA.md]
|
||||
|
||||
@@ -90,7 +90,7 @@ Code approvers are members that have signed an ICLA and have been granted additi
|
||||
## Project Manager
|
||||
The Project Manager role provides the user with control over management aspects of the project.
|
||||
|
||||
**Defined by:** PegaSys
|
||||
**Defined by:** Hyperledger
|
||||
|
||||
### Requirements
|
||||
- Includes all of the requirements of a Member user
|
||||
@@ -107,7 +107,7 @@ The Project Manager role provides the user with control over management aspects
|
||||
## Project Sponsor
|
||||
The Project Sponsor role provides a user with the ability to contribute additional developer resources to the project. Project Sponsors must sign the ICLA.
|
||||
|
||||
**Defined by:** PegaSys
|
||||
**Defined by:** Hyperledger
|
||||
|
||||
### Requirements
|
||||
- Signed ICLA, as described in [CLA.md]
|
||||
@@ -119,7 +119,7 @@ The Project Sponsor role provides a user with the ability to contribute addition
|
||||
|
||||
## Open Source Circle
|
||||
The Open Source Circle is a group that provides open source software support to projects.
|
||||
**Defined by:** PegaSys
|
||||
**Defined by:** Hyperledger
|
||||
|
||||
### Requirements
|
||||
- Includes all of the requirements of a Member user
|
||||
@@ -134,7 +134,7 @@ The Open Source Circle is a group that provides open source software support to
|
||||
|
||||
## Project Evangelist
|
||||
The Project Evangelist role is for those who wish to promote the project to the outside world, but not actively contribute to it.
|
||||
**Defined by:** PegaSys
|
||||
**Defined by:** Hyperledger
|
||||
|
||||
### Requirements
|
||||
- Includes all of the requirements of a Member user
|
||||
@@ -170,6 +170,6 @@ This document is adapted from the following sources:
|
||||
[contributor guide]: /CONTRIBUTING.md
|
||||
[New contributors]: /CONTRIBUTING.md
|
||||
[two-factor authentication]: https://help.github.com/articles/about-two-factor-authentication
|
||||
[pantheon-dev@pegasys.tech]: mailto:pantheon-dev@pegasys.tech
|
||||
[Pantheon Gitter]: https://gitter.im/PegaSysEng/pantheon
|
||||
[Pantheon Documentation]: https://pantheon.readthedocs.io/
|
||||
[besu-dev@pegasys.tech]: mailto:besu-dev@pegasys.tech
|
||||
[Besu RocketChat]: https://chat.hyperledger.org/channel/besu
|
||||
[Besu Documentation]: https://besu.readthedocs.io/
|
||||
|
||||
@@ -7,8 +7,8 @@
|
||||
## Quick start
|
||||
|
||||
```sh
|
||||
git clone --recursive https://github.com/PegasysEng/pantheon
|
||||
cd pantheon
|
||||
git clone --recursive https://github.com/hyperledger/besu
|
||||
cd besu
|
||||
./gradlew build
|
||||
./gradlew integrationTest
|
||||
```
|
||||
@@ -16,17 +16,17 @@ cd pantheon
|
||||
## Checkout source code
|
||||
|
||||
```
|
||||
git clone --recursive git@github.com:PegasysEng/pantheon.git
|
||||
git clone --recursive git@github.com:hyperledger/besu.git
|
||||
```
|
||||
OR
|
||||
```
|
||||
git clone --recursive https://github.com/PegasysEng/pantheon
|
||||
git clone --recursive https://github.com/hyperledger/besu
|
||||
```
|
||||
|
||||
## See what tasks are available
|
||||
To see all of the gradle tasks that are available:
|
||||
```
|
||||
cd pantheon
|
||||
cd besu
|
||||
./gradlew tasks
|
||||
```
|
||||
|
||||
@@ -34,7 +34,7 @@ cd pantheon
|
||||
## Build from source
|
||||
After you have checked out the code, this will build the distribution binaries.
|
||||
```
|
||||
cd pantheon
|
||||
cd besu
|
||||
./gradlew build
|
||||
```
|
||||
|
||||
@@ -70,11 +70,11 @@ as part of the unit test suite as described above, but for debugging, it is
|
||||
often convenient to run only a subset of those tests, for which a few convenience
|
||||
as provided. For instance, one can run only "Frontier" general state tests with
|
||||
```
|
||||
./gradlew :ethereum:tech.pegasys.pantheon.ethereum.vm:referenceTest -Dtest.single=GeneralStateTest -Dtest.ethereum.state.eip=Frontier
|
||||
./gradlew :ethereum:org.hyperledger.besu.ethereum.vm:referenceTest -Dtest.single=GeneralStateTest -Dtest.ethereum.state.eip=Frontier
|
||||
```
|
||||
or only the tests that match a particular pattern with something like:
|
||||
```
|
||||
gradle :ethereum:tech.pegasys.pantheon.ethereum.vm:test -Dtest.single=GeneralStateTest -Dtest.ethereum.include='^CALLCODE.*-Frontier'
|
||||
gradle :ethereum:org.hyperledger.besu.ethereum.vm:test -Dtest.single=GeneralStateTest -Dtest.ethereum.include='^CALLCODE.*-Frontier'
|
||||
```
|
||||
Please see the comment on the `test` target in the top level `build.gradle`
|
||||
file for more details.
|
||||
|
||||
@@ -15,7 +15,7 @@ ALL: All levels including custom levels.
|
||||
```
|
||||
|
||||
One mechanism of globally effecting the log output of a running client is though modification the file
|
||||
`/pantheon/src/main/resources/log4j2.xml`, where it can be specified under the `<Property name="root.log.level">`.
|
||||
`/besu/src/main/resources/log4j2.xml`, where it can be specified under the `<Property name="root.log.level">`.
|
||||
As such, corresponding instances of information logs throughout the codebase, e.g. `log.fatal("Fatal Message!");`,
|
||||
will be rendered to the console while the client is in use.
|
||||
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
# Running Developer Builds
|
||||
|
||||
Build and run Pantheon with default options using:
|
||||
Build and run Besu with default options using:
|
||||
|
||||
```
|
||||
./gradlew installDist
|
||||
```
|
||||
|
||||
By default this stores all persistent data in `build/install/pantheon`.
|
||||
By default this stores all persistent data in `build/install/besu`.
|
||||
|
||||
To set custom CLI arguments for the Pantheon execution:
|
||||
To set custom CLI arguments for the Besu execution:
|
||||
|
||||
```sh
|
||||
cd build/install/pantheon
|
||||
cd build/install/besu
|
||||
|
||||
./bin/pantheon --discovery-enabled=false --data-path=/tmp/pantheontmp
|
||||
./bin/besu --discovery-enabled=false --data-path=/tmp/besutmp
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user