Skip to content

Commit 7d68161

Browse files
NiKrauseclaude
andauthored
docs: point at the relay replication matrix as the real verification (#41)
This repo's suite runs two OrbitDB peers in-process, which is useful but self-referential: one working tree, one process, identities minted by the same code that verifies them. orbitdb-relay's mode matrix is the harder test, and it is the one that actually cleared 0.5.0 before the consumers moved. It runs out of process against the published package, pairs two distinct peers with separate keystores and identity documents, and puts a third independent verifier — the relay itself — in the path. Six pairings across worker-Ed25519, hardware-Ed25519 and hardware-P-256. Worth saying in the README because the instinct on a signing change is to run the local tests and ship. Those pass either way; the matrix is what would not have. Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
1 parent 3976a46 commit 7d68161

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,27 @@ Mermaid sequences for scripts:
290290
- `SECURITY.md`
291291
- `CODE_OF_CONDUCT.md`
292292

293+
## Cross-Project Verification
294+
295+
This repo's own suite covers the units and runs two OrbitDB peers in-process. The strongest evidence that a release actually works, though, comes from outside it: the replication mode matrix in [`orbitdb-relay`](https://github.com/NiKrause/orbitdb-relay), at `mocha/relay-replication-mode-matrix.mjs`.
296+
297+
It drives six alice/bob pairings through a real relay:
298+
299+
| Mode | Pairing |
300+
| --------------------------------------------- | ------------------------------------------ |
301+
| `alice-worker-bob-hardware-ed25519` | worker keystore ↔ hardware Ed25519 |
302+
| `alice-worker-bob-hardware-p256` | worker keystore ↔ hardware P-256 |
303+
| `alice-hardware-ed25519-bob-hardware-p256` | the two hardware curves against each other |
304+
| `alice-worker-ed25519-bob-worker-ed25519` | worker keystore, both sides |
305+
| `alice-hardware-ed25519-bob-hardware-ed25519` | hardware Ed25519, both sides |
306+
| `alice-hardware-p256-bob-hardware-p256` | hardware P-256, both sides |
307+
308+
Three things make it worth more than an in-repo test. It runs **out of process and across repos**, against the published package rather than the working tree. It exercises **identity verification between two distinct peers** — different keystores, different identity documents — instead of one instance talking to itself. And the relay **verifies identities itself**, so a third independent verifier sits in the path.
309+
310+
That is exactly the surface a change to the signing format breaks. The 0.5.0 signing-context change was validated here before the consumers moved: all six pairings replicate under the new format.
311+
312+
If you change anything that touches signing, identity documents or verification, run that matrix — not just this repo's tests.
313+
293314
## Identity Recovery Summary
294315

295316
Current identity recovery behavior in this repo:

0 commit comments

Comments
 (0)