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 f05f61cc92a..3bf27cb512a 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 @@ -3,8 +3,6 @@ import { contractAddressToLink } from "../../../../utils/contractAddressToLink"; import { SEPOLIA_CONFIG, GRIMSVOTN_CONFIG } from "../../../../domain/chain"; import { StyledLink } from "/components/StyledLink"; -{console.log(contractAddressToLink(SEPOLIA_CONFIG.blockExplorer.url, SEPOLIA_CONFIG.basedContracts.taikoL1.address.proxy))} - # Enable a proposer This guide will help you enable your Taiko node as a proposer. @@ -52,28 +50,33 @@ For example if you want to deposit `69` TTKO/TTKOe, you would enter `6900000000` Click `Write` and confirm the transaction in your wallet. -### Open `.env` file in `simple-taiko-node` +### Open .env file in `simple-taiko-node` -Open the `.env` file in the `simple-taiko-node` directory. +Open the `.env` (or `.env.l3` for Eldfell L3 proposers) file in the `simple-taiko-node` directory. ### Set environment variables to enable a proposer 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**. + stored in plain text in the `.env` or `.env.l3` file, and this is not secure. + There is a real risk of losing your assets. You should **only use a test + account**. 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` 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` to the recipient of L2/L3 ETH rewards. +- 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. ### Verify proposer logs You should see a log if you have proposed a block: `📝 Propose transactions succeeded`. -If you are running a node in the background, you can view the logs with `docker compose logs -f`. +You can check all commands to see proposer logs in the [node runner manual](/docs/manuals/node-runner-manual#view-client-proposer-logs). + +## Troubleshooting + +View the [Node troubleshooting reference](/docs/reference/node-troubleshooting) for help on any common error codes / issues. 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 89ab33acb1b..60f451a2758 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 @@ -14,45 +14,68 @@ This guide will help you enable your Taiko node as a prover. Read more about pro ## Prerequisites - You have already setup a node (see: [Run a node](/docs/guides/run-a-node)) -- Must have some ETH on Sepolia (see: [Receive tokens](/docs/guides/receive-tokens)). - Should have at least 8/16 core CPU and 32GB of RAM. +### Grimsvotn L2 + +- Must have a balance of ETH on Sepolia L1 (see: [Receive tokens](/docs/guides/receive-tokens)). + +### Eldfell L3 + +- Must have a balance of ETH on Grimsvotn L2 (see: [Receive tokens](/docs/guides/receive-tokens)). + ## Steps -### Open `.env` file in `simple-taiko-node` -Open the `.env` file in the `simple-taiko-node` directory. +### 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. ### Set environment variables to enable prover 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**. + stored in plain text in the `.env` or `.env.l3` file, and this is not secure. + There is a real risk of losing your assets. You should **only use a test + account**. 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` 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)). +- 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)). + +### Verify prover logs + +Verify you have some prover logs: + +- `💰 Your block proof was accepted` means you are the first prover and receive the reward. +- `✅ Block proven` just means a proposed block was successfully proved on TaikoL1 (by anyone). + +You can check all commands to see prover logs in the [node runner manual](/docs/manuals/node-runner-manual#view-client-prover-relayer-logs). ### Stake your TTKOe (Eldfell L3 provers only) -If you are trying to run a prover for Eldfell L3 first keep in mind, the competition for getting into the prover pool will be high. But don't worry! Even if you get slashed, there's nothing wrong with that. TTKOe is a worthless testnet token, and even getting slashed really helps us to test the network. +The simple-taiko-node comes with a default value of `PROVE_UNASSIGNED_BLOCKS` set to `true`. This means that your prover will attempt to prove these open blocks. To be assigned blocks by the protocol, you need to stake your TTKOe. To stake your TTKOe try using the [staking dashboard](https://staking.l3test.taiko.xyz/) or the base layer contract manually (see [TaikoL1](/docs/reference/contract-addresses)). -### Verify prover logs +1. Set the amount per capacity. This is the amount you in TTKOe you are staking. The more you stake, the higher your rank will be in prover pool. +2. Set the reward per gas. This is the reward you want to receive in TTKOe. A good value would be close to the current protocol `feePerGas`. +3. Set the capacity you can provide. This is the amount of parallel blocks you can handle within the proof window. -Verify you have some prover logs: +### Exit your prover from prover pool (Eldfell L3 provers only) -- `💰 Your block proof was accepted` means you are the first prover and receive the reward. -- `✅ Block proven` just means a proposed block was successfully proved on TaikoL1 (by anyone). +If you want to stop proving, you can exit your prover from the prover pool. This will stop your prover from being assigned blocks. + +There are two actions you can use on the `ProverPool.sol` contract, the proxy contract can be found [here](/docs/reference/contract-addresses#based-contracts-1): + +1. Withdraw. This will withdraw your stake for your prover. +2. Exit. This will withdraw your stake and fully exit you from the prover pool (delete from storage). -If you are running a node in the background, you can view the logs with `docker compose logs -f`. +If want to temporarily leave the pool a withdraw should be enough, if you want to completely leave the pool you should use exit. ## Troubleshooting -Consult [Run a node - Troubleshooting](/docs/guides/run-a-node#troubleshooting) for common issues. +View the [Node troubleshooting reference](/docs/reference/node-troubleshooting) for help on any common error codes / issues. diff --git a/packages/website/pages/docs/reference/_meta.json b/packages/website/pages/docs/reference/_meta.json index 858f4072deb..6baf38ec6b8 100644 --- a/packages/website/pages/docs/reference/_meta.json +++ b/packages/website/pages/docs/reference/_meta.json @@ -7,5 +7,8 @@ }, "node-troubleshooting": { "title": "Node troubleshooting" + }, + "faq": { + "title": "FAQ" } } diff --git a/packages/website/pages/docs/reference/faq.mdx b/packages/website/pages/docs/reference/faq.mdx new file mode 100644 index 00000000000..aa592c75166 --- /dev/null +++ b/packages/website/pages/docs/reference/faq.mdx @@ -0,0 +1,11 @@ +# FAQ + +Please feel free to click "Edit this page" and add any additional FAQs you think would be helpful to others. + +## Can I ignore these logs from my node? + +See [node troubleshooting](/docs/reference/node-troubleshooting) for a list of node logs that can be ignored and which are errors. + +## Where can I find the deployed contract addresses? + +See [contract addresses](/docs/reference/contract-addresses) for a list of deployed contract addresses.