Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,33 @@ executors:
node_executor:
docker:
- image: circleci/node:12.9.0-stretch
shell_executor:
docker:
- image: circleci/buildpack-deps:buster-scm
jobs:
dco:
executor: shell_executor
steps:
- checkout
- run:
name: check
command: |
status=0
while IFS= read -r -a line; do
my_array+=( "$line" )
done < <( git branch -r | grep -v origin/HEAD )
for branch in "${my_array[@]}"
do
branch=$(echo "$branch" | xargs)
echo "Checking commits in branch $branch for commits missing DCO..."
while read -r results; do
status=1
commit_hash="$(echo "$results" | cut -d' ' -f1)"
>&2 echo "$commit_hash is missing Signed-off-by line."
done < <(git log "$branch" --no-merges --pretty="%H %ae" --grep 'Signed-off-by' --invert-grep -- )
done
exit $status

build:
executor: python_executor
steps:
Expand Down Expand Up @@ -95,6 +121,7 @@ workflows:
version: 2
default:
jobs:
- dco
- build
- vale
- markdownlint
Expand Down
19 changes: 0 additions & 19 deletions CLA.md

This file was deleted.

6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ The process described here has several goals:

Please follow these steps to have your contribution considered by the approvers:

1. Complete the CLA, as described in [CLA.md].
1. Ensure all commits have a Sign-off for DCO, as described in [DCO.md].
2. Follow all instructions in [PULL-REQUEST-TEMPLATE.md](.github/pull_request_template.md).
4. Follow the [Style Guides](#documentation-style-guide).
5. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/)
Expand Down Expand Up @@ -219,6 +219,6 @@ in this guide.

[Hyperledger Besu chat]: https://chat.hyperledger.org/channel/besu
[Hyperledger Besu documentation]: https://besu.hyperledger.org/
[CLA.md]: ./CLA.md
[DCO.md]: ./DCO.md
[Code Reviews]: ./docs/community/code-reviews.md
[MkDocs]: https://www.mkdocs.org/
[MkDocs]: https://www.mkdocs.org/
9 changes: 9 additions & 0 deletions DCO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
DCO
===

