Skip to content

Commit

Permalink
chore(website): remove ttko discord and combine node runner manual (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
d1onys1us authored and dong77 committed Jul 24, 2023
1 parent e10bee7 commit aa5d03d
Show file tree
Hide file tree
Showing 30 changed files with 111 additions and 2,461 deletions.
3 changes: 3 additions & 0 deletions packages/website/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
.next
node_modules
# temporarily ignoring auto-generated contract documentation until
# we can separate L2/L3 contracts
contract-documentation
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This guide will help you receive testnet tokens. You can see all the deployed to

It's possible more will be distributed, especially considering those that did not run a proposer/prover in alpha1/alpha2, and those who are new to the Taiko community.

Otherwise, you can obtain TTKO by successfully [proving blocks](/docs/guides/enable-a-prover) (the protocol rewards you in TTKO), from [Swap](https://swap.test.taiko.xyz), or by asking a community member on our [Discord](https://discord.gg/taikoxyz).
Otherwise, you can obtain TTKO by successfully [proving blocks](/docs/guides/enable-a-prover) (the protocol rewards you in TTKO) or from [Swap](https://swap.test.taiko.xyz).

By the way, TTKO is specific to Grimsvotn testnet, you won't earn any TTKO for proving Eldfell blocks (you will earn TTKOe, see below).

Expand Down
2 changes: 1 addition & 1 deletion packages/website/pages/docs/manuals/_meta.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"contributing-manual": "Contributing manual",
"integration-manual": "Integration manual",
"node-runner-manuals": "Node runner manuals"
"node-runner-manual": "Node runner manual"
}
Original file line number Diff line number Diff line change
@@ -1,67 +1,169 @@
# Eldfell L3 node runner manual
# Node runner manual

## Start node

**Grimsvotn L2:**

```sh
docker compose up -d
```

**Eldfell L3:**

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 up -d
```

## Stop node

**Grimsvotn L2:**

```sh
docker compose down
```

**Eldfell L3:**

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 down
```

## Restart node

**Grimsvotn L2:**

```sh
docker compose down && docker compose up -d
```

**Eldfell L3:**

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 down && docker compose -f ./docker-compose.l3.yml --env-file .env.l3 up -d
```

## Update node

**Grimsvotn L2:**

```sh
git pull origin main && docker compose pull
```

**Eldfell L3:**

```sh
git pull origin main && docker compose -f ./docker-compose.l3.yml --env-file .env.l3 pull
```

## Remove node

**Grimsvotn L2:**

```sh
docker compose down -v
```

**Eldfell L3:**

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 down -v
```

## View grafana dashboard

**Grimsvotn L2:**

```sh
open http://localhost:3000/d/L2ExecutionEngine/l2-execution-engine-overview
```

**Eldfell L3:**

```sh
open http://localhost:3001/d/L2ExecutionEngine/l2-execution-engine-overview
```

## View all logs

**Grimsvotn L2:**

```sh
docker compose logs -f
```

**Eldfell L3:**

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f
```

## View execution logs

**Grimsvotn L2:**

```sh
docker compose logs -f l2_execution_engine
```

**Eldfell L3:**

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f l3_execution_engine
```

## View client driver logs

**Grimsvotn L2:**

```sh
docker compose logs -f taiko_client_driver
```

**Eldfell L3:**

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f l3_taiko_client_driver
```

## View client proposer logs

**Grimsvotn L2:**

```sh
docker compose logs -f taiko_client_proposer
```

**Eldfell L3:**

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f l3_taiko_client_proposer
```

## View client prover relayer logs

**Grimsvotn L2:**

```sh
docker compose logs -f taiko_client_prover_relayer
```

**Eldfell L3:**

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f l3_taiko_client_prover_relayer
```

## View zkevm prover logs

**Grimsvotn L2:**

```sh
docker compose logs -f zkevm_chain_prover_rpcd
```

**Eldfell L3:**

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f l3_zkevm_chain_prover_rpcd
```
6 changes: 0 additions & 6 deletions packages/website/pages/docs/manuals/node-runner-manuals.mdx

This file was deleted.

This file was deleted.

This file was deleted.

3 changes: 3 additions & 0 deletions packages/website/pages/docs/reference/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,8 @@
},
"rpc-configuration": {
"title": "RPC configuration"
},
"contract-documentation": {
"display": "hidden"
}
}

This file was deleted.

Loading

0 comments on commit aa5d03d

Please sign in to comment.