Skip to content

docs: scope the no-Go claim to exclude the optional fixtures step #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mellowcroc merged 1 commit into from
Aug 20, 2026
Merged

docs: scope the no-Go claim to exclude the optional fixtures step #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

This is the normal installation path for coordinators, participants, witnesses,
mirrors, auditors, and release operators. It installs a coordinated Relay and
`mpc-ceremony` kit; it does not require Go or either source repository.
`mpc-ceremony` kit; it does not require Go or either source repository. The one
exception is the rehearsal's optional evidence-upload transport test (steps
33-42), whose fixture generator is built from proof-tool source on Machine 1
and therefore needs a Go toolchain and a proof-tool checkout at the approved
tag; every required rehearsal step runs from the kit alone.

Release maintainers and independent build auditors use
[RELEASE.md](RELEASE.md) instead.
Expand Down
7 changes: 7 additions & 0 deletions scripts/three-machine-rehearsal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,13 @@ This section uses proof-tool's centralized same-host rehearsal helper. It tests
Relay's enrollment authentication and scoped uploads, but it does not convert
the three-machine run into independent witness or mirror evidence.

Unlike every step above, this section is not kit-only: step 33 builds the
fixture helper from proof-tool source on Machine 1, so it additionally needs a
Go toolchain (`go` on `PATH`, or `GO_BIN`) and `PROOF_TOOL_ROOT` in Machine 1's
`.env` pointing at a proof-tool checkout at the approved `MPC_TAG` commit. The
rehearsal is complete without this section; skip steps 33-42 on machines that
install only the kit.

### 33. Machine 1: generate and verify operational fixtures

```bash
Expand Down
5 changes: 4 additions & 1 deletion scripts/three-machine-rehearsal/machine-1/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,8 @@ R2_CONTROL_WRANGLER_BIN=
# Required only for R2:
# STORAGE_ENDPOINT=https://ACCOUNT_ID.r2.cloudflarestorage.com

# Exact proof-tool test checkout, used only for same-host operational fixtures.
# Exact proof-tool source checkout, used only by the optional operational
# fixtures (step 33). Check it out at the approved MPC_TAG commit; the step
# builds a helper from it with a locally installed Go toolchain, so kit-only
# machines that skip steps 33-42 can leave this placeholder in place.
PROOF_TOOL_ROOT=/absolute/path/to/proof-tool