@smartledger/bsv 9.2.0 → 9.3.0

package/docs/getting-started/INSTALLATION.md

@@ -48,7 +48,7 @@ const tx: Transaction = new Transaction();
 #### **Core Library Only (937KB)**
 For basic Bitcoin SV operations:
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
 <script>
   const privateKey = new bsv.PrivateKey();
   const address = privateKey.toAddress();
@@ -58,7 +58,7 @@ For basic Bitcoin SV operations:
 #### **Complete Bundle (937KB)**  
 Everything in one file:
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.bundle.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.bundle.js"></script>
 <script>
   // All features available immediately
   const shares = bsv.splitSecret('secret', 5, 3);
@@ -71,9 +71,9 @@ Everything in one file:
 
 #### **Smart Contract Development (~2.7MB total — each bundle is self-contained and re-embeds core BSV)**
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-covenant.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-smartcontract.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-covenant.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-smartcontract.min.js"></script>
 <script>
   const covenant = bsv.SmartContract.createCovenantBuilder()
     .extractField('amount').push(50000).greaterThanOrEqual().build();
@@ -82,9 +82,9 @@ Everything in one file:
 
 #### **Legal & Identity Development (~3.2MB total — each bundle is self-contained and re-embeds core BSV)**
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-ltp.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-gdaf.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-ltp.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-gdaf.min.js"></script>
 <script>
   // Legal Token Protocol
   const propertyToken = bsv.createPropertyToken({
@@ -98,9 +98,9 @@ Everything in one file:
 
 #### **Security & Cryptography (~1.4MB total — each bundle is self-contained and re-embeds core BSV)**
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-security.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-shamir.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-security.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-shamir.min.js"></script>
 <script>
   // Threshold Cryptography
   const shares = bsv.splitSecret('my_secret_key', 5, 3);
@@ -114,18 +114,18 @@ Everything in one file:
 
 | Module | Size | Purpose | CDN Link |
 |--------|------|---------|----------|
-| **bsv.min.js** | 937KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@9.2.0/bsv.min.js` |
-| **bsv.bundle.js** | 937KB | Everything in one file | `unpkg.com/@smartledger/bsv@9.2.0/bsv.bundle.js` |
-| **bsv-smartcontract.min.js** | 937KB | Complete covenant framework | `unpkg.com/@smartledger/bsv@9.2.0/bsv-smartcontract.min.js` |
-| **bsv-ltp.min.js** | 1184KB | **Legal Token Protocol** | `unpkg.com/@smartledger/bsv@9.2.0/bsv-ltp.min.js` |
-| **bsv-gdaf.min.js** | 1184KB | **Digital Identity & Attestation** | `unpkg.com/@smartledger/bsv@9.2.0/bsv-gdaf.min.js` |
-| **bsv-shamir.min.js** | 432KB | **Threshold Cryptography** | `unpkg.com/@smartledger/bsv@9.2.0/bsv-shamir.min.js` |
-| **bsv-security.min.js** | 26KB | Security enhancements (opt-in helpers — see README › Security) | `unpkg.com/@smartledger/bsv@9.2.0/bsv-security.min.js` |
-| **bsv-mnemonic.min.js** | 681KB | HD wallets | `unpkg.com/@smartledger/bsv@9.2.0/bsv-mnemonic.min.js` |
-| **bsv-ecies.min.js** | 71KB | Encryption | `unpkg.com/@smartledger/bsv@9.2.0/bsv-ecies.min.js` |
-| **bsv-covenant.min.js** | 913KB | Covenant operations | `unpkg.com/@smartledger/bsv@9.2.0/bsv-covenant.min.js` |
-| **bsv-script-helper.min.js** | 26KB | Custom script tools | `unpkg.com/@smartledger/bsv@9.2.0/bsv-script-helper.min.js` |
-| **bsv-message.min.js** | 26KB | Message signing | `unpkg.com/@smartledger/bsv@9.2.0/bsv-message.min.js` |
+| **bsv.min.js** | 937KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js` |
+| **bsv.bundle.js** | 937KB | Everything in one file | `unpkg.com/@smartledger/bsv@9.3.0/bsv.bundle.js` |
+| **bsv-smartcontract.min.js** | 937KB | Complete covenant framework | `unpkg.com/@smartledger/bsv@9.3.0/bsv-smartcontract.min.js` |
+| **bsv-ltp.min.js** | 1184KB | **Legal Token Protocol** | `unpkg.com/@smartledger/bsv@9.3.0/bsv-ltp.min.js` |
+| **bsv-gdaf.min.js** | 1184KB | **Digital Identity & Attestation** | `unpkg.com/@smartledger/bsv@9.3.0/bsv-gdaf.min.js` |
+| **bsv-shamir.min.js** | 432KB | **Threshold Cryptography** | `unpkg.com/@smartledger/bsv@9.3.0/bsv-shamir.min.js` |
+| **bsv-security.min.js** | 26KB | Security enhancements (opt-in helpers — see README › Security) | `unpkg.com/@smartledger/bsv@9.3.0/bsv-security.min.js` |
+| **bsv-mnemonic.min.js** | 681KB | HD wallets | `unpkg.com/@smartledger/bsv@9.3.0/bsv-mnemonic.min.js` |
+| **bsv-ecies.min.js** | 71KB | Encryption | `unpkg.com/@smartledger/bsv@9.3.0/bsv-ecies.min.js` |
+| **bsv-covenant.min.js** | 913KB | Covenant operations | `unpkg.com/@smartledger/bsv@9.3.0/bsv-covenant.min.js` |
+| **bsv-script-helper.min.js** | 26KB | Custom script tools | `unpkg.com/@smartledger/bsv@9.3.0/bsv-script-helper.min.js` |
+| **bsv-message.min.js** | 26KB | Message signing | `unpkg.com/@smartledger/bsv@9.3.0/bsv-message.min.js` |
 
 ## ⚙️ **Development Environment Setup**
 

package/docs/getting-started/QUICK_START.md

@@ -14,10 +14,10 @@ npm install @smartledger/bsv
 ### Browser CDN (Instant)
 ```html
 <!-- Core library (937KB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
 
 <!-- Everything included (937KB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.bundle.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.bundle.js"></script>
 ```
 
 ## 💰 **Your First Transaction (60 seconds)**
@@ -127,19 +127,19 @@ SmartLedger-BSV offers 12 different loading options - use only what you need:
 
 ```html
 <!-- Core BSV only (937KB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
 
 <!-- Smart contracts (937KB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-smartcontract.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-smartcontract.min.js"></script>
 
 <!-- Legal tokens (1.16MB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-ltp.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-ltp.min.js"></script>
 
 <!-- Digital identity (1.16MB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-gdaf.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-gdaf.min.js"></script>
 
 <!-- Everything (937KB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.bundle.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.bundle.js"></script>
 ```
 
 ## ⚡ **Key Advantages**

package/docs/migration/FROM_BSV_1_5_6.md

@@ -159,17 +159,17 @@ const recovered = bsv.reconstructSecret([shares[0], shares[2], shares[4]]);
 ### **New Modular Options** 
 ```html
 <!-- Core compatibility (same size as bsv@1.5.6) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
 
 <!-- Add smart contracts when ready -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-smartcontract.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-smartcontract.min.js"></script>
 
 <!-- Add advanced features as needed -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-ltp.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv-gdaf.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-ltp.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-gdaf.min.js"></script>
 
 <!-- Everything in one file -->
-<script src="https://unpkg.com/@smartledger/bsv@9.2.0/bsv.bundle.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.bundle.js"></script>
 ```
 
 ## 🔍 **Testing Your Migration**

package/gdaf-entry.d.ts

@@ -0,0 +1,7 @@
+/**
+ * GDAF — governed data anchoring.
+ *
+ * Same class as `require("@smartledger/bsv").GDAF`.
+ */
+import { GDAF } from '@smartledger/bsv';
+export = GDAF;

package/lib/ordinals/inscription.js

@@ -89,6 +89,103 @@ function resolveLock (params) {
   throw new Error('buildInscription requires an address or a lock script')
 }
 
+// Tags the Ordinals spec names. Everything else is "unrecognized", and the spec
+// treats unrecognized tags by parity — see assertTagIsSafe.
+var KNOWN_TAGS = [0, 1, 2, 3, 5, 7, 9, 11]
+
+var BODY_TAG = 0
+var CONTENT_TYPE_TAG = 1
+
+/**
+ * Push a field tag the way a parser expects to read it back.
+ *
+ * Tags are script numbers. 1..16 have dedicated opcodes; anything larger has no
+ * opcode form at all, because OP_16 is the largest numeric opcode — so tag 21
+ * must be a data push. Indexers read the resulting STACK ELEMENT, so `OP_5` and
+ * a one-byte push of `0x05` are the same tag; the opcode form is used wherever
+ * it exists because the data-push form of a small number is non-minimal, and
+ * non-minimal pushes are non-standard.
+ */
+function addTag (script, tag) {
+  if (tag >= 1 && tag <= 16) return script.add(Opcode.OP_1 - 1 + tag)
+
+  var le = []
+  var n = tag
+  while (n > 0) { le.push(n & 0xff); n = Math.floor(n / 256) }
+  // A script number carries its sign in the high bit of its last byte, so a
+  // value ending >= 0x80 needs a zero pad or it reads back negative.
+  if (le[le.length - 1] & 0x80) le.push(0x00)
+  return script.add(Buffer.from(le))
+}
+
+/**
+ * Refuse a tag that would produce a permanently broken inscription.
+ *
+ * The parity rule is the one that costs money. From the spec: "inscriptions with
+ * unrecognized even fields must be displayed as unbound, that is, without a
+ * location". An unknown ODD tag is simply ignored by an indexer that does not
+ * know it; an unknown EVEN tag costs the inscription its location, everywhere,
+ * permanently, on an output already paid for — and nothing local reports it,
+ * because a builder and its own parser agreeing proves only that they agree.
+ *
+ * This refuses rather than warns, but it is deliberately not a hard wall. The
+ * set of named tags grows as the protocol does, so a library that can never be
+ * overridden would eventually be wrong AND unbypassable, and the workaround —
+ * hand-assembling envelope bytes — is far more dangerous than the thing being
+ * prevented. Hence `allowUnknownEvenFields`, which exists to be reached for
+ * knowingly and named so it cannot be passed by accident.
+ */
+function assertTagIsSafe (tag, allowUnknownEven) {
+  if (!Number.isSafeInteger(tag) || tag < 0) {
+    throw new Error('field tag must be a non-negative integer, got ' + JSON.stringify(tag))
+  }
+  if (tag === BODY_TAG) {
+    throw new Error('field tag 0 opens the inscription body and cannot carry a field: ' +
+      'anything pushed after it becomes part of the content')
+  }
+  if (tag === CONTENT_TYPE_TAG) {
+    throw new Error('field tag 1 is the content type; pass `contentType` instead of ' +
+      'a field, or the inscription declares it twice')
+  }
+  if (tag % 2 === 0 && KNOWN_TAGS.indexOf(tag) === -1 && !allowUnknownEven) {
+    throw new Error('field tag ' + tag + ' is an unrecognized even tag. The Ordinals ' +
+      'spec requires such an inscription to be treated as unbound — it would be ' +
+      'indexed without a location, permanently, and nothing local would report it. ' +
+      'Use an odd tag, or pass { allowUnknownEvenFields: true } if you have ' +
+      'established that every indexer you care about recognises ' + tag + '.')
+  }
+}
+
+/**
+ * Normalise `params.fields` into ordered [tag, value] pairs.
+ *
+ * Emitted in ascending tag order rather than in whatever order the object was
+ * written, so the same fields always produce the same bytes. Field order is not
+ * significant to a parser before the body opens, but reproducibility is worth
+ * more than honouring insertion order nobody specified.
+ */
+function resolveFields (params) {
+  var fields = params.fields
+  if (fields == null) return []
+  if (typeof fields !== 'object' || Array.isArray(fields) || Buffer.isBuffer(fields)) {
+    throw new Error('fields must be an object of tag numbers to values, e.g. { 5: metadata }')
+  }
+
+  return Object.keys(fields)
+    .filter(function (k) { return fields[k] != null })
+    .map(function (k) {
+      var tag = Number(k)
+      assertTagIsSafe(tag, params.allowUnknownEvenFields)
+      var value = toBuf(fields[k], 'field ' + tag)
+      if (!value.length) {
+        throw new Error('field ' + tag + ' has an empty value; omit the field instead ' +
+          'of inscribing a zero-length one permanently')
+      }
+      return [tag, value]
+    })
+    .sort(function (a, b) { return a[0] - b[0] })
+}
+
 /**
  * Build a 1Sat Ordinals inscription locking script: a base lock followed by the
  * inert `OP_FALSE OP_IF ... OP_ENDIF` envelope carrying the content.
@@ -106,6 +203,12 @@ function resolveLock (params) {
  *   with `address`)
  * @param {Address|string} [params.address]     P2PKH owner (mutually exclusive with `lock`)
  * @param {boolean} [params.allowEmptyLock]     permit an empty base lock; see resolveLock
+ * @param {object} [params.fields]              additional envelope fields as tag numbers
+ *   to values, e.g. `{ 5: manifest, 21: thumbnail }`. Tag 5 is `metadata`, the spec's
+ *   own home for an object's own record. Emitted in ascending tag order, between the
+ *   content type and the body. Unrecognized EVEN tags are refused — see assertTagIsSafe.
+ * @param {boolean} [params.allowUnknownEvenFields] permit an unrecognized even tag.
+ *   Costs the inscription its location in conformant indexers, permanently.
  * @returns {Script} the full inscription locking script
  */
 function buildInscription (params) {
@@ -135,12 +238,21 @@ function buildInscription (params) {
   }
 
   // Clone the base lock so we never mutate the caller's Script.
+  var fields = resolveFields(params)
+
   var s = Script.fromBuffer(lock.toBuffer())
   s.add(Opcode.OP_FALSE)
   s.add(Opcode.OP_IF)
   s.add(ORD)
   s.add(Opcode.OP_1)
   s.add(contentType)
+  // Every field goes here, between the content type and the body. Tag 0 opens
+  // the body and everything after it IS the body, so a field emitted late does
+  // not fail — it silently becomes part of the file.
+  fields.forEach(function (f) {
+    addTag(s, f[0])
+    s.add(f[1])
+  })
   s.add(Opcode.OP_0)
   s.add(content)
   s.add(Opcode.OP_ENDIF)

package/ltp-entry.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Legal Token Protocol — rights, claims, obligations, and their registry.
+ *
+ * Same class as `require("@smartledger/bsv").LTP`, including its statics.
+ */
+import { LTP } from '@smartledger/bsv';
+export = LTP;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartledger/bsv",
-  "version": "9.2.0",
+  "version": "9.3.0",
   "description": "Bitcoin SV library with an interpreter-verified script engine: OP_PUSH_TX covenants, BIP-143 preimage tooling, and consensus flags that match what miners actually enforce. Also ships DID:web / W3C VC-JWT credentials and the Legal Token Protocol.",
   "author": "SmartLedger Technology <hello@smartledger.technology> (https://smartledger.technology)",
   "homepage": "https://github.com/codenlighten/smartledger-bsv#readme",
@@ -18,21 +18,54 @@
     },
     "./package.json": "./package.json",
     "./version": "./version.js",
-    "./anchor": "./anchor-entry.js",
-    "./covenant": "./covenant-entry.js",
-    "./didweb": "./didweb-entry.js",
-    "./gdaf": "./gdaf-entry.js",
+    "./anchor": {
+      "types": "./anchor-entry.d.ts",
+      "default": "./anchor-entry.js"
+    },
+    "./covenant": {
+      "types": "./covenant-entry.d.ts",
+      "default": "./covenant-entry.js"
+    },
+    "./didweb": {
+      "types": "./didweb-entry.d.ts",
+      "default": "./didweb-entry.js"
+    },
+    "./gdaf": {
+      "types": "./gdaf-entry.d.ts",
+      "default": "./gdaf-entry.js"
+    },
     "./jcs": {
       "types": "./jcs-entry.d.ts",
       "default": "./jcs-entry.js"
     },
-    "./ltp": "./ltp-entry.js",
-    "./script-helper": "./script-helper-entry.js",
-    "./security": "./security-entry.js",
-    "./shamir": "./shamir-entry.js",
-    "./smartcontract": "./smartcontract-entry.js",
-    "./statuslist": "./statuslist-entry.js",
-    "./vcjwt": "./vcjwt-entry.js",
+    "./ltp": {
+      "types": "./ltp-entry.d.ts",
+      "default": "./ltp-entry.js"
+    },
+    "./script-helper": {
+      "types": "./script-helper-entry.d.ts",
+      "default": "./script-helper-entry.js"
+    },
+    "./security": {
+      "types": "./security-entry.d.ts",
+      "default": "./security-entry.js"
+    },
+    "./shamir": {
+      "types": "./shamir-entry.d.ts",
+      "default": "./shamir-entry.js"
+    },
+    "./smartcontract": {
+      "types": "./smartcontract-entry.d.ts",
+      "default": "./smartcontract-entry.js"
+    },
+    "./statuslist": {
+      "types": "./statuslist-entry.d.ts",
+      "default": "./statuslist-entry.js"
+    },
+    "./vcjwt": {
+      "types": "./vcjwt-entry.d.ts",
+      "default": "./vcjwt-entry.js"
+    },
     "./lib/anchor": "./lib/anchor/index.js",
     "./lib/block": "./lib/block/index.js",
     "./lib/covenant": "./lib/covenant/index.js",
@@ -85,7 +118,7 @@
     "test:all": "npm test && npm run test:covenants && npm run test:scripts",
     "coverage": "nyc --reporter=text npm run test",
     "demo": "node demos/smart_contract_demo.js",
-    "demo:web": "echo '🌐 Open demos/smart_contract_demo.html in your browser'",
+    "demo:web": "echo '\ud83c\udf10 Open demos/smart_contract_demo.html in your browser'",
     "demo:basics": "node demos/smart_contract_demo.js --feature basics",
     "demo:covenant": "node demos/smart_contract_demo.js --feature covenant",
     "demo:preimage": "node demos/smart_contract_demo.js --feature preimage",
@@ -94,7 +127,7 @@
     "demo:legacy": "npm run test:covenants",
     "demo:legacy:basic": "npm run test:basic",
     "demo:legacy:scripts": "npm run test:scripts",
-    "demo:legacy:preimage": "echo '🧠 BIP-143 Preimage Extractor Demo' && node examples/preimage/extract_preimage_bidirectional.js",
+    "demo:legacy:preimage": "echo '\ud83e\udde0 BIP-143 Preimage Extractor Demo' && node examples/preimage/extract_preimage_bidirectional.js",
     "smart-contracts": "node examples/smart_contract_templates.js",
     "smart-contracts:working": "node examples/final_working_contracts.js",
     "workflow": "node examples/complete_workflow_demo.js",
@@ -102,12 +135,13 @@
     "test:browser": "echo 'Open tests/standalone-modules-test.html in browser for comprehensive testing'",
     "test:bundle": "echo 'Open tests/bundle-completeness-test.html in browser to verify bundle completeness'",
     "preimage:extract": "node examples/preimage/extract_preimage_bidirectional.js",
-    "prepublishOnly": "npm run build-all && npm run check:readme && npm run check:api",
+    "prepublishOnly": "npm run build-all && npm run check:readme && npm run check:api && npm run check:types",
     "sync-cdn": "node scripts/sync-cdn-urls.js",
     "version": "node scripts/sync-cdn-urls.js && node scripts/sync-version.js && node scripts/gen-esm-wrapper.js && git add README.md docs version.js index.mjs",
     "test:browser:ci": "node tests/browser-smoke-runner.js",
     "api:snapshot": "node scripts/api-surface.js",
-    "check:api": "mocha test/api_surface.js --no-config"
+    "check:api": "mocha test/api_surface.js --no-config",
+    "check:types": "node scripts/check-types.js"
   },
   "unpkg": "bsv.min.js",
   "jsdelivr": "bsv.min.js",
@@ -178,6 +212,7 @@
     "@noble/ciphers": "^2.3.0",
     "@noble/curves": "^2.3.0",
     "@noble/hashes": "^2.3.0",
+    "@types/node": "^20.19.0",
     "bn.js": "=4.12.5",
     "secrets.js-grempe": "^2.0.0"
   },

