@smartledger/bsv 8.3.1 → 9.1.0

package/test/cli/smoke.js

@@ -1,261 +0,0 @@
-'use strict'
-
-// End-to-end smoke test for `bin/cli.js`.
-//
-// Exercises every subcommand advertised in the README quickstart:
-//   didweb init  → vc issue → vc verify
-//   status create → status set → status check
-//   anchor hash  → anchor build
-//
-// Each test runs the CLI in an isolated temp directory so the files it
-// drops (.well-known/did.json, issuer-key-<kid>.json, etc.) don't pollute
-// the repo. We assert on stdout/stderr/exit-code only — the CLI's primary
-// output is stdout, status messages go to stderr.
-
-var expect = require('chai').expect
-var spawnSync = require('child_process').spawnSync
-var fs = require('fs')
-var os = require('os')
-var path = require('path')
-
-var REPO_ROOT = path.resolve(__dirname, '..', '..')
-var CLI = path.join(REPO_ROOT, 'bin', 'cli.js')
-var PKG_VERSION = require(path.join(REPO_ROOT, 'package.json')).version
-
-function runCli(args, opts) {
-  opts = opts || {}
-  var result = spawnSync(process.execPath, [CLI].concat(args), {
-    cwd: opts.cwd || REPO_ROOT,
-    encoding: 'utf8',
-    timeout: 15000,
-    env: Object.assign({}, process.env, opts.env || {})
-  })
-  return {
-    stdout: result.stdout || '',
-    stderr: result.stderr || '',
-    code: result.status,
-    signal: result.signal
-  }
-}
-
-describe('CLI smoke', function () {
-  this.timeout(20000) // crypto + JWT signing can be slow on cold start
-
-  var tmpDir
-
-  beforeEach(function () {
-    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'bsv-cli-smoke-'))
-  })
-
-  afterEach(function () {
-    try {
-      fs.rmSync(tmpDir, { recursive: true, force: true })
-    } catch (e) { /* best-effort cleanup */ }
-  })
-
-  describe('meta', function () {
-    it('--version prints package.json version', function () {
-      var r = runCli(['--version'])
-      expect(r.code).to.equal(0)
-      expect(r.stdout.trim()).to.equal(PKG_VERSION)
-    })
-
-    it('-v is an alias for --version', function () {
-      var r = runCli(['-v'])
-      expect(r.code).to.equal(0)
-      expect(r.stdout.trim()).to.equal(PKG_VERSION)
-    })
-
-    it('no args prints the help banner with the current version', function () {
-      var r = runCli([])
-      expect(r.code).to.equal(0)
-      expect(r.stdout).to.include('SmartLedger BSV CLI v' + PKG_VERSION)
-      expect(r.stdout).to.include('didweb init')
-      expect(r.stdout).to.include('vc issue')
-      expect(r.stdout).to.include('status create')
-      expect(r.stdout).to.include('anchor hash')
-    })
-
-    it('--help prints the help banner', function () {
-      var r = runCli(['--help'])
-      expect(r.code).to.equal(0)
-      expect(r.stdout).to.include('Usage:')
-    })
-
-    it('unknown top-level command exits non-zero', function () {
-      var r = runCli(['nope'])
-      expect(r.code).to.not.equal(0)
-      expect(r.stderr).to.match(/Unknown command/i)
-    })
-  })
-
-  describe('didweb', function () {
-    it('init --domain creates .well-known files and an issuer key', function () {
-      var r = runCli(['didweb', 'init', '--domain', 'example.com', '--alg', 'ES256'], { cwd: tmpDir })
-      expect(r.code, r.stderr).to.equal(0)
-
-      var didPath = path.join(tmpDir, '.well-known', 'did.json')
-      var jwksPath = path.join(tmpDir, '.well-known', 'jwks.json')
-      expect(fs.existsSync(didPath), 'did.json missing').to.equal(true)
-      expect(fs.existsSync(jwksPath), 'jwks.json missing').to.equal(true)
-
-      var didDoc = JSON.parse(fs.readFileSync(didPath, 'utf8'))
-      expect(didDoc.id).to.equal('did:web:example.com')
-
-      var jwks = JSON.parse(fs.readFileSync(jwksPath, 'utf8'))
-      expect(jwks.keys).to.be.an('array').with.length.greaterThan(0)
-      expect(jwks.keys[0].kty).to.be.a('string')
-
-      // Issuer key file is named issuer-key-<kid>.json
-      var keyFiles = fs.readdirSync(tmpDir).filter(function (f) {
-        return f.startsWith('issuer-key-') && f.endsWith('.json')
-      })
-      expect(keyFiles, 'issuer key not written').to.have.length(1)
-
-      var keyData = JSON.parse(fs.readFileSync(path.join(tmpDir, keyFiles[0]), 'utf8'))
-      expect(keyData.did).to.equal('did:web:example.com')
-      expect(keyData.privateJwk).to.be.an('object')
-      expect(keyData.publicJwk).to.be.an('object')
-      expect(keyData.alg).to.equal('ES256')
-    })
-
-    it('init --alg ES256K produces a secp256k1 key', function () {
-      var r = runCli(['didweb', 'init', '--domain', 'example.org', '--alg', 'ES256K'], { cwd: tmpDir })
-      expect(r.code, r.stderr).to.equal(0)
-
-      var keyFiles = fs.readdirSync(tmpDir).filter(function (f) {
-        return f.startsWith('issuer-key-')
-      })
-      var keyData = JSON.parse(fs.readFileSync(path.join(tmpDir, keyFiles[0]), 'utf8'))
-      expect(keyData.alg).to.equal('ES256K')
-    })
-
-    it('init without --domain exits non-zero', function () {
-      var r = runCli(['didweb', 'init'], { cwd: tmpDir })
-      expect(r.code).to.not.equal(0)
-      expect(r.stderr).to.match(/--domain is required/)
-    })
-  })
-
-  describe('vc → status → anchor end-to-end', function () {
-    // One big sequenced test that uses didweb init's output to issue,
-    // verify, anchor, and revoke a credential — mirrors the README's
-    // quickstart exactly.
-    it('full credential lifecycle', function () {
-      // 1. Init a DID:web issuer
-      var initRes = runCli(['didweb', 'init', '--domain', 'example.com', '--alg', 'ES256'], { cwd: tmpDir })
-      expect(initRes.code, initRes.stderr).to.equal(0)
-
-      // The CLI writes the key file as issuer-key-<kid>.json but `vc issue`
-      // looks for `issuer-key.json` by default. Rename so we can use the
-      // default --key path.
-      var keyFile = fs.readdirSync(tmpDir).filter(function (f) {
-        return f.startsWith('issuer-key-')
-      })[0]
-      fs.renameSync(path.join(tmpDir, keyFile), path.join(tmpDir, 'issuer-key.json'))
-
-      // 2. Issue a credential
-      var issueRes = runCli([
-        'vc', 'issue',
-        '--issuer', 'did:web:example.com',
-        '--subject', 'did:example:alice',
-        '--types', 'VerifiableCredential,AgeCredential',
-        '--claims', JSON.stringify({ ageOver: 18, country: 'US' })
-      ], { cwd: tmpDir })
-      expect(issueRes.code, issueRes.stderr).to.equal(0)
-
-      // JWT format: three base64url segments separated by `.`
-      var jwt = issueRes.stdout.trim()
-      expect(jwt.split('.')).to.have.length(3)
-
-      // 3. Verify the credential
-      fs.writeFileSync(path.join(tmpDir, 'cred.jwt'), jwt)
-      var verifyRes = runCli(['vc', 'verify', 'cred.jwt'], { cwd: tmpDir })
-      expect(verifyRes.code, verifyRes.stderr).to.equal(0)
-      expect(verifyRes.stderr).to.match(/VALID/)
-      // Verified payload echoed on stdout
-      var payload = JSON.parse(verifyRes.stdout)
-      expect(payload.iss).to.equal('did:web:example.com')
-
-      // 4. Anchor the credential hash
-      var anchorRes = runCli(['anchor', 'hash', 'cred.jwt'], { cwd: tmpDir })
-      expect(anchorRes.code, anchorRes.stderr).to.equal(0)
-      var hash = anchorRes.stdout.trim()
-      expect(hash).to.match(/^[0-9a-f]{64}$/)
-
-      // 5. Build an anchor payload around that hash
-      var buildRes = runCli([
-        'anchor', 'build',
-        '--kind', 'VC_ANCHOR_SHA256',
-        '--hash', hash,
-        '--issuer', 'did:web:example.com'
-      ], { cwd: tmpDir })
-      expect(buildRes.code, buildRes.stderr).to.equal(0)
-      var payloadJson = JSON.parse(buildRes.stdout)
-      expect(payloadJson.hash).to.equal(hash)
-
-      // 6. Create a status list
-      var statusCreateRes = runCli([
-        'status', 'create',
-        '--issuer', 'did:web:example.com'
-      ], { cwd: tmpDir })
-      expect(statusCreateRes.code, statusCreateRes.stderr).to.equal(0)
-      var listJwt = statusCreateRes.stdout.trim()
-      expect(listJwt.split('.')).to.have.length(3)
-
-      // 7. Revoke index 42
-      fs.writeFileSync(path.join(tmpDir, 'list.jwt'), listJwt)
-      var statusSetRes = runCli([
-        'status', 'set',
-        '--list', 'list.jwt',
-        '--index', '42',
-        '--status', 'revoked'
-      ], { cwd: tmpDir })
-      expect(statusSetRes.code, statusSetRes.stderr).to.equal(0)
-      var updatedListJwt = statusSetRes.stdout.trim()
-      expect(updatedListJwt.split('.')).to.have.length(3)
-
-      // 8. Check the new status at index 42
-      fs.writeFileSync(path.join(tmpDir, 'list-updated.jwt'), updatedListJwt)
-      var statusCheckRes = runCli([
-        'status', 'check',
-        '--list', 'list-updated.jwt',
-        '--index', '42'
-      ], { cwd: tmpDir })
-      expect(statusCheckRes.code, statusCheckRes.stderr).to.equal(0)
-      expect(statusCheckRes.stdout.trim()).to.equal('revoked')
-
-      // 9. A different index should still report valid
-      var statusCheckValidRes = runCli([
-        'status', 'check',
-        '--list', 'list-updated.jwt',
-        '--index', '0'
-      ], { cwd: tmpDir })
-      expect(statusCheckValidRes.code, statusCheckValidRes.stderr).to.equal(0)
-      expect(statusCheckValidRes.stdout.trim()).to.equal('valid')
-    })
-  })
-
-  describe('error handling', function () {
-    it('vc issue without --issuer exits non-zero', function () {
-      var r = runCli(['vc', 'issue', '--subject', 'x', '--claims', '{}'], { cwd: tmpDir })
-      expect(r.code).to.not.equal(0)
-      expect(r.stderr).to.match(/--issuer/)
-    })
-
-    it('vc verify on a missing file exits non-zero', function () {
-      var r = runCli(['vc', 'verify', 'no-such-file.jwt'], { cwd: tmpDir })
-      expect(r.code).to.not.equal(0)
-    })
-
-    it('status set without --list exits non-zero', function () {
-      var r = runCli(['status', 'set', '--index', '1', '--status', 'revoked'], { cwd: tmpDir })
-      expect(r.code).to.not.equal(0)
-    })
-
-    it('anchor build without --kind exits non-zero', function () {
-      var r = runCli(['anchor', 'build', '--hash', 'x', '--issuer', 'y'], { cwd: tmpDir })
-      expect(r.code).to.not.equal(0)
-    })
-  })
-})

