Skip to content

Commit 3d5ab8b

Browse files
author
sls_0x
committed
Align historical docs with canonical root
1 parent 9a148fc commit 3d5ab8b

7 files changed

Lines changed: 18 additions & 7 deletions

File tree

AUDIT_FINDINGS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11

22
# Dark Null Protocol v1 — Audit Execution Report
33

4+
Historical note: this report documents an older v18/v1 audit pass against files and flows that are not the same as the current canonical public root.
5+
46
**Date:** January 10, 2026
57
**Auditor:** AI Assistant (Cursor/Gemini)
68
**Target:** Dark Null Protocol v1 (Diamond Release)
@@ -121,4 +123,3 @@ Remove source directories from `.gitignore`. Only ignore build artifacts (`targe
121123
---
122124

123125
**Signed:** AI Auditor (Dark Null Protocol)
124-

CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
## [Unreleased]
1111

12+
Historical note: older entries below describe devnet milestones and historical release framing. They are not the same thing as the current public-root assurance level described in [`README.md`](./README.md), [`PROTOTYPE_STATUS.md`](./PROTOTYPE_STATUS.md), and [`SECURITY_MODEL.md`](./SECURITY_MODEL.md).
13+
1214
### Planned
1315
- Mainnet deployment (pending audit)
1416
- Multi-region relayer deployment
@@ -91,9 +93,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
9193

9294
## [1.0.0] - 2026-01-09
9395

94-
### 🎉 Initial Production Release (Devnet)
96+
### 🎉 Initial Public Devnet Milestone
9597

96-
**Dark Null Protocol V18 (Dark Null v1)**First production-ready release on Solana Devnet.
98+
**Dark Null Protocol V18 (Dark Null v1)**Historical devnet milestone later superseded by the current canonical public-root track.
9799

98100
### Added
99101

@@ -194,4 +196,3 @@ No automatic migration — this preserves privacy by not linking old/new deposit
194196
[1.22.0]: https://github.com/Parad0x-Labs/Dark-Null-Protocol/releases/tag/v1.22
195197
[1.0.0]: https://github.com/Parad0x-Labs/Dark-Null-Protocol/releases/tag/v1.0.0
196198
[0.17.0]: https://github.com/Parad0x-Labs/Dark-Null-Protocol/releases/tag/v0.17.0
197-

docs/SECURITY_CHECKLIST.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Dark Null v1.22 — Security Checklist (Public)
22

3+
> Historical note: this checklist tracks the older v1.22 commit/challenge/finalize design. It is not a statement that the current canonical public root already implements every item below.
4+
35
## Protocol Invariants
46

57
### State Guards

docs/VERIFICATION.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Dark Null Protocol v1 - Verification Specification
22

33
**Version:** 1.0 (Locked)
4-
**Status:** Canonical Source of Truth
4+
**Status:** Historical v1 verification spec, not the current canonical-root payout contract
5+
6+
> Historical note: this document describes the stronger v1/v18-v20 verification model and proof-pack shape. The current canonical public root in [`../src/lib.rs`](../src/lib.rs) only binds the published `null_proof` artifact set and fails closed before payout because withdrawal amount and recipient semantics are not yet bound by that canonical proof bundle.
57
68
This document defines the binary encoding, hashing, and validation rules for Proof Packs, ensuring interoperability between the Dark Null Client (SDK), Relayer, and On-chain Program.
79

@@ -82,6 +84,8 @@ The Relayer enforces the following **Hard Gates**:
8284

8385
## 4. On-Chain Verification
8486

87+
This section is historical protocol intent, not the current canonical-root payout behavior.
88+
8589
The on-chain program (`programs/paradox_v18/src/lib.rs`) enforces:
8690

8791
1. **Proof Verification:** `groth16_verify(proof, public_inputs) == true`.
@@ -95,4 +99,3 @@ The on-chain program (`programs/paradox_v18/src/lib.rs`) enforces:
9599
**Audit Status:**
96100
- Encoding Rules: **VERIFIED** (Codebase matches Spec)
97101
- VK Match: **VERIFIED** (Script `scripts/verify_vk_match.ts` passes)
98-

docs/architecture.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Dark Null Protocol — Technical Architecture
44

5+
> Historical note: this architecture page blends older protocol/infrastructure plans with recovered artifacts. For the current canonical public root, start with [`../README.md`](../README.md), [`../MANIFEST.json`](../MANIFEST.json), and [`../src/lib.rs`](../src/lib.rs).
6+
57
---
68

79
## High-Level Architecture
@@ -333,4 +335,3 @@ Example (0.1 SOL tier):
333335
- [API Reference](./api-reference.md) — SDK documentation
334336
- [Integration Guide](./integration-guide.md) — How to integrate
335337

336-

interfaces/accounts.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Dark Null v1.22 — Account Structures (Public Notes)
22

3+
> Historical note: `PendingCommit` and the finalize/challenge fields below describe the older v1.22 design track. The current canonical public root only uses the bounded `Vault` plus `RootAuthorityConfig`, and it fails closed before payout.
4+
35
## PendingCommit
46

57
Stores the state of a pending withdrawal claim during the challenge window.

scripts/check-public-repo.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ const disallowedPatterns = [
8383
{ label: "embedded rpc api key", regex: /helius-rpc\.com\/\?api-key=/i },
8484
{ label: "stale auditor recruitment copy", regex: /We're seeking auditors/ },
8585
{ label: "stale public release badge", regex: /Status-Public_Release/ },
86+
{ label: "stale production-ready devnet claim", regex: /production-ready release on solana devnet/i },
8687
];
8788

8889
async function assertRequiredFiles() {

0 commit comments

Comments
 (0)