package/script-helper-entry.d.ts

@@ -0,0 +1,75 @@
+/**
+ * CustomScriptHelper — script construction and signing helpers.
+ *
+ * All members are static; the class is never instantiated. Signatures follow
+ * the JSDoc in `lib/custom-script-helper.js`.
+ */
+import { Transaction, Script, PrivateKey, PublicKey } from '@smartledger/bsv';
+
+declare class CustomScriptHelper {
+  /** SIGHASH_ALL | SIGHASH_FORKID. */
+  static readonly SIGHASH_ALL: number;
+  /** SIGHASH_NONE | SIGHASH_FORKID. */
+  static readonly SIGHASH_NONE: number;
+  /** SIGHASH_SINGLE | SIGHASH_FORKID. */
+  static readonly SIGHASH_SINGLE: number;
+
+  /**
+   * DER signature with the sighash byte appended, ready to push.
+   * Defaults to SIGHASH_ALL | SIGHASH_FORKID.
+   */
+  static createSignature(
+    transaction: Transaction,
+    privateKey: PrivateKey,
+    inputIndex: number,
+    lockingScript: Script,
+    satoshis: number,
+    sighashType?: number | null
+  ): Buffer;
+
+  /** m-of-n locking script over the supplied keys. */
+  static createMultisigScript(m: number, publicKeys: PublicKey[]): Script;
+  /** Unlocking script for a multisig input; prepends OP_0 for the CHECKMULTISIG off-by-one. */
+  static createMultisigUnlocking(signatures: Buffer[]): Script;
+  /** OP_IF / [OP_ELSE] / OP_ENDIF around the supplied branches. */
+  static createConditionalScript(ifScript: Script, elseScript?: Script | null): Script;
+
+  static createP2PKHScript(publicKey: PublicKey): Script;
+  static createP2PKHUnlocking(signature: Buffer, publicKey: PublicKey): Script;
+
+  /**
+   * BIP-143 preimage for the given input.
+   * Defaults to SIGHASH_ALL | SIGHASH_FORKID.
+   */
+  static getPreimage(
+    transaction: Transaction,
+    inputIndex: number,
+    lockingScript: Script,
+    satoshis: number,
+    sighashType?: number | null
+  ): Buffer;
+
+  /** A bare data push. A string is encoded as UTF-8. */
+  static createDataScript(data: Buffer | string): Script;
+  /** OP_FALSE OP_RETURN <data>. A string is encoded as UTF-8. */
+  static createOpReturnScript(data: Buffer | string): Script;
+
+  /** Returns false rather than throwing when verification fails. */
+  static validateTransaction(transaction: Transaction): boolean;
+  /** Runs the interpreter over one input. Returns false rather than throwing. */
+  static validateScript(
+    unlockingScript: Script,
+    lockingScript: Script,
+    transaction: Transaction,
+    inputIndex: number
+  ): boolean;
+
+  /** Builds a transaction at the given fee rate. Defaults to 10 sat/kb. */
+  static createLowFeeTransaction(
+    utxos: object[],
+    outputs: Array<{ address: string; satoshis: number }>,
+    feePerKb?: number
+  ): Transaction;
+}
+
+export = CustomScriptHelper;