package/test/consensus/base58-vectors.js

@@ -1,120 +0,0 @@
-'use strict'
-
-/**
- * Base58 and Base58Check vectors from SV Node v1.2.0.
- *
- * `base58_encode_decode.json` had no counterpart in the inherited bitcoind
- * corpus and nothing else here exercises it. It is small, but it is the only
- * place the raw codec is pinned against the node in both directions, and it
- * carries the two cases an implementation gets wrong: the empty input, and
- * leading zero bytes, which base58 encodes as leading '1's rather than as part
- * of a number.
- *
- * The key vectors are content-identical to the bitcoind copies that
- * test/address.js and test/privatekey.js already use — same 50 rows, different
- * whitespace. They are run here against the SV copies regardless, so that the
- * corpus under test/data/bitcoin-sv is the one this library is measured
- * against. That directory is the declared specification, and re-copying it
- * from a newer node tag should move these tests with it.
- */
-
-require('chai').should()
-const bsv = require('../..')
-const Base58 = bsv.encoding.Base58
-const Base58Check = bsv.encoding.Base58Check
-const Address = bsv.Address
-const PrivateKey = bsv.PrivateKey
-
-const encodeDecode = require('../data/bitcoin-sv/base58_encode_decode.json')
-const keysValid = require('../data/bitcoin-sv/base58_keys_valid.json')
-const keysInvalid = require('../data/bitcoin-sv/base58_keys_invalid.json')
-
-describe('base58 vectors (SV Node v1.2.0)', function () {
-  describe('the raw codec', function () {
-    it('encodes every vector to the recorded string', function () {
-      encodeDecode.forEach(function (v, i) {
-        Base58.encode(Buffer.from(v[0], 'hex'))
-          .should.equal(v[1], 'encoding row ' + i + ' (' + v[0] + ')')
-      })
-    })
-
-    it('decodes every vector back to the recorded bytes', function () {
-      encodeDecode.forEach(function (v, i) {
-        Base58.decode(v[1]).toString('hex')
-          .should.equal(v[0], 'decoding row ' + i + ' (' + JSON.stringify(v[1]) + ')')
-      })
-    })
-
-    it('keeps leading zero bytes as leading ones', function () {
-      // Ten zero bytes encode as ten '1's. An implementation that treats the
-      // input purely as a number loses them, and every address starting 1
-      // depends on this.
-      Base58.encode(Buffer.alloc(10)).should.equal('1111111111')
-      Base58.decode('1111111111').should.deep.equal(Buffer.alloc(10))
-    })
-
-    it('round-trips the empty input', function () {
-      Base58.encode(Buffer.alloc(0)).should.equal('')
-      Base58.decode('').length.should.equal(0)
-    })
-  })
-
-  describe('keys and addresses', function () {
-    it('accepts every valid key vector', function () {
-      let addresses = 0
-      let privkeys = 0
-      keysValid.forEach(function (v, i) {
-        const str = v[0]
-        const meta = v[2]
-        if (meta.isPrivkey) {
-          const key = PrivateKey.fromWIF(str)
-          key.toWIF().should.equal(str, 'WIF round trip at ' + i)
-          privkeys++
-        } else {
-          const network = meta.isTestnet ? 'testnet' : 'livenet'
-          const address = Address.fromString(str, network)
-          address.toString().should.equal(str, 'address round trip at ' + i)
-          address.hashBuffer.toString('hex')
-            .should.equal(v[1], 'hash at ' + i)
-          address.type.should.equal(
-            meta.addrType === 'script' ? Address.PayToScriptHash : Address.PayToPublicKeyHash,
-            'type at ' + i)
-          addresses++
-        }
-      })
-      // Both kinds must actually have been reached.
-      addresses.should.be.above(0)
-      privkeys.should.be.above(0)
-    })
-
-    it('rejects every invalid key vector, as neither address nor key', function () {
-      // The claim these vectors make is that the string is not a valid address
-      // and not a valid WIF — not that it fails Base58Check. Several of them
-      // carry a perfectly good checksum and are simply the wrong length or
-      // version, so the checksum layer accepts them and the layer above is
-      // what has to refuse. Asserting the stronger thing would be asserting
-      // something the corpus does not say.
-      let checksumOk = 0
-      keysInvalid.forEach(function (v, i) {
-        const str = v[0]
-        Address.isValid(str).should.equal(false, 'Address accepted row ' + i)
-
-        let isKey = true
-        try {
-          PrivateKey.fromWIF(str)
-        } catch (e) {
-          isKey = false
-        }
-        isKey.should.equal(false, 'PrivateKey accepted row ' + i)
-
-        try {
-          Base58Check.decode(str)
-          checksumOk++
-        } catch (e) { /* a bad checksum is one way to be invalid, not the only one */ }
-      })
-      // Guards the reasoning above: if none of them had a valid checksum, this
-      // test would be weaker than it looks and Base58Check could be asserted.
-      checksumOk.should.be.above(0)
-    })
-  })
-})

