@smartledger/bsv 7.8.1 → 7.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/CHANGELOG.md +58 -6
  2. package/README.md +38 -38
  3. package/bsv-gdaf.min.js +29 -29
  4. package/bsv-ltp.min.js +29 -29
  5. package/bsv-smartcontract.min.js +6 -6
  6. package/bsv.bundle.js +29 -29
  7. package/bsv.min.js +29 -29
  8. package/docs/MODULE_REFERENCE_COMPLETE.md +27 -27
  9. package/docs/advanced/UTXO_MANAGER_GUIDE.md +1 -1
  10. package/docs/getting-started/INSTALLATION.md +23 -23
  11. package/docs/getting-started/QUICK_START.md +7 -7
  12. package/docs/migration/FROM_BSV_1_5_6.md +5 -5
  13. package/lib/script/interpreter.js +96 -31
  14. package/lib/smart_contract/covenant_helpers.js +12 -1
  15. package/package.json +1 -1
  16. package/test/script/chronicle.js +53 -10
  17. package/test/script/interpreter.js +9 -6
  18. package/test/script/string_ops.js +26 -10
  19. package/version.js +1 -1
package/CHANGELOG.md CHANGED
@@ -7,14 +7,66 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
- ## [7.8.1] - 2026-08-10
10
+ ## [7.9.0] - 2026-08-10
11
11
 
12
- Bundle-only re-release of 7.8.0. No source, API or behaviour change — see
13
- [7.7.1] for the full explanation; the same stale `bn.js@4.12.3` in a local
14
- `node_modules` produced non-reproducible bundles here too.
12
+ Five divergences from the SV Node source (checked at tag **v1.2.0**), and the
13
+ consequence closing one of them exposed.
15
14
 
16
- Published under the `bundles-7.8` dist-tag so `latest` continues to point at the
17
- newest release.
15
+ ### Fixed (consensus)
16
+
17
+ - **`OP_SUBSTR`/`OP_LEFT`/`OP_RIGHT` ran unconditionally.** The node treats bytes
18
+ `0xb3`–`0xb5` as upgradable NOPs until Chronicle activates. This library executed
19
+ them regardless, consuming stack where the network does nothing — reachable today,
20
+ since those bytes are live NOPs.
21
+
22
+ - **Out-of-range string-op arguments were clamped instead of rejected.** The node:
23
+ `if(offset < 0 || offset >= size || len < 0 || len > size - offset) return
24
+ SCRIPT_ERR_INVALID_NUMBER_RANGE`. Measured before the fix, `'hi' 1 9 OP_SUBSTR`
25
+ yielded `'i'` and the script **succeeded**. Note `offset >= size` is strict — a begin
26
+ index at the end is an error, not an empty result.
27
+
28
+ - **`OP_VER` pushed a script number** where the node builds a `sizeof(tx_version)`
29
+ vector and `to_le`s into it: `01000000`, not `01`.
30
+
31
+ - **`OP_VERIF` compared numerically.** The node requires exactly four bytes and
32
+ compares byte-wise (`if(vch.size() == 4) … std::ranges::equal(val, vch)`), so a
33
+ 1-byte script number never matches however equal it looks. `OP_2 OP_VERIF` against
34
+ version 2 was true here and false on the node; `OP_VER OP_VERIF` is the idiomatic
35
+ form.
36
+
37
+ - **`OP_VERIF` in an unexecuted branch returned `BAD_OPCODE`.** Core treats it as
38
+ illegal everywhere — a rule it applies to no other opcode — but BSV drops that at
39
+ Genesis and the node breaks instead. Asserting the Core rule made this library reject
40
+ scripts the network accepts. (This corrects an assertion added in 7.7.0.)
41
+
42
+ Also taken from the source: MINIMALIF applies only to `OP_IF`/`OP_NOTIF`, never to the
43
+ `OP_VER` family.
44
+
45
+ ### Consequence worth reading
46
+
47
+ Closing the gating divergence surfaced something the old behaviour was hiding.
48
+ `pushTxCore` emits `OP_RIGHT`/`OP_LEFT` — see `extractHashOutputs` and
49
+ `assertSighashType` — so **OP_PUSH_TX covenants built by this library cannot be spent
50
+ on a pre-Chronicle chain**. Confirmed end to end: an OrdLock purchase verifies with
51
+ `SCRIPT_ENABLE_CHRONICLE` and fails `SCRIPT_ERR_EQUALVERIFY` without it.
52
+
53
+ That was invisible *because* the interpreter ran the string opcodes unconditionally:
54
+ the library was more permissive than the network, so the covenant and OrdLock suites
55
+ passed against a validator that did not match consensus. `covenant_helpers.flags()` now
56
+ sets the flag explicitly, so the dependency is stated rather than assumed. Whether that
57
+ tooling should target pre- or post-activation is a product decision this does not make.
58
+
59
+ ### Breaking
60
+
61
+ Scripts using `OP_SUBSTR`/`OP_LEFT`/`OP_RIGHT` now require `SCRIPT_ENABLE_CHRONICLE` to
62
+ execute; without it they are no-ops, as on the network. Out-of-range arguments error
63
+ rather than clamping. `OP_VER` pushes four bytes. `OP_VERIF` needs a 4-byte operand.
64
+
65
+ With this release the independent conformance corpus in `@smartledger/bsv-core` — whose
66
+ Chronicle fixtures have been regenerated against the same source — reports
67
+ **PASS: 452/452** across all 13 suites. The two implementations agree completely.
68
+
69
+ Suite 4638 → 4641.
18
70
 
