Skip to content

Commit

Permalink
docs(docs-site): remove prover_endpoints from guide (#17769)
Browse files Browse the repository at this point in the history
  • Loading branch information
dionysuzx authored Jul 10, 2024
1 parent 98a98ba commit ed4c9d6
Show file tree
Hide file tree
Showing 6 changed files with 908 additions and 472 deletions.
5 changes: 0 additions & 5 deletions packages/docs-site/astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,6 @@ export default defineConfig({
label: "Event Indexer API",
schema: "../eventindexer/docs/swagger.yaml",
},
{
base: "api-reference/prover-server",
label: "Prover Server API",
schema: "../taiko-client/docs/swagger.yaml",
},
]),
],
components: {
Expand Down
6 changes: 3 additions & 3 deletions packages/docs-site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
"astro": "astro"
},
"dependencies": {
"@astrojs/check": "^0.6.0",
"@astrojs/starlight": "^0.22.2",
"astro": "^4.8.3",
"@astrojs/check": "^0.8.0",
"@astrojs/starlight": "^0.25.0",
"astro": "^4.11.5",
"astro-og-canvas": "^0.5.0",
"canvaskit-wasm": "^0.39.1",
"sharp": "^0.33.3",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ This guide outlines how to achieve this with separate EOAs running prover and pr

## Prerequisites

- You have set up a prover and proposer with the guides in our documentation
- You have TAIKO or TTKOh depending on which network you are proving on
- You have enough ETH for gas fees
- You have enough ETH or holesky ETH for gas fees

## Deploying a ProverSet

Expand Down Expand Up @@ -46,7 +45,7 @@ This guide outlines how to achieve this with separate EOAs running prover and pr
2. **Deploy the ProverSet**

Set `ROLLUP_ADDRESS_MANAGER` to the address of the RollupAddressManager contract on the network you are deploying to. You can find these values in our network reference docs.

Set `PROVER_SET_ADMIN` to the address of your **prover** EOA. You will be able to withdraw TAIKO/TTKOh from the contract to this address.

Run the `DeployProverSet.s.sol` script with your **proposer's private key**. You can find the script [here](https://github.com/taikoxyz/taiko-mono/tree/main/packages/protocol/script/DeployProverSet.s.sol).
Expand Down Expand Up @@ -107,6 +106,6 @@ This guide outlines how to achieve this with separate EOAs running prover and pr
</Steps>

<Card title="Troubleshooting" icon="error">
If you run into any problems, please visit the [troubleshooting page](/guides/node-operators/node-troubleshooting) for help.
If you run into an error that isn't yet listed, please reach out in our [discord](https://discord.com/invite/taikoxyz)!
</Card>
If you run into any problems, please visit the [node troubleshooting page](/guides/node-operators/node-troubleshooting) for help.
If you run into an error that isn't yet listed, please reach out in our [Discord](https://discord.com/invite/taikoxyz)!
</Card>
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Aside, Card, CardGrid, Steps} from '@astrojs/starlight/components';
## Prerequisites

