@smartledger/bsv 9.1.1 → 9.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartledger/bsv",
-  "version": "9.1.1",
+  "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,17 +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",
-    "./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",
+    "./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": {
+      "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",
@@ -81,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",
@@ -90,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",
@@ -98,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",
@@ -121,6 +159,7 @@
     "build/",
     "tools/",
     "*-entry.js",
+    "*-entry.d.ts",
     "bsv.min.js",
     "bsv.bundle.js",
     "bsv-ecies.min.js",
@@ -173,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.1.1'
+module.exports = '9.3.0'