Skip to content

Commit 1a4b568

Browse files
authored
feat(docs-site): update docs for based preconfs, node running, removal of proverset (#19928)
1 parent cfe0ef4 commit 1a4b568

File tree

10 files changed

+42
-290
lines changed

10 files changed

+42
-290
lines changed

packages/docs-site/astro.config.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ export default defineConfig({
8484
link: "/taiko-alethia-protocol/protocol-design/inception-layers/",
8585
},
8686
{
87-
label: "Pacaya fork Taiko Alethia",
87+
label: "Pacaya Fork Taiko Alethia",
8888
link: "/taiko-alethia-protocol/protocol-design/pacaya-fork-taiko-alethia/",
8989
},
9090
{
@@ -227,10 +227,6 @@ export default defineConfig({
227227
label: "Enable a prover",
228228
link: "/guides/node-operators/enable-a-prover/",
229229
},
230-
{
231-
label: "Deploy a ProverSet",
232-
link: "guides/node-operators/deploy-a-proverset/",
233-
},
234230
{
235231
label: "Node troubleshooting",
236232
link: "/guides/node-operators/node-troubleshooting/",

packages/docs-site/src/content/docs/guides/node-operators/deploy-a-proverset.mdx

Lines changed: 0 additions & 221 deletions
This file was deleted.

packages/docs-site/src/content/docs/guides/node-operators/enable-a-proposer.mdx

Lines changed: 0 additions & 48 deletions
This file was deleted.

packages/docs-site/src/content/docs/guides/node-operators/enable-a-prover.mdx

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,11 @@ These are the bare minimum required settings along with a functional Taiko node
2424

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

27-
4. You may optionally [deploy a `ProverSet` contract](/guides/node-operators/deploy-a-proverset) to run your prover. 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.
27+
4. Finally set `ENABLE_PROVER` to `true` in simple-taiko-node `.env`.
2828

29-
5. Finally set `ENABLE_PROVER` to `true` in simple-taiko-node `.env`.
29+
5. Set `COMPOSE_PROFILES=prover` or add prover to the list.
3030

31-
6. Set `COMPOSE_PROFILES=prover` or add prover to the list.
32-
33-
7. You can then run your prover with `docker compose up -d`! Please use `docker compose -f docker-compose-hekla.yml up -d` if you are running on Taiko Hekla.
31+
6. You can then run your prover with `docker compose up -d`! Please use `docker compose -f docker-compose-hekla.yml up -d` if you are running on Taiko Hekla.
3432

3533
</Steps>
3634

@@ -47,8 +45,6 @@ The recommended value for SGX_BATCH_SIZE is 10+ as you will see the most gas sav
4745

4846
We highly recommend you test the function **on Taiko Hekla**, not on Taiko Alethia.
4947

50-
Please note that you must use the [upgraded ProverSet contract](https://github.com/taikoxyz/taiko-mono/blob/taiko-alethia-protocol-v2.3.0/packages/protocol/contracts/layer1/provers/ProverSet.sol) to use this functionality.
51-
5248
Please also note that you should NOT enable revert protection without a PBS service that has revert protection support, as it will interfere with your batch proving on Taiko Hekla.
5349
</Aside>
5450

@@ -68,10 +64,6 @@ To prevent this, we have introduced another flag `FORCE_BATCH_PROVING_INTERVAL`.
6864

6965
This flag will force the prover to submit a batch of proofs every x minutes, regardless of the batch size being fulfilled. We don't recommend this value be set > 45 minutes, as the provingWindow is 60 minutes and any closer will put you at risk of having proof assignments expire. It is by default set to 30 minutes.
7066

71-
<Aside>
72-
The following steps can be done through the [ProverSet contract](/guides/node-operators/deploy-a-proverset/#deploying-a-proverset) if you have deployed one. We highly recommend this for a stable setup.
73-
</Aside>
74-
7567
### Approve TaikoInbox as TAIKO spender (Taiko Alethia)
7668

7769
<Steps>
@@ -92,7 +84,7 @@ The following steps can be done through the [ProverSet contract](/guides/node-op
9284

9385
You will need at least 125 TAIKO for the `livenessBond`. After entering 125, you need to set the 18 decimals that the TAIKO contract takes, you can click the plus button and then select 10^18.
9486

95-
If you have bonded TAIKO in the TaikoInbox contract, it will be used first before more is taken from your ProverSet.
87+
If you have bonded TAIKO in the TaikoInbox contract, it will be used first before more is taken from your allowance.
9688

9789
For an explanation on bonds, please refer to the terminology section [here](/resources/terminology).
9890

@@ -118,7 +110,7 @@ You will need TTKOh deposited on the TaikoInbox contract to secure the bond for
118110

119111
You will need at least 125 TTKOh for the `livenessBond`. After entering 125, you need to set the 18 decimals that the TAIKO contract takes, you can click the plus button and then select 10^18.
120112

121-
If you have bonded TTKOh in the TaikoInbox contract, it will be used first before more is taken from your ProverSet.
113+
If you have bonded TTKOh in the TaikoInbox contract, it will be used first before more is taken from your allowance.
122114

123115
For an explanation of the difference between these bonds, please refer to the terminology section [here](/resources/terminology).
124116

packages/docs-site/src/content/docs/guides/node-operators/run-a-node-for-taiko-alethia.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,12 @@ If you aren't, you can configure the ports and addresses so that the services ca
126126

127127
This command assumes you've run the `taiko-geth` command as is, if you've changed ports please change them accordingly.
128128

129+
<Aside type="tip">
130+
If you wish to enable a node without joining the preconfirmations p2p network, simply **remove all `p2p` and `preconfirmation` flags with the exception of `--p2p.sync` and `--p2p.checkPointSyncUrl`.**
131+
132+
Please note that your node's chainhead will not be up-to-date with the preconfed blocks if you do not join the p2p network.
133+
</Aside>
134+
129135
```bash
130136
./bin/taiko-client driver \
131137
--l1.ws ${L1_WS} \

packages/docs-site/src/content/docs/guides/node-operators/run-a-node-for-taiko-hekla.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,12 @@ If you aren't, you can configure the ports and addresses so that the services ca
126126

127127
This command assumes you've run the `taiko-geth` command as is, if you've changed ports please change them accordingly.
128128

129+
<Aside type="tip">
130+
If you wish to enable a node without joining the preconfirmations p2p network, simply **remove all `p2p` and `preconfirmation` flags with the exception of `--p2p.sync` and `--p2p.checkPointSyncUrl`.**
131+
132+
Please note that your node's chainhead will not be up-to-date with the preconfed blocks if you do not join the p2p network.
133+
</Aside>
134+
129135
```bash
130136
./bin/taiko-client driver \
131137
--l1.ws ${L1_ENDPOINT_WS} \

0 commit comments

Comments
 (0)