Skip to main content

Documentation Index

Fetch the complete documentation index at: https://open-dbe26606.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Directory layout

opendev/
├── cli/        # CLI entry point and terminal renderer
├── services/   # Analysis engine, RPC layer, decoders
├── scripts/    # Validation and benchmark scripts
├── docs/       # Architecture, troubleshooting, schema references
└── web/        # Web frontend (work in progress)

CLI (cli/)

Entry point and terminal user interface.
  • bin/ — executable entry point
  • src/ — command implementations (tx, simulate, batch, config, login)
  • dist/ — compiled output (tsup bundle)
Output: Single open.js bundle, installed globally as opendev

Services (services/)

Analysis engine and supporting utilities.
  • Analysis engine — CPI tree building, compute unit tracking, state diffs
  • RPC layer — Solana RPC client wrappers
  • Decoders — Program-specific instruction/state decoders
  • IDL cache — Local cache of program IDLs
  • AI integration — MCP client for LLM calls

Scripts (scripts/)

Validation and benchmarking.
  • validate-decoders.ts — Verify decoder coverage
  • benchmark.ts — Performance and latency tests
  • audit.ts — Supply chain and dependency checks
Run before opening PRs:
npm run test:all
npm run validate:decoders
npm run audit:prod

Docs (docs/)

Developer documentation.
FileTopic
ArchitectureSystem architecture and data flow
Use CasesReal-world usage scenarios
TroubleshootingCommon errors and fixes
AI InsightsPrompt sources, insight ranking, MCP format
DecodersProgram registry schema, adding decoders
Anomaly DetectionSpam / MEV-like / nondeterministic-failure detection
Performance & QualityLatency benchmarks, test coverage

Web (web/)

Web frontend (work in progress).

Workspaces

This is an npm monorepo. Install dependencies once at the root:
npm install
npm run build
To build a single workspace:
npm run build --workspace cli
npm run build --workspace services

Build artifacts

After npm run build:
dist/
├── open.js           # CLI bundle (installed globally)
├── services/
│   ├── analysis/     # Analysis engine bundle
│   └── decoders/     # Decoder plugins
└── web/              # Web build (Next.js output)

Contributing

See CONTRIBUTING.md. Before opening a PR:
npm run test:all              # Run all tests
npm run validate:decoders     # Verify decoders
npm audit --omit=dev          # Check prod dependencies (should be 0 vulns)