Skip to content

Commit

Permalink
Merge branch 'main' into bridge-improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
dionysuzx authored Jul 22, 2023
2 parents 2c91e67 + cc35f5b commit 8f80d56
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 13 deletions.
9 changes: 8 additions & 1 deletion packages/website/components/Ecosystem/EcosystemSection.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@ const ecosystemData: EcosystemData[] = [
"FoxWallet is a safe and easy-to-use decentralized audited wallet, dedicated to creating an entrance and connection to the Web3 world.",
filters: [],
},
{
icon: "/images/ecosystem/kalkiswap.png",
name: "KALKI SWAP",
link: "https://kalkiswap.org",
description: "KalkiSwap is a cutting-edge decentralized exchange (DEX) that provides lightning-fast token swapping and innovative liquidity provision across diverse blockchains.",
filters: [],
},
{
icon: "/images/ecosystem/kekkai.png",
name: "KEKKAI",
Expand Down Expand Up @@ -110,7 +117,7 @@ const ecosystemData: EcosystemData[] = [
{
icon: "/images/ecosystem/owlto.png",
name: "Owlto",
link: "https://stg.owlto.finance",
link: "https://owlto.finance",
description: "The decentralized cross-rollup bridge focused on Layer2.",
filters: [],
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ Open the `.env` file in the `simple-taiko-node` directory.

### Set environment variables to enable a proposer

<Callout type="warning">
Do **not** use a private key that is valuable to you. The private key will be
stored in plain text in the `.env` file, and this is not secure. There is a
real risk of losing your assets. You should **only use a test account**.
</Callout>

Set the following environment variables to enable your node as a proposer:

- Set `ENABLE_PROPOSER` to `true` (replacing the default `false` with `true`).
Expand Down
14 changes: 11 additions & 3 deletions packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import { Callout, Steps } from "nextra-theme-docs";

<Callout type="warning">
Keep in mind that running a prover is a very competitive space, and those who generate proofs will have very powerful machines and optimized clients.
It's unlikely to prove a block and gain rewards with the default client and minimum hardware requirements.
Keep in mind that running a prover is a very competitive space, and those who
generate proofs will have very powerful machines and optimized clients. It's
unlikely to prove a block and gain rewards with the default client and minimum
hardware requirements.
</Callout>

# Enable a prover
Expand All @@ -23,6 +25,12 @@ Open the `.env` file in the `simple-taiko-node` directory.

### Set environment variables to enable prover

<Callout type="warning">
Do **not** use a private key that is valuable to you. The private key will be
stored in plain text in the `.env` file, and this is not secure. There is a
real risk of losing your assets. You should **only use a test account**.
</Callout>

Set the following environment variables to enable your node as a prover:

- Set `ENABLE_PROVER` to `true` (replacing the default `false` with `true`).
Expand All @@ -39,7 +47,7 @@ To stake your TTKOe try using the [staking dashboard](https://staking.l3test.tai
Verify you have some prover logs:

- `💰 Your block proof was accepted` means you are the first prover and receive the reward.
- `Valid block proven` just means a proposed block was successfully proved on TaikoL1 (by anyone).
- `Block proven` just means a proposed block was successfully proved on TaikoL1 (by anyone).

If you are running a node in the background, you can view the logs with `docker compose logs -f`.

Expand Down
30 changes: 27 additions & 3 deletions packages/website/pages/docs/guides/run-a-node/run-a-taiko-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -220,19 +220,19 @@ docker compose pull

To view the Docker logs, the following commands can be ran:

#### View all logs
#### View all L2 logs

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

#### View the proposer image's logs
#### View the L2 proposer image's logs

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

#### View the prover image's logs
#### View the L2 prover image's logs

```sh
docker compose logs -f taiko_client_prover_relayer
Expand All @@ -244,6 +244,30 @@ docker compose logs -f taiko_client_prover_relayer
docker compose logs -f l2_execution_engine
```

#### View all L3 logs

```sh
docker compose -f docker-compose.l3.yml logs -f
```

#### View the L3 proposer image's logs

```sh
docker compose -f docker-compose.l3.yml logs -f l3_taiko_client_proposer
```

#### View the L3 prover image's logs

```sh
docker compose -f docker-compose.l3.yml logs -f l3_taiko_client_prover_relayer
```

#### View the L3 execution engine logs

```sh
docker compose -f docker-compose.l3.yml logs -f l3_execution_engine
```

#### View the live data streams of your running containers

This shows the CPU/MEM USAGE % and consumption of your machine's resources (add prefix "`docker stats -a`" to display all containers)
Expand Down
6 changes: 6 additions & 0 deletions packages/website/pages/docs/manuals/node-runner-manuals.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Node runner manuals

These manuals list commonly used commands for node operation and troubleshooting. To setup a node, see the [Guides](/docs/guides).

- [Grimsvotn L2 node runner manual](/docs/manuals/node-runner-manuals/grimsvotn-l2-node-runner-manual)
- [Eldfell L3 node runner manual](/docs/manuals/node-runner-manuals/grimsvotn-l2-node-runner-manual)
Original file line number Diff line number Diff line change
Expand Up @@ -39,29 +39,29 @@ docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f
## View execution logs

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

## View client driver logs

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

## View client proposer logs

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

## View client prover relayer logs

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

## View zkevm prover logs

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f zkevm-chain-prover-rpcd
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f l3_zkevm_chain_prover_rpcd
```
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,5 @@ docker compose logs -f taiko_client_prover_relayer
## View zkevm prover logs

```sh
docker compose logs -f zkevm-chain-prover-rpcd
docker compose logs -f zkevm_chain_prover_rpcd
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8f80d56

Please sign in to comment.