Developers
Read the record. Verify a wave. Build on it.
The fastest path to read the open record, verify a wave, and build on the open contracts and protocol references.
Veraq is an open record with published rails. Every wave runs on a mechanism committed before it begins and provable after, and every participation, outcome and contribution is written to a record anyone can read. You do not have to take an endpoint’s word for an outcome. You can fetch the entry, walk its links, and check the mechanism that produced it.
This page is the short path for engineers: read the record, verify a wave, then build on the same contracts and protocol references Veraq uses. Everything referenced here is published at github.com/mirinsim. Nothing important is held in private state.
Quickstart
- 01
Read a wave
Fetch a wave by id from the open record. The response carries its Mechanism, its Participations, and the Outcome, each as a linked entry you can resolve on its own.
- 02
Resolve its links
Follow the wave to the Mechanism commitment published before it ran, and to the Contribution that routes the defined share to a Cause after it settled.
- 03
Verify the mechanism
Recompute the commit-reveal-v1 result from the published commitment and the revealed inputs. A matching digest is your proof the recorded outcome is the one the committed mechanism produced.
- 04
Build on it
Install @veraq/contracts and @veraq/protocol to read, verify, and integrate against the same entities and rules described below.
The open-record data model
- Wave
- One round of participation. Names the mechanism it ran on and the participations it collected, and links to a single outcome.
- Mechanism
- The published selection process for a wave (commit-reveal-v1). Committed before the wave begins, revealed after it ends.
- Participant
- A person taking part on legible terms. Referenced by participations; identifying data is kept off the open record.
- Participation
- A single act of taking part in a wave, linked to its participant and its wave.
- Outcome
- What a wave produced, derived from the revealed mechanism. Linked to its wave and verifiable against the commitment.
- Contribution
- The defined share of an outcome, allocated automatically and recorded from outcome to cause.
- Cause
- A verified, participant-chosen destination for a contribution, named openly on the record.
commit-reveal-v1
- 01
Commit
Before a wave opens, the mechanism’s inputs are sealed and a commitment digest is written to the open record. The digest binds the result without disclosing it, so no party can alter the mechanism once participation is under way.
- 02
Participate
Participations are collected and recorded against the open wave. The committed digest is already public and fixed at this point.
- 03
Reveal
After the wave closes, the sealed inputs are revealed and written to the record. Anyone can hash the revealed inputs and confirm they match the earlier commitment.
- 04
Recompute
With the revealed inputs and the recorded participations, recompute the outcome deterministically. A matching result proves the recorded outcome followed the mechanism committed in step one — no privileged path, no hidden state.
SDKs, contracts, and protocol
Clients
Typed clients read the open record and resolve entity links for you, so a wave, its mechanism, and its contribution come back as connected objects rather than raw rows.
@veraq/contracts
The published contracts behind the record. Read them to confirm what is written on commit, on reveal, and on contribution — not to trust a description of it.
@veraq/protocol
The protocol references for commit-reveal-v1: the commitment format, the reveal format, and the recompute rule. Enough to verify a wave without any Veraq code in the path.
Stable entities
The seven entities — Wave, Mechanism, Participant, Participation, Outcome, Contribution, Cause — are documented and versioned. Build against them with the same surface Veraq builds on.
Verification recipes
Prove an outcome
Resolve a wave to its mechanism, recompute commit-reveal-v1 from the reveal, and check the result against the recorded outcome.
Confirm a commitment held
Hash the revealed inputs and compare against the commitment digest written before the wave opened. Equality means the mechanism was fixed before participation.
Follow the defined share
Walk an outcome to its contribution and on to the verified cause it names, confirming the recorded share matches the published rule.
Audit a range of waves
Page through recent waves and run the same checks in a loop to verify a window of activity, not a single hand-picked entry.
Status (illustrative; the record is authoritative)
- 7
- core entities
- v1
- mechanism version (commit-reveal-v1)
- 2
- published packages: contracts and protocol
- 100%
- of outcomes verifiable from the record
commit-reveal-v1 and the seven entities are versioned and dated; older shapes stay readable, so what you build against today stays checkable tomorrow. Don’t trust the box — open it.