@smartledger/bsv 7.4.0 → 7.5.1

package/CHANGELOG.md

@@ -7,6 +7,134 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.5.1] - 2026-08-06
+
+Three defects reported from the field against 7.4.0, each reproduced here before
+being fixed. All three return or publish a key other than the one the caller
+intended. **Anyone using `GDAF.anchorCredential` or `anchorBatch` should treat any
+key passed to them as compromised and rotate it.**
+
+### Fixed (security)
+
+- **`GDAF.anchorCredential` and `anchorBatch` published the caller's private key in
+  the OP_RETURN.** The wrappers take `(payload, privateKey, options)` while the
+  underlying `SmartLedgerAnchor` methods take `(payload, metadata, utxos)`, and every
+  wrapper forwarded `privateKey` into a slot that is not a key. For these two it
+  landed in `metadata`, which is `JSON.stringify`-ed straight into the anchor payload
+  — and `PrivateKey.prototype.toJSON` emitted the secret scalar as hex. The key was
+  therefore recoverable from chain data: reconstructing it from the OP_RETURN yields
+  an **identical WIF and address**, so an observer can spend the funds.
+
+  The anchor already holds the key it was constructed with, so the wrappers no longer
+  forward it. `options` is now `{ utxos, metadata }`; a bare UTXO array is still
+  accepted, since that was the only shape that previously produced a transaction.
+  `registerDID` and `revokeCredential` shared the argument-order defect but put the
+  key in the `utxos` slot, where they died on `utxos.reduce` — they never leaked, and
+  are corrected too.
+
+  Defence in depth: `_createAnchorPayload` now refuses to serialise a `PrivateKey`
+  instance or any key-shaped field (`bn`, `wif`, `privateJwk`, `seed`, `xprv`, ...),
+  so reaching the payload builder with key material fails loudly instead of
+  broadcasting it.
+
+- **`PrivateKey.prototype.toJSON` no longer emits the secret scalar.** It was the same
+  function as `toObject`, so *anything* that stringified a key — a log line, an error
+  dump, a request body, or the anchor path above — published it. `JSON.stringify(key)`
+  now yields `bn: '[REDACTED]'`. `toObject()` is unchanged and remains the deliberate
+  export, so `PrivateKey.fromObject(key.toObject())` still round-trips exactly.
+
+- **`PrivateKey.fromString(str, network)` honours `network` instead of discarding it.**
+  It accepted the argument and ignored it, so `fromString(hex, 'testnet')` returned a
+  livenet key and therefore a **mainnet address** — funds sent there land on the wrong
+  network. The failure was intermittent because `toAddress(network)` does honour its
+  own argument. For a WIF, which encodes its own network, a conflicting `network` now
+  throws rather than being silently overridden.
+
+- **`PrivateKey.fromHex` / `fromBuffer` agree with the constructor.**
+  `_transformBNBuffer` hardcoded `compressed: false` while every other path — random
+  keys, hex strings, compressed WIF — produced `true`, so `PrivateKey.fromHex(h)` and
+  `new PrivateKey(h)` returned **different addresses and different WIFs for identical
+  input**. Restore a key by the wrong route and you derive an address you never funded.
+  A raw 32-byte scalar carries no compression information, so the default now matches
+  the rest of the library; pass `compressed = false` explicitly for the legacy form.
+
+### Changed
+
+- `bsv.d.ts`: `fromString`/`fromWIF` take an optional `network`; `fromHex`/`fromBuffer`
+  take optional `network` and `compressed`; `toObject()` and `toJSON()` have distinct
+  return types so the redaction is visible to TypeScript; the GDAF anchoring methods
+  declare `AnchorOptions | Utxo[]` and return `Promise`. Verified under `tsc --strict`.
+
+- Two tests asserted that `JSON.stringify(privateKey)` emits the scalar, encoding the
+  unsafe behaviour as intent. They now assert the opposite, while still checking that
+  `toObject()` round-trips exactly.
+
+### Breaking
+
+`JSON.stringify(privateKey)` no longer contains the key; use `toObject()` or `toWIF()`
+where the export is intended. `PrivateKey.fromHex`/`fromBuffer` on a 32-byte scalar now
+default to compressed, changing the derived address and WIF — pass `false` for the old
+behaviour. The GDAF anchoring wrappers no longer accept a private key in the `options`
+position, and reject key material in `metadata`.
+
+Suite 4544 → 4559.
+
+## [7.5.0] - 2026-08-05
+
+### Fixed
+
+- **`useGenesisLimits()` now lifts the total script size cap, which it previously
+  could not.** The cap was a literal inside `Interpreter.prototype.evaluate`,
+  carrying its own `// TODO: script size should be configurable. no magic numbers`:
+
+  ```js
+  if (this.script.toBuffer().length > 10000) {
+  ```
+
+  So a caller who opted into post-Genesis limits still hit a **pre-Genesis 10,000
+  byte ceiling** — the function said "post-Genesis limits" and enforced one of the
+  limits Genesis removed. Any script above 10 KB failed `SCRIPT_ERR_SCRIPT_SIZE`
+  no matter what was asked for, which put a sizeable 1Sat Ordinals inscription out
+  of reach of the interpreter entirely: transferring one could not be verified by
+  this library at all, in any version, and callers were pushed into checking the
+  ECDSA signature against the sighash by hand.
+
+  The cap is now `Interpreter.MAX_SCRIPT_SIZE`, still defaulting to the
+  pre-Genesis 10,000, and `useGenesisLimits()` raises it along with the other
+  three. Two limits bite at different sizes and the regression test pins both: a
+  3 KB inscription loads and fails on the 520-byte push cap
+  (`SCRIPT_ERR_PUSH_SIZE`), while a 50 KB one is refused before evaluation begins
+  (`SCRIPT_ERR_SCRIPT_SIZE`).
+
+### Added
+
+- **`Interpreter.getLimits()` / `Interpreter.setLimits()`** — capture and restore
+  the four caps as a unit. The caps are process-wide statics, so anything that
+  raises them must put them back or it silently changes the rules for unrelated
+  code later in the same process. Five test files were each restoring three caps
+  by hand, which would have quietly leaked the new fourth one into the bitcoind
+  consensus fixtures; they now use the pair.
+
+- Regression coverage for the case that prompted this: signing a large inscription
+  transfer over the **full previous locking script** (envelope included, which is
+  the script code the network uses), verifying it through the interpreter under
+  Genesis limits, and confirming the interpreter agrees with a direct
+  signature-against-sighash check. A companion test asserts the trap: a signature
+  made over the **base lock alone** verifies against its own preimage and fails the
+  real one, so that mistake cannot pass unnoticed.
+
+### Note on defaults
+
+Post-Genesis limits remain **opt-in**. Making them the default was measured, not
+assumed: it fails **19 bitcoind consensus fixtures** that assert oversized pushes,
+excess opcodes and oversized numerics must be rejected. Those fixtures encode
+pre-Genesis consensus and share the same process-wide statics, so the default
+cannot move while the caps are global. Making the limits per-`Interpreter` policy
+is the real fix and is deliberately not attempted here — it changes a
+consensus-critical evaluation path and deserves its own change.
+
+Suite 4536 → 4544.
+
 ## [7.4.0] - 2026-08-05
 
 Completes BSV-21 coverage. 7.3.0 taught the parser every operation the specification