As per section 13.a of the [Hyperledger Charter](https://www.hyperledger.org/about/charter) all code submitted to the Hyperledger Foundation needs to have a [Developer Certificate of Origin](http://developercertificate.org/) (DCO) sign-off.

The sign off needs to be using your legal name, not a pseudonym. Git has a built-in mechanism to allow this with the `-s` or `--signoff` argument to `git commit` command, providing your `user.name` and `user.email` have been setup correctly.

If you have any questions, you can reach us on [Besu chat].
[Besu chat]: https://chat.hyperledger.org/channel/besu
2 changes: 1 addition & 1 deletion MKDOCS-MARKDOWN-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ enables displaying a list as a checklist.

For writing code examples inside the documentation, refer to the developer style guides:

- Java : refer to Hyperledger Besu [coding convention](https://github.com/hyperledger/besus/blob/master/CODING-CONVENTIONS.md).
- Java : refer to Hyperledger Besu [coding convention](https://github.com/hyperledger/besu/blob/master/CODING-CONVENTIONS.md).
- JSON : use https://jsonformatter.curiousconcept.com/ to format your JSON code.
- TOML : we follow version 0.5.0 language definition.
- JavaScript : see [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html).
Expand Down
5 changes: 4 additions & 1 deletion docs/Concepts/Privacy/Privacy-Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ Other participants cannot access the transaction content or list of participants

!!! important
For production systems requiring private transactions, we recommend using a network
with a consensus mechanism supporting transaction finality. For example, [IBFT 2.0](../../HowTo/Configure-Besu/Consensus-Protocols/IBFT.md). All private transaction participants must be online for a private transaction to be successfully distributed. If any participants are offline when the private transaction is submitted, the transaction is not attempted and must be resubmitted.
with a consensus mechanism supporting transaction finality. For example, [IBFT 2.0](../../HowTo/Configure/Consensus-Protocols/IBFT.md).
All private transaction participants must be online for a private transaction to be successfully distributed.
If any participants are offline when the private transaction is submitted, the transaction is
not attempted and must be resubmitted.

## Private Transaction Manager

Expand Down
2 changes: 2 additions & 0 deletions docs/HowTo/Deploy/Monitoring-Performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ To specify the host and port on which Prometheus accesses Besu, use the [`--metr
[`--metrics-port`](../../Reference/CLI/CLI-Syntax.md#metrics-port) options.
The default host and port are 127.0.0.1 and 9545.

Prometheus requires 3MB of space per node per hour for metrics, with a `scrape_interval` of 15s.

To use Prometheus with Besu, install the [prometheus main component](https://prometheus.io/download/). On MacOS, install with [Homebrew](https://formulae.brew.sh/formula/prometheus):

```
Expand Down
10 changes: 5 additions & 5 deletions docs/HowTo/Get-Started/Run-Docker-Image.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ To run a Besu node in a container connected to the Ethereum mainnet:
docker run hyperledger/besu:latest
```

```bash tab="{{ versions.stable }}"
docker run hyperledger/besu:{{ versions.stable }}
```

!!! note
`latest` runs the latest cached version. To pull the latest version, use `docker pull hyperledger/besu:latest`.
Available tags for the image are listed at https://hub.docker.com/r/hyperledger/besu/tags.

If you previously pulled `latest`, Docker runs the cached version.

To ensure your image is up to date, pull the `latest` version again using `docker pull hyperledger/besu:latest`.

## Exposing Ports

Expand Down
2 changes: 1 addition & 1 deletion docs/HowTo/Interact/APIs/GraphQL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: How to access the Hyperledger Besu API using GraphQL
GraphQL can reduce the overhead needed for common queries. For example, instead of querying each receipt in a
block, GraphQL can obtain the same result with a single query for the entire block.

The GraphQL implementation for Ethereum is described in the [schema](https://github.com/hyperledger/besu/blob/master/ethereum/graphql/src/main/resources/schema.graphqls).
The GraphQL implementation for Ethereum is described in the [schema](https://github.com/hyperledger/besu/blob/master/ethereum/api/src/main/resources/schema.graphqls).
The GraphQL service is enabled using the [command line options](API.md#enabling-api-access).

!!! note
Expand Down
4 changes: 2 additions & 2 deletions docs/Reference/API-Methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ None
{
"jsonrpc" : "2.0",
"id" : 53,
"result" : "besu/{{ versions.stable }}"
"result" : "besu/<version>"
}
```

Expand Down Expand Up @@ -479,7 +479,7 @@ None

!!! note
Methods with an equivalent [GraphQL](../HowTo/Interact/APIs/GraphQL.md) query include a GraphQL request and result in the method example.
The parameter and result descriptions apply to the JSON-RPC requests. The GraphQL specification is defined in the [schema](https://github.com/hyperledger/besu/blob/master/ethereum/graphql/src/main/resources/schema.graphqls).
The parameter and result descriptions apply to the JSON-RPC requests. The GraphQL specification is defined in the [schema](https://github.com/hyperledger/besu/blob/master/ethereum/api/src/main/resources/schema.graphqls).

### eth_syncing

Expand Down
11 changes: 5 additions & 6 deletions docs/Tutorials/Quickstarts/Privacy-Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,14 @@ To run this tutorial, you must have the following installed:

## Clone Besu Quickstart Source Code

Clone the repository from the `besu-quickstart` repository where `<version>` is replaced with the latest version (`{{ versions.quickstart }}`).
Clone the repository from the `besu-quickstart` repository.

```bash tab="Command"
git clone --branch <version> https://github.com/PegaSysEng/besu-quickstart.git
```bash tab="Linux/MacOS"
git clone https://github.com/PegaSysEng/besu-quickstart.git
```

```bash tab="Example"
git clone --branch {{ versions.quickstart }} https://github.com/PegaSysEng/besu-quickstart.git
```
!!!note
Download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases.

## Clone EEAJS Libraries

Expand Down
11 changes: 7 additions & 4 deletions docs/Tutorials/Quickstarts/Private-Network-Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,15 @@ the MetaMask plug-in installed. This tutorial uses screenshots from Brave.

## Clone Besu Quickstart Source Code

Clone the repository from the `besu-quickstart` with the version matching Besu version, currently `{{ versions.quickstart }}`:
Clone the repository from the `besu-quickstart` repository:

```bash tab="Linux/MacOS"
git clone --branch {{ versions.quickstart }} https://github.com/PegaSysEng/besu-quickstart.git
git clone https://github.com/PegaSysEng/besu-quickstart.git
```

!!!note
Download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases.

## Build Docker Images and Start Services and Network

This tutorial uses [Docker Compose](https://docs.docker.com/compose/) to assemble the images and
Expand All @@ -55,7 +58,7 @@ When the process ends, it lists the running services:
!!! example "Docker-compose services list example"
```log
*************************************
Besu Quickstart {{ versions.quickstart }}
Besu Quickstart <version>
*************************************
List endpoints and services
----------------------------------
Expand Down Expand Up @@ -166,7 +169,7 @@ The result specifies the client version:
{
"jsonrpc" : "2.0",
"id" : 1,
"result" : "besu/{{ versions.stable }}"
"result" : "besu/<version number>"
}
```
Here we simply query the version of the Besu node, which confirms the node is running.
Expand Down
Binary file modified docs/custom_theme/favicon.ico
Binary file not shown.
3 changes: 0 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ copyright: Hyperledger Besu and its documentation are licensed under Apache 2.0
#extra project info and template customisation
extra:
doc_site_edit_url: https://github.com/hyperledger/besu-docs/
versions:
stable: &stable_version 1.3.0
quickstart: *stable_version
latest_version_warning:
url_contains: /latest/
text: 'You are reading Hyperledger Besu development version documentation and
Expand Down