Vector Catalog

The conformance corpus is the shared test fixture set for TypeScript and other implementations. It is intentionally implementation-neutral: each JSON file defines inputs, expected outputs, metadata, and the specification area it exercises.

Current totals and runner outcomes are published on Generated Stack Facts. The detailed, machine-readable file-by-file view is conformance/PARITY_MATRIX.json; CI regenerates and compares it to the corpus.

Repository Layout

conformance/vectors/
  auth/brc31-handshake.json
  broadcast/{arc-submit,merkle-path-validation,merkle-service}.json
  messaging/{authsocket,brc31/authrite-signature,message-box-http}.json
  overlay/{lookup,submit,topic-management}.json
  payments/{brc121,brc29-payment-protocol}.json
  regressions/*.json (12 files)
  sdk/compat/bsm.json
  sdk/crypto/{aes,ecdsa,ecies,hash160,hmac,ripemd160,sha256,signature}.json
  sdk/keys/{key-derivation,private-key,public-key}.json
  sdk/scripts/evaluation.json (5,116 vectors)
  sdk/transactions/{merkle-path,serialization}.json
  storage/uhrp-http.json
  sync/{brc40-user-state,brc136-basm,gasp-protocol}.json
  wallet/brc100/*.json (27 files)
  wallet/brc29/payment-derivation.json
  wallet/storage/adapter-conformance.json

Vector Format

Vector files use one top-level object with metadata and a vectors array. A typical file looks like this:

{
  "metadata": {
    "name": "BRC-100 WalletInterface.getPublicKey",
    "domain": "wallet",
    "spec": "BRC-100",
    "version": "1.0.0"
  },
  "vectors": [
    {
      "id": "brc100-getpublickey-identity",
      "description": "Returns the wallet identity key",
      "input": { "args": { "identityKey": true } },
      "expected": { "publicKey": "..." },
      "tags": ["wallet", "brc100"]
    }
  ]
}

Always inspect the target JSON file before porting a vector to another language; some files include fixtures, deterministic keys, expected errors, or protocol-specific notes.

Coverage By Directory

Wallet BRC-100

Current BRC-100 conformance coverage is focused on deterministic crypto and key methods:

Use the BRC-100 wallet method reference for the full interface shape. Use this catalog to see which parts already have portable fixtures.

Coverage By BRC

Regression Fixtures

Regression files reproduce bugs found in TypeScript or other SDKs so new implementations can prove they do not repeat them.

Running Vectors

Run the complete corpus:

pnpm conformance

Validate JSON structure only:

pnpm conformance --validate-only

Run a directory subset:

pnpm conformance --vectors conformance/vectors/wallet/brc100

Write a JUnit report:

pnpm conformance --report conformance/runner/reports/results.xml

Porting To Another Implementation

1. Read conformance/META.json and conformance/PARITY_MATRIX.json to confirm corpus totals and file-level parity status.
2. Start with deterministic SDK vectors before stateful wallet vectors.
3. Treat wallet/brc100 as method-level fixtures, not as a complete wallet behavior test suite yet.
4. Preserve vector IDs and expected error semantics when adding a runner for another language.
5. For node-derived script fixtures, consume the normalized hex fields; original node ASM is retained for provenance.
6. Add new vectors to the corpus first when you find a behavioral ambiguity, then update each runner.