From 8c2aa48dc8af73432fd7d3df4a91bb0e21c9af17 Mon Sep 17 00:00:00 2001 From: Kenk Date: Mon, 7 Aug 2023 16:41:20 +0700 Subject: [PATCH 1/4] feat(website): update node running guides --- .../guides/run-a-node/enable-a-proposer.mdx | 32 ++++++++++++++++--- .../guides/run-a-node/enable-a-prover.mdx | 29 +++++++++++++++-- 2 files changed, 54 insertions(+), 7 deletions(-) diff --git a/packages/website/pages/docs/guides/run-a-node/enable-a-proposer.mdx b/packages/website/pages/docs/guides/run-a-node/enable-a-proposer.mdx index 7c9a9f5b27..6d8c53bb4b 100644 --- a/packages/website/pages/docs/guides/run-a-node/enable-a-proposer.mdx +++ b/packages/website/pages/docs/guides/run-a-node/enable-a-proposer.mdx @@ -59,7 +59,15 @@ Click `Write` and confirm the transaction in your wallet. ### Open .env file in `simple-taiko-node` -Open the `.env` (or `.env.l3` for Eldfell L3 proposers) file in the `simple-taiko-node` directory. +For Grimsvotn L2: +```sh +nano .env +``` + +For Eldfell L3: +```sh +nano .env.l3 +``` ### Set environment variables to enable a proposer @@ -72,9 +80,25 @@ Open the `.env` (or `.env.l3` for Eldfell L3 proposers) file in the `simple-taik Set the following environment variables to enable your node as a proposer: -- Set `ENABLE_PROPOSER` to `true` (replacing the default `false` with `true`). -- Set `L1_PROPOSER_PRIVATE_KEY` (or `L2_PROPOSER_PRIVATE_KEY` for Eldfell L3 proposers) to that of your wallet's private key; it will need some TTKO/TTKOe on Sepolia/Grimsvotn to propose blocks (if using MetaMask, follow these directions to [retrieve the private key](https://metamask.zendesk.com/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key)). -- Set `L2_SUGGESTED_FEE_RECIPIENT` (or `L3_SUGGESTED_FEE_RECIPIENT` for Eldfell L3 proposers) to the recipient of L2/L3 ETH rewards. +For Grimsvotn L2 `.env`: + +```sh +ENABLE_PROPOSER=true # change from false to true +# A L1 account (with balance) private key who will send TaikoL1.proposeBlock transactions +L1_PROPOSER_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000000 # your wallet's private key +# A L2 account address who will be the tx fee beneficiary of the L2 blocks that you proposed +L2_SUGGESTED_FEE_RECIPIENT=0x0000000000000000000000000000000000000000 # the recipient of L2/L3 ETH rewards. +``` + +For Eldfell L3 `.env.l3`: + +```sh +ENABLE_PROPOSER=true # change from false to true +# A L2 account (with balance) private key who will send TaikoL1.proposeBlock transactions +L2_PROPOSER_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000000 # your wallet's private key +# A L3 account address who will be the tx fee beneficiary of the L3 blocks that you proposed +L3_SUGGESTED_FEE_RECIPIENT=0x0000000000000000000000000000000000000000 # the recipient of L2/L3 ETH rewards. +``` ### Verify proposer logs diff --git a/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx b/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx index 60f451a275..e0caeb61f1 100644 --- a/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx +++ b/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx @@ -28,7 +28,17 @@ This guide will help you enable your Taiko node as a prover. Read more about pro ### Open the .env file in `simple-taiko-node` -Open the `.env` (or `.env.l3` for Eldfell L3 provers) file in the `simple-taiko-node` directory. + +For Grimsvotn L2: +```sh +nano .env +``` + +For Eldfell L3: +```sh +nano .env.l3 +``` + ### Set environment variables to enable prover @@ -41,8 +51,21 @@ Open the `.env` (or `.env.l3` for Eldfell L3 provers) file in the `simple-taiko- Set the following environment variables to enable your node as a prover: -- Set `ENABLE_PROVER` to `true` (replacing the default `false` with `true`). -- Set `L1_PROVER_PRIVATE_KEY` (or `L2_PROVER_PRIVATE_KEY` for Eldfell L3 provers) to that of your wallet's private key; it will need some ETH on Sepolia to prove blocks (if using MetaMask, follow these directions to [retrieve the private key](https://metamask.zendesk.com/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key)). +For Grimsvotn L2 `.env`: + +```sh +ENABLE_PROVER=true # change from false to true +# A L1 account (with balance) private key which will send the TaikoL1.proveBlock transactions. +L1_PROVER_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000000 # your prover's private key +``` + +For Eldfell L3 `.env.l3`: + +```sh +ENABLE_PROVER=true # change from false to true +# A L2 account (with balance) private key which will send the TaikoL1.proveBlock transactions. +L2_PROVER_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000000 # your prover's private key +``` ### Verify prover logs From 73355a6d29d65bf9f5ff637091c33ca4ad8f1f41 Mon Sep 17 00:00:00 2001 From: Kenk Date: Mon, 7 Aug 2023 22:13:06 +0800 Subject: [PATCH 2/4] Update packages/website/pages/docs/guides/run-a-node/enable-a-proposer.mdx Co-authored-by: d1onys1us <13951458+d1onys1us@users.noreply.github.com> --- .../website/pages/docs/guides/run-a-node/enable-a-proposer.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/website/pages/docs/guides/run-a-node/enable-a-proposer.mdx b/packages/website/pages/docs/guides/run-a-node/enable-a-proposer.mdx index 6d8c53bb4b..b8088001d0 100644 --- a/packages/website/pages/docs/guides/run-a-node/enable-a-proposer.mdx +++ b/packages/website/pages/docs/guides/run-a-node/enable-a-proposer.mdx @@ -65,6 +65,7 @@ nano .env ``` For Eldfell L3: + ```sh nano .env.l3 ``` From d3dddcc048cadbf0b06e76c290c295ce0d330e70 Mon Sep 17 00:00:00 2001 From: Kenk Date: Mon, 7 Aug 2023 22:13:16 +0800 Subject: [PATCH 3/4] Update packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx Co-authored-by: d1onys1us <13951458+d1onys1us@users.noreply.github.com> --- .../website/pages/docs/guides/run-a-node/enable-a-prover.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx b/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx index e0caeb61f1..aaa6fe8984 100644 --- a/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx +++ b/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx @@ -30,6 +30,7 @@ This guide will help you enable your Taiko node as a prover. Read more about pro ### Open the .env file in `simple-taiko-node` For Grimsvotn L2: + ```sh nano .env ``` From 437c0fc9713e355af4d326be8db199d62571fdaf Mon Sep 17 00:00:00 2001 From: Kenk Date: Mon, 7 Aug 2023 22:13:22 +0800 Subject: [PATCH 4/4] Update packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx Co-authored-by: d1onys1us <13951458+d1onys1us@users.noreply.github.com> --- .../website/pages/docs/guides/run-a-node/enable-a-prover.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx b/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx index aaa6fe8984..c3b99647f5 100644 --- a/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx +++ b/packages/website/pages/docs/guides/run-a-node/enable-a-prover.mdx @@ -36,6 +36,7 @@ nano .env ``` For Eldfell L3: + ```sh nano .env.l3 ```