You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: validate and correct documentation vs codebase
- Fixed GASP acronym hallucination and Network domain summary
- Synced README.md + docs/packages/index.md (avoided exact counts per feedback)
- Updated BRC-100 spec with ReviewActionResult notes and cross-refs to match Wallet.interfaces.ts
- Updated dates, added HUMAN_QUESTION.md with review items
Why: Ensure all statements/examples accurate to rebuild developer trust; err on side of removing unverified claims
# Questions for Human Review on ts-stack Documentation
2
+
3
+
## Package Organization and Counts
4
+
- The top-level README.md claims 35 packages + conformance across 7 domains, with a detailed map. docs/packages/index.md claims 27 production-ready. Which count and structure should be canonical? Should we consolidate into one source of truth?
5
+
Consolidate into one source of truth. 27 seems right, because we condensed overlay topics into one package.
6
+
7
+
- Some packages like wallet-toolbox-examples, wallet-infra, btms-backend are marked private or legacy. Should they be excluded from main "production-ready" lists?
8
+
No, just avoid using exact numbers because they're bound to change over time.
9
+
10
+
- Templates and did-client moved from sdk/ to helpers/. Should README.md be updated to reflect current locations?
11
+
Yes please.
12
+
13
+
## GASP Acronym
14
+
- Confirmed from code: "Graph Aware Sync Protocol". The "Generic Append-only Structured Proofs" in docs/packages/index.md is a hallucination. I've planned to fix it. Any preferred full description or link to spec?
15
+
Correct. The spec is somewhere in this repo under ./specs
16
+
17
+
## Network Domain
18
+
- The teranode-listener is for P2P event subscription (blocks, subtrees, etc.), not general broadcast or node queries (explicitly "When NOT to use"). Should the domain summary in docs/packages/index.md and docs/index.md be revised to "P2P Real-time Event Listener for Teranode" ?
19
+
Yes please.
20
+
21
+
## Documentation Site vs Embedded Docs
22
+
- There are docs/*.md, package-specific docs/ in packages/*/, CLAUDE.md, BASELINE.md, specs/*.md, and top-level README. What is the intended primary documentation for developers? Should we de-duplicate content or use one as source?
23
+
the tol level ./docs are the intended primary documentation for developers. The lower level ./docs go into detail for particular packages (they were written prior to this monorepo) and serve as good source material and should even be included within the main docs if developers want to dig deep into the details.
24
+
25
+
## Code Examples and Links
26
+
- Many links point to ./packages/helpers/wallet-helper.md but the file might be in docs/packages/helpers/wallet-helper.md. Are relative links correct for the docs site?
27
+
They seem to work fine as they are: https://bsv-blockchain.github.io/ts-stack/packages/helpers/wallet-helper/ is working.
28
+
29
+
- In teranode-listener.md, API reference and GitHub links point to old ts-p2p repo and ts-p2p TypeDoc. What should they point to now (ts-stack monorepo, new docs site)?
30
+
This repo, but we need to update the spec anyway so leave it broken for now.
31
+
32
+
## BRC-100 and Specs
33
+
- The specs/brc-100-wallet.md seems to document the interface. Is it generated or hand-written? Does it accurately match packages/sdk/src/wallet/Wallet.interfaces.ts and the JSON schema?
34
+
I want you to verify whether it does or not. It was generated by another model.
35
+
36
+
## Infrastructure and Conformance
37
+
- Infrastructure docs reference deployed endpoints. Are the names and statuses in docs/infrastructure/*.md still accurate? (e.g. store-us-1.bsvb.tech)
38
+
Yes that's a good reference URL.
39
+
40
+
- Conformance vectors coverage claims - do they match current META.json and vectors/ ?
41
+
We should check.
42
+
43
+
Please review and provide guidance on these. I will update docs to remove any unverified claims in the meantime.
Copy file name to clipboardExpand all lines: docs/packages/index.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,16 +3,16 @@ id: packages-index
3
3
title: Packages
4
4
kind: meta
5
5
version: "n/a"
6
-
last_updated: "2026-04-30"
7
-
last_verified: "2026-04-30"
6
+
last_updated: "2026-05-01"
7
+
last_verified: "2026-05-01"
8
8
review_cadence_days: 30
9
9
status: stable
10
10
tags: ["packages"]
11
11
---
12
12
13
13
# Packages
14
14
15
-
ts-stack contains 27 production-ready packages organized into 7 domains. Each domain serves a specific part of the stack — from core crypto to business logic.
15
+
ts-stack contains packages organized into 7 domains. Each domain serves a specific part of the stack — from core crypto to business logic. See the top-level README.md for the current package map.
16
16
17
17
## Seven Domains
18
18
@@ -29,13 +29,13 @@ ts-stack contains 27 production-ready packages organized into 7 domains. Each do
-[@bsv/wallet-relay](./wallet/wallet-relay.md) — Broadcast and query wrapper for wallet synchronization
32
+
-[@bsv/wallet-relay](./wallet/wallet-relay.md) — Mobile-to-desktop wallet pairing via QR codes + encrypted WebSocket relay
33
33
34
34
### Network
35
35
36
-
**Broadcast transactions and query BSV nodes through a typed client.**
36
+
**P2P Real-time Event Listener for Teranode**
37
37
38
-
-[@bsv/teranode-listener](./network/teranode-listener.md) — Connect to Teranode and listen for transactions
38
+
-[@bsv/teranode-listener](./network/teranode-listener.md) — Subscribe to Teranode P2P topics (blocks, subtrees, mining) with callbacks (see specs/sync for related)
39
39
40
40
### Overlays
41
41
@@ -45,7 +45,7 @@ ts-stack contains 27 production-ready packages organized into 7 domains. Each do
45
45
-[@bsv/overlay-express](./overlays/overlay-express.md) — HTTP server for the Overlay spec
-[BRC-100 in the BRC repository](https://github.com/bitcoin-sv/BRCs/blob/master/wallet/0100.md)
21
21
22
-
The TypeScript interface passes `originator?: OriginatorDomainNameStringUnder250Bytes` as an optional second method parameter. Wire formats may carry the originator inside the request envelope.
22
+
This MD is a human-readable summary. Implement against the TS interfaces and JSON schema. The TypeScript interface passes `originator?: OriginatorDomainNameStringUnder250Bytes` as an optional second method parameter (wire formats carry it in the request envelope). See `ReviewActionResult` for delayed-broadcast responses.
23
23
24
24
## Data Conventions
25
25
@@ -96,6 +96,7 @@ Returns:
96
96
|`noSendChange`|`OutpointString[]`| When `noSend` produces change for later chained actions. |
97
97
|`sendWithResults`|`SendWithResult[]`| When sending a batch created with `sendWith`. |
98
98
|`signableTransaction`|`{ tx: AtomicBEEF, reference: Base64String }`| When the action needs a follow-up `signAction`. |
99
+
| (ReviewActionResult fields) |`object`| When `acceptDelayedBroadcast: false`; see `ReviewActionResult` (status, competingTxs, etc.) in `Wallet.interfaces.ts`. |
0 commit comments