Skip to content

Commit

Permalink
Address feedback.
Browse files Browse the repository at this point in the history
Signed-off-by: bgravenorst <[email protected]>
  • Loading branch information
bgravenorst committed Jun 24, 2024
1 parent 0a7637f commit 757eae5
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/developers/guides/run-linea/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ direct access to the blockchain's capabilities.
## When to run a Linea node

Run a Linea node if you want a local view of the Linea blockchain state.
A node enables users to call Linea JSON RPC API methods and submit transactions to the
A node enables users to call Linea JSON-RPC API methods and submit transactions to the
mempool independently, without depending on external RPC providers.

Select the appropriate card for more information on running Linea using your preferred setup:
Expand Down
42 changes: 21 additions & 21 deletions docs/developers/guides/run-linea/run-the-stack/local.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ import TabItem from "@theme/TabItem";

## Prerequisites

The following installed:
Install the following:

- [Node.js v18](https://nodejs.org/en/download/package-manager)
- [Docker v24](https://docs.docker.com/get-docker/)
- [Node.js v18 or later](https://nodejs.org/en/download/package-manager)
- [Docker v24 or later](https://docs.docker.com/get-docker/)
- [Docker Compose v2.19 or later](https://docs.docker.com/compose/install/)
- [Make v3.81 or later](https://www.npmjs.com/package/make)
- [Pnpm >=v9.0.6](https://pnpm.io/installation)
- [Pnpm v9.0.6 or later](https://pnpm.io/installation)

:::important
These instructions runs the Linea stack using Docker containers. Ensure you set your Docker resources to
use at a minimum 10 CPU cores, 8GB of memory and 1GB swap space.
These instructions run the Linea stack using Docker containers. Set your Docker resources to
use at least 10 CPU cores, 8 GB of memory, and 1 GB swap space.
:::

## Run the Linea stack
Expand All @@ -42,19 +42,19 @@ cd linea-monorepo
```

```bash
pnpm i
pnpm install
```

### 3. Start the Linea stack

Start the network stack, this will also compile and deploy the required rollup contracts:
Start the network stack. This will also compile and deploy the required rollup contracts:

```bash
make fresh-start-all
```

You now have a local developer instance of the entire Linea network which includes components such as
the sequencer, prover, coordinator, and a local L1 settlement layer. You can view the components in
You now have a local developer instance of the entire Linea network, which includes components such as
the sequencer, prover, coordinator, and a local L1 settlement layer. You can view these components in
Docker Desktop.

<div class="center-container">
Expand All @@ -70,31 +70,31 @@ Docker Desktop.

Access the RPC endpoints from the following local URLs:

:::info
You can [connect your MetaMask wallet](https://support.metamask.io/networks-and-sidechains/managing-networks/how-to-add-a-custom-network-rpc/#adding-a-network-manually)
to the required chain and [import the deployment account](https://support.metamask.io/managing-my-wallet/accounts-and-addresses/how-to-import-an-account/#importing-using-a-private-key)
to access the test tokens.
:::

<Tabs className="my-tabs">
<TabItem value="Linea" label="Linea (L2)" default>
- Endpoints:
- HTTPS: `http:\\localhost:8545`
- WebSockets: `ws:\\localhost:8546`
- HTTPS: `http://localhost:8545`
- WebSockets: `ws://localhost:8546`
- Chain ID: `1337`
- [Message service address](../../../../architecture/stack/canonical-msg-service/message-service.mdx): `0xe537D669CA013d86EBeF1D64e40fC74CADC91987`
- Deployment account private key: `0x1dd171cec7e2995408b5513004e8207fe88d6820aeff0d82463b3e41df251aae`
</TabItem>
<TabItem value="Base layer" label="Base layer (L1)">
- Endpoints:
- HTTPS: `http:\\localhost:8445`
- WebSockets: `ws:\\localhost:8446`
- HTTPS: `http://localhost:8445`
- WebSockets: `ws://localhost:8446`
- Chain ID: `31648428`
- Linea rollup contract address: `0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9`
- Deployment account private key: `0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80`
</TabItem>
</Tabs>

:::info
You can [connect your MetaMask wallet](https://support.metamask.io/networks-and-sidechains/managing-networks/how-to-add-a-custom-network-rpc/#adding-a-network-manually)
to the required chain and [import the deployment account](https://support.metamask.io/managing-my-wallet/accounts-and-addresses/how-to-import-an-account/#importing-using-a-private-key)
to access the test tokens.
:::

## Stop the Linea stack

You can stop and start the the Docker containers in Docker Desktop. However, constant stopping and
Expand All @@ -103,7 +103,7 @@ starting can lead to network or state issues.
Once stopped, you can clean your environment using the following commands:

:::note
This will permanently remove all docker images, containers and docker volumes and any data saved it them.
This will permanently remove all Docker images, containers, volumes, and any data saved in them.
:::

```bash
Expand Down
6 changes: 3 additions & 3 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,7 @@ html[data-theme="dark"] .header-dockerhub-link::before {
.navbar__link[href="/users"]::before,
.navbar__link[href="/developers/quickstart"]::before,
.navbar__link[href="/architecture"]::before,
.navbar__link[href="/developers/guides/run-a-node"]::before {
.navbar__link[href="/developers/guides/run-linea"]::before {
content: "";
display: inline-block;
width: 7px;
Expand All @@ -588,7 +588,7 @@ html[data-theme="dark"] .header-dockerhub-link::before {
.navbar__link[href="/users"]:hover::before,
.navbar__link[href="/developers/quickstart"]:hover::before,
.navbar__link[href="/architecture"]:hover::before,
.navbar__link[href="/developers/guides/run-a-node"]:hover::before {
.navbar__link[href="/developers/guides/run-linea"]:hover::before {
background-color: #61dfff;
border: 1px solid #61dfff;
}
Expand All @@ -610,7 +610,7 @@ html[data-theme="dark"] .header-dockerhub-link::before {
.navbar__link[href="/users"]::before,
.navbar__link[href="/developers/quickstart"]::before,
.navbar__link[href="/architecture"]::before,
.navbar__link[href="/developers/guides/run-a-node"]::before {
.navbar__link[href="/developers/guides/run-linea"]::before {
display: none;
}
}
Expand Down

0 comments on commit 757eae5

Please sign in to comment.