BITCODE_SPEC.txt is the canonical pointer for active-system work. It currently
resolves to V28; V29 is the active draft target for deeper Terminal
transaction workflows and operator recovery.
Bitcode is the protocol and the commercial source tree implements it in-place. The primary operator routes are:
/terminalfor depositing, reading, transaction work, and protocol follow-through./auxillariesfor Wallet, Externals, Profile, and Interfaces support surfaces.
Exchange and website Conversations remain in source as deferred commercial work. V29 closure focuses on Terminal transaction depth over the promoted V28 Reading, Finding Fits, AssetPack preview, BTC settlement, rights transfer, and delivery canon.
The protocol demonstration remains the minimal deterministic reference for the same protocol. Commercial code may mount or compare against demonstration runtime facts, but commercial source should name the owning product surface directly: Terminal, Exchange, Auxillaries, Conversations, API, MCP, or ChatGPT App.
- Ground new work in
BITCODE_SPEC.txtand the active specification family. - Treat
_legacy/as non-canonical. - Do not add explicit versioned source routes or compatibility source names.
- Update source in-place to match the active canon and current draft target.
- Keep specification notes, QA ledgers, tests, and implementation synchronized.
The default branch is protected by the active Bitcode Core Contributions
ruleset. Direct pushes to main are not part of the normal workflow; expect
them to be rejected because changes must arrive through pull requests and
verified signatures.
Use a version branch and gate-numbered branches:
- Create one base branch per draft target, such as
version/v29. - Create scoped gate branches from the version branch. Prefix every gate branch
with the gate number, for example
v29/gate-1-objectives-and-gatingorv29/gate-6-settlement-reconciliation-repair. - Group related work into clear commits with quality commit messages whose titles and bodies describe the proof, implementation, or documentation change.
- Continue on the gate branch until that gate's acceptance criteria are implemented, specified, tested, documented, committed, pushed, and ready for closure review.
- Open pull requests from gate branches into the version branch as gates close.
Title gate PRs with the uppercase version and gate prefix plus a topical
title, for example
V29 Gate 5: AssetPack Disclosure Rights And Preview Depth. - Open the version branch back into
mainonly after all gates close and the version is formally promoted as canon.
Gate pull requests into version/** run the Bitcode gate-quality workflow:
active/draft canon checks, casing/import checks, relevant package typechecks and
Jest suites, protocol-demonstration QA, and diff hygiene. The repository-wide
canon quality workflow stays green during draft work by checking active/draft
posture and promoted-spec proof posture, while full promoted-suite closure is
reserved for the version promotion workflow. Version pull requests into main
run the version promotion workflow. For V29, promotion work must validate the
Terminal-depth proof posture, generate BITCODE_SPEC_V29_PROVEN.md, and commit
promotion artifacts plus the BITCODE_SPEC.txt pointer change from V28 to
V29 on the version branch.
Gate 10 is the local/staging promotion-readiness gate; run
pnpm run check:v29-gate10 before opening the final gate PR. The V29 promotion
workflow is v29-canon-promotion.yml.
The application CI workflow uses the root pnpm workspace install, runs uapi
lint/typecheck/build plus mocked Jest coverage, and keeps heavier legacy scans
explicitly opt-in until their catalogs are refurbished: set
ENABLE_FULL_DB_E2E, ENABLE_STORYBOOK_BUILD, ENABLE_SUPER_LINTER, or
ENABLE_ADVANCED_CODEQL when those checks are intentionally part of a branch
or promotion validation.
- BITCODE_SPEC.txt is the canonical version pointer.
- BITCODE_SPEC_V28.md is the active promoted spec family.
- BITCODE_SPEC_V29.md is the active draft target.
- BITCODE_SPEC_V29_PARITY_MATRIX.md tracks V29 gate parity.
- uapi/README.md documents the commercial website/API surface.
- uapi/app/terminal/README.md documents Terminal.
- uapi/app/exchange/README.md documents Exchange.
- uapi/app/auxillaries/README.md documents Auxillaries.
- protocol-demonstration/README.md documents the deterministic demonstration.
uapi/: commercial website, API routes, Terminal, Exchange, Auxillaries, Conversations, public docs, and shared UI systems.protocol-demonstration/: deterministic Bitcode demonstration, proof generator inputs, and standalone validation runtime.packages/*: protocol, storage, inference, conversation, BTD, API, MCP, ChatGPT App, and integration package owners..bitcode/: generated proof, checkpoint, and spec-family artifacts.
Mock-mode commercial review:
cd uapi
NEXT_PUBLIC_MASTER_MOCK_MODE=true \
NEXT_PUBLIC_ENABLE_MOCKS=true \
NEXT_PUBLIC_MOCK_USER_ORBITAL=true \
NEXT_PUBLIC_MOCK_USER_ORBITAL_SCENARIO=demo \
NEXT_PUBLIC_MOCK_SCENARIO=demo \
NEXT_PUBLIC_MOCK_GITHUB_ACCOUNTS=true \
NEXT_PUBLIC_MOCK_GITHUB_REPOS=true \
HOST=127.0.0.1 PORT=3000 pnpm dev:remoteCommercial verification:
cd uapi
pnpm exec tsc --noEmit --pretty false
pnpm run test:e2e:commercial-mvpDemonstration verification:
cd protocol-demonstration
pnpm test:integration
pnpm test:v28-mvp-qa