PROJECT_INDEX.json

{
  "project": {
    "name": "demos-node-software",
    "version": "0.9.8",
    "generatedAt": "2026-02-18T13:55:45Z",
    "generatedBy": "Repository Index Creator"
  },
  "summary": {
    "sourceFiles": 345,
    "testFiles": 16,
    "docFiles": 500,
    "configFiles": 57,
    "scriptFiles": 10
  },
  "entryPoints": [
    {
      "type": "cli",
      "path": "src/index.ts",
      "description": "Main node bootstrap and runtime orchestration"
    },
    {
      "type": "runner",
      "path": "run",
      "description": "Primary launch script used for node startup"
    },
    {
      "type": "api",
      "path": "src/libs/network/server_rpc.ts",
      "description": "RPC API server implementation"
    },
    {
      "type": "service",
      "path": "src/libs/omniprotocol/integration/startup.ts",
      "description": "OmniProtocol server startup/shutdown"
    },
    {
      "type": "tests",
      "path": "tests/omniprotocol/*.test.ts",
      "description": "Primary protocol and handler test suite"
    }
  ],
  "coreModules": [
    {
      "name": "Node Runtime",
      "path": "src/index.ts",
      "exports": ["executable entrypoint"],
      "purpose": "Bootstraps node services, loops, and global runtime state"
    },
    {
      "name": "Network API",
      "path": "src/libs/network/index.ts",
      "exports": ["serverRpcBun", "emptyResponse"],
      "purpose": "Public RPC surface and request routing layer"
    },
    {
      "name": "OmniProtocol",
      "path": "src/libs/omniprotocol/index.ts",
      "exports": [
        "types/config",
        "types/message",
        "types/errors",
        "protocol/opcodes",
        "protocol/registry",
        "integration",
        "serialization/*",
        "auth/*",
        "tls",
        "ratelimit"
      ],
      "purpose": "Protocol primitives, transport contracts, and serialization"
    },
    {
      "name": "Blockchain Core",
      "path": "src/libs/blockchain/",
      "exports": ["chain", "block", "mempool", "transaction", "routines/*"],
      "purpose": "Core chain data model and execution/validation routines"
    },
    {
      "name": "Peer Layer",
      "path": "src/libs/peer/",
      "exports": ["Peer", "PeerManager", "routines/*"],
      "purpose": "Peer lifecycle, discovery/bootstrap, gossip and broadcast"
    },
    {
      "name": "L2PS and ZK",
      "path": "src/libs/l2ps/ + src/features/zk/",
      "exports": ["L2PSHashService", "L2PSBatchAggregator", "proof managers", "merkle/prover wrappers"],
      "purpose": "Batch proving, zk verification and L2 operations"
    },
    {
      "name": "MCP Feature",
      "path": "src/features/mcp/",
      "exports": ["MCPServer", "tools/demosTools"],
      "purpose": "MCP-compatible tool interface for node capabilities"
    }
  ],
  "configuration": [
    { "file": "package.json", "purpose": "scripts, deps, runtime metadata" },
    { "file": "tsconfig.json", "purpose": "TypeScript compiler settings" },
    { "file": "ormconfig.json", "purpose": "TypeORM/database config" },
    { "file": "knip.json", "purpose": "unused code/dependency analysis" },
    { "file": "devnet/docker-compose.yml", "purpose": "local multi-node network" },
    { "file": "tlsnotary/docker-compose.yml", "purpose": "TLSNotary stack" },
    { "file": "monitoring/prometheus/prometheus.yml", "purpose": "metrics scraping" },
    { "file": "monitoring/grafana/provisioning/dashboards/dashboard.yml", "purpose": "Grafana dashboard provisioning" }
  ],
  "documentation": [
    { "file": "README.md", "topic": "overview and quick start" },
    { "file": "INSTALL.md", "topic": "installation guide" },
    { "file": "CONTRIBUTING.md", "topic": "contribution workflow" },
    { "file": "monitoring/README.md", "topic": "observability stack" },
    { "file": "devnet/README.md", "topic": "local devnet" },
    { "file": "OMNIPROTOCOL_SETUP.md", "topic": "omni protocol setup" },
    { "file": "L2PS_TESTING.md", "topic": "L2PS testing" }
  ],
  "tests": {
    "unit": 10,
    "integration": 8,
    "supportFiles": 6,
    "coverage": {
      "reported": false,
      "percentage": null,
      "note": "No committed coverage report detected"
    }
  },
  "dependencies": [
    { "name": "bun", "version": "^1.2.10", "purpose": "runtime" },
    { "name": "typescript", "version": "^5.9.3", "purpose": "type system and compilation" },
    { "name": "fastify", "version": "^4.28.1", "purpose": "API framework" },
    { "name": "typeorm", "version": "^0.3.17", "purpose": "database ORM" },
    { "name": "pg", "version": "^8.12.0", "purpose": "postgres driver" },
    { "name": "@kynesyslabs/demosdk", "version": "^2.10.2", "purpose": "Demos SDK integration" },
    { "name": "@modelcontextprotocol/sdk", "version": "^1.13.3", "purpose": "MCP protocol support" },
    { "name": "ethers", "version": "^6.16.0", "purpose": "EVM interactions" },
    { "name": "@solana/web3.js", "version": "^1.98.4", "purpose": "Solana interactions" },
    { "name": "snarkjs", "version": "^0.7.5", "purpose": "zk proof tooling" }
  ],
  "quickStart": [
    "bun install",
    "configure .env and demos_peerlist.json",
    "./run",
    "bun run type-check",
    "bun run test:chains",
    "bun run zk:test"
  ],
  "analysisNotes": {
    "semanticSearch": {
      "tool": "mantic.sh",
      "status": "executed",
      "result": "no high-confidence ranked file matches for broad discovery queries"
    }
  }
}