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

docs(website): proposer + prover private key format and status log command to find errors #14862

Merged
merged 3 commits into from
Sep 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions packages/website/pages/docs/guides/enable-a-proposer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,15 @@ nano .env

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

<Callout type="error">
For `L1_PROPOSER_PRIVATE_KEY`
make sure your private key is in hexadecimal format and with the `0x` prefix removed!
Otherwise you will get this error in your proposer status logs:
```
simple-taiko-node-taiko_client_proposer-1 | invalid L1 proposer private key: invalid length, need 256 bits
```
</Callout>

- Set `ENABLE_PROPOSER` to `true`
- Set `L1_PROPOSER_PRIVATE_KEY` to the private key of your L1 account (with balance) who will send TaikoL1.proposeBlock transactions
- Set `L2_SUGGESTED_FEE_RECIPIENT` to the address of your L2 account who will be the tx fee beneficiary of the L2 blocks that you proposed
Expand All @@ -69,15 +78,23 @@ If you are not running a local prover, then you can specify a prover from the [p

- `PROVER_ENDPOINTS`

### Verify proposer logs
### Check proposer status logs

To see if your proposer is running correctly or has errors run:

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

### See proposed blocks

Run this command to verify you have some proposer logs:
When you run:

```sh
docker compose logs -f taiko_client_proposer | egrep "Propose transactions succeeded"
```

You should see a log if you have proposed a block: `📝 Propose transactions succeeded`.
if your proposer successfully proposed a block, your logs should show: `📝 Propose transactions succeeded`.

You can check all commands to see proposer logs in the [node runner manual](/docs/manuals/node-runner-manual#view-client-proposer-logs).

Expand Down
21 changes: 19 additions & 2 deletions packages/website/pages/docs/guides/enable-a-prover.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,15 @@ nano .env

Open the `.env` file and set the following environment variables to enable your node as a prover:

<Callout type="error">
For `L1_PROVER_PRIVATE_KEY`
make sure your private key is in hexadecimal format and with the `0x` prefix removed!
Otherwise you will get this error in your prover status logs:
```
simple-taiko-node-taiko_client_prover_relayer-1 | invalid L1 prover private key: invalid length, need 256 bits
```
</Callout>

- Set `ENABLE_PROVER` to `true`
- Set `L1_PROVER_PRIVATE_KEY` to your L1 account private key (with balance of TTKOj on TaikoL1), we will the public key of this account in the next Steps

Expand Down Expand Up @@ -85,15 +94,23 @@ Finally, click the **Write** button.

> Note: If you were already running a prover from your address when you approved TaikoL1 as a spender, the contract may directly drain up to the approved amount of TTKOj from your wallet to use as bond for proving. This may cause `depositTaikoToken` transactions to fail.

### Check prover status logs

To see if your prover is running correctly or has errors run:

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

### Verify prover logs

Run this command to verify you have some prover logs:
When you run:

```sh
docker compose logs -f taiko_client_prover_relayer | egrep "block proof was|proof submission error|Block proven"
```

You should see logs like this if it was successful:
if your prover has successfully proven a block, your logs should show:

- `💰 Your block proof was accepted` means you successfully submitted a proof and your bond is returned.
- `✅ Block proven` means a proposed block was successfully proved on TaikoL1 (by anyone).
Expand Down
Loading