update documentation

risc0 · Jan 27, 2025 · f402ec3 · f402ec3
1 parent 6390096
commit f402ec3
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 20 deletions.
diff --git a/book/src/design.md b/book/src/design.md
@@ -14,7 +14,7 @@ proposal.
 
 ```admonish note
 While Kailua can be configured to operate using a single published commitment per proposal, this may make the proving
-work required to resolve disputes impractical for chains with very low block times, or a significantly large number
+work required to resolve disputes expensive for chains with very low block times, or a significantly large number
 of blocks per proposal in general.
 ```
 

diff --git a/book/src/parameters.md b/book/src/parameters.md
@@ -77,6 +77,11 @@ This would cover the worst-case proving cost in case of dispute, and, discountin
 The current implementation of Kailua does not yet have adaptive dispute periods based on congestion.
 Consequently, you should keep your existing challenge timeout period.
 
+```admonish note
+If you wish to practically operate Kailua using only validity proofs, set this value to `31536000000000000` seconds
+(i.e. 1 billion calendar years).
+```
+
 ## Verifier Contract
 RISC Zero maintains a set of pre-deployed verifier contracts for its ZK proving system.
 These contracts are regularly upgraded to support new releases of the prover, and also have a permissionless fail-safe

diff --git a/book/src/quickstart.md b/book/src/quickstart.md
@@ -33,7 +33,8 @@ You can deploy a local optimism devnet equipped with Kailua through the followin
 6. `just devnet-validate`
     * Launches the Kailua validator.
     * This monitors `KailuaGame` instances for disputes and creates proofs to resolve them.
-    * Note: Use `RISC0_DEV_MODE=1` to use fake proofs.
+    * (VALIDITY PROVING) Use `just devnet-validate [block-height]` to generate validity proofs to fast-forward finality until the specified L2 block height.
+    * (DEVELOPMENT MODE): Use `RISC0_DEV_MODE=1` to use fake proofs.
 7. `just devnet-fault`
     * Deploys a single `KailuaGame` instance with a faulty sequencing proposal.
     * Tests the validator's fault proving functionality.

diff --git a/book/src/validator.md b/book/src/validator.md
@@ -46,7 +46,23 @@ from delaying the finality of honest sequencing proposals.
 ```
 
 ```admonish success
-Running `kailua-cli validate` should monitor your rollup for disputes and generate the required proofs!
+Running `kailua-cli validate` should monitor your rollup for any disputes and generate the required proofs!
+```
+
+## Validity Proof Generation
+Instead of only generating fault proofs, the validator can be instructed to generate a validity proof for every correct
+canonical proposal it encounters to fast-forward finality until a specified block height.
+This is configured using the below parameter:
+*  `fast-forward-target`: The L2 block height until which validity proofs should be computed.
+
+```admonish note
+To indefinitely power a validity-proof only rollup, this value can be specified to the maximum 64-bit value of
+`18446744073709551615`.
+```
+
+```admonish success
+Running `kailua-cli validate` with the above parameter should generate a validity proof as soon as a correct proposal
+is made by an honest proposer!
 ```
 
 ## Delegated Proof Generation
@@ -81,26 +97,26 @@ These parameters can be passed in as CLI arguments or set as environment variabl
 
 #### Proof Requests
 The following first set of parameters determine where/how requests are made:
-* `boundless_rpc_url`: The rpc endpoint of the L1 chain where the Boundless network is deployed.
-* `boundless_wallet_key`: The wallet private key to use to send proof request transactions.
-* `boundless_offchain`: (Optional) Flag instructing whether to submit proofs off-chain.
-* `boundless_order_stream_url`: (Optional) The URL to use for off-chain order submission.
-* `boundless_set_verifier_address`: The address of the RISC Zero verifier supporting aggregated proofs for order validation.
-* `boundless_market_address`: The address of the Boundless market contract.
-* `boundless_lookback`: (Defaults to `5`) The number of previous proof requests to inspect for duplicates before making a new proof request.
+* `boundless-rpc-url`: The rpc endpoint of the L1 chain where the Boundless network is deployed.
+* `boundless-wallet-key`: The wallet private key to use to send proof request transactions.
+* `boundless-offchain`: (Optional) Flag instructing whether to submit proofs off-chain.
+* `boundless-order-stream-url`: (Optional) The URL to use for off-chain order submission.
+* `boundless-set-verifier-address`: The address of the RISC Zero verifier supporting aggregated proofs for order validation.
+* `boundless-market-address`: The address of the Boundless market contract.
+* `boundless-lookback`: (Defaults to `5`) The number of previous proof requests to inspect for duplicates before making a new proof request.
 
 #### Storage Provider
 The below second set of parameters determine where the proven executable and its input are stored:
-* `storage_provider`: One of `s3`, `pinata`, or `file`.
-* `s3_access_key`: The `s3` access key.
-* `s3_secret_key`: The `s3` secret key.
-* `s3_bucket`: The `s3` bucket.
-* `s3_url`: The `s3` url.
-* `aws_region`: The `s3` region.
-* `pinata_jwt`: The private `pinata` jwt.
-* `pinata_api_url`: The `pinata` api URL.
-* `ipfs_gateway_url`: The `pinata` gateway URL.
-* `file_path`: The file storage provider path.
+* `storage-provider`: One of `s3`, `pinata`, or `file`.
+* `s3-access-key`: The `s3` access key.
+* `s3-secret-key`: The `s3` secret key.
+* `s3-bucket`: The `s3` bucket.
+* `s3-url`: The `s3` url.
+* `aws-region`: The `s3` region.
+* `pinata-jwt`: The private `pinata` jwt.
+* `pinata-api-url`: The `pinata` api URL.
+* `ipfs-gateway-url`: The `pinata` gateway URL.
+* `file-path`: The file storage provider path.
 
 ```admonish success
 Running `kailua-cli validate` with the above extra arguments should now delegate all validator proving to the [Boundless proving network](https://docs.beboundless.xyz/)!