package/README.md

@@ -186,42 +186,42 @@ console.log('Status:', status) // 'revoked'
 ### **Core Modules**
 | Module | Size | Use Case | CDN |
 |--------|------|----------|-----|
-| **bsv.min.js** | 1149KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@7.4.0/bsv.min.js` |
-| **bsv.bundle.js** | 1149KB | Everything in one file | `unpkg.com/@smartledger/bsv@7.4.0/bsv.bundle.js` |
+| **bsv.min.js** | 1149KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@7.5.1/bsv.min.js` |
+| **bsv.bundle.js** | 1149KB | Everything in one file | `unpkg.com/@smartledger/bsv@7.5.1/bsv.bundle.js` |
 
 ### **W3C Verifiable Credentials**
 | Module | Size | Use Case | CDN |
 |--------|------|----------|-----|
-| **🟢 bsv-didweb.min.js** | 315KB | **DID:web generation** | `unpkg.com/@smartledger/bsv@7.4.0/bsv-didweb.min.js` |
-| **🟢 bsv-vcjwt.min.js** | 315KB | **VC-JWT issue/verify** | `unpkg.com/@smartledger/bsv@7.4.0/bsv-vcjwt.min.js` |
-| **🟢 bsv-statuslist.min.js** | 415KB | **StatusList2021 revocation** | `unpkg.com/@smartledger/bsv@7.4.0/bsv-statuslist.min.js` |
-| **🟢 bsv-anchor.min.js** | 314KB | **BSV anchoring (hash-only)** | `unpkg.com/@smartledger/bsv@7.4.0/bsv-anchor.min.js` |
+| **🟢 bsv-didweb.min.js** | 315KB | **DID:web generation** | `unpkg.com/@smartledger/bsv@7.5.1/bsv-didweb.min.js` |
+| **🟢 bsv-vcjwt.min.js** | 315KB | **VC-JWT issue/verify** | `unpkg.com/@smartledger/bsv@7.5.1/bsv-vcjwt.min.js` |
+| **🟢 bsv-statuslist.min.js** | 415KB | **StatusList2021 revocation** | `unpkg.com/@smartledger/bsv@7.5.1/bsv-statuslist.min.js` |
+| **🟢 bsv-anchor.min.js** | 314KB | **BSV anchoring (hash-only)** | `unpkg.com/@smartledger/bsv@7.5.1/bsv-anchor.min.js` |
 
 ### **Smart Contract & Development**
 | Module | Size | Use Case | CDN |
 |--------|------|----------|-----|
