Skip to content

Commit

Permalink
Merge branch 'main' into 1385-update-parameter-description
Browse files Browse the repository at this point in the history
  • Loading branch information
mjsmike62 authored Sep 14, 2023
2 parents e680e14 + 7d90b0d commit 066390b
Show file tree
Hide file tree
Showing 639 changed files with 109,635 additions and 4,129 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@
.env.development.local
.env.test.local
.env.production.local
/env

npm-debug.log*
yarn-debug.log*
yarn-error.log*
.vercel
.vercel
Binary file added docs/assets/images/chainlens-block-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-block.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-contracts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-events.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-loading.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/chainlens-transactions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/sirato-block-details.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-blocks.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-contract-details.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-contracts.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-dashboard.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-events.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-loading.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-token-details.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-tokens.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-transaction-details.png
Binary file not shown.
Binary file removed docs/assets/images/sirato-transactions.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/assets/postman/postman_collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -3868,7 +3868,7 @@
"host": ["{{rpc-http-host}}"],
"port": "{{rpc-http-port}}"
},
"description": "Returns the [network ID](https://besu.hyperledger.org/en/stable/Concepts/NetworkID-And-ChainID).\n\n#### Parameters\n\nNone\n\n#### Returns\n\n`result` : *string* - Current network ID.\n\n| Network ID | Chain | Network | Description\n|------------|-------|---------|-------------------------------|\n| `1` | ETH | Mainnet | Main Ethereum network |\n| `3` | ETH | Ropsten | PoW test network |\n| `4` | ETH | Rinkeby | PoA test network using Clique |\n| `5` | ETH | Goerli | PoA test network using Clique |\n| `2018` | ETH | Dev | PoW development network |\n| `1` | ETC | Classic | Main Ethereum Classic network |\n| `6` | ETC | Kotti | PoA test network using Clique |\n| `7` | ETC | Mordor | PoW test network |\n\n> **note**\n>\n> For almost all networks network ID and chain ID are the same.\nThe only networks in the table above with different network and chain IDs are\nClassic with a chain ID of `61` and Mordor with a chain ID of `63`."
"description": "Returns the [network ID](https://besu.hyperledger.org/en/stable/Concepts/NetworkID-And-ChainID).\n\n#### Parameters\n\nNone\n\n#### Returns\n\n`result` : *string* - Current network ID.\n\n| Network ID | Chain | Network | Description\n|------------|-------|---------|-------------------------------|\n| `1` | ETH | Mainnet | Main Ethereum network |\n| `3` | ETH | Ropsten | PoW test network |\n| `4` | ETH | Rinkeby | PoA test network using Clique |\n| `5` | ETH | Goerli | PoA test network using Clique |\n| `2018` | ETH | Dev | PoW development network |\n| `1` | ETC | Classic | Main Ethereum Classic network |\n| `7` | ETC | Mordor | PoW test network |\n\n> **note**\n>\n> For almost all networks network ID and chain ID are the same.\nThe only networks in the table above with different network and chain IDs are\nClassic with a chain ID of `61` and Mordor with a chain ID of `63`."
},
"response": [
{
Expand Down
14 changes: 7 additions & 7 deletions docs/private-networks/how-to/configure/free-gas.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ When gas is free, limiting block and contract sizes is less important. In free g

### 1. Set the block size

If you want to remove gas from consideration and don't mind blocks potentially taking longer to create, in the genesis file set the block size limit (measured in gas) to the maximum accepted by Truffle (`0x1fffffffffffff`). In the genesis file, specify `gasLimit` following the `config` key.
If you want to remove gas from consideration and don't mind blocks potentially taking longer to create, in the genesis file set the block size limit (measured in gas) to the maximum accepted by Hardhat (`0x1fffffffffffff`). In the genesis file, specify `gasLimit` following the `config` key.

```json
{
Expand Down Expand Up @@ -107,21 +107,21 @@ If your network is configured to use the `londonBlock` or a later hard fork, the
}
```

## Configure free gas in Truffle
## Configure free gas in Hardhat

If using Truffle to develop on your free gas network, you also need to configure free gas in Truffle.
If using Hardhat to develop on your free gas network, you also need to configure free gas in Hardhat.

Like setting block and contract size limits to their maximum values for Besu, set the transaction gas limit in Truffle to the maximum possible.
Like setting block and contract size limits to their maximum values for Besu, set the transaction gas limit in Hardhat to the maximum possible.

:::info

Besu does not support private key management. To use Besu with Truffle, you must configure a [Truffle wallet](../../../public-networks/how-to/develop/truffle.md).
Besu does not support private key management. To use Besu with Hardhat, you must configure a [Hardhat wallet](../../../public-networks/how-to/develop/hardhat.md).

:::

### Update `truffle-config.js`
### Update `hardhat.config.js`

Update the `truffle-config.js` file:
Update the `hardhat.config.js` file:

1. Set the gas price to zero.

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The following features are shared with [public networks](../../public-networks/i
- [Manage JVM memory](../../public-networks/how-to/configure-jvm/manage-memory.md)
- [Use Java Flight Recorder](../../public-networks/how-to/configure-jvm/java-flight-recorder.md)
- Develop dapps:
- [Use Truffle](../../public-networks/how-to/develop/truffle.md)
- [Use Hardhat](../../public-networks/how-to/develop/hardhat.md)
- [Use client libraries](../../public-networks/how-to/develop/client-libraries.md)
- Troubleshoot:
- [Use EVM tool](../../public-networks/how-to/troubleshoot/evm-tool.md)
Expand Down
116 changes: 116 additions & 0 deletions docs/private-networks/how-to/monitor/chainlens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
title: Use Chainlens Explorer
sidebar_position: 7
description: Use Chainlens Explorer on a privacy-enabled Besu network
tags:
- private networks
---

# Use Chainlens Blockchain Explorer

[Chainlens Blockchain Explorer](https://chainlens.com/) supports public and private EVM networks.
This page describes how to use the free version of Chainlens with its built-in support for
[privacy-enabled](../../concepts/privacy/index.md) Besu networks created using the
[Developer Quickstart](../../tutorials/quickstart.md).

Chainlens provides an overview of the entire network, including block information, contract
metadata, transaction searches, and [more](https://chainlens.com/).

:::note
You must connect to one of the privacy nodes (for example, `member1besu`), not the dedicated RPC, to
allow access for Besu [privacy API methods](../../reference/api/index.md#priv-methods).
In production networks, you must [secure access](../../../public-networks/how-to/use-besu-api/authenticate.md)
to RPC nodes.
:::

## Prerequisites

[Docker and Docker Compose](https://docs.docker.com/compose/install/) installed.

## Start Chainlens

Clone the [Chainlens GitHub repository](https://github.com/web3labs/chainlens-free):

```bash
git clone https://github.com/web3labs/chainlens-free
```

The repository contains a `docker-compose` directory to allow Chainlens to start with a Developer
Quickstart test network.
From the `docker-compose` directory, run the following command:

```bash
NODE_ENDPOINT=http://rpcnode:8545 docker-compose -f docker-compose.yml -f chainlens-extensions/docker-compose-quorum-dev-quickstart.yml up
```

This command does two things:

- Sets up the node endpoint
- Tells Docker to run by using the two Docker Compose files provided

The first `docker-compose.yml` file in the command contains all the services required for Chainlens.

The second file named `docker-compose-quorum-dev-quickstart` contains the network settings required to start
Chainlens on the same network as the Besu development node.

Next, open `http://localhost/` on your browser.
You’ll see the new initialization page while it boots up.
This may take 5–10 minutes for the all services to start and the ingestion sync to complete.

![`Chainlens_loading`](../../../assets/images/chainlens-loading.png)

## View on Chainlens

After starting Chainlens, you can view information about your network.

:::note
Screenshots in this section are taken from the [Chainlens Goerli network](https://goerli.chainlens.com/dashboard).
:::

The **Dashboard** page provides an aggregated view of network activities.

![`Chainlens_dashboard`](../../../assets/images/chainlens-dashboard.png)

The **Network** page provides an overview of the network status and connected peers.
This page is disabled by default, and is only visible if you set `DISPLAY_NETWOR_TAB=enabled` using
the following command:

```bash
NODE_ENDPOINT=http://member1besu:8545 DISPLAY_NETWORK_TAB=enabled docker-compose -f docker-compose.yml -f chainlens-extensions/docker-compose-quorum-dev-quickstart.yml up
```

The **Blocks** page shows a real-time view of the finalized blocks.

![Chainlens blocks](../../../assets/images/chainlens-block.png)

You can view a given block details by selecting a block hash or number.

![Chainlens block details](../../../assets/images/chainlens-block-details.png)

The **Transactions** page shows a paginated view of new and historical transactions.

![Chainlens transactions](../../../assets/images/chainlens-transactions.png)

If you select any transaction hash, you can get the **transaction details.**

![Chainlens transaction_details](../../../assets/images/chainlens-transaction-details.png)

The **Contracts** page shows all the smart contracts deployed on the network.

![Chainlens contracts](../../../assets/images/chainlens-contracts.png)

You can view a smart contract details by selecting the contract address.

![Chainlens contract details](../../../assets/images/chainlens-contract-details.png)

The **Events** page shows all the events generated on the network.

![Chainlens events](../../../assets/images/chainlens-events.png)

## Stop Chainlens

To stop all the services from running, run the following command:

```bash
docker-compose down
```
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/monitor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ You can also use the following monitoring tools in private networks:
- [Quorum Hibernate](quorum-hibernate.md)
- [Splunk](splunk.md)
- [OpenTelemetry](opentelemetry.md)
- [Sirato Explorer](sirato-explorer.md)
- [Chainlens Explorer](chainlens.md)

For an overview of monitoring Hyperledger Besu, view [this recording](https://www.youtube.com/watch?v=7BuutRe0I28&feature=youtu.be).
125 changes: 0 additions & 125 deletions docs/private-networks/how-to/monitor/sirato-explorer.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ By default, the error returned by [`eth_estimateGas`](../../../public-networks/r
"id": 3,
"error": {
"code": -32000,
"message": "Execution reverted",
"message": "Execution reverted: ERC20: transfer amount exceeds balance",
"data": "0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001a4e6f7420656e6f7567682045746865722070726f76696465642e000000000000"
}
}
Expand Down
4 changes: 2 additions & 2 deletions docs/private-networks/how-to/use-privacy/web3js-quorum.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ Initialize your client where:
# Syntax

```js
const Web3 = require("web3");
const { Web3 } = require("web3");
const Web3Quorum = require("web3js-quorum");
const web3 = new Web3Quorum(new Web3("<JSON-RPC HTTP endpoint>"));
```

# Example

```js
const Web3 = require("web3");
const { Web3 } = require("web3");
const Web3Quorum = require("web3js-quorum");
const web3 = new Web3Quorum(new Web3("http://localhost:8545"));
```
Expand Down
10 changes: 10 additions & 0 deletions docs/private-networks/tutorials/permissioning/onchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ The following steps describe bootstrapping a permissioned network using a Hyperl

This tutorial configures permissioning on a [IBFT 2.0 proof of authority (PoA)] network.

:::caution Please use this as reference material only!

The [permissioning-contract-repo](https://github.com/ConsenSys/permissioning-smart-contracts) has been archived and is intended as reference material only.
Please update all dependencies in there before proceeding.

In addition, we also recommend using [Hardhat](https://hardhat.org/hardhat-runner/docs/guides/deploying) instead of [Truffle](https://trufflesuite.com/),
as the development environment. Please refer to the [Quorum Dev Quickstart](../../tutorials/quickstart.md) for an example.

:::

## Prerequisites

- [Node.js](https://nodejs.org/en/) v10.16.0 or later
Expand Down
12 changes: 12 additions & 0 deletions docs/private-networks/tutorials/permissioning/upgrade-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ tags:

The following tutorial describes the steps to upgrade the onchain permissioning contracts to the latest version.

:::caution Please use this as reference material only!

The [permissioning-contract-repo](https://github.com/ConsenSys/permissioning-smart-contracts) has been archived and is intended as reference material only.
Please update all dependencies in there before proceeding.

In addition we also recommend using [Hardhat](https://hardhat.org/hardhat-runner/docs/guides/deploying) instead of [Truffle](https://trufflesuite.com/),
as the development environment. Please refer to the [Quorum Dev Quickstart](../../tutorials/quickstart.md) for an example.

:::

## Prerequisites

<!-- vale off -->
Expand All @@ -19,8 +29,10 @@ The following tutorial describes the steps to upgrade the onchain permissioning
- [Yarn](https://yarnpkg.com/en/) v1.15 or later
- Browser with [MetaMask installed](https://metamask.io/).


## Steps


### 1. Get the latest contracts and install dependencies

:::note
Expand Down
Loading

0 comments on commit 066390b

Please sign in to comment.