19
71
  ## [7.8.0] - 2026-08-10
20
72
 
package/README.md CHANGED
@@ -186,42 +186,42 @@ console.log('Status:', status) // 'revoked'
186
186
  ### **Core Modules**
187
187
  | Module | Size | Use Case | CDN |
188
188
  |--------|------|----------|-----|
189
- | **bsv.min.js** | 1149KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@7.8.1/bsv.min.js` |
190
- | **bsv.bundle.js** | 1149KB | Everything in one file | `unpkg.com/@smartledger/bsv@7.8.1/bsv.bundle.js` |
189
+ | **bsv.min.js** | 1149KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@7.9.0/bsv.min.js` |
190
+ | **bsv.bundle.js** | 1149KB | Everything in one file | `unpkg.com/@smartledger/bsv@7.9.0/bsv.bundle.js` |
191
191
 
192
192
  ### **W3C Verifiable Credentials**
193
193
  | Module | Size | Use Case | CDN |
194
194
  |--------|------|----------|-----|
195
- | **🟢 bsv-didweb.min.js** | 315KB | **DID:web generation** | `unpkg.com/@smartledger/bsv@7.8.1/bsv-didweb.min.js` |
196
- | **🟢 bsv-vcjwt.min.js** | 315KB | **VC-JWT issue/verify** | `unpkg.com/@smartledger/bsv@7.8.1/bsv-vcjwt.min.js` |
197
- | **🟢 bsv-statuslist.min.js** | 415KB | **StatusList2021 revocation** | `unpkg.com/@smartledger/bsv@7.8.1/bsv-statuslist.min.js` |
198
- | **🟢 bsv-anchor.min.js** | 314KB | **BSV anchoring (hash-only)** | `unpkg.com/@smartledger/bsv@7.8.1/bsv-anchor.min.js` |
195
+ | **🟢 bsv-didweb.min.js** | 315KB | **DID:web generation** | `unpkg.com/@smartledger/bsv@7.9.0/bsv-didweb.min.js` |
196
+ | **🟢 bsv-vcjwt.min.js** | 315KB | **VC-JWT issue/verify** | `unpkg.com/@smartledger/bsv@7.9.0/bsv-vcjwt.min.js` |
197
+ | **🟢 bsv-statuslist.min.js** | 415KB | **StatusList2021 revocation** | `unpkg.com/@smartledger/bsv@7.9.0/bsv-statuslist.min.js` |
198
+ | **🟢 bsv-anchor.min.js** | 314KB | **BSV anchoring (hash-only)** | `unpkg.com/@smartledger/bsv@7.9.0/bsv-anchor.min.js` |
199
199
 
200
200
  ### **Smart Contract & Development**
201
201
  | Module | Size | Use Case | CDN |
202
202
  |--------|------|----------|-----|
203
- | **bsv-smartcontract.min.js** | 873KB | Complete covenant framework | `unpkg.com/@smartledger/bsv@7.8.1/bsv-smartcontract.min.js` |
204
- | **bsv-covenant.min.js** | 873KB | Covenant operations | `unpkg.com/@smartledger/bsv@7.8.1/bsv-covenant.min.js` |
205
- | **bsv-script-helper.min.js** | 30KB | Custom script tools | `unpkg.com/@smartledger/bsv@7.8.1/bsv-script-helper.min.js` |
206
- | **bsv-security.min.js** | 30KB | Security enhancements | `unpkg.com/@smartledger/bsv@7.8.1/bsv-security.min.js` |
203
+ | **bsv-smartcontract.min.js** | 873KB | Complete covenant framework | `unpkg.com/@smartledger/bsv@7.9.0/bsv-smartcontract.min.js` |
204
+ | **bsv-covenant.min.js** | 873KB | Covenant operations | `unpkg.com/@smartledger/bsv@7.9.0/bsv-covenant.min.js` |
205
+ | **bsv-script-helper.min.js** | 30KB | Custom script tools | `unpkg.com/@smartledger/bsv@7.9.0/bsv-script-helper.min.js` |
206
+ | **bsv-security.min.js** | 30KB | Security enhancements | `unpkg.com/@smartledger/bsv@7.9.0/bsv-security.min.js` |
207
207
 