-| **bsv-smartcontract.min.js** | 873KB | Complete covenant framework | `unpkg.com/@smartledger/bsv@7.4.0/bsv-smartcontract.min.js` |
-| **bsv-covenant.min.js** | 873KB | Covenant operations | `unpkg.com/@smartledger/bsv@7.4.0/bsv-covenant.min.js` |
-| **bsv-script-helper.min.js** | 30KB | Custom script tools | `unpkg.com/@smartledger/bsv@7.4.0/bsv-script-helper.min.js` |
-| **bsv-security.min.js** | 30KB | Security enhancements | `unpkg.com/@smartledger/bsv@7.4.0/bsv-security.min.js` |
+| **bsv-smartcontract.min.js** | 873KB | Complete covenant framework | `unpkg.com/@smartledger/bsv@7.5.1/bsv-smartcontract.min.js` |
+| **bsv-covenant.min.js** | 873KB | Covenant operations | `unpkg.com/@smartledger/bsv@7.5.1/bsv-covenant.min.js` |
+| **bsv-script-helper.min.js** | 30KB | Custom script tools | `unpkg.com/@smartledger/bsv@7.5.1/bsv-script-helper.min.js` |
+| **bsv-security.min.js** | 30KB | Security enhancements | `unpkg.com/@smartledger/bsv@7.5.1/bsv-security.min.js` |
 
 ### **Legal & Compliance**
 | Module | Size | Use Case | CDN |
 |--------|------|----------|-----|
-| **bsv-ltp.min.js** | 1149KB | Legal Token Protocol | `unpkg.com/@smartledger/bsv@7.4.0/bsv-ltp.min.js` |
-| **bsv-gdaf.min.js** | 1149KB | Digital Identity & Attestation | `unpkg.com/@smartledger/bsv@7.4.0/bsv-gdaf.min.js` |
+| **bsv-ltp.min.js** | 1149KB | Legal Token Protocol | `unpkg.com/@smartledger/bsv@7.5.1/bsv-ltp.min.js` |
+| **bsv-gdaf.min.js** | 1149KB | Digital Identity & Attestation | `unpkg.com/@smartledger/bsv@7.5.1/bsv-gdaf.min.js` |
 
 ### **Advanced Cryptography**
 | Module | Size | Use Case | CDN |
 |--------|------|----------|-----|
-| **bsv-shamir.min.js** | 353KB | Threshold Cryptography | `unpkg.com/@smartledger/bsv@7.4.0/bsv-shamir.min.js` |
+| **bsv-shamir.min.js** | 353KB | Threshold Cryptography | `unpkg.com/@smartledger/bsv@7.5.1/bsv-shamir.min.js` |
 
 ### **Utilities**
 | Module | Size | Use Case | CDN |
 |--------|------|----------|-----|
-| **bsv-ecies.min.js** | 79KB | Encryption | `unpkg.com/@smartledger/bsv@7.4.0/bsv-ecies.min.js` |
-| **bsv-message.min.js** | 30KB | Message signing | `unpkg.com/@smartledger/bsv@7.4.0/bsv-message.min.js` |
-| **bsv-mnemonic.min.js** | 592KB | HD wallets | `unpkg.com/@smartledger/bsv@7.4.0/bsv-mnemonic.min.js` |
+| **bsv-ecies.min.js** | 79KB | Encryption | `unpkg.com/@smartledger/bsv@7.5.1/bsv-ecies.min.js` |
+| **bsv-message.min.js** | 30KB | Message signing | `unpkg.com/@smartledger/bsv@7.5.1/bsv-message.min.js` |
+| **bsv-mnemonic.min.js** | 592KB | HD wallets | `unpkg.com/@smartledger/bsv@7.5.1/bsv-mnemonic.min.js` |
 
 ## ⚡ **2-Minute Quick Start**
 
