Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs-site/scripts/frontmatter-parser.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import assert from 'node:assert/strict'
import { createRequire } from 'node:module'
import test from 'node:test'

import mdx from '@mdx-js/rollup'
import remarkFrontmatter from 'remark-frontmatter'
import remarkMdxFrontmatter from 'remark-mdx-frontmatter'

const pluginRequire = createRequire(import.meta.resolve('remark-mdx-frontmatter'))
const toml = pluginRequire('toml')

async function compile(source, options) {
const plugin = mdx(options)
return (await plugin.transform.call({}, source, 'fixture.mdx')).code
}

test('patched TOML parser preserves the frontmatter plugin contract', async () => {
const result = await compile(
'+++\ntitle = "Overlay recovery"\n[review]\nready = true\n+++\n\n# Test',
{
remarkPlugins: [[remarkFrontmatter, ['yaml', 'toml']], remarkMdxFrontmatter]
}
)
assert.match(String(result), /Overlay recovery/)
assert.match(String(result), /"ready": true/)
const yaml = await compile('---\ntitle: Overlay recovery\n---\n\n# Test', {
remarkPlugins: [remarkFrontmatter, remarkMdxFrontmatter]
})
assert.match(String(yaml), /Overlay recovery/)
})

test('patched TOML isolates prototype paths and rejects excessive nesting', () => {
const parsed = toml.parse('[__proto__]\npolluted = true')
assert.equal(Object.getPrototypeOf(parsed), null)
assert.equal(parsed.__proto__.polluted, true)
assert.equal(Object.prototype.polluted, undefined)
assert.throws(() => toml.parse(`value = ${'['.repeat(1000)}0${']'.repeat(1000)}`))
})
10 changes: 7 additions & 3 deletions docs/packages/content/lch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: '@bsv/lch'
kind: package
domain: content
npm: '@bsv/lch'
version: '0.1.0'
last_updated: '2026-08-30'
last_verified: '2026-08-30'
version: '0.1.1'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/content/lch'
status: experimental
Expand All @@ -15,6 +15,10 @@ tags: ['content', 'licensing', 'brc-170', 'odrl', 'c2pa', 'chirp', 'uhrp']

# @bsv/lch

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> Browser- and Node-compatible reference implementation of published BRC-170
> Licensed Content Header protocol.

Expand Down
10 changes: 7 additions & 3 deletions docs/packages/helpers/amountinator.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-amountinator
title: '@bsv/amountinator'
kind: package
domain: helpers
version: '2.1.5'
version: '2.1.6'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-26'
last_verified: '2026-08-26'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/amountinator'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/helpers/amountinator'
Expand All @@ -16,6 +16,10 @@ tags: [helpers, amounts, satoshis]

# @bsv/amountinator

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> Satoshi/BSV/USD and multi-fiat currency conversion with exchange rate caching and wallet settings integration — convert between crypto (SATS, BSV) and 15+ fiat currencies with auto-refresh.

## Install
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/helpers/did-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-did-client
title: '@bsv/did-client'
kind: package
domain: helpers
version: '1.3.1'
version: '1.3.2'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-26'
last_verified: '2026-08-26'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/did-client'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/helpers/did-client'
Expand All @@ -16,6 +16,10 @@ tags: [did, identity, helpers]

# @bsv/did-client

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> DID (Decentralized Identifier) client for BSV blockchain — creates, revokes, and queries `did:bsv:` tokens stored as PushDrop outputs on-chain, with overlay broadcast and lookup service integration.

## Install
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/helpers/did.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-did
title: '@bsv/did'
kind: package
domain: helpers
version: '0.2.5'
version: '0.2.6'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-27'
last_verified: '2026-08-27'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/did'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/helpers/did'
Expand All @@ -16,6 +16,10 @@ tags: [did, sd-jwt, credentials, identity, helpers]

# @bsv/did

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> SD-JWT VC and optional `did:key` helpers for BSV SDK identity keys.

## Install
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/helpers/fund-wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-fund-wallet
title: '@bsv/fund-wallet'
kind: package
domain: helpers
version: '1.4.4'
version: '1.4.5'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-26'
last_verified: '2026-08-26'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/fund-wallet'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/helpers/fund-wallet'
Expand All @@ -16,6 +16,10 @@ tags: [helpers, testing, faucet, development]

# @bsv/fund-wallet

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> Command-line faucet/funding tool for development and testing — funds a remote wallet with satoshis from a local Metanet Desktop wallet via private key derivation.

## Install
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/helpers/simple.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-simple
title: '@bsv/simple'
kind: package
domain: helpers
version: '0.5.2'
version: '0.5.3'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-26'
last_verified: '2026-08-26'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/simple'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/helpers/simple'
Expand All @@ -16,6 +16,10 @@ tags: [helpers, simple, payments]

# @bsv/simple

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> High-level wallet API for browser and server — manage payments, tokens, inscriptions, DIDs, and credentials without wrestling with private keys or transactions.

## Install
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/helpers/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-templates
title: '@bsv/templates'
kind: package
domain: helpers
version: '1.10.1'
version: '1.10.2'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-27'
last_verified: '2026-08-27'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/templates'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/helpers/ts-templates'
Expand All @@ -16,6 +16,10 @@ tags: [templates, scripts, locking, unlocking]