package/test/consensus/sv-script-vectors.js

@@ -1,81 +0,0 @@
-'use strict'
-
-/**
- * Consensus ratchet over the SV Node script vectors.
- *
- * A report tells you where you are; this stops you going backwards. Both read
- * the same harness, so the progress figure and the gate cannot disagree.
- *
- * False accepts are held at zero outright rather than through an allowlist,
- * because accepting a script the network rejects is the direction that can
- * cost money. False rejects are held at zero too — the corpus passes
- * completely, so there is nothing to exempt and no list to maintain.
- */
-
-require('chai').should()
-const harness = require('../../tools/sv-vector-harness')
-
-describe('SV Node script vectors', function () {
-  this.timeout(120000)
-
-  let results = null
-
-  before(function () {
-    results = harness.runAll()
-  })
-
-  it('runs the whole corpus', function () {
-    results.length.should.equal(1483)
-  })
-
-  it('uses no flag the harness does not recognise', function () {
-    // An unrecognised flag means vectors run under the wrong rules, and any
-    // pass among them means nothing.
-    const unknown = new Set()
-    results.forEach(r => r.unknownFlags.forEach(f => unknown.add(f)))
-    Array.from(unknown).should.deep.equal([])
-  })
-
-  it('accepts nothing the node rejects', function () {
-    const accepts = results.filter(r => r.direction === 'accept')
-    const detail = accepts.map(r =>
-      '\n  ' + r.id + '  ' + r.reason + '\n      ' + harness.describe(r.row)).join('')
-    accepts.length.should.equal(0, 'false accepts must stay at zero:' + detail)
-  })
-
-  it('rejects nothing the node accepts', function () {
-    const rejects = results.filter(r => r.direction === 'reject')
-    const detail = rejects.map(r =>
-      '\n  ' + r.id + '  ' + r.reason + '\n      ' + harness.describe(r.row)).join('')
-    rejects.length.should.equal(0, 'false rejects must stay at zero:' + detail)
-  })
-
-  it('fails for the reason the node gives', function () {
-    // Matching the outcome is not the same as matching the reason, and the gap
-    // hid three real bugs — see ERROR_CODE_ALIASES in the harness. Each left
-    // the script failing, so the two tests above stayed green throughout.
-    const wrong = results.filter(r => r.codeMatches === false)
-    const detail = wrong.map(r =>
-      '\n  ' + r.id + '  expected ' + r.expectedCode + ', reported ' + r.gotCode +
-      '\n      ' + harness.describe(r.row)).join('')
-    wrong.length.should.equal(0,
-      wrong.length + ' vector(s) fail for the wrong reason:' + detail)
-  })
-
-  it('compares a code on every vector the node rejects', function () {
-    // Guards the test above: if `comparable` ever narrowed, it would pass by
-    // checking nothing.
-    const rejected = results.filter(r => r.row.expected !== 'OK' && r.passed)
-    rejected.length.should.equal(600)
-    rejected.every(r => r.codeMatches !== null).should.equal(true)
-  })
-
-  it('uses every alias it grants', function () {
-    // The ratchet's other direction. An alias no vector produces any more is
-    // an exemption outliving its reason, and should be deleted rather than
-    // left to cover something later.
-    const produced = new Set(results.filter(r => r.gotCode).map(r => r.gotCode))
-    const unused = Object.keys(harness.ERROR_CODE_ALIASES).filter(a => !produced.has(a))
-    unused.should.deep.equal([], 'alias(es) no vector produces; remove them')
-  })
-})