@@ -232,7 +232,7 @@ Get started with Bitcoin SV development in under 2 minutes:
 npm install @smartledger/bsv
 
 # Or include in HTML
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv.min.js"></script>
 ```
 
 > **🔒 v5.0.0 (production hardening — has breaking changes):** Shamir secret
@@ -332,8 +332,8 @@ const covenant = bsv.SmartContract.createCovenantBuilder()
 
 ### 🔧 **Basic Development** (~1.2MB total)
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-script-helper.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-script-helper.min.js"></script>
 <script>
   const privateKey = new bsv.PrivateKey();
   const utxos = new bsv.SmartContract.UTXOGenerator().createRealUTXOs(2, 100000);
@@ -342,9 +342,9 @@ const covenant = bsv.SmartContract.createCovenantBuilder()
 
 ### 🔒 **Smart Contract Development** (~2.8MB total — each bundle re-embeds core BSV)
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-covenant.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-smartcontract.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-covenant.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-smartcontract.min.js"></script>
 <script>
   const covenant = bsv.SmartContract.createCovenantBuilder()
     .extractField('amount').push(50000).greaterThanOrEqual().verify().build();
@@ -354,9 +354,9 @@ const covenant = bsv.SmartContract.createCovenantBuilder()
 
 ### 🆕 **Legal & Identity Development** (~3.4MB total — each bundle re-embeds core BSV)
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-ltp.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-gdaf.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-ltp.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-gdaf.min.js"></script>
 <script>
   // Legal Token Protocol
   const propertyToken = bsv.createPropertyToken({
@@ -370,9 +370,9 @@ const covenant = bsv.SmartContract.createCovenantBuilder()
 
 ### 🆕 **Security & Cryptography** (~1.5MB total)
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-security.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-shamir.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-security.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-shamir.min.js"></script>
 <script>
   // Threshold Cryptography
   const shares = bsv.splitSecret('my_secret_key', 5, 3); // 5 shares, 3 needed
@@ -384,7 +384,7 @@ const covenant = bsv.SmartContract.createCovenantBuilder()
 
 ### 🎯 **Everything Bundle** (~1.1MB)
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv.bundle.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv.bundle.js"></script>
 <script>
   // Everything available immediately
   const shares = bsv.splitSecret('secret', 5, 3);           // Shamir Secret Sharing
@@ -494,8 +494,8 @@ const contractTx = covenant.createCovenantTransaction({
 
 #### 1. **Minimal Setup** - Core + Script Helper (~1.2MB)
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-script-helper.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-script-helper.min.js"></script>
 <script>
   const tx = new bsv.Transaction();
   const sig = bsvScriptHelper.createSignature(tx, privateKey, 0, script, satoshis);
@@ -504,9 +504,9 @@ const contractTx = covenant.createCovenantTransaction({
 
 #### 2. **DeFi Development** - Core + Covenants + Debug (~2.8MB — each bundle re-embeds core BSV)
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-covenant.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-smartcontract.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-covenant.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-smartcontract.min.js"></script>
 <script>
   const covenant = new bsvCovenant.CovenantInterface();
   const debugInfo = SmartContract.interpretScript(script);
@@ -516,8 +516,8 @@ const contractTx = covenant.createCovenantTransaction({
 
 #### 3. **Security First** - Core + Enhanced Security (~1.2MB)
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv-security.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv-security.min.js"></script>
 <script>
   const verified = bsvSecurity.SmartVerify.verify(signature, hash, publicKey);
   const enhanced = bsvSecurity.EllipticFixed.createSignature(privateKey, hash);
@@ -526,7 +526,7 @@ const contractTx = covenant.createCovenantTransaction({
 
 #### 4. **Everything Bundle** - One File Solution (~1.1MB)
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@7.4.0/bsv.bundle.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@7.5.1/bsv.bundle.js"></script>
 <script>
   // Everything available under bsv namespace
   const keys = bsv.SmartLedgerBundle.generateKeys();
@@ -834,7 +834,7 @@ const timelockScript = helper.createTimelockScript(
 
 See the **[16 Loading Options](#-16-loading-options---choose-your-approach)**
 table near the top for the full list of bundles with current sizes and
-canonical `unpkg.com/@smartledger/bsv@7.4.0/...` URLs.
+canonical `unpkg.com/@smartledger/bsv@7.5.1/...` URLs.
 
 ## 🔐 Security