@gatedpath/preflight 0.1.0

package/dist/suites.js

@@ -0,0 +1,53 @@
+// The five-state suites: test contracts under test/ that inherit GatedTest from @gatedpath/receptor-mock.
+// Shared by `ship` here and by the MCP server's five_state_tests and status.
+import { existsSync, readdirSync, readFileSync } from 'node:fs';
+import { join } from 'node:path';
+export function findGatedSuites(project, testDir = 'test') {
+    const dir = join(project, testDir);
+    if (!existsSync(dir))
+        return [];
+    const names = [];
+    const walk = (d) => {
+        for (const entry of readdirSync(d, { withFileTypes: true })) {
+            const p = join(d, entry.name);
+            if (entry.isDirectory())
+                walk(p);
+            else if (entry.name.endsWith('.t.sol')) {
+                const text = readFileSync(p, 'utf8');
+                for (const m of text.matchAll(/\bcontract\s+([A-Za-z0-9_]+)\s+is\s+([^{]*)\bGatedTest\b/g))
+                    names.push(m[1]);
+            }
+        }
+    };
+    walk(dir);
+    return names;
+}
+/** Counts a `forge test --json` result against the suites that inherit GatedTest. */
+export function summariseTests(parsed, gatedSuites) {
+    let passed = 0;
+    let failed = 0;
+    let skipped = 0;
+    const perSuite = new Map();
+    const failures = [];
+    for (const [suitePath, v] of Object.entries(parsed)) {
+        const name = suitePath.split(':').pop() ?? suitePath;
+        const s = perSuite.get(name) ?? { passed: 0, failed: 0 };
+        for (const [test, r] of Object.entries(v.test_results ?? {})) {
+            if (r.status === 'Success') {
+                passed++;
+                s.passed++;
+            }
+            else if (r.status === 'Failure') {
+                failed++;
+                s.failed++;
+                failures.push({ suite: name, test, reason: r.reason ?? null });
+            }
+            else
+                skipped++;
+        }
+        perSuite.set(name, s);
+    }
+    const suites = gatedSuites.map((name) => ({ name, ...(perSuite.get(name) ?? { passed: 0, failed: 0 }) }));
+    const fiveState = gatedSuites.length > 0 && suites.every((s) => s.failed === 0 && s.passed > 0);
+    return { passed, failed, skipped, suites, fiveState, failures };
+}

package/dist/types.d.ts

@@ -0,0 +1,58 @@
+export type CheckStatus = 'pass' | 'fail' | 'warn' | 'skip';
+export type CheckId = 'chain-id' | 'deployer-verified' | 'admin-safe' | 'compiler-pins' | 'git-secrets' | 'balance' | 'slither-report';
+export interface CheckResult {
+    readonly id: CheckId;
+    readonly status: CheckStatus;
+    /** One sentence. Printed after the status on the terminal and copied into the JSON. */
+    readonly reason: string;
+    /** Machine-readable detail. Never contains a secret. */
+    readonly data?: Record<string, unknown>;
+}
+export interface PreflightOptions {
+    /** Project directory holding foundry.toml or hardhat.config.*. Default: cwd. */
+    project?: string;
+    /** Foundry profile or Hardhat network name to read. Default: Foundry `default`, Hardhat: the network whose chainId matches. */
+    profile?: string;
+    /** Target chain. Default: whatever the RPC reports, checked against config. */
+    chain?: 151 | 153;
+    /** JSON-RPC URL. Default: the governors endpoint for `chain`. */
+    rpc?: string;
+    /** Foundry keystore account name; resolved with `cast wallet address --account`. */
+    account?: string;
+    /** Deployer address for a read-only run. */
+    address?: string;
+    /** Admin or owner address the deployed contracts will hand control to. */
+    admin?: string;
+    /** Gas the deployment is expected to burn. Default 3,000,000. */
+    gas?: number | bigint;
+    /** Slither report path. Default: reports/slither.json or reports/slither.md under the project. */
+    slitherReport?: string;
+    /** Check ids to skip. */
+    skip?: readonly CheckId[];
+    /** Registry, permission and price feed overrides for local chains. Tests use these. */
+    registry?: string;
+    /** Working directory for `cast`. Default: project. */
+    env?: NodeJS.ProcessEnv;
+}
+export interface PreflightReport {
+    readonly tool: 'redbelly-preflight';
+    readonly version: string;
+    readonly generatedAt: string;
+    readonly project: string;
+    readonly config: {
+        kind: 'foundry' | 'hardhat' | 'none';
+        file: string | null;
+        profile: string | null;
+    };
+    readonly chain: {
+        expected: number | null;
+        reported: number | null;
+        rpc: string;
+        network: 'mainnet' | 'testnet' | 'unknown';
+    };
+    readonly deployer: string | null;
+    readonly admin: string | null;
+    readonly checks: readonly CheckResult[];
+    /** True when no check failed. Warnings and skips do not clear a fail and do not cause one. */
+    readonly ok: boolean;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+// Shared shapes. A check never throws for a "no" answer; it returns a result with a status
+// and one sentence saying why. Only a bug throws.
+export {};

package/dist/well-known.d.ts

@@ -0,0 +1,2 @@
+export declare const WELL_KNOWN_DEV_ACCOUNTS: readonly string[];
+export declare function isWellKnownDevAccount(address: string): boolean;

package/dist/well-known.js

@@ -0,0 +1,21 @@
+// The ten accounts every anvil and Hardhat node starts with, whose private keys are printed
+// on every start and sit in every tutorial. RESEARCH.md question 30 (2026-09-12) found that
+// accounts 0 and 1 pass permission.isAllowed on both Redbelly networks, so a deploy from one
+// of them would succeed under an identity nobody here controls. Pre-flight warns on any of
+// the ten. The list is checked in the tests against a spawned anvil's eth_accounts.
+export const WELL_KNOWN_DEV_ACCOUNTS = [
+    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
+    '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
+    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
+    '0x90F79bf6EB2c4f870365E785982E1f101E93b906',
+    '0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65',
+    '0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc',
+    '0x976EA74026E726554dB657fA54763abd0C3a0aa9',
+    '0x14dC79964da2C08b23698B3D3cc7Ca32193d9955',
+    '0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f',
+    '0xa0Ee7A142d267C1f36714E4a8F75612F20a79720',
+];
+export function isWellKnownDevAccount(address) {
+    const a = address.toLowerCase();
+    return WELL_KNOWN_DEV_ACCOUNTS.some((w) => w.toLowerCase() === a);
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@gatedpath/preflight",
+  "version": "0.1.0",
+  "description": "Pre-flight checks before deploying to Redbelly Network (151 mainnet, 153 testnet): chain ID, deployer verification, Safe admin, compiler pins, secrets in git history, RBNT balance, Slither report.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tshirtdropper/redbelly-development-tool.git",
+    "directory": "packages/preflight"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=18"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "redbelly-preflight": "./dist/cli.js",
+    "redbelly-doctor": "./dist/doctor-cli.js",
+    "redbelly": "./dist/redbelly.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "node scripts/ensure-deps-built.mjs && tsc -p tsconfig.json && node -e \"for (const f of ['cli.js','doctor-cli.js','redbelly.js']) require('fs').chmodSync('dist/'+f,0o755)\"",
+    "test": "npm run build && node --test --test-reporter=spec --test-concurrency=1 test/unit.test.mjs test/preflight.test.mjs test/doctor.test.mjs test/gas.test.mjs test/ship.test.mjs",
+    "test:live": "npm run build && node --test --test-reporter=spec test/live.test.mjs",
+    "prepack": "npm run build"
+  },
+  "dependencies": {
+    "@gatedpath/agent-rules": "0.1.0",
+    "@gatedpath/chains": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.2",
+    "typescript": "^5.9.3"
+  }
+}