Skip to content

Commit bf274d2

Browse files
authored
chore(docs): update docs for pacaya fork (#513)
1 parent 6250eac commit bf274d2

File tree

2 files changed

+33
-7
lines changed

2 files changed

+33
-7
lines changed

docs/README_Docker_and_RA.md

+33-7
Original file line numberDiff line numberDiff line change
@@ -296,12 +296,14 @@ docker compose build raiko
296296
297297
If you do not wish to build the image locally, you can optionally pull them from our registry.
298298

299+
If you are using a SGX2 machine, please use `1.6.0-rc1-edmm`. If you are using a SGX1 machine, please use `1.6.0-rc1-non-edmm`.
300+
299301
```
300-
docker pull us-docker.pkg.dev/evmchain/images/raiko:1.4.0
302+
docker pull us-docker.pkg.dev/evmchain/images/raiko:{TAG}
301303
docker pull us-docker.pkg.dev/evmchain/images/pccs:latest
302304
```
303305

304-
If you do this step, you need to change your raiko docker-compose.yml to use this image. Navigate to `raiko/docker` and search for `raiko:latest` and change all instances to `raiko:1.4.0`.
306+
If you do this step, you need to change your raiko docker-compose.yml to use this image. Navigate to `raiko/docker` and search for `raiko:latest` and change all instances to `raiko:{TAG}`.
305307

306308
You can continue on with the following steps as usual after this.
307309

@@ -347,7 +349,6 @@ You've now prepared your machine for running Raiko through Docker. Now, you need
347349
cd ~
348350
git clone https://github.com/taikoxyz/taiko-mono.git
349351
cd taiko-mono
350-
git checkout tags/{release-tag}
351352
cd packages/protocol
352353
```
353354

@@ -367,21 +368,28 @@ pnpm install
367368
pnpm compile
368369
```
369370

370-
3. Ensure the values in the `script/layer1/config_dcap_sgx_verifier.sh` script match whichever network you are registering for.
371+
3. Ensure the values in the `script/layer1/provers/config_dcap_sgx_verifier.sh` script match whichever network you are registering for.
372+
373+
> **_NOTE:_** You will have to do this step twice for Hekla: once for the Ontake addresses and once for the Pacaya addresses. Please keep both SGX_INSTANCE_IDs.
371374
372-
Hekla Addresses:
375+
Hekla Ontake Addresses:
373376
`SGX_VERIFIER_ADDRESS`=0x532EFBf6D62720D0B2a2Bb9d11066E8588cAE6D9
374377
`ATTESTATION_ADDRESS`=0xC6cD3878Fc56F2b2BaB0769C580fc230A95e1398
375378
`PEM_CERTCHAIN_ADDRESS`=0x08d7865e7F534d743Aba5874A9AD04bcB223a92E
376379

380+
Hekla Pacaya Addresses:
381+
`SGX_VERIFIER_ADDRESS`=0xa8cD459E3588D6edE42177193284d40332c3bcd4
382+
`ATTESTATION_ADDRESS`=0xC6cD3878Fc56F2b2BaB0769C580fc230A95e1398
383+
`PEM_CERTCHAIN_ADDRESS`=0x08d7865e7F534d743Aba5874A9AD04bcB223a92E
384+
377385
Mainnet Addresses:
378386
`SGX_VERIFIER_ADDRESS`=0xb0f3186FC1963f774f52ff455DC86aEdD0b31F81
379387
`ATTESTATION_ADDRESS`=0x8d7C954960a36a7596d7eA4945dDf891967ca8A3
380388
`PEM_CERTCHAIN_ADDRESS`=0x02772b7B3a5Bea0141C993Dbb8D0733C19F46169
381389

382390
These values are already in the script, it defaults to Hekla; please comment those lines out and uncomment the Mainnet ones if performing RA on Mainnet.
383391

384-
4. In the `script/layer1/config_dcap_sgx_verifier.sh` script, replace `--fork-url https://any-holesky-rpc-url/` with the RPC URL of the hekla/mainnet network. Alternatively, export it like so: `export FORK_URL="https://any-holesky-rpc-url/"`.
392+
4. In the `script/layer1/provers/config_dcap_sgx_verifier.sh` script, replace `--fork-url https://any-holesky-rpc-url/` with the RPC URL of the hekla/mainnet network. Alternatively, export it like so: `export FORK_URL="https://any-holesky-rpc-url/"`.
385393

386394
5. If you've followed the Raiko Docker guide, you will have bootstrapped raiko and obtained a quote:
387395

@@ -397,6 +405,8 @@ Copy your quote and use in the following step.
397405

398406
6. Call the script with `PRIVATE_KEY=0x{YOUR_PRIVATE_KEY} ./script/layer1/config_dcap_sgx_verifier.sh --quote {YOUR_QUOTE_HERE}`. "YOUR_QUOTE_HERE" comes from above step 5.
399407

408+
> **_NOTE:_** You can use the same command for registering both verifiers, just comment out the Ontake addresses and uncomment the Pacaya ones in the script and re-run.
409+
400410
7. If you've been successful, you will get a SGX instance `id` which can be used to run Raiko!
401411

402412
It should look like this:
@@ -414,7 +424,8 @@ Once you've completed the above steps, you can actually run a prover.
414424

415425
Raiko now supports more configurations, which need to be carefully checked to avoid errors.
416426

417-
- SGX_INSTANCE_ID: Your `SGX_INSTANCE_ID` is the one emitted in the `InstanceAdded` event above. (Deprecated)
427+
> **_NOTE:_** We have deprecated `SGX_INSTANCE_ID`, if you only register with the Ontake addresses please export to `SGX_ONTAKE_INSTANCE_ID`.
428+
418429
- SGX_ONTAKE_INSTANCE_ID: SGX registered ID for ontake fork. (if raiko start before/in ontake, set this one)
419430
- SGX_PACAYA_INSTANCE_ID: SGX registered ID for pacaya fork. (if raiko start before/in pacaya, set this one)
420431
- ETHEREUM_RPC: ethereum node url, from which you query the ethereum data.
@@ -466,6 +477,21 @@ Opt {
466477
cache_path: None,
467478
log_level: "info",
468479
}
480+
481+
...
482+
483+
+ jq --arg update_value {SGX_ONTAKE_INSTANCE_ID} '.sgx.instance_ids.ONTAKE = ($update_value | tonumber)' /etc/raiko/config.sgx.json
484+
raiko | + mv /tmp/config_tmp.json /etc/raiko/config.sgx.json
485+
raiko | + echo 'Update ontake sgx instance id to {SGX_ONTAKE_INSTANCE_ID}'
486+
raiko | Update ontake sgx instance id to {SGX_ONTAKE_INSTANCE_ID}
487+
raiko | + [[ -n 1 ]]
488+
raiko | + jq --arg update_value {SGX_PACAYA_INSTANCE_ID} '.sgx.instance_ids.PACAYA = ($update_value | tonumber)' /etc/raiko/config.sgx.json
489+
raiko | + mv /tmp/config_tmp.json /etc/raiko/config.sgx.json
490+
raiko | + echo 'Update pacaya sgx instance id to {SGX_PACAYA_INSTANCE_ID}'
491+
raiko | Update pacaya sgx instance id to {SGX_PACAYA_INSTANCE_ID}
492+
493+
...
494+
469495
2024-04-18T12:50:09.400319Z INFO raiko_host::server: Listening on http://0.0.0.0:8080
470496
```
471497

script/prove-aggregation-blocks.sh

100644100755
File mode changed.

0 commit comments

Comments
 (0)