@smartledger/bsv 8.3.1 → 9.1.0

package/test/build/bundle_externals.js

@@ -1,125 +0,0 @@
-'use strict'
-
-/* global describe, it, before */
-
-// Feature bundles must EXTERNALISE the shared primitives, not embed a second copy.
-//
-// Getting this wrong is not a size regression. If a feature bundle ships its own
-// PrivateKey class, a key built by bsv.min.js fails `instanceof` inside that bundle
-// and index.js's versionGuard reports two library instances — a failure that is
-// invisible to every test that stays inside one bundle.
-//
-// build/esbuild.js has always had a `metafile` option whose comment said it was "used
-// to assert" this property. Nothing consumed it: `grep -rn metafile` returned only the
-// option itself. This file is that consumer.
-
-require('chai').should()
-var esbuild = require('../../build/esbuild.js')
-
-// Bundles that resolve bsv from the global instead of embedding it.
-var EXTERNALISED = esbuild.BUNDLES.filter(function (c) { return c.externalBsv })
-
-describe('feature bundles externalise the shared primitives', function () {
-  this.timeout(120000)
-
-  var inputsByBundle = {}
-
-  before(function () {
-    // Build each one in memory (write:false) and keep its module graph.
-    return Promise.all(EXTERNALISED.map(function (cfg) {
-      return esbuild.buildOne(cfg, { metafile: true, write: false, logLevel: 'silent' })
-        .then(function (result) {
-          inputsByBundle[cfg.file] = Object.keys(result.metafile.inputs)
-            .filter(function (p) { return p.indexOf('lib/') === 0 })
-            .sort()
-        })
-    }))
-  })
-
-  it('has bundles to check', function () {
-    EXTERNALISED.length.should.be.above(0)
-    Object.keys(inputsByBundle).length.should.equal(EXTERNALISED.length)
-  })
-
-  // The primary assertion, derived from the config rather than hand-maintained: every
-  // path in LIB_GLOBALS is a module the build promises to take from the global bsv, so
-  // none of them may appear as a bundled input. Because it reads the same table the
-  // build uses, it cannot drift out of step with it.
-  it('never embeds a module that LIB_GLOBALS maps to the global bsv', function () {
-    var mapped = Object.keys(esbuild.LIB_GLOBALS)
-    var offences = []
-    Object.keys(inputsByBundle).forEach(function (file) {
-      inputsByBundle[file].forEach(function (input) {
-        // 'lib/privatekey.js' -> 'privatekey'; 'lib/script/index.js' -> 'script/index'
-        var key = input.replace(/^lib\//, '').replace(/\.js$/, '')
-        if (mapped.indexOf(key) !== -1) {
-          offences.push(file + ' embeds ' + input + ' (should come from global bsv.' +
-            esbuild.LIB_GLOBALS[key] + ')')
-        }
-      })
-    })
-    offences.should.deep.equal([])
-  })
-
-  // LIB_GLOBALS is deliberately not exhaustive — a feature bundle SHOULD contain its own
-  // feature code. So the catch-all is to pin what each bundle contains: anything new
-  // appearing here is either the feature growing or a primitive leaking in, and a human
-  // decides which. Without this, a `require('../mnemonic')` added to a module reachable
-  // from an externalised entry would bundle a second copy silently, with every existing
-  // test green.
-  it('contains only its own feature code, pinned per bundle', function () {
-    // Accepted in any bundle: stateless helpers, deliberately duplicated rather than
-    // routed through the global.
-    //
-    // Named FILES, not the directory. `lib/util/` as a prefix exempts anything added
-    // under it later, including something stateful — which is the property this test
-    // exists to prevent. Listing them means a new util file has to be considered.
-    //
-    // And listing ONLY what is actually embedded, for the same reason: naming a file
-    // that no bundle pulls in pre-approves it, so the consideration never happens.
-    // Measured — `lib/util/_.js` is the only one today. If a bundle starts needing
-    // another, this line should change in the same commit that causes it.
-    var SHARED = ['lib/util/_.js']
-    var EXPECTED = {
-      'bsv-ecies.min.js': ['lib/ecies/'],
-      'bsv-message.min.js': ['lib/message/'],
-      'bsv-mnemonic.min.js': ['lib/mnemonic/'],
-      'bsv-shamir.min.js': ['lib/crypto/'],
-      'bsv-smartcontract.min.js': ['lib/smart_contract/', 'lib/covenant/', 'lib/smartutxo.js'],
-      'bsv-covenant.min.js': ['lib/smart_contract/'],
-      'bsv-script-helper.min.js': ['lib/custom-script-helper.js']
-    }
-    var unexpected = []
-    Object.keys(inputsByBundle).forEach(function (file) {
-      var allowed = (EXPECTED[file] || []).concat(SHARED)
-      if (!EXPECTED[file]) {
-        unexpected.push(file + ' is externalised but has no expected-input list')
-        return
-      }
-      inputsByBundle[file].forEach(function (input) {
-        var ok = allowed.some(function (prefix) { return input.indexOf(prefix) === 0 })
-        if (!ok) unexpected.push(file + ' unexpectedly embeds ' + input)
-      })
-    })
-    unexpected.should.deep.equal([])
-  })
-
-  it('shares nothing but documented helpers across bundles', function () {
-    // A module appearing in two feature bundles is a duplicated copy in the shipped
-    // set. Only these are accepted, and each is a deliberate call rather than an
-    // accident: lib/util/_.js is a tiny lodash subset, and lib/smart_contract/covenant.js
-    // is genuinely the feature of both covenant-flavoured bundles.
-    var ACCEPTED_DUPLICATES = ['lib/util/_.js', 'lib/smart_contract/covenant.js']
-    var seen = {}
-    Object.keys(inputsByBundle).forEach(function (file) {
-      inputsByBundle[file].forEach(function (input) {
-        (seen[input] = seen[input] || []).push(file)
-      })
-    })
-    var duplicated = Object.keys(seen)
-      .filter(function (p) { return seen[p].length > 1 })
-      .filter(function (p) { return ACCEPTED_DUPLICATES.indexOf(p) === -1 })
-      .sort()
-    duplicated.should.deep.equal([])
-  })
-})

package/test/build/bundle_smoke.js

@@ -1,55 +0,0 @@
-'use strict'
-
-/* global describe, it */
-
-// Cutover safety net for the webpack -> esbuild bundle migration: every SHIPPED bundle
-// must load and expose an API. Each bundle is loaded in an ISOLATED child process (they
-// are self-contained bsv builds; loading them all into one process would collide), with a
-// global `bsv` present for the feature bundles that externalise it. Load/shape smoke only —
-// full browser behaviour (window.crypto CSPRNG) is covered by the Chrome browser-smoke.
-
-require('chai').should()
-var path = require('path')
-var execFileSync = require('child_process').execFileSync
-
-var ROOT = path.resolve(__dirname, '../..')
-
-// file -> a key that must be present on the loaded module (null = just needs a non-empty API).
-var BUNDLES = {
-  'bsv.min.js': 'PrivateKey',
-  'bsv.bundle.js': 'PrivateKey',
-  'bsv-ecies.min.js': null,
-  'bsv-message.min.js': null,
-  'bsv-mnemonic.min.js': null,
-  'bsv-shamir.min.js': null,
-  'bsv-smartcontract.min.js': 'Covenant',
-  'bsv-covenant.min.js': null,
-  'bsv-script-helper.min.js': null,
-  'bsv-security.min.js': null,
-  'bsv-ltp.min.js': null,
-  'bsv-gdaf.min.js': null,
-  'bsv-didweb.min.js': null,
-  'bsv-vcjwt.min.js': null,
-  'bsv-statuslist.min.js': null,
-  'bsv-anchor.min.js': null
-}
-
-describe('bundles: every shipped bundle loads (esbuild cutover)', function () {
-  this.timeout(20000)
-
-  Object.keys(BUNDLES).forEach(function (file) {
-    it(file + ' loads via require() and exposes an API', function () {
-      var key = BUNDLES[file]
-      var script =
-        'global.bsv=require(' + JSON.stringify(path.join(ROOT, 'index.js')) + ');' +
-        'var m=require(' + JSON.stringify(path.join(ROOT, file)) + ');' +
-        'if(m==null)process.exit(2);' +
-        'var ok=(typeof m==="function")||(typeof m==="object"&&Object.keys(m).length>0);' +
-        'if(!ok)process.exit(3);' +
-        (key ? 'if(m[' + JSON.stringify(key) + ']==null)process.exit(4);' : '') +
-        'process.exit(0)'
-      // execFileSync throws if the child exits non-zero (a broken/unloadable bundle).
-      execFileSync(process.execPath, ['-e', script], { stdio: 'pipe' })
-    })
-  })
-})

package/test/build/esbuild_main.js

@@ -1,65 +0,0 @@
-'use strict'
-
-/* global describe, it */
-
-// Build-integrity gate for the esbuild bundler migration. Proves every browser bundle
-// (all 16) builds — esbuild resolves each Node-core polyfill and, for the feature bundles,
-// externalises the bsv root to the global `bsv` — and that the output is a real UMD module
-// (browser global + require()/AMD). Full browser behaviour (Shamir CSPRNG via window.crypto)
-// is validated by the Chrome browser-smoke against the full bundle.
-
-require('chai').should()
-var fs = require('fs')
-var os = require('os')
-var path = require('path')
-var E = require('../../build/esbuild')
-
-describe('esbuild: all browser bundles build', function () {
-  this.timeout(60000)
-
-  it('all ' + E.BUNDLES.length + ' bundles build with no unresolved modules', function () {
-    return Promise.all(E.BUNDLES.map(function (cfg) {
-      return E.buildOne(cfg, { write: false, logLevel: 'silent' }).then(function (res) {
-        res.errors.length.should.equal(0)
-        var js = res.outputFiles[0].text
-        js.length.should.be.above(20000) // smallest bundle (message) ~31KB; a broken build is tiny
-        js.indexOf('var ' + cfg.global + '=').should.be.above(-1) // IIFE global assignment
-      })
-    }))
-  })
-
-  // UMD contract: the full bundle must load via CommonJS require() (as the webpack UMD bundle
-  // did). Browser <script> global is validated by the Chrome browser-smoke.
-  it('the full bundle is require()-able (UMD) with a working static API', function () {
-    return E.buildFullBundle({ write: false, logLevel: 'silent' }).then(function (res) {
-      var tmp = path.join(os.tmpdir(), 'bsv-esbuild-full-' + process.pid + '.js')
-      fs.writeFileSync(tmp, res.outputFiles[0].text)
-      try {
-        var bsv = require(tmp)
-        ;(typeof bsv.PrivateKey).should.equal('function')
-        bsv.version.should.be.a('string')
-        bsv.crypto.Hash.sha256(bsv.deps.Buffer.from('x')).length.should.equal(32)
-        ;(!!bsv.Ordinals && !!bsv.SPV).should.equal(true)
-      } finally { delete require.cache[tmp]; fs.unlinkSync(tmp) }
-    })
-  })
-
-  // A feature bundle that externalises bsv (bsv-covenant) must load against a global `bsv`.
-  it('a feature bundle (bsv-covenant) loads against the global bsv', function () {
-    var cfg = E.BUNDLES.filter(function (c) { return c.file === 'bsv-covenant.min.js' })[0]
-    return E.buildOne(cfg, { write: false, logLevel: 'silent' }).then(function (res) {
-      var tmp = path.join(os.tmpdir(), 'bsv-esbuild-cov-' + process.pid + '.js')
-      fs.writeFileSync(tmp, res.outputFiles[0].text)
-      var had = 'bsv' in global // Node: global === globalThis, which the bundle reads
-      global.bsv = require('../..')
-      try {
-        var cov = require(tmp)
-        ;(cov == null).should.equal(false)
-        Object.keys(cov).length.should.be.above(0)
-      } finally {
-        delete require.cache[tmp]; fs.unlinkSync(tmp)
-        if (!had) delete global.bsv
-      }
-    })
-  })
-})

package/test/build/esm_wrapper.js

@@ -1,73 +0,0 @@
-'use strict'
-
-/* global describe, it */
-
-// Guards index.mjs — the real ESM entry behind the package's `import` condition.
-// Asserts (a) it hasn't drifted from the CJS surface, (b) native ESM default AND
-// named imports actually work, and (c) deprecated getters (SmartUTXO) are NOT
-// forced as named exports (they'd fire their warning on every import).
-//
-// ESM behaviour is exercised in a child process (via an --input-type=module
-// script string) rather than a dynamic import() in this file, so the source
-// stays parseable by the pinned standard@12 linter.
-
-require('chai').should()
-var fs = require('fs')
-var path = require('path')
-var execFileSync = require('child_process').execFileSync
-var spawnSync = require('child_process').spawnSync
-
-var ROOT = path.resolve(__dirname, '../..')
-var MJS = path.join(ROOT, 'index.mjs')
-
-// scripts/ is dev tooling and is not published, so the two checks that
-// regenerate index.mjs can only run from a checkout. The ESM import checks below
-// run everywhere, including against an installed copy. Presence is tested rather
-// than try/catch'd so a broken generator still fails loudly in the repo.
-var GEN = path.join(ROOT, 'scripts', 'gen-esm-wrapper.js')
-var gen = fs.existsSync(GEN) ? require(GEN) : null
-var itFromCheckout = gen ? it : it.skip
-
-function runEsm (body) {
-  return execFileSync(process.execPath, ['--input-type=module', '-e', body],
-    { cwd: ROOT, stdio: 'pipe' })
-}
-
-describe('ESM wrapper (index.mjs)', function () {
-  itFromCheckout('is in sync with the CJS surface (no drift)', function () {
-    var onDisk = fs.readFileSync(MJS, 'utf8')
-    onDisk.should.equal(gen.generate())
-  })
-
-  itFromCheckout('exports every non-accessor top-level member as a named binding', function () {
-    var bsv = require('../..')
-    var names = gen.exportableNames(bsv)
-    names.length.should.be.above(100)
-    // SmartUTXO is an accessor (deprecated getter) and must be excluded.
-    names.should.not.include('SmartUTXO')
-    Object.getOwnPropertyDescriptor(bsv, 'SmartUTXO').get.should.be.a('function')
-  })
-
-  it('resolves real ESM default + named imports natively', function () {
-    runEsm(
-      'import bsv, { PrivateKey, crypto } from ' + JSON.stringify('./index.mjs') + ';' +
-      'process.exit((bsv && typeof PrivateKey === "function" && ' +
-      'PrivateKey === bsv.PrivateKey && typeof crypto.ECDSA === "function") ? 0 : 3)')
-  })
-
-  it('does not emit the SmartUTXO deprecation warning at import (getter excluded)', function () {
-    // Re-exporting the getter would trip its console.warn at import time; stderr
-    // must be empty for a bare `import './index.mjs'`.
-    var res = spawnSync(process.execPath,
-      ['--input-type=module', '-e', 'import ' + JSON.stringify('./index.mjs') + ';'],
-      { cwd: ROOT, encoding: 'utf8' })
-    res.status.should.equal(0)
-    res.stderr.should.equal('')
-  })
-
-  it('keeps deprecated getters reachable via the default export only', function () {
-    runEsm(
-      'import bsv from ' + JSON.stringify('./index.mjs') + ';' +
-      'process.exit(("SmartUTXO" in bsv) ? 0 : 3)')
-  })
-})

package/test/build/exports_resolution.js

@@ -1,84 +0,0 @@
-'use strict'
-
-/* global describe, it */
-
-// Guards the 7.0 package.json `exports` map. Adding `exports` switches Node to
-// strict subpath resolution, so this asserts the surface consumers actually use
-// still resolves (via package self-reference, which Node enables once `exports`
-// exists): the main entry, package.json, ./version, the shipped bundles, and
-// lib/* deep imports in BOTH extension styles. Also smoke-tests the ESM `import`
-// condition in a child process so the dual-ready "." entry can't silently rot.
-
-require('chai').should()
-var fs = require('fs')
-var path = require('path')
-var execFileSync = require('child_process').execFileSync
-
-var N = '@smartledger/bsv'
-var ROOT = path.resolve(__dirname, '../..')
-
-describe('7.0 exports map resolution', function () {
-  it('resolves the main entry via self-reference', function () {
-    var bsv = require(N)
-    bsv.should.be.an('object')
-    bsv.PrivateKey.should.be.a('function')
-    bsv.crypto.ECDSA.should.be.a('function')
-  })
-
-  it('exposes package.json and ./version, and they agree', function () {
-    var pkg = require(N + '/package.json')
-    var version = require(N + '/version')
-    pkg.name.should.equal(N)
-    version.should.equal(pkg.version)
-  })
-
-  it('resolves lib/* deep imports with and without the .js extension', function () {
-    var withExt = require(N + '/lib/crypto/ecdsa.js')
-    var noExt = require(N + '/lib/crypto/ecdsa')
-    withExt.should.be.a('function')
-    noExt.should.equal(withExt) // same module, one cache entry
-  })
-
-  // `./lib/*` maps to `./lib/*.js`, so a DIRECTORY module (lib/script, lib/ordinals,
-  // ...) did not resolve at all — `require('@smartledger/bsv/lib/script')` raised
-  // MODULE_NOT_FOUND, because there is no lib/script.js. Explicit entries now point each
-  // directory at its index.js. Every directory under lib/ that has one is listed, so a
-  // new module cannot be added without also being exported.
-  it('resolves every lib/ directory module by its bare directory name', function () {
-    var libDir = path.join(ROOT, 'lib')
-    var dirs = fs.readdirSync(libDir).filter(function (d) {
-      return fs.existsSync(path.join(libDir, d, 'index.js'))
-    })
-    dirs.length.should.be.above(0)
-    dirs.forEach(function (d) {
-      var bare = require(N + '/lib/' + d)
-      var explicit = require(N + '/lib/' + d + '/index.js')
-      ;(bare === explicit).should.equal(true) // same module, one cache entry
-    })
-  })
-
-  it('still resolves lib/ FILE modules, which share the same pattern', function () {
-    var noExt = require(N + '/lib/address')
-    var withExt = require(N + '/lib/address.js')
-    ;(noExt === withExt).should.equal(true)
-    noExt.should.be.a('function')
-  })
-
-  it('serves the full browser bundle over a subpath (loaded in isolation)', function () {
-    // The bundle is a self-contained bsv; loading it in-process collides with the
-    // main require above ("multiple bsv instances"), so resolve+load it in a child.
-    var script = 'var m=require(' + JSON.stringify(N + '/bsv.min.js') + ');' +
-      'process.exit(m && m.PrivateKey ? 0 : 3)'
-    execFileSync(process.execPath, ['-e', script], { cwd: ROOT, stdio: 'pipe' })
-  })
-
-  it('routes the ESM `import` condition to index.mjs with default AND named exports', function () {
-    // Proves the dual-ESM entry end-to-end through the package specifier: the
-    // `import` condition resolves to index.mjs, which exposes real named bindings.
-    var script =
-      'import bsv, { PrivateKey, Transaction, crypto } from ' + JSON.stringify(N) + ';' +
-      'process.exit((bsv && bsv.PrivateKey && PrivateKey === bsv.PrivateKey && ' +
-      'typeof Transaction === "function" && typeof crypto.ECDSA === "function") ? 0 : 3)'
-    execFileSync(process.execPath, ['--input-type=module', '-e', script], { cwd: ROOT, stdio: 'pipe' })
-  })
-})

package/test/build/version_sync.js

@@ -1,14 +0,0 @@
-'use strict'
-
-/* global describe, it */
-
-// version.js is generated from package.json by the `version` npm hook so the bundles
-// embed only the version string (not the whole package.json). Assert it hasn't drifted.
-
-require('chai').should()
-
-describe('version.js stays in sync with package.json', function () {
-  it('version.js === package.json.version', function () {
-    require('../../version').should.equal(require('../../package.json').version)
-  })
-})