- You are already running a Taiko node [with Docker](/guides/node-operators/run-a-taiko-node-with-docker) or [from source](/guides/node-operators/build-a-taiko-node-from-source).
- You are able to receive prover bonds from your own prover or from [a community marketplace](https://dojonode.xyz/tatami).
- You have [set up a prover](/guides/node-operators/enable-a-prover) or [configured a ProverSet](/guides/node-operators/deploy-a-proverset) with a third-party partner.

{/*## Using `stn`
Expand All @@ -17,17 +17,17 @@ import { Aside, Card, CardGrid, Steps} from '@astrojs/starlight/components';

## Using simple-taiko-node

<Aside>
These are the bare minimum required settings along with a functional Taiko node to run a proposer, feel free to customize the rest of the variables in the `.env` file as you see fit!
</Aside>
:::caution
You can choose to either use a ProverSet, or leave the `PROVER_SET` variable blank. If you leave it blank, you will eventually run into some nonce issues as the proposer and prover will be using the same address. This may be sufficient for testing, but for a longer term proposer / prover setup, we recommend utilizing a ProverSet.
:::

<Steps>

1. First, you will need to have a prover from <a href="https://dojonode.xyz/tatami" target="_blank">the community marketplace</a> or [run your own SGX prover](/guides/node-operators/enable-a-prover).
1. First, you will need to [set up a prover](/guides/node-operators/enable-a-prover).

2. You MUST set `PROVER_ENDPOINTS` in simple-taiko-node `.env` file to the your SGX prover's endpoint or one from the marketplace. If you do not set it and leave it default while not running a prover, **your proposer will not work**.
2. If you are using a ProverSet, set the ProverSet contract address in the `PROVER_SET` env variable from the previous guide. Otherwise, leave it blank.

3. Next, set the `L1_PROPOSER_PRIVATE_KEY` to an L1 account's private key which will send the Propose Block transactions.
3. Next, set the `L1_PROPOSER_PRIVATE_KEY` to an L1 account's private key which will send the Propose Block transactions. If you are not using a ProverSet, this must be the same private key as your prover.

4. Then, set the `L2_SUGGESTED_FEE_RECIPIENT` to an L2 account's public key that will receive the fee.

Expand All @@ -37,20 +37,9 @@ These are the bare minimum required settings along with a functional Taiko node

7. Now that the proposer is configured properly, you can run it with `docker compose up -d`!

<Aside type="danger">
We strongly recommend you [deploy a `ProverSet` contract](/guides/node-operators/deploy-a-proverset) to run your proposer. If you don't, you will run into nonce issues running your proposer and prover from the same EOA.

If you are working with a third party prover, you will have to follow the guide with them to negotiate allowance and deposit of TAIKO/TTKOh.
</Aside>

</Steps>

<CardGrid>
<Card title="Troubleshooting" icon="error">
If you run into any problems, please visit the [troubleshooting page](/guides/node-operators/node-troubleshooting) for help.
If you run into an error that isn't yet listed, please reach out in our [discord](https://discord.com/invite/taikoxyz)!
</Card>
<Card title="Deploy a ProverSet" icon="rocket">
Now that you've enabled a proposer, to prevent nonce issues whilst running please [deploy a ProverSet](/guides/node-operators/deploy-a-proverset)!
</Card>
</CardGrid>
<Card title="Troubleshooting" icon="error">
If you run into any problems, please visit the [node troubleshooting page](/guides/node-operators/node-troubleshooting) for help.
If you run into an error that isn't yet listed, please reach out in our [Discord](https://discord.com/invite/taikoxyz)!
</Card>
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,20 @@ These are the bare minimum required settings along with a functional Taiko node

<Steps>

1. A Taiko prover needs to be able to generate SGX proofs at the moment. Please follow the README guide on our [raiko](https://github.com/taikoxyz/raiko/blob/main/docs/README_Docker_and_RA.md) repository.
1. A Taiko prover needs to be able to generate SGX proofs at the moment. To do that, you need to run raiko. Please follow the Docker setup guide [here](https://github.com/taikoxyz/raiko/blob/main/docs/README_Docker_and_RA.md).

2. Then set the `SGX_RAIKO_HOST` endpoint in your `.env` file.
2. After successfully setting up raiko, set the `SGX_RAIKO_HOST` endpoint in your `.env` file.

3. Set the `L1_PROVER_PRIVATE_KEY` to an L1 account's private key which will send the Prove Block transactions.

4. Set the `MIN_ACCEPTABLE_PROOF_FEE` to the value in GWei that you deem sufficient.
4. You may optionally [deploy a `ProverSet` contract](/guides/node-operators/deploy-a-proverset) to run your proposer. If you are working with a third party prover, you will have to follow the guide with them to negotiate allowance and deposit of TAIKO/TTKOh. A ProverSet is recommended for a longer term stable setup to avoid nonce issues. For testing purposes, you may not feel the need to deploy a ProverSet.

5. Finally set `ENABLE_PROVER` to `true` in simple-taiko-node `.env`.

6. Set `COMPOSE_PROFILES=prover` or add prover to the list.

7. You can then run your prover with `docker compose up -d`!

<Aside type="danger">
We strongly recommend you [deploy a `ProverSet` contract](/guides/node-operators/deploy-a-proverset) to run your prover. If you don't, you will run into nonce issues running your proposer and prover from the same EOA.
</Aside>

</Steps>

### Approve TaikoL1 as TAIKO spender (mainnet)
Expand Down Expand Up @@ -88,12 +84,7 @@ You will need TTKOh deposited on the TaikoL1 contract to secure the bond for the

Finally you can choose to register your prover endpoint on the <a href="https://dojonode.xyz/tatami" target="_blank">community prover marketplace</a> so other can use it to propose blocks.

<CardGrid>
<Card title="Troubleshooting" icon="error">
If you run into any problems, please visit the [troubleshooting page](/guides/node-operators/node-troubleshooting) for help.
If you run into an error that isn't yet listed, please reach out in our [discord](https://discord.com/invite/taikoxyz)!
</Card>
<Card title="Deploy a ProverSet" icon="rocket">
Now that you've enabled a proposer, to prevent nonce issues whilst running please [deploy a ProverSet](/guides/node-operators/deploy-a-proverset)!
</Card>
</CardGrid>
<Card title="Troubleshooting" icon="error">
If you run into any problems, please visit the [node troubleshooting page](/guides/node-operators/node-troubleshooting) for help.
If you run into an error that isn't yet listed, please reach out in our [Discord](https://discord.com/invite/taikoxyz)!
</Card>
Loading

0 comments on commit ed4c9d6

Please sign in to comment.