Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
MdTeach committed Feb 3, 2025
1 parent 5863da8 commit 6bbf6e9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion bin/datatool/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ default = []
risc0-builder = ["strata-risc0-guest-builder", "bytemuck"]
sp1-builder = ["strata-sp1-guest-builder/sp1-dev"]
sp1-mock-builder = ["sp1-builder", "strata-sp1-guest-builder/mock"]
sp1-docker-docker = ["sp1-builder", "strata-sp1-guest-builder/docker-build"]
sp1-docker-builder = ["sp1-builder", "strata-sp1-guest-builder/docker-build"]
6 changes: 3 additions & 3 deletions bin/datatool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,16 @@ Before proceeding, make sure that you have SP1 correctly set up by following the

To ensure that the RollupParams contain the correct verifying key, build the binary in release mode and confirm that SP1 is set up correctly by following its installation instructions.

For production usage—since SP1 verification key generation is platform and workspace dependent—build the data tool in release mode with the sp1-docker feature:
For production usage—since SP1 verification key generation is platform and workspace dependent—build the data tool in release mode with the sp1-docker-builder feature:

```bash
cargo build --bin strata-datatool -F "sp1-docker" --release
cargo build --bin strata-datatool -F "sp1-docker-builder" --release
```

Because building the guest code in Docker can be time-consuming, you can generate the verification key locally for testing or development using:

```bash
cargo build --bin strata-datatool -F "sp1" --release
cargo build --bin strata-datatool -F "sp1-builder" --release
```

Additionally, the generated ELF can be exported after building the datatool as specified above:
Expand Down

0 comments on commit 6bbf6e9

Please sign in to comment.