package/test/consensus/sv-sighash-vectors.js

@@ -1,51 +0,0 @@
-'use strict'
-
-/**
- * Transaction digest vectors from SV Node v1.2.0 — the regression gate.
- *
- * The work is in tools/sv-sighash-harness.js, which npm run vectors:sv-sighash
- * also uses, so the progress report and this gate cannot disagree about what
- * passes. That file documents the corpus layout and the node's routing.
- *
- * Unlike the script and transaction vectors, this one carries no known-failure
- * list. It has never had a failing row and there is no reason it should: a
- * digest is a pure function of a transaction and a hash type, with no era to
- * negotiate.
- */
-
-require('chai').should()
-const harness = require('../../tools/sv-sighash-harness')
-
-describe('SV Node sighash vectors', function () {
-  this.timeout(120000)
-
-  const results = harness.runAll()
-
-  it('covers the whole corpus', function () {
-    results.length.should.equal(1000)
-  })
-
-  it('matches the node on both digest columns', function () {
-    const failures = results.filter(r => !r.passed)
-      .map(r => '#' + r.index + ' ' + r.reason)
-    failures.slice(0, 8).should.deep.equal([],
-      failures.length + ' of ' + results.length + ' rows disagree with the node')
-  })
-
-  it('routes every Chronicle-bit row to the original digest', function () {
-    // Stated separately so a routing regression reads as one rather than as
-    // hundreds of unexplained hash mismatches.
-    const withBit = harness.chronicleRows()
-    withBit.length.should.equal(511)
-    withBit.forEach(v => v[4].should.equal(v[5]))
-    results.filter(r => r.chronicleBit)
-      .forEach(r => r.algorithm.should.equal('OTDA'))
-  })
-
-  it('still exercises both algorithms', function () {
-    // Guards the test above: if the routing collapsed to OTDA everywhere it
-    // would pass, and this is what would notice.
-    results.filter(r => r.algorithm === 'BIP143').length.should.be.above(0)
-    results.filter(r => r.algorithm === 'OTDA').length.should.be.above(0)
-  })
-})

