trac-msb 0.2.27 → 0.2.28

package/README.md

@@ -37,6 +37,40 @@ cd main_settlement_bus
 npm install
 ```
 
+## HyperDHT LAN compatibility (0.2.28)
+
+HyperDHT 6.29.x calls `bogon.isReserved` when connecting peers through a relay on
+one host or LAN. Bogon 1.1.0 lacks that export; 1.2.0 first supplies it. This
+release requires `bogon ^1.2.0` and checks the Bogon actually resolved by every
+reachable HyperDHT copy during `postinstall`. This applies to regular peers as
+well as validators.
+
+A package lockfile or `overrides` in a dependency does not protect an application's
+installation. Applications should update their own lockfiles and run
+`node node_modules/trac-msb/scripts/check-hyperdht-bogon.cjs` after installation.
+If lifecycle scripts are disabled, also run
+`node node_modules/trac-msb/scripts/hypercore-stallfix/apply.mjs` and then repeat
+it with `--check`. Both checks must succeed before starting the application.
+The check reports an incompatible nested Bogon instead of modifying dependencies.
+
+From this repository, run `npm run check:dependencies` and
+`npm run test:hyperdht-bogon`. The regression uses only a local bootstrap and
+throwaway keys, binds to loopback ports 59100–59199, and does not join a Trac
+network. Start the application with `npm start` (there is no `prod` script).
+
+## Upgrading from releases started with `npm run prod`
+
+Early 0.2.x releases started with `npm run prod --store=<name>` (through `pear run`). Current releases have no
+`prod` script; start a mainnet node with:
+
+```sh
+npm run start -- --stores-directory stores/<name> --network mainnet
+```
+
+The node reads its key from `stores/<name>/db/keypair.json`. A store created by an older release may live in a
+different location, in which case the key file is not found. Copy that store's `db/keypair.json` to the new path
+before the first start, or restore the wallet from its mnemonic.
+
 ## Post-install checklist
 
 Before running tests, install bare globally:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "trac-msb",
   "main": "msb.mjs",
-  "version": "0.2.27",
+  "version": "0.2.28",
   "pear": {
     "name": "trac-msb",
     "type": "terminal"
@@ -13,12 +13,13 @@
     "NOTICE",
     "rpc/",
     "SECURITY.md",
+    "scripts/check-hyperdht-bogon.cjs",
     "scripts/hypercore-stallfix/",
     "scripts/pear-runner.js",
     "src/"
   ],
   "scripts": {
-    "postinstall": "node scripts/hypercore-stallfix/apply.mjs",
+    "postinstall": "node scripts/check-hyperdht-bogon.cjs && node scripts/hypercore-stallfix/apply.mjs",
     "start": "NODE_OPTIONS='--max-old-space-size=4096' node scripts/pear-runner.js",
     "rpc": "NODE_OPTIONS='--max-old-space-size=4096' node scripts/pear-runner.js --rpc --host ${npm_config_host} --port ${npm_config_port}",
     "env": "if [ -f .env ]; then set -a; . ./.env; set +a; fi; NODE_OPTIONS='--max-old-space-size=4096' node scripts/pear-runner.js --stores-directory ${STORES_DIRECTORY:-stores} --network ${NETWORK:-mainnet}",
@@ -35,8 +36,10 @@
     "test:unit:bare": "brittle-bare -t 60000 tests/unit/unit.test.js",
     "test:unit:pear": "BRITTLE='-t 60000' brittle-pear tests/unit/unit.test.js",
     "test:pear-runner": "node --test tests/runner/pear-runner.test.js",
-    "test:unit:all": "(npm run test:unit:prepare && npm run test:unit:node && npm run test:unit:bare && npm run test:pear-runner) || exit 1",
-    "test:unit:node:cov": "brittle-node -c -t 60000 tests/unit/unit.test.js"
+    "test:unit:all": "(npm run test:unit:prepare && npm run test:hyperdht-bogon && npm run test:unit:node && npm run test:unit:bare && npm run test:pear-runner) || exit 1",
+    "test:unit:node:cov": "brittle-node -c -t 60000 tests/unit/unit.test.js",
+    "check:dependencies": "node scripts/check-hyperdht-bogon.cjs",
+    "test:hyperdht-bogon": "node --test tests/hyperdht-bogon-check.test.cjs && node tests/hyperdht-lan-repro.cjs"
   },
   "dependencies": {
     "autobase": "7.20.1",
@@ -48,6 +51,7 @@
     "bare-tty": "5.0.2",
     "bare-utils": "1.5.1",
     "bech32": "2.0.0",
+    "bogon": "^1.2.0",
     "compact-encoding": "2.18.0",
     "corestore": "7.5.0",
     "crypto": "npm:bare-node-crypto",
@@ -58,8 +62,8 @@
     "hypercore": "11.18.3",
     "hypercore-crypto": "3.6.1",
     "hyperdht": "6.29.6",
-    "hyperswarm": "4.14.2",
     "hyperschema": "1.17.1",
+    "hyperswarm": "4.14.2",
     "lodash": "^4.18.1",
     "p-queue": "^9.1.0",
     "pear-runtime": "1.3.1",

package/scripts/check-hyperdht-bogon.cjs

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+// Check the actual Bogon seen by each reachable HyperDHT, including nested copies.
+// A dependency's overrides and package-lock.json do not constrain its consumers.
+const fs = require('node:fs')
+const path = require('node:path')
+const { createRequire } = require('node:module')
+
+function check(root = path.resolve(__dirname, '..')) {
+    const pending = [path.join(root, 'package.json')]
+    const seen = new Set()
+    let checked = 0
+    while (pending.length) {
+        const manifest = pending.pop()
+        if (seen.has(manifest)) continue
+        seen.add(manifest)
+        const pkg = JSON.parse(fs.readFileSync(manifest, 'utf8'))
+        const requireFrom = createRequire(manifest)
+        if (pkg.name === 'hyperdht') {
+            checked++
+            const [major, minor] = pkg.version.split('.').map(Number)
+            if (major < 6 || (major === 6 && minor < 29)) continue
+            const bogon = requireFrom('bogon')
+            if (typeof bogon.isReserved !== 'function' || typeof bogon.isBogon !== 'function') {
+                throw new Error(`HyperDHT ${pkg.version} resolves incompatible Bogon at ${requireFrom.resolve('bogon')}. Update the consumer lockfile to bogon >=1.2.0 and reinstall; same-host or LAN peer connections can otherwise crash.`)
+            }
+        }
+        for (const name of Object.keys({ ...pkg.dependencies, ...pkg.optionalDependencies })) {
+            // Resolve physical manifests even when package exports hide package.json.
+            const paths = requireFrom.resolve.paths(`${name}/package.json`) || []
+            const resolved = paths.map(dir => path.join(dir, name, 'package.json')).find(file => fs.existsSync(file))
+            if (!resolved) {
+                if (pkg.optionalDependencies?.[name]) continue
+                throw new Error(`Missing dependency ${name} required by ${pkg.name}`)
+            }
+            pending.push(fs.realpathSync(resolved))
+        }
+    }
+    if (checked === 0) throw new Error('No HyperDHT found; dependency installation is incomplete.')
+    return checked
+}
+
+module.exports = { check }
+if (require.main === module) {
+    try {
+        console.log(`HyperDHT/Bogon compatibility: ${check()} copies checked`)
+    } catch (error) {
+        console.error(error.message)
+        process.exitCode = 1
+    }
+}