Skip to content

Commit

Permalink
docs(website): proposer + prover private key format and status log co…
Browse files Browse the repository at this point in the history
…mmand to find errors (#14862)

Co-authored-by: Roger <50648015+RogerLamTd@users.noreply.github.com>
  • Loading branch information
MarcusWentz and RogerLamTd authored Sep 30, 2023
1 parent 87ed466 commit 02f18d2
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 5 deletions.
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

0 comments on commit 02f18d2

Please sign in to comment.