package/security-entry.d.ts

@@ -0,0 +1,52 @@
+/**
+ * SmartMiner — an in-process BSV miner simulator for tests and development.
+ *
+ * This simulates mempool acceptance and block assembly; it is not a miner and
+ * performs no proof of work.
+ */
+import { Transaction } from '@smartledger/bsv';
+
+declare class SmartMiner {
+  constructor(bsv: unknown, options?: {
+    difficulty?: number;
+    /** Milliseconds. Defaults to 10000. */
+    blockTime?: number;
+    /** Defaults to true. */
+    validateScripts?: boolean;
+    logLevel?: string;
+    [key: string]: unknown;
+  });
+
+  options: Record<string, unknown>;
+  mempool: Transaction[];
+  currentBlock: { height: number; transactions: Transaction[]; timestamp: number; hash?: string };
+
+  /** Accepts into the mempool, or returns false if rejected. */
+  acceptTransaction(transaction: Transaction): boolean;
+  validateTransactionSignatures(transaction: Transaction): boolean;
+  /** Assembles a block from the mempool. Defaults to 10 transactions. */
+  mineBlock(maxTransactions?: number): {
+    height: number;
+    transactions: Transaction[];
+    timestamp: number;
+    hash?: string;
+    [key: string]: unknown;
+  };
+  getMempoolStats(): {
+    transactionCount: number;
+    transactions: Array<{ id: string; size: number; inputs: number; outputs: number }>;
+  };
+  getBlockchainStats(): {
+    currentHeight: number;
+    currentBlockHash: string | undefined;
+    currentBlockTimestamp: number;
+    mempoolSize: number;
+    difficulty: number;
+    blockTime: number;
+  };
+  /** Returns the miner to genesis state and empties the mempool. */
+  reset(): void;
+  log(level: string, message: string): void;
+}
+
+export = SmartMiner;