package/test/consensus/sv-tx-vectors.js

@@ -1,48 +0,0 @@
-'use strict'
-
-/**
- * Consensus ratchet over the SV Node transaction vectors.
- *
- * These reach a level the script corpus cannot. A script vector evaluates one
- * unlocking script against one locking script; these deserialise a whole
- * transaction, resolve each input against the output it claims to spend, and
- * require every one to verify, with locktimes and sequence numbers in play.
- *
- * That level earned itself immediately: it found that Genesis reverts
- * OP_CHECKLOCKTIMEVERIFY and OP_CHECKSEQUENCEVERIFY to upgradable NOPs, which
- * this library did not implement and no script vector can reach — the
- * behaviour only appears once a real nLockTime and sequence number exist.
- */
-
-require('chai').should()
-const harness = require('../../tools/sv-tx-harness')
-
-describe('SV Node transaction vectors', function () {
-  this.timeout(120000)
-
-  let results = null
-
-  before(function () {
-    results = harness.runAll()
-  })
-
-  it('runs both files', function () {
-    results.length.should.equal(161)
-    results.filter(r => r.expected).length.should.equal(93)
-    results.filter(r => !r.expected).length.should.equal(68)
-  })
-
-  it('accepts no transaction the node rejects', function () {
-    const accepts = results.filter(r => r.direction === 'accept')
-    const detail = accepts.map(r =>
-      '\n  ' + r.id + '  ' + r.reason + '\n      ' + harness.describe(r)).join('')
-    accepts.length.should.equal(0, 'false accepts must stay at zero:' + detail)
-  })
-
-  it('rejects no transaction the node accepts', function () {
-    const rejects = results.filter(r => r.direction === 'reject')
-    const detail = rejects.map(r =>
-      '\n  ' + r.id + '  ' + r.reason + '\n      ' + harness.describe(r)).join('')
-    rejects.length.should.equal(0, 'false rejects must stay at zero:' + detail)
-  })
-})