# @bsv/templates

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> Low-level BSV script templates library — provides reusable locking/unlocking script implementations (OpReturn, MultiPushDrop, P2MSKH) for common and advanced Bitcoin SV patterns without abstracting away control.

## Install
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/helpers/wallet-helper.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-wallet-helper
title: '@bsv/wallet-helper'
kind: package
domain: helpers
version: '0.1.7'
version: '0.1.8'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-27'
last_verified: '2026-08-27'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/wallet-helper'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/helpers/bsv-wallet-helper'
Expand All @@ -16,6 +16,10 @@ tags: [helpers, wallet, transaction-builder]

# @bsv/wallet-helper

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> Fluent transaction builder and wallet-compatible script templates for BSV — construct multi-output transactions (P2PKH, ordinals, custom) with method chaining, BRC-29 key derivation, and no private key exposure.

`@bsv/wallet-helper` is a good starting point for developers coming from other blockchain ecosystems who expect to build transactions explicitly. It gives you a transaction-builder shape for outputs, scripts, ordinals, metadata, inputs, and explicit change destinations, while still delegating keys and signing to a BRC-100 wallet.
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/messaging/authsocket-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-authsocket-client
title: '@bsv/authsocket-client'
kind: package
domain: messaging
version: '2.1.6'
version: '2.1.7'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-26'
last_verified: '2026-08-26'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/authsocket-client'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/messaging/authsocket-client'
Expand All @@ -16,6 +16,10 @@ tags: [messaging, websocket, brc-31, auth]

# @bsv/authsocket-client

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> Client-side BRC-103 mutual authentication wrapper for socket.io-client. Signs all outbound messages and verifies inbound messages using a wallet, enabling authenticated peer-to-peer WebSocket communication.

## Install
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/messaging/authsocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-authsocket
title: '@bsv/authsocket'
kind: package
domain: messaging
version: '2.1.7'
version: '2.1.8'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-27'
last_verified: '2026-08-27'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/authsocket'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/messaging/authsocket'
Expand All @@ -16,6 +16,10 @@ tags: [messaging, websocket, brc-31, auth]

# @bsv/authsocket

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> Server-side BRC-103 mutual authentication wrapper for Socket.IO. Enforces cryptographic signing and verification on all WebSocket messages, enabling peer-to-peer identity verification and certificate exchange.

## Install
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/messaging/message-box-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-message-box-client
title: '@bsv/message-box-client'
kind: package
domain: messaging
version: '2.4.2'
version: '2.4.3'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-26'
last_verified: '2026-08-26'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/message-box-client'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/messaging/message-box-client'
Expand All @@ -16,6 +16,10 @@ tags: [messaging, message-box, brc-103, brc-29]

# @bsv/message-box-client

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> Browser- and Node-compatible authenticated store-and-forward messaging,
> live WebSockets, peer payments, token settlement, permissions, quotes, and
> push-device registration.
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/messaging/paymail.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-paymail
title: '@bsv/paymail'
kind: package
domain: messaging
version: '2.4.7'
version: '2.4.8'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-27'
last_verified: '2026-08-27'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/paymail'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/messaging/ts-paymail'
Expand All @@ -16,6 +16,10 @@ tags: [paymail, messaging, brc-29, identity]

# @bsv/paymail

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> TypeScript SDK for BSV Paymail (BRC-121 capability discovery and routing). Provides both client-side capability discovery and server-side router with built-in support for PKI, P2P destinations, and public profiles.

## Install
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/middleware/402-pay.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-402-pay
title: '@bsv/402-pay'
kind: package
domain: middleware
version: '0.2.5'
version: '0.2.6'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-27'
last_verified: '2026-08-27'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/402-pay'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/middleware/402-pay'
Expand All @@ -16,6 +16,10 @@ tags: [middleware, payment, '402', client]

# @bsv/402-pay

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

> BRC-121 HTTP 402 Payment Required handler for client and server. Client-side: auto-pays 402 responses. Server-side: middleware/validation for accepting BSV micropayments over HTTP.

## Install
Expand Down
10 changes: 7 additions & 3 deletions docs/packages/middleware/auth-express-middleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: pkg-auth-express-middleware
title: '@bsv/auth-express-middleware'
kind: package
domain: middleware
version: '2.2.3'
version: '2.2.4'
source_repo: 'bsv-blockchain/ts-stack'
last_updated: '2026-08-27'
last_verified: '2026-08-27'
last_updated: '2026-09-04'
last_verified: '2026-09-04'
review_cadence_days: 30
npm: 'https://www.npmjs.com/package/@bsv/auth-express-middleware'
repo: 'https://github.com/bsv-blockchain/ts-stack/tree/main/packages/middleware/auth-express-middleware'
Expand All @@ -16,6 +16,10 @@ tags: [middleware, express, auth, brc-103, brc-104]

# @bsv/auth-express-middleware

This version accepts SDK 3 alongside its existing SDK 2 peer range. Follow the
[SDK 3 migration guide](https://github.com/bsv-blockchain/ts-stack/blob/main/packages/sdk/docs/overlay-lookup-migration.md)
when upgrading the application SDK.

Express transport for BRC-103 peer-to-peer mutual authentication over
BRC-104 HTTP. It handles the public handshake, verifies authenticated
application requests, signs responses, and optionally exchanges verifiable
Expand Down
Loading
Loading