package/shamir-entry.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Shamir secret sharing.
+ *
+ * Same class as `require("@smartledger/bsv").crypto.Shamir`. The underscore-
+ * prefixed `_*Legacy` helpers present at runtime are deliberately not declared:
+ * they exist to reconstruct shares produced by pre-6.x releases and are not
+ * part of the supported surface.
+ */
+import { crypto } from '@smartledger/bsv';
+export = crypto.Shamir;

package/smartcontract-entry.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Script-level contract construction: OP_PUSH_TX covenants, BIP-143 preimage
+ * tooling, the interpreter-backed tester, and the template library.
+ *
+ * Same surface as `require("@smartledger/bsv").SmartContract`.
+ */
+import { SmartContract } from '@smartledger/bsv';
+export = SmartContract;

package/statuslist-entry.d.ts

@@ -0,0 +1,11 @@
+/**
+ * StatusList2021 revocation lists.
+ *
+ * Note `getCredentialStatusEntry` is async — awaiting it is not optional.
+ * Comparing the returned Promise to a string type-checks and is always false,
+ * which is how a revoked credential passes.
+ *
+ * Same surface as `require("@smartledger/bsv").StatusList`.
+ */
+import { StatusList } from '@smartledger/bsv';
+export = StatusList;

package/vcjwt-entry.d.ts

@@ -0,0 +1,15 @@
+/**
+ * W3C Verifiable Credentials as JWTs.
+ *
+ * Same surface as `require("@smartledger/bsv").VcJwt`, plus `ALG_TO_CRV`, which
+ * the module exports at runtime but the root declaration does not describe.
+ */
+import { VcJwt } from '@smartledger/bsv';
+
+declare namespace vcjwt {
+  /** Maps a JWS algorithm to the JWK curve it requires. */
+  const ALG_TO_CRV: Readonly<Record<string, string>>;
+}
+declare const vcjwt: typeof VcJwt & { readonly ALG_TO_CRV: Readonly<Record<string, string>> };
+
+export = vcjwt;

package/version.js

@@ -1,3 +1,3 @@
 'use strict'
 // GENERATED by scripts/sync-version.js on `npm version` — do not edit.
-module.exports = '9.2.0'
+module.exports = '9.3.0'