Skip to content

Commit 1ca4609

Browse files
committed
fix little arrows
1 parent 3cb4824 commit 1ca4609

5 files changed

Lines changed: 63 additions & 58 deletions

File tree

docs/assets/diagrams/brc100-wallet-flows.svg

Lines changed: 8 additions & 8 deletions
Loading
Lines changed: 38 additions & 38 deletions
Loading

docs/packages/helpers/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Utility libraries and helper tools for common BSV operations. Includes high-leve
2020
|---------|---------|
2121
| [@bsv/simple](simple.md) | High-level wallet API for browser and server — manage payments, tokens, inscriptions, DIDs, and credentials |
2222
| [@bsv/wallet-helper](wallet-helper.md) | Fluent transaction builder for explicit wallet-backed transactions, BRC-29 derivation, and ordinal support |
23-
| [@bsv/templates](templates.md) | Low-level script templates (OpReturn, MultiPushDrop, P2MSKH) with lock/unlock patterns |
23+
| [@bsv/templates](templates.md) | Predefined ScriptTemplate examples for protocol engineers, including OpReturn, MultiPushDrop, and P2MSKH lock/unlock patterns |
2424
| [@bsv/did-client](did-client.md) | DID client for creating, revoking, and querying on-chain DIDs with overlay broadcast |
2525
| [@bsv/amountinator](amountinator.md) | Multi-currency converter (SATS↔BSV↔15+ fiat) with exchange rate caching |
2626
| [@bsv/fund-wallet](fund-wallet.md) | CLI faucet for funding wallets from Metanet Desktop during development and testing |

docs/packages/index.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ id: packages-index
33
title: Packages
44
kind: meta
55
version: "n/a"
6-
last_updated: "2026-04-28"
7-
last_verified: "2026-04-28"
6+
last_updated: "2026-04-30"
7+
last_verified: "2026-04-30"
88
review_cadence_days: 30
99
status: stable
1010
tags: ["packages"]
@@ -27,7 +27,7 @@ ts-stack contains 27 production-ready packages organized into 7 domains. Each do
2727
**Key management, balance tracking, signing — local or via wallet service.**
2828

2929
- [@bsv/wallet-toolbox](./wallet/wallet-toolbox.md) — BRC-100 wallet client library
30-
- [@bsv/btms](./wallet/btms.md)Binary Token Management System (token issuance and transfer)
30+
- [@bsv/btms](./wallet/btms.md)Basic Token Management System for token issuance, transfer, receiving, burning, and ownership proofs
3131
- [@bsv/btms-permission-module](./wallet/btms-permission-module.md) — Token permission checking
3232
- [@bsv/wallet-relay](./wallet/wallet-relay.md) — Broadcast and query wrapper for wallet synchronization
3333

@@ -59,17 +59,22 @@ ts-stack contains 27 production-ready packages organized into 7 domains. Each do
5959

6060
### Middleware
6161

62-
**Drop-in Express middleware for payment-gating and identity verification.**
62+
**HTTP authentication and payment-gating packages.**
63+
64+
Authenticated Express middleware stack:
6365

6466
- [@bsv/auth-express-middleware](./middleware/auth-express-middleware.md) — Verify identity signatures in Express
65-
- [@bsv/payment-express-middleware](./middleware/payment-express-middleware.md) — Gate routes behind payment requirements
66-
- [@bsv/402-pay](./middleware/402-pay.md) — HTTP 402 payment handler
67+
- [@bsv/payment-express-middleware](./middleware/payment-express-middleware.md) — Gate authenticated Express routes behind payment requirements; requires `@bsv/auth-express-middleware`
68+
69+
Independent HTTP 402 flow:
70+
71+
- [@bsv/402-pay](./middleware/402-pay.md) — HTTP 402 payment handler designed to work without auth middleware
6772

6873
### Helpers
6974

7075
**Shared utilities, codecs, templates, and adapters.**
7176

72-
- [@bsv/templates](./helpers/templates.md)Template system for OP_RETURN inscriptions
77+
- [@bsv/templates](./helpers/templates.md)Predefined `ScriptTemplate` examples for protocol engineers; `OpReturn` is one template among several
7378
- [@bsv/did-client](./helpers/did-client.md) — DID resolver (Decentralized Identifiers)
7479
- [@bsv/simple](./helpers/simple.md) — Simplified API for common operations
7580
- [@bsv/wallet-helper](./helpers/wallet-helper.md) — Wallet utility functions

docs/packages/middleware/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: domain-middleware
33
title: Middleware
44
kind: reference
5-
last_updated: "2026-04-28"
5+
last_updated: "2026-04-30"
66
version: "n/a"
77
last_verified: "2026-04-28"
88
review_cadence_days: 90
@@ -12,12 +12,12 @@ tags: [packages, middleware]
1212

1313
# Middleware Domain
1414

15-
Express.js middleware and client utilities for adding cryptographic authentication and micropayment gating to HTTP services. Implements BRC-103 mutual authentication over HTTP (BRC-104) and HTTP 402 Payment Required (BRC-121) for monetizing APIs with Bitcoin SV micropayments.
15+
Express.js middleware and client utilities for adding cryptographic authentication and micropayment gating to HTTP services. There are two distinct payment paths: `@bsv/payment-express-middleware` layers payment requirements on top of authenticated Express routes, while `@bsv/402-pay` is an independent HTTP 402 flow that can work without auth middleware.
1616

1717
## Packages
1818

1919
| Package | Purpose |
2020
|---------|---------|
2121
| **@bsv/auth-express-middleware** | Express middleware implementing BRC-103 peer-to-peer mutual authentication via BRC-104 HTTP transport. Verify request signatures, attach verified identity to req.auth, and optionally exchange verifiable certificates. |
22-
| **@bsv/payment-express-middleware** | Express middleware for HTTP 402 Payment Required micropayment gating. Builds on top of BRC-103 auth middleware to require BSV satoshi payments derived using BRC-29 key derivation. |
23-
| **@bsv/402-pay** | Client-side and server-side HTTP 402 payment handler. Auto-pay 402 responses on the client; validate and accept payments on the server with caching and replay protection. |
22+
| **@bsv/payment-express-middleware** | Express middleware for HTTP 402 Payment Required micropayment gating. Requires `@bsv/auth-express-middleware` first, then derives payment requirements from the authenticated identity context. |
23+
| **@bsv/402-pay** | Independent client-side and server-side HTTP 402 payment handler. Auto-pay 402 responses on the client; validate and accept payments on the server with caching and replay protection, without requiring auth middleware. |

0 commit comments

Comments
 (0)