@smartledger/bsv 7.12.0 → 8.0.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.
- package/CHANGELOG.md +178 -0
- package/README.md +38 -38
- package/bsv-didweb.min.js +6 -6
- package/bsv-gdaf.min.js +66 -66
- package/bsv-ltp.min.js +46 -46
- package/bsv-mnemonic.min.js +8 -8
- package/bsv-smartcontract.min.js +1 -1
- package/bsv.bundle.js +66 -66
- package/bsv.min.js +66 -66
- package/docs/AUDIT_SCOPE.md +29 -21
- package/docs/MODULE_REFERENCE_COMPLETE.md +27 -27
- package/docs/advanced/UTXO_MANAGER_GUIDE.md +1 -1
- package/docs/getting-started/INSTALLATION.md +23 -23
- package/docs/getting-started/QUICK_START.md +7 -7
- package/docs/migration/FROM_BSV_1_5_6.md +5 -5
- package/index.js +10 -2
- package/lib/crypto/bn.js +22 -2
- package/lib/crypto/hash.browser.js +13 -5
- package/lib/crypto/hash.js +58 -2
- package/lib/crypto/random.js +72 -15
- package/lib/didweb/index.js +88 -9
- package/lib/encoding/base58.js +67 -3
- package/lib/mnemonic/mnemonic.js +19 -5
- package/lib/mnemonic/pbkdf2.js +35 -2
- package/lib/script/interpreter.js +420 -58
- package/lib/transaction/input/multisig.js +1 -1
- package/lib/transaction/input/multisigscripthash.js +1 -1
- package/lib/transaction/input/publickey.js +1 -1
- package/lib/transaction/input/publickeyhash.js +1 -1
- package/lib/transaction/sighash.js +18 -6
- package/lib/transaction/signature.js +1 -1
- package/lib/util/inherits.js +37 -0
- package/package.json +7 -8
- package/test/consensus/base58-vectors.js +120 -0
- package/test/consensus/sv-script-vectors.js +81 -0
- package/test/consensus/sv-sighash-vectors.js +51 -0
- package/test/consensus/sv-tx-vectors.js +48 -0
- package/test/crypto/backend_selection.js +126 -0
- package/test/crypto/random.js +73 -0
- package/test/data/bitcoin-sv/README.md +170 -0
- package/test/data/bitcoin-sv/base58_encode_decode.json +14 -0
- package/test/data/bitcoin-sv/base58_keys_invalid.json +152 -0
- package/test/data/bitcoin-sv/base58_keys_valid.json +452 -0
- package/test/data/bitcoin-sv/script_tests.json +2591 -0
- package/test/data/bitcoin-sv/sighash.json +1003 -0
- package/test/data/bitcoin-sv/tx_invalid.json +285 -0
- package/test/data/bitcoin-sv/tx_valid.json +367 -0
- package/test/didweb/relationships.js +144 -0
- package/test/regressions.js +35 -0
- package/test/script/chronicle.js +170 -25
- package/test/script/defaults.js +93 -0
- package/test/script/genesis_limits.js +62 -6
- package/test/script/interpreter.js +24 -8
- package/test/transaction/sighash.js +21 -1
- package/test/transaction/unspentoutput.js +6 -1
- package/version.js +1 -1
package/docs/AUDIT_SCOPE.md
CHANGED
|
@@ -5,8 +5,7 @@ cryptographic core, and carries the enquiry text to send to vendors. It exists s
|
|
|
5
5
|
every vendor prices the *same* thing, and so that the reasoning behind the scope
|
|
6
6
|
boundary survives past the engagement that prompted it.
|
|
7
7
|
|
|
8
|
-
Measured against **
|
|
9
|
-
figures were first taken). Re-measure before sending if the version has
|
|
8
|
+
Measured against **v8.0.0**, 2026-08-13. Re-measure before sending if the version has
|
|
10
9
|
moved (`docs/AUDIT_SCOPE.md` is not covered by a drift gate).
|
|
11
10
|
|
|
12
11
|
## 1. The question we are asking
|
|
@@ -30,24 +29,24 @@ testing.
|
|
|
30
29
|
Two tiers, to be **priced separately** so the boundary can be drawn against a number
|
|
31
30
|
rather than before seeing one.
|
|
32
31
|
|
|
33
|
-
### Tier 1 — core,
|
|
32
|
+
### Tier 1 — core, 12,254 lines across 33 files
|
|
34
33
|
|
|
35
34
|
| Module | Lines | Why it matters |
|
|
36
35
|
| --- | ---: | --- |
|
|
37
|
-
| `lib/script/` | 3,
|
|
38
|
-
| `lib/transaction/` | 2,
|
|
39
|
-
| `lib/crypto/` | 2,
|
|
36
|
+
| `lib/script/` | 3,737 | Consensus script interpreter. Divergence from the node means accepting a transaction the network rejects, or the reverse. |
|
|
37
|
+
| `lib/transaction/` | 2,779 | Sighash construction and signing — both BIP-143 and the Original Transaction Digest Algorithm. |
|
|
38
|
+
| `lib/crypto/` | 2,519 | ECDSA, nonce derivation, signature encoding, the script-number type. |
|
|
40
39
|
| `lib/hdprivatekey.js`, `lib/hdpublickey.js` | 1,168 | BIP-32 derivation, including hardened paths. |
|
|
41
40
|
| `lib/privatekey.js`, `lib/publickey.js` | 843 | Key construction, serialisation, WIF. Recent defects here produced a *different* key without error. |
|
|
42
41
|
| `lib/address.js` | 543 | Address derivation and network binding. |
|
|
43
42
|
| `lib/networks.js`, `lib/opcode.js` | 665 | Network parameters and the opcode table, which BSV upgrades have reassigned. |
|
|
44
43
|
|
|
45
|
-
### Tier 2 — optional, 1,
|
|
44
|
+
### Tier 2 — optional, 1,607 lines
|
|
46
45
|
|
|
47
46
|
| Module | Lines | Why it may belong in scope |
|
|
48
47
|
| --- | ---: | --- |
|
|
49
|
-
| `lib/encoding/` |
|
|
50
|
-
| `lib/mnemonic/` |
|
|
48
|
+
| `lib/encoding/` | 708 | Base58Check, varint and buffer readers — the parsing surface untrusted bytes hit first. |
|
|
49
|
+
| `lib/mnemonic/` | 591 | BIP-39 seed derivation. Small, but a weakness here compromises every key beneath it. |
|
|
51
50
|
| `lib/ecies/` | 308 | Encryption built on audited primitives; the composition is ours. |
|
|
52
51
|
|
|
53
52
|
Tier 2 is cryptographic rather than application code, so excluding it is a **budget
|
|
@@ -59,19 +58,19 @@ is not.
|
|
|
59
58
|
| Component | Status | Reason |
|
|
60
59
|
| --- | --- | --- |
|
|
61
60
|
| `@noble/curves`, `@noble/hashes`, `@noble/ciphers` | Already audited | The primitives come from the Noble libraries, which **Cure53 has audited and published on**. We do not implement curve or hash arithmetic ourselves. State this explicitly to vendors — otherwise they price work we do not need. |
|
|
62
|
-
| `lib/smart_contract/`, `lib/ltp/`, `lib/gdaf/`, `lib/ordinals/`, `lib/block/`, plus 9 further directories and 6 top-level files | Excluded | Application layer, 22,
|
|
61
|
+
| `lib/smart_contract/`, `lib/ltp/`, `lib/gdaf/`, `lib/ordinals/`, `lib/block/`, plus 9 further directories and 6 top-level files | Excluded | Application layer, 22,815 lines — 18,435 in the five named modules and 4,380 in the remainder. Written in-house and covered by adversarial tests. Worth a separate engagement; including it here would blur the question in §1. |
|
|
63
62
|
|
|
64
|
-
Totals reconcile against `lib/`, which is
|
|
63
|
+
Totals reconcile against `lib/`, which is 36,676 lines across 123 files:
|
|
65
64
|
|
|
66
65
|
```
|
|
67
|
-
tier 1
|
|
68
|
-
tier 2 1,
|
|
69
|
-
excluded 22,
|
|
66
|
+
tier 1 12,254
|
|
67
|
+
tier 2 1,607
|
|
68
|
+
excluded 22,815
|
|
70
69
|
------
|
|
71
|
-
total
|
|
70
|
+
total 36,676
|
|
72
71
|
```
|
|
73
72
|
|
|
74
|
-
Core + optional = 13,
|
|
73
|
+
Core + optional = 13,861.
|
|
75
74
|
|
|
76
75
|
## 4. What an auditor gets on day one
|
|
77
76
|
|
|
@@ -83,10 +82,19 @@ Each of these should *reduce* the quote — they remove discovery work.
|
|
|
83
82
|
longer exist. Scope that honestly: the gate asserts existence and a minimum citation
|
|
84
83
|
count, not that the cited tests still assert anything — a test gutted in place would
|
|
85
84
|
pass it.
|
|
85
|
+
- **The reference node's own consensus vectors**, copied verbatim from
|
|
86
|
+
`bitcoin-sv/bitcoin-sv` v1.2.0 with provenance in `test/data/bitcoin-sv/README.md`, and
|
|
87
|
+
run as gates: 1483/1483 script vectors with zero false accepts and zero false rejects,
|
|
88
|
+
600/600 result codes, 161/161 transaction vectors, 1000/1000 digest vectors on both
|
|
89
|
+
routing columns. This is the single most useful thing here, and it did not exist before
|
|
90
|
+
v8.0.0 — the first run scored 1426/1483 with **21 false accepts**. An auditor can treat
|
|
91
|
+
consensus conformance as measured and spend the engagement on what the vectors cannot
|
|
92
|
+
reach: key handling, nonce generation, encoding, and the composition above the
|
|
93
|
+
interpreter.
|
|
86
94
|
- **`npm run conformance`** — 452 cases across 13 suites, freezing observable behaviour
|
|
87
95
|
so any change surfaces as a diff. A second, independently written implementation
|
|
88
96
|
(`smartledger-bsv-core`, the TypeScript port) agrees on all 452.
|
|
89
|
-
- **4,
|
|
97
|
+
- **4,461 passing tests**, plus a reproducible-bundle gate, a require-cycle gate, and a
|
|
90
98
|
type-drift gate that parses the published types against the runtime.
|
|
91
99
|
- **`SECURITY.md`** — a published advisory (GHSA-gw63-x79h-mhjc) and a changelog of
|
|
92
100
|
security fixes with the reasoning for each.
|
|
@@ -125,17 +133,17 @@ seeking a quote for an independent security review of its cryptographic core.
|
|
|
125
133
|
|
|
126
134
|
Scope, and we would like these priced separately:
|
|
127
135
|
|
|
128
|
-
Tier 1 —
|
|
136
|
+
Tier 1 — 12,254 lines, 33 files. Script interpreter, sighash and signing,
|
|
129
137
|
ECDSA and signature encoding, BIP-32 derivation, key and address
|
|
130
138
|
construction.
|
|
131
139
|
|
|
132
|
-
Tier 2 — 1,
|
|
140
|
+
Tier 2 — 1,607 lines. BIP-39 mnemonics, ECIES, and the Base58Check/varint
|
|
133
141
|
decoding surface.
|
|
134
142
|
|
|
135
143
|
JavaScript (CommonJS), Node >= 20.19. The code is public.
|
|
136
144
|
|
|
137
145
|
Explicitly out of scope: elliptic-curve and hash primitives, which are supplied
|
|
138
|
-
by the Noble libraries and already audited; and our 22,
|
|
146
|
+
by the Noble libraries and already audited; and our 22,815-line application
|
|
139
147
|
layer (credentials, tokens, ordinals), which we would treat as a separate
|
|
140
148
|
engagement.
|
|
141
149
|
|
|
@@ -163,7 +171,7 @@ SmartLedger Technology
|
|
|
163
171
|
Every figure in this document, including the excluded total, must come out of this
|
|
164
172
|
script. **Derive the excluded count as the complement — never by subtracting tier 1
|
|
165
173
|
alone.** The first draft did exactly that, double-counted tier 2, and published parts
|
|
166
|
-
summing to 37,430 against a
|
|
174
|
+
summing to 37,430 against a 36,676 whole; §7 could not catch it because it reproduced
|
|
167
175
|
every figure except the wrong one.
|
|
168
176
|
|
|
169
177
|
```sh
|
|
@@ -55,19 +55,19 @@ Three advanced modules totaling **~2.7MB** of functionality:
|
|
|
55
55
|
- **Purpose**: Threshold cryptography for secure secret distribution
|
|
56
56
|
- **Use Cases**: Backup keys, multi-party security, key recovery
|
|
57
57
|
- **Features**: Split secrets into N shares, require M to reconstruct
|
|
58
|
-
- **CDN**: `unpkg.com/@smartledger/bsv@
|
|
58
|
+
- **CDN**: `unpkg.com/@smartledger/bsv@8.0.0/bsv-shamir.min.js`
|
|
59
59
|
|
|
60
60
|
#### **🌐 Global Digital Attestation Framework - GDAF (1184KB)**
|
|
61
61
|
- **Purpose**: W3C Verifiable Credentials and decentralized identity
|
|
62
62
|
- **Use Cases**: Identity verification, attestations, zero-knowledge proofs
|
|
63
63
|
- **Features**: DID creation, credential issuance, selective disclosure
|
|
64
|
-
- **CDN**: `unpkg.com/@smartledger/bsv@
|
|
64
|
+
- **CDN**: `unpkg.com/@smartledger/bsv@8.0.0/bsv-gdaf.min.js`
|
|
65
65
|
|
|
66
66
|
#### **⚖️ Legal Token Protocol - LTP (1184KB)**
|
|
67
67
|
- **Purpose**: Legal compliance framework for tokenized assets
|
|
68
68
|
- **Use Cases**: Property rights, obligations, compliant tokenization
|
|
69
69
|
- **Features**: Legal primitives, compliance checking, attestation anchoring
|
|
70
|
-
- **CDN**: `unpkg.com/@smartledger/bsv@
|
|
70
|
+
- **CDN**: `unpkg.com/@smartledger/bsv@8.0.0/bsv-ltp.min.js`
|
|
71
71
|
|
|
72
72
|
### **2. Incorrect File Sizes in Documentation**
|
|
73
73
|
|
|
@@ -81,18 +81,18 @@ Three advanced modules totaling **~2.7MB** of functionality:
|
|
|
81
81
|
|
|
82
82
|
| Module | Size | Use Case | CDN Link |
|
|
83
83
|
|--------|------|----------|----------|
|
|
84
|
-
| **bsv.min.js** | 937KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@
|
|
85
|
-
| **bsv.bundle.js** | 937KB | Everything in one file | `unpkg.com/@smartledger/bsv@
|
|
86
|
-
| **bsv-smartcontract.min.js** | 937KB | Covenant development | `unpkg.com/@smartledger/bsv@
|
|
87
|
-
| **bsv-covenant.min.js** | 913KB | Covenant operations | `unpkg.com/@smartledger/bsv@
|
|
88
|
-
| **bsv-script-helper.min.js** | 26KB | Custom script tools | `unpkg.com/@smartledger/bsv@
|
|
89
|
-
| **bsv-security.min.js** | 26KB | Security enhancements (opt-in helpers — see README › Security) | `unpkg.com/@smartledger/bsv@
|
|
90
|
-
| **bsv-ecies.min.js** | 71KB | Encryption | `unpkg.com/@smartledger/bsv@
|
|
91
|
-
| **bsv-message.min.js** | 26KB | Message signing | `unpkg.com/@smartledger/bsv@
|
|
92
|
-
| **bsv-mnemonic.min.js** | 681KB | HD wallets | `unpkg.com/@smartledger/bsv@
|
|
93
|
-
| **🆕 bsv-shamir.min.js** | 432KB | **Secret sharing** | `unpkg.com/@smartledger/bsv@
|
|
94
|
-
| **🆕 bsv-gdaf.min.js** | 1184KB | **Digital attestation** | `unpkg.com/@smartledger/bsv@
|
|
95
|
-
| **🆕 bsv-ltp.min.js** | 1184KB | **Legal tokens** | `unpkg.com/@smartledger/bsv@
|
|
84
|
+
| **bsv.min.js** | 937KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js` |
|
|
85
|
+
| **bsv.bundle.js** | 937KB | Everything in one file | `unpkg.com/@smartledger/bsv@8.0.0/bsv.bundle.js` |
|
|
86
|
+
| **bsv-smartcontract.min.js** | 937KB | Covenant development | `unpkg.com/@smartledger/bsv@8.0.0/bsv-smartcontract.min.js` |
|
|
87
|
+
| **bsv-covenant.min.js** | 913KB | Covenant operations | `unpkg.com/@smartledger/bsv@8.0.0/bsv-covenant.min.js` |
|
|
88
|
+
| **bsv-script-helper.min.js** | 26KB | Custom script tools | `unpkg.com/@smartledger/bsv@8.0.0/bsv-script-helper.min.js` |
|
|
89
|
+
| **bsv-security.min.js** | 26KB | Security enhancements (opt-in helpers — see README › Security) | `unpkg.com/@smartledger/bsv@8.0.0/bsv-security.min.js` |
|
|
90
|
+
| **bsv-ecies.min.js** | 71KB | Encryption | `unpkg.com/@smartledger/bsv@8.0.0/bsv-ecies.min.js` |
|
|
91
|
+
| **bsv-message.min.js** | 26KB | Message signing | `unpkg.com/@smartledger/bsv@8.0.0/bsv-message.min.js` |
|
|
92
|
+
| **bsv-mnemonic.min.js** | 681KB | HD wallets | `unpkg.com/@smartledger/bsv@8.0.0/bsv-mnemonic.min.js` |
|
|
93
|
+
| **🆕 bsv-shamir.min.js** | 432KB | **Secret sharing** | `unpkg.com/@smartledger/bsv@8.0.0/bsv-shamir.min.js` |
|
|
94
|
+
| **🆕 bsv-gdaf.min.js** | 1184KB | **Digital attestation** | `unpkg.com/@smartledger/bsv@8.0.0/bsv-gdaf.min.js` |
|
|
95
|
+
| **🆕 bsv-ltp.min.js** | 1184KB | **Legal tokens** | `unpkg.com/@smartledger/bsv@8.0.0/bsv-ltp.min.js` |
|
|
96
96
|
|
|
97
97
|
## 🎯 **Updated Usage Examples**
|
|
98
98
|
|
|
@@ -100,22 +100,22 @@ Three advanced modules totaling **~2.7MB** of functionality:
|
|
|
100
100
|
|
|
101
101
|
#### **1. Basic Development (~963KB)**
|
|
102
102
|
```html
|
|
103
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
104
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
103
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
104
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-script-helper.min.js"></script>
|
|
105
105
|
```
|
|
106
106
|
|
|
107
107
|
#### **2. Smart Contract Development (~2.7MB — each bundle re-embeds core BSV)**
|
|
108
108
|
```html
|
|
109
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
110
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
111
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
109
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
110
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-covenant.min.js"></script>
|
|
111
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-smartcontract.min.js"></script>
|
|
112
112
|
```
|
|
113
113
|
|
|
114
114
|
#### **3. 🆕 Legal & Compliance Development (~3.2MB — each bundle re-embeds core BSV)**
|
|
115
115
|
```html
|
|
116
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
117
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
118
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
116
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
117
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-ltp.min.js"></script>
|
|
118
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-gdaf.min.js"></script>
|
|
119
119
|
<script>
|
|
120
120
|
// Legal Token Protocol
|
|
121
121
|
const legalToken = bsv.createLegalToken({
|
|
@@ -132,9 +132,9 @@ Three advanced modules totaling **~2.7MB** of functionality:
|
|
|
132
132
|
|
|
133
133
|
#### **4. 🆕 Security & Cryptography (~1.4MB)**
|
|
134
134
|
```html
|
|
135
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
136
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
137
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
135
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
136
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-security.min.js"></script>
|
|
137
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-shamir.min.js"></script>
|
|
138
138
|
<script>
|
|
139
139
|
// Shamir Secret Sharing
|
|
140
140
|
const shares = bsv.splitSecret('my_secret_key', 5, 3); // 5 shares, 3 needed
|
|
@@ -146,7 +146,7 @@ Three advanced modules totaling **~2.7MB** of functionality:
|
|
|
146
146
|
|
|
147
147
|
#### **5. Everything Bundle (937KB)**
|
|
148
148
|
```html
|
|
149
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
149
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.bundle.js"></script>
|
|
150
150
|
<script>
|
|
151
151
|
// Everything available immediately
|
|
152
152
|
const shares = bsv.splitSecret('secret', 5, 3);
|
|
@@ -722,7 +722,7 @@ interface UTXO {
|
|
|
722
722
|
<html>
|
|
723
723
|
<head>
|
|
724
724
|
<title>UTXO Manager Demo</title>
|
|
725
|
-
<script src="https://cdn.jsdelivr.net/npm/@smartledger/bsv@
|
|
725
|
+
<script src="https://cdn.jsdelivr.net/npm/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
726
726
|
</head>
|
|
727
727
|
<body>
|
|
728
728
|
<script>
|
|
@@ -48,7 +48,7 @@ const tx: Transaction = new Transaction();
|
|
|
48
48
|
#### **Core Library Only (937KB)**
|
|
49
49
|
For basic Bitcoin SV operations:
|
|
50
50
|
```html
|
|
51
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
51
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
52
52
|
<script>
|
|
53
53
|
const privateKey = new bsv.PrivateKey();
|
|
54
54
|
const address = privateKey.toAddress();
|
|
@@ -58,7 +58,7 @@ For basic Bitcoin SV operations:
|
|
|
58
58
|
#### **Complete Bundle (937KB)**
|
|
59
59
|
Everything in one file:
|
|
60
60
|
```html
|
|
61
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
61
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.bundle.js"></script>
|
|
62
62
|
<script>
|
|
63
63
|
// All features available immediately
|
|
64
64
|
const shares = bsv.splitSecret('secret', 5, 3);
|
|
@@ -71,9 +71,9 @@ Everything in one file:
|
|
|
71
71
|
|
|
72
72
|
#### **Smart Contract Development (~2.7MB total — each bundle is self-contained and re-embeds core BSV)**
|
|
73
73
|
```html
|
|
74
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
75
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
76
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
74
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
75
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-covenant.min.js"></script>
|
|
76
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-smartcontract.min.js"></script>
|
|
77
77
|
<script>
|
|
78
78
|
const covenant = bsv.SmartContract.createCovenantBuilder()
|
|
79
79
|
.extractField('amount').push(50000).greaterThanOrEqual().build();
|
|
@@ -82,9 +82,9 @@ Everything in one file:
|
|
|
82
82
|
|
|
83
83
|
#### **Legal & Identity Development (~3.2MB total — each bundle is self-contained and re-embeds core BSV)**
|
|
84
84
|
```html
|
|
85
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
86
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
87
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
85
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
86
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-ltp.min.js"></script>
|
|
87
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-gdaf.min.js"></script>
|
|
88
88
|
<script>
|
|
89
89
|
// Legal Token Protocol
|
|
90
90
|
const propertyToken = bsv.createPropertyToken({
|
|
@@ -98,9 +98,9 @@ Everything in one file:
|
|
|
98
98
|
|
|
99
99
|
#### **Security & Cryptography (~1.4MB total — each bundle is self-contained and re-embeds core BSV)**
|
|
100
100
|
```html
|
|
101
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
102
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
103
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
101
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
102
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-security.min.js"></script>
|
|
103
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-shamir.min.js"></script>
|
|
104
104
|
<script>
|
|
105
105
|
// Threshold Cryptography
|
|
106
106
|
const shares = bsv.splitSecret('my_secret_key', 5, 3);
|
|
@@ -114,18 +114,18 @@ Everything in one file:
|
|
|
114
114
|
|
|
115
115
|
| Module | Size | Purpose | CDN Link |
|
|
116
116
|
|--------|------|---------|----------|
|
|
117
|
-
| **bsv.min.js** | 937KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@
|
|
118
|
-
| **bsv.bundle.js** | 937KB | Everything in one file | `unpkg.com/@smartledger/bsv@
|
|
119
|
-
| **bsv-smartcontract.min.js** | 937KB | Complete covenant framework | `unpkg.com/@smartledger/bsv@
|
|
120
|
-
| **bsv-ltp.min.js** | 1184KB | **Legal Token Protocol** | `unpkg.com/@smartledger/bsv@
|
|
121
|
-
| **bsv-gdaf.min.js** | 1184KB | **Digital Identity & Attestation** | `unpkg.com/@smartledger/bsv@
|
|
122
|
-
| **bsv-shamir.min.js** | 432KB | **Threshold Cryptography** | `unpkg.com/@smartledger/bsv@
|
|
123
|
-
| **bsv-security.min.js** | 26KB | Security enhancements (opt-in helpers — see README › Security) | `unpkg.com/@smartledger/bsv@
|
|
124
|
-
| **bsv-mnemonic.min.js** | 681KB | HD wallets | `unpkg.com/@smartledger/bsv@
|
|
125
|
-
| **bsv-ecies.min.js** | 71KB | Encryption | `unpkg.com/@smartledger/bsv@
|
|
126
|
-
| **bsv-covenant.min.js** | 913KB | Covenant operations | `unpkg.com/@smartledger/bsv@
|
|
127
|
-
| **bsv-script-helper.min.js** | 26KB | Custom script tools | `unpkg.com/@smartledger/bsv@
|
|
128
|
-
| **bsv-message.min.js** | 26KB | Message signing | `unpkg.com/@smartledger/bsv@
|
|
117
|
+
| **bsv.min.js** | 937KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js` |
|
|
118
|
+
| **bsv.bundle.js** | 937KB | Everything in one file | `unpkg.com/@smartledger/bsv@8.0.0/bsv.bundle.js` |
|
|
119
|
+
| **bsv-smartcontract.min.js** | 937KB | Complete covenant framework | `unpkg.com/@smartledger/bsv@8.0.0/bsv-smartcontract.min.js` |
|
|
120
|
+
| **bsv-ltp.min.js** | 1184KB | **Legal Token Protocol** | `unpkg.com/@smartledger/bsv@8.0.0/bsv-ltp.min.js` |
|
|
121
|
+
| **bsv-gdaf.min.js** | 1184KB | **Digital Identity & Attestation** | `unpkg.com/@smartledger/bsv@8.0.0/bsv-gdaf.min.js` |
|
|
122
|
+
| **bsv-shamir.min.js** | 432KB | **Threshold Cryptography** | `unpkg.com/@smartledger/bsv@8.0.0/bsv-shamir.min.js` |
|
|
123
|
+
| **bsv-security.min.js** | 26KB | Security enhancements (opt-in helpers — see README › Security) | `unpkg.com/@smartledger/bsv@8.0.0/bsv-security.min.js` |
|
|
124
|
+
| **bsv-mnemonic.min.js** | 681KB | HD wallets | `unpkg.com/@smartledger/bsv@8.0.0/bsv-mnemonic.min.js` |
|
|
125
|
+
| **bsv-ecies.min.js** | 71KB | Encryption | `unpkg.com/@smartledger/bsv@8.0.0/bsv-ecies.min.js` |
|
|
126
|
+
| **bsv-covenant.min.js** | 913KB | Covenant operations | `unpkg.com/@smartledger/bsv@8.0.0/bsv-covenant.min.js` |
|
|
127
|
+
| **bsv-script-helper.min.js** | 26KB | Custom script tools | `unpkg.com/@smartledger/bsv@8.0.0/bsv-script-helper.min.js` |
|
|
128
|
+
| **bsv-message.min.js** | 26KB | Message signing | `unpkg.com/@smartledger/bsv@8.0.0/bsv-message.min.js` |
|
|
129
129
|
|
|
130
130
|
## ⚙️ **Development Environment Setup**
|
|
131
131
|
|
|
@@ -14,10 +14,10 @@ npm install @smartledger/bsv
|
|
|
14
14
|
### Browser CDN (Instant)
|
|
15
15
|
```html
|
|
16
16
|
<!-- Core library (937KB) -->
|
|
17
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
17
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
18
18
|
|
|
19
19
|
<!-- Everything included (937KB) -->
|
|
20
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
20
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.bundle.js"></script>
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
## 💰 **Your First Transaction (60 seconds)**
|
|
@@ -127,19 +127,19 @@ SmartLedger-BSV offers 12 different loading options - use only what you need:
|
|
|
127
127
|
|
|
128
128
|
```html
|
|
129
129
|
<!-- Core BSV only (937KB) -->
|
|
130
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
130
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
131
131
|
|
|
132
132
|
<!-- Smart contracts (937KB) -->
|
|
133
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
133
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-smartcontract.min.js"></script>
|
|
134
134
|
|
|
135
135
|
<!-- Legal tokens (1.16MB) -->
|
|
136
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
136
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-ltp.min.js"></script>
|
|
137
137
|
|
|
138
138
|
<!-- Digital identity (1.16MB) -->
|
|
139
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
139
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-gdaf.min.js"></script>
|
|
140
140
|
|
|
141
141
|
<!-- Everything (937KB) -->
|
|
142
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
142
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.bundle.js"></script>
|
|
143
143
|
```
|
|
144
144
|
|
|
145
145
|
## ⚡ **Key Advantages**
|
|
@@ -159,17 +159,17 @@ const recovered = bsv.reconstructSecret([shares[0], shares[2], shares[4]]);
|
|
|
159
159
|
### **New Modular Options**
|
|
160
160
|
```html
|
|
161
161
|
<!-- Core compatibility (same size as bsv@1.5.6) -->
|
|
162
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
162
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.min.js"></script>
|
|
163
163
|
|
|
164
164
|
<!-- Add smart contracts when ready -->
|
|
165
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
165
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-smartcontract.min.js"></script>
|
|
166
166
|
|
|
167
167
|
<!-- Add advanced features as needed -->
|
|
168
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
169
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
168
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-ltp.min.js"></script>
|
|
169
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv-gdaf.min.js"></script>
|
|
170
170
|
|
|
171
171
|
<!-- Everything in one file -->
|
|
172
|
-
<script src="https://unpkg.com/@smartledger/bsv@
|
|
172
|
+
<script src="https://unpkg.com/@smartledger/bsv@8.0.0/bsv.bundle.js"></script>
|
|
173
173
|
```
|
|
174
174
|
|
|
175
175
|
## 🔍 **Testing Your Migration**
|
package/index.js
CHANGED
|
@@ -24,14 +24,22 @@ bsv.deps = bsv.deps || {}
|
|
|
24
24
|
bsv.deps._ = require('./lib/util/_')
|
|
25
25
|
bsv.deps.Buffer = (typeof Buffer !== 'undefined') ? Buffer : null
|
|
26
26
|
|
|
27
|
+
// `bsv.deps.bs58` is kept as a compatible facade rather than the `bs58` package, which
|
|
28
|
+
// this library no longer depends on — the encoder now lives in lib/encoding/base58.js.
|
|
29
|
+
// The contract callers rely on is unchanged: `encode(Buffer) -> string` and
|
|
30
|
+
// `decode(string) -> bytes` (a Buffer, which is a Uint8Array, as bs58 also returned).
|
|
31
|
+
var Base58Dep = require('./lib/encoding/base58')
|
|
32
|
+
bsv.deps.bs58 = {
|
|
33
|
+
encode: Base58Dep.encode,
|
|
34
|
+
decode: Base58Dep.decode
|
|
35
|
+
}
|
|
36
|
+
|
|
27
37
|
if (typeof window === 'undefined') {
|
|
28
38
|
// Node — hard require; failure means broken install.
|
|
29
39
|
bsv.deps.bnjs = require('bn.js')
|
|
30
|
-
bsv.deps.bs58 = require('bs58')
|
|
31
40
|
} else {
|
|
32
41
|
// Browser — bundler-resolved; tolerate absence individually.
|
|
33
42
|
try { bsv.deps.bnjs = require('bn.js') } catch (e) { /* polyfilled by bundler */ }
|
|
34
|
-
try { bsv.deps.bs58 = require('bs58') } catch (e) { /* polyfilled by bundler */ }
|
|
35
43
|
}
|
|
36
44
|
|
|
37
45
|
// module information (./version is generated from package.json by the `version` npm hook;
|
package/lib/crypto/bn.js
CHANGED
|
@@ -174,6 +174,23 @@ BN.prototype.toSM = function (opts) {
|
|
|
174
174
|
return buf
|
|
175
175
|
}
|
|
176
176
|
|
|
177
|
+
/**
|
|
178
|
+
* An error carrying the node's own result code for the failure.
|
|
179
|
+
*
|
|
180
|
+
* Script number decoding fails for two consensus reasons, and both are named
|
|
181
|
+
* in the node's script vectors — SCRIPT_ERR_SCRIPTNUM_OVERFLOW and
|
|
182
|
+
* SCRIPT_ERR_SCRIPTNUM_MINENCODE. This layer knows which one it hit, and the
|
|
183
|
+
* interpreter's evaluator is where that has to be reported, so the code
|
|
184
|
+
* travels on the error rather than being guessed from its message. An error
|
|
185
|
+
* without a `scriptErr` really is unknown to the interpreter and is still
|
|
186
|
+
* reported as such.
|
|
187
|
+
*/
|
|
188
|
+
function scriptNumError (message, scriptErr) {
|
|
189
|
+
var err = new Error(message)
|
|
190
|
+
err.scriptErr = scriptErr
|
|
191
|
+
return err
|
|
192
|
+
}
|
|
193
|
+
|
|
177
194
|
/**
|
|
178
195
|
* Create a BN from a "ScriptNum": This is analogous to the constructor for
|
|
179
196
|
* CScriptNum in bitcoind. Many ops in bitcoind's script interpreter use
|
|
@@ -188,7 +205,9 @@ BN.prototype.toSM = function (opts) {
|
|
|
188
205
|
*/
|
|
189
206
|
BN.fromScriptNumBuffer = function (buf, fRequireMinimal, size) {
|
|
190
207
|
var nMaxNumSize = size || 4
|
|
191
|
-
|
|
208
|
+
if (buf.length > nMaxNumSize) {
|
|
209
|
+
throw scriptNumError('script number overflow', 'SCRIPT_ERR_SCRIPTNUM_OVERFLOW')
|
|
210
|
+
}
|
|
192
211
|
if (fRequireMinimal && buf.length > 0) {
|
|
193
212
|
// Check that the number is encoded with the minimum possible
|
|
194
213
|
// number of bytes.
|
|
@@ -203,7 +222,8 @@ BN.fromScriptNumBuffer = function (buf, fRequireMinimal, size) {
|
|
|
203
222
|
// is +-255, which encode to 0xff00 and 0xff80 respectively.
|
|
204
223
|
// (big-endian).
|
|
205
224
|
if (buf.length <= 1 || (buf[buf.length - 2] & 0x80) === 0) {
|
|
206
|
-
throw
|
|
225
|
+
throw scriptNumError('non-minimally encoded script number',
|
|
226
|
+
'SCRIPT_ERR_SCRIPTNUM_MINENCODE')
|
|
207
227
|
}
|
|
208
228
|
}
|
|
209
229
|
}
|
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
'use strict'
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
// The browser digests come from @noble/hashes — the same audited implementation the
|
|
4
|
+
// Node path's primitives ultimately rest on, and already a dependency here for
|
|
5
|
+
// @noble/curves. Previously this file used `hash.js`, so the browser bundle and Node
|
|
6
|
+
// computed the same digests via two different implementations; one of them was audited.
|
|
7
|
+
//
|
|
8
|
+
// Only the four raw digests came from that dependency. `Hash.hmac` below is
|
|
9
|
+
// hand-implemented against `hashf.blocksize` and is unchanged.
|
|
10
|
+
var { sha256, sha512 } = require('@noble/hashes/sha2.js')
|
|
11
|
+
var { sha1, ripemd160 } = require('@noble/hashes/legacy.js')
|
|
4
12
|
var $ = require('../util/preconditions')
|
|
5
13
|
|
|
6
14
|
var Hash = module.exports
|
|
@@ -16,7 +24,7 @@ var Hash = module.exports
|
|
|
16
24
|
*/
|
|
17
25
|
Hash.sha1 = function (buf) {
|
|
18
26
|
$.checkArgument(Buffer.isBuffer(buf))
|
|
19
|
-
return Buffer.from(
|
|
27
|
+
return Buffer.from(sha1(buf))
|
|
20
28
|
}
|
|
21
29
|
|
|
22
30
|
Hash.sha1.blocksize = 512
|
|
@@ -32,7 +40,7 @@ Hash.sha1.blocksize = 512
|
|
|
32
40
|
*/
|
|
33
41
|
Hash.sha256 = function (buf) {
|
|
34
42
|
$.checkArgument(Buffer.isBuffer(buf))
|
|
35
|
-
return Buffer.from(
|
|
43
|
+
return Buffer.from(sha256(buf))
|
|
36
44
|
}
|
|
37
45
|
|
|
38
46
|
Hash.sha256.blocksize = 512
|
|
@@ -64,7 +72,7 @@ Hash.sha256sha256 = function (buf) {
|
|
|
64
72
|
*/
|
|
65
73
|
Hash.ripemd160 = function (buf) {
|
|
66
74
|
$.checkArgument(Buffer.isBuffer(buf))
|
|
67
|
-
return Buffer.from(
|
|
75
|
+
return Buffer.from(ripemd160(buf))
|
|
68
76
|
}
|
|
69
77
|
/**
|
|
70
78
|
* A RIPEMD160 hash of a SHA256 hash, which is always 160 bits or 20 bytes long.
|
|
@@ -93,7 +101,7 @@ Hash.sha256ripemd160 = function (buf) {
|
|
|
93
101
|
*/
|
|
94
102
|
Hash.sha512 = function (buf) {
|
|
95
103
|
$.checkArgument(Buffer.isBuffer(buf))
|
|
96
|
-
return Buffer.from(
|
|
104
|
+
return Buffer.from(sha512(buf))
|
|
97
105
|
}
|
|
98
106
|
|
|
99
107
|
Hash.sha512.blocksize = 1024
|
package/lib/crypto/hash.js
CHANGED
|
@@ -1,2 +1,58 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
'use strict'
|
|
2
|
+
|
|
3
|
+
// Pick the hashing backend by CAPABILITY, not by `process.browser`.
|
|
4
|
+
//
|
|
5
|
+
// This file used to read `process.browser`, a Browserify-era convention that is
|
|
6
|
+
// undefined in React Native, Deno, Cloudflare Workers and Bun. All of them took the
|
|
7
|
+
// node branch and required('crypto'), which in React Native fails outright or — worse —
|
|
8
|
+
// resolves to a partial shim. See lib/crypto/random.js for the same bug in the CSPRNG.
|
|
9
|
+
//
|
|
10
|
+
// Node's implementation is kept as the preferred backend rather than always using
|
|
11
|
+
// @noble/hashes, because it is materially faster on the payload sizes this library
|
|
12
|
+
// actually hashes in bulk: measured at parity for 32 bytes (1.2x) but ~10x for 64 KB
|
|
13
|
+
// and above, which is block parsing and document anchoring.
|
|
14
|
+
//
|
|
15
|
+
// Two capability checks, not one:
|
|
16
|
+
//
|
|
17
|
+
// - The digests must be CORRECT, verified against known-answer vectors. A partial
|
|
18
|
+
// crypto shim that supplies a wrong or stubbed createHash would otherwise silently
|
|
19
|
+
// corrupt every hash in the library. Falling back to the audited pure-JS
|
|
20
|
+
// implementation is always safe; trusting an unknown shim is not.
|
|
21
|
+
// - `ripemd160` must be present. OpenSSL 3 moved it to the legacy provider, so some
|
|
22
|
+
// Node builds have sha256 but throw on ripemd160 — which is what addresses are
|
|
23
|
+
// built from, making this a real failure and not a theoretical one.
|
|
24
|
+
//
|
|
25
|
+
// The probe costs four hashes of three bytes, once, at module load.
|
|
26
|
+
|
|
27
|
+
var VECTORS = {
|
|
28
|
+
sha1: 'a9993e364706816aba3e25717850c26c9cd0d89d',
|
|
29
|
+
sha256: 'ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad',
|
|
30
|
+
sha512: 'ddaf35a193617abacc417349ae20413112e6fa4e89a97ea20a9eeee64b55d39a' +
|
|
31
|
+
'2192992a274fc1a836ba3c23a3feebbd454d4423643ce80e2a9ac94fa54ca49f',
|
|
32
|
+
ripemd160: '8eb208f7e05d987a9b044a8e98c6b087f15a0bfc'
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
function nodeHashesAreUsable () {
|
|
36
|
+
var crypto
|
|
37
|
+
try {
|
|
38
|
+
crypto = require('crypto')
|
|
39
|
+
} catch (e) {
|
|
40
|
+
return false
|
|
41
|
+
}
|
|
42
|
+
if (!crypto || typeof crypto.createHash !== 'function') return false
|
|
43
|
+
|
|
44
|
+
var algorithms = Object.keys(VECTORS)
|
|
45
|
+
for (var i = 0; i < algorithms.length; i++) {
|
|
46
|
+
var algorithm = algorithms[i]
|
|
47
|
+
try {
|
|
48
|
+
if (crypto.createHash(algorithm).update('abc').digest('hex') !== VECTORS[algorithm]) {
|
|
49
|
+
return false
|
|
50
|
+
}
|
|
51
|
+
} catch (e) {
|
|
52
|
+
return false
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
return true
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
module.exports = nodeHashesAreUsable() ? require('./hash.node') : require('./hash.browser')
|