Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for enabling linea-sequencer plugin #680

Closed
wants to merge 11 commits into from
2 changes: 1 addition & 1 deletion docs/architecture/stack/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Linea software
image: /img/socialCards/the-linea-stack.jpg
image: /img/socialCards/linea-software.jpg
---

import DocCardList from "@theme/DocCardList";
Expand Down
30 changes: 30 additions & 0 deletions docs/developers/guides/run-a-node/linea-sequencer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Install the linea-sequencer plugin for BESU
jlwllmr marked this conversation as resolved.
Show resolved Hide resolved
description: How to install and configure the linea-sequencer plugin for Besu
image: /img/socialCards/install-the-linea-sequencer-plugin-for-besu.jpg
---

# Install `linea-sequencer`
jlwllmr marked this conversation as resolved.
Show resolved Hide resolved

If you want to run a Linea node and use it to interact with the blockchain, rather than running a
'follower' node that simply keeps a local copy of the chain, then you will need to install the
`linea-sequencer` plugin to ensure full functionality.

Specifically, the Linea-specific API methods documented in our [reference section](/developers/reference/api)
will not work properly unless you install and configure `linea-sequencer`.
jlwllmr marked this conversation as resolved.
Show resolved Hide resolved

## Instructions
jlwllmr marked this conversation as resolved.
Show resolved Hide resolved

1. Go to the [`linea-sequencer` repo releases page](https://github.com/Consensys/linea-sequencer/releases)
and download the `.jar` file for the latest release.
jlwllmr marked this conversation as resolved.
Show resolved Hide resolved

2. In the local Besu runtime directory (where you will run Besu from), create a directory called
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"In the root of the Besu installation directory"?

Copy link
Collaborator Author

@jlwllmr jlwllmr Aug 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the original instructions (https://github.com/Consensys/linea-sequencer/blob/main/docs/quickstart.md) stated explicitly the runtime directory, "not where you're building Besu", so I tried to reflect this -- unsure if I did so correctly. I.e. unsure if the installation directory == runtime directory?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, the Besu docs is also slightly inconsistent as to where the plugin goes: https://besu.hyperledger.org/development/private-networks/concepts/plugins#install-plugins

So I'm a bit confused. I'm sure users will be too.

`plugins` and place the `.jar` file there.

3. In the `config-mainnet.toml` file, add `LINEA` to the list of RPC methods:
jlwllmr marked this conversation as resolved.
Show resolved Hide resolved

```
rpc-http-api=["ADMIN","NET","ETH","WEB3","TXPOOL","LINEA"]
```

When you run Besu, you will see the `linea-sequencer` plugin registered during startup.
13 changes: 13 additions & 0 deletions docs/developers/guides/run-a-node/use-binary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,19 @@ Download the genesis file and Besu configuration file.

</Tabs>

:::warning[Important: enable linea-sequencer]

You must install and enable the `linea-sequencer` Besu plugin if you are offering RPC services or
hosting nodes for usage. Enabling the plugin is a requirement for using certain endpoints, such as
[`linea_estimateGas`](/developers/reference/api/linea-estimategas).
jlwllmr marked this conversation as resolved.
Show resolved Hide resolved

Please see our instructions [here](./linea-sequencer) for installing the plugin.
jlwllmr marked this conversation as resolved.
Show resolved Hide resolved

If you are simply running a node to follow the chain and its activity, rather than using it to
submit transactions, you do not need to install `linea-sequencer`.
jlwllmr marked this conversation as resolved.
Show resolved Hide resolved

:::

jlwllmr marked this conversation as resolved.
Show resolved Hide resolved
### Step 3. Define disk space volume (optional) {#disk-space-besu}

Define a volume size appropriate to your expected usage. As of March 20 2024, Besu nodes use:
Expand Down
Binary file modified static/img/socialCards/ethsendrawtransaction.jpg
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 static/img/socialCards/linea-software.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/socialCards/lineaestimategas.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.