docs: scrub private-doc references from source comments (pre-publish)

Source comments pointed at gitignored docs/private/*.md design docs — harmless
(no secret) but dangling references in a public tree. Inlined the rationale and
dropped the pointers. Comment-only.
This commit is contained in:
jwinterm
2026-06-28 08:33:24 -04:00
parent 8120d93fb8
commit efb54911de
3 changed files with 4 additions and 6 deletions
+1 -2
View File
@@ -6,8 +6,7 @@
//! wallet's outputs and read amounts, but cannot spend) and sends it per scan; //! wallet's outputs and read amounts, but cannot spend) and sends it per scan;
//! the backend forwards it to grin-wallet's `scan_rewind_hash` and stores no //! the backend forwards it to grin-wallet's `scan_rewind_hash` and stores no
//! secret. Spending (input selection, kernel signing) happens in the wallet; the //! secret. Spending (input selection, kernel signing) happens in the wallet; the
//! backend only broadcasts the finalized transaction. See //! backend only broadcasts the finalized transaction.
//! `docs/private/GRIN_LWS_DESIGN.md`.
//! //!
//! Conventions (matching [`super::btc_ltc`] / [`super::xmr_wow`]): //! Conventions (matching [`super::btc_ltc`] / [`super::xmr_wow`]):
//! * JWT-gated; the `rewind_hash` is a view credential — its request struct omits //! * JWT-gated; the `rewind_hash` is a view credential — its request struct omits
+2 -3
View File
@@ -11,9 +11,8 @@
//! //!
//! Non-custodial by construction: the relay stores only opaque slatepack text //! Non-custodial by construction: the relay stores only opaque slatepack text
//! (slatepacks are encrypted to the recipient's address) and lifecycle status. It //! (slatepacks are encrypted to the recipient's address) and lifecycle status. It
//! never holds keys, never finalizes, never broadcasts — unlike the legacy //! never holds keys, never finalizes, never broadcasts. The wallet finalizes and
//! backend, which finalized + broadcast server-side. See //! broadcasts locally; the relay is only a store-and-forward mailbox.
//! `docs/private/OWN_BACKEND_CONVERGENCE.md`.
//! //!
//! Controls: JWT-gated; every action authorizes the caller as the slate's sender //! Controls: JWT-gated; every action authorizes the caller as the slate's sender
//! or recipient (a non-party gets 404, never an existence oracle); the recipient //! or recipient (a non-party gets 404, never an existence oracle); the recipient
+1 -1
View File
@@ -7,7 +7,7 @@
//! `scan_rewind_hash(rewind_hash, start_height)` does the chain scan (rangeproof //! `scan_rewind_hash(rewind_hash, start_height)` does the chain scan (rangeproof
//! rewind) and returns a [`ViewWallet`]; this client drives that, plus node //! rewind) and returns a [`ViewWallet`]; this client drives that, plus node
//! status and broadcast. Spending (input selection, kernel signing) happens in //! status and broadcast. Spending (input selection, kernel signing) happens in
//! the wallet, locally — never here. See `docs/private/GRIN_LWS_DESIGN.md`. //! the wallet, locally — never here.
//! //!
//! The Owner API v3 transport is an ECDH (secp256k1) handshake + AES-256-GCM //! The Owner API v3 transport is an ECDH (secp256k1) handshake + AES-256-GCM
//! channel; the secure session is initialized once (TOCTOU-free), the nonce //! channel; the secure session is initialized once (TOCTOU-free), the nonce