208
208
  ### **Legal & Compliance**
209
209
  | Module | Size | Use Case | CDN |
210
210
  |--------|------|----------|-----|
211
- | **bsv-ltp.min.js** | 1149KB | Legal Token Protocol | `unpkg.com/@smartledger/bsv@7.8.1/bsv-ltp.min.js` |
212
- | **bsv-gdaf.min.js** | 1149KB | Digital Identity & Attestation | `unpkg.com/@smartledger/bsv@7.8.1/bsv-gdaf.min.js` |
211
+ | **bsv-ltp.min.js** | 1149KB | Legal Token Protocol | `unpkg.com/@smartledger/bsv@7.9.0/bsv-ltp.min.js` |
212
+ | **bsv-gdaf.min.js** | 1149KB | Digital Identity & Attestation | `unpkg.com/@smartledger/bsv@7.9.0/bsv-gdaf.min.js` |
213
213
 
214
214
  ### **Advanced Cryptography**
215
215
  | Module | Size | Use Case | CDN |
216
216
  |--------|------|----------|-----|
217
- | **bsv-shamir.min.js** | 353KB | Threshold Cryptography | `unpkg.com/@smartledger/bsv@7.8.1/bsv-shamir.min.js` |
217
+ | **bsv-shamir.min.js** | 353KB | Threshold Cryptography | `unpkg.com/@smartledger/bsv@7.9.0/bsv-shamir.min.js` |
218
218
 
219
219
  ### **Utilities**
220
220
  | Module | Size | Use Case | CDN |
221
221
  |--------|------|----------|-----|
222
- | **bsv-ecies.min.js** | 79KB | Encryption | `unpkg.com/@smartledger/bsv@7.8.1/bsv-ecies.min.js` |
223
- | **bsv-message.min.js** | 30KB | Message signing | `unpkg.com/@smartledger/bsv@7.8.1/bsv-message.min.js` |
224
- | **bsv-mnemonic.min.js** | 592KB | HD wallets | `unpkg.com/@smartledger/bsv@7.8.1/bsv-mnemonic.min.js` |
222
+ | **bsv-ecies.min.js** | 79KB | Encryption | `unpkg.com/@smartledger/bsv@7.9.0/bsv-ecies.min.js` |
223
+ | **bsv-message.min.js** | 30KB | Message signing | `unpkg.com/@smartledger/bsv@7.9.0/bsv-message.min.js` |
224
+ | **bsv-mnemonic.min.js** | 592KB | HD wallets | `unpkg.com/@smartledger/bsv@7.9.0/bsv-mnemonic.min.js` |
225
225
 
226
226
  ## ⚡ **2-Minute Quick Start**
227
227
 
@@ -232,7 +232,7 @@ Get started with Bitcoin SV development in under 2 minutes:
232
232
  npm install @smartledger/bsv
233
233
 
234
234
  # Or include in HTML
235
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv.min.js"></script>
235
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv.min.js"></script>
236
236
  ```
237
237
 
238
238
  > **🔒 v5.0.0 (production hardening — has breaking changes):** Shamir secret
@@ -332,8 +332,8 @@ const covenant = bsv.SmartContract.createCovenantBuilder()
332
332
 
333
333
  ### 🔧 **Basic Development** (~1.2MB total)
334
334
  ```html
335
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv.min.js"></script>
336
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-script-helper.min.js"></script>
335
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv.min.js"></script>
336
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-script-helper.min.js"></script>
337
337
  <script>
338
338
  const privateKey = new bsv.PrivateKey();
339
339
  const utxos = new bsv.SmartContract.UTXOGenerator().createRealUTXOs(2, 100000);
@@ -342,9 +342,9 @@ const covenant = bsv.SmartContract.createCovenantBuilder()
342
342
 
343
343
  ### 🔒 **Smart Contract Development** (~2.8MB total — each bundle re-embeds core BSV)
344
344
  ```html
345
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv.min.js"></script>
346
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-covenant.min.js"></script>
347
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-smartcontract.min.js"></script>
345
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv.min.js"></script>
346
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-covenant.min.js"></script>
347
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-smartcontract.min.js"></script>
348
348
  <script>
349
349
  const covenant = bsv.SmartContract.createCovenantBuilder()
350
350
  .extractField('amount').push(50000).greaterThanOrEqual().verify().build();
@@ -354,9 +354,9 @@ const covenant = bsv.SmartContract.createCovenantBuilder()
354
354
 
355
355
  ### 🆕 **Legal & Identity Development** (~3.4MB total — each bundle re-embeds core BSV)
356
356
  ```html
357
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv.min.js"></script>
358
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-ltp.min.js"></script>
359
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-gdaf.min.js"></script>
357
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv.min.js"></script>
358
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-ltp.min.js"></script>
359
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-gdaf.min.js"></script>
360
360
  <script>
361
361
  // Legal Token Protocol
362
362
  const propertyToken = bsv.createPropertyToken({
@@ -370,9 +370,9 @@ const covenant = bsv.SmartContract.createCovenantBuilder()
370
370
 
371
371
  ### 🆕 **Security & Cryptography** (~1.5MB total)
372
372
  ```html
373
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv.min.js"></script>
374
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-security.min.js"></script>
375
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-shamir.min.js"></script>
373
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv.min.js"></script>
374
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-security.min.js"></script>
375
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-shamir.min.js"></script>
376
376
  <script>
377
377
  // Threshold Cryptography
378
378
  const shares = bsv.splitSecret('my_secret_key', 5, 3); // 5 shares, 3 needed
@@ -384,7 +384,7 @@ const covenant = bsv.SmartContract.createCovenantBuilder()
384
384
 
385
385
  ### 🎯 **Everything Bundle** (~1.1MB)
386
386
  ```html
387
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv.bundle.js"></script>
387
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv.bundle.js"></script>
388
388
  <script>
389
389
  // Everything available immediately
390
390
  const shares = bsv.splitSecret('secret', 5, 3); // Shamir Secret Sharing
@@ -494,8 +494,8 @@ const contractTx = covenant.createCovenantTransaction({
494
494
 
495
495
  #### 1. **Minimal Setup** - Core + Script Helper (~1.2MB)
496
496
  ```html
497
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv.min.js"></script>
498
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-script-helper.min.js"></script>
497
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv.min.js"></script>
498
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-script-helper.min.js"></script>
499
499
  <script>
500
500
  const tx = new bsv.Transaction();
501
501
  const sig = bsvScriptHelper.createSignature(tx, privateKey, 0, script, satoshis);
@@ -504,9 +504,9 @@ const contractTx = covenant.createCovenantTransaction({
504
504
 
505
505
  #### 2. **DeFi Development** - Core + Covenants + Debug (~2.8MB — each bundle re-embeds core BSV)
506
506
  ```html
507
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv.min.js"></script>
508
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-covenant.min.js"></script>
509
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-smartcontract.min.js"></script>
507
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv.min.js"></script>
508
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-covenant.min.js"></script>
509
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-smartcontract.min.js"></script>
510
510
  <script>
511
511
  const covenant = new bsvCovenant.CovenantInterface();
512
512
  const debugInfo = SmartContract.interpretScript(script);
@@ -516,8 +516,8 @@ const contractTx = covenant.createCovenantTransaction({
516
516
 
517
517
  #### 3. **Security First** - Core + Enhanced Security (~1.2MB)
518
518
  ```html
519
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv.min.js"></script>
520
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv-security.min.js"></script>
519
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv.min.js"></script>
520
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv-security.min.js"></script>
521
521
  <script>
522
522
  const verified = bsvSecurity.SmartVerify.verify(signature, hash, publicKey);
523
523
  const enhanced = bsvSecurity.EllipticFixed.createSignature(privateKey, hash);
@@ -526,7 +526,7 @@ const contractTx = covenant.createCovenantTransaction({
526
526
 
527
527
  #### 4. **Everything Bundle** - One File Solution (~1.1MB)
528
528
  ```html
529
- <script src="https://unpkg.com/@smartledger/bsv@7.8.1/bsv.bundle.js"></script>
529
+ <script src="https://unpkg.com/@smartledger/bsv@7.9.0/bsv.bundle.js"></script>
530
530
  <script>
531
531
  // Everything available under bsv namespace
532
532
  const keys = bsv.SmartLedgerBundle.generateKeys();
@@ -834,7 +834,7 @@ const timelockScript = helper.createTimelockScript(
834
834
 
835
835
  See the **[16 Loading Options](#-16-loading-options---choose-your-approach)**
836
836
  table near the top for the full list of bundles with current sizes and
837
- canonical `unpkg.com/@smartledger/bsv@7.8.1/...` URLs.
837
+ canonical `unpkg.com/@smartledger/bsv@7.9.0/...` URLs.
838
838
 
839
839
  ## 🔐 Security
840
840