DOCUMENTATION

Get started with Securithm in minutes. Scan your first contract.

• Install the CLI: npm install securithm -g
• Scan a contract: securithm scan ./contract.sol
• View results in the dashboard
• Set up CI/CD integration

Different ways to analyze your smart contracts.

• Static Analysis: Pattern matching and vulnerability detection
• Symbolic Execution: Deep path analysis for complex bugs
• Risk Scoring: Overall risk assessment with grade A-F
• Continuous Monitoring: Real-time on-chain surveillance

Automate security scanning in your pipeline.

• GitHub Action: Runs on every push and PR
• GitLab CI: Custom job template available
• Inline Comments: Findings posted on PR diffs
• Severity Gating: Block merges above threshold

Programmatic access to all Securithm features.

• POST /api/v1/scans — Submit new contract for analysis
• GET /api/v1/scans/{id} — Retrieve scan results
• GET /api/v1/risk-score/{chain}/{address} — Get risk score
• GET /api/v1/risk-score/{chain}/{address}/history — Historical data

Watch your deployed contracts in real time.

• Add contracts to monitoring dashboard
• Configure alert thresholds by severity
• Webhook delivery for critical alerts
• Slack, Discord, and PagerDuty integrations

Trust and compliance information.

• SOC 2 Type II certification (in progress)
• Data encryption at rest and in transit
• Role-based access control (RBAC)
• Audit logging with 1-year retention

Understand how Securithm evaluates contract risk.

• Grade A (0-20): Low risk, no critical findings
• Grade B (21-40): Moderate risk, minor issues
• Grade C (41-60): Elevated risk, needs attention
• Grade D-F (61+): High risk, immediate action required

Fix findings and track resolution progress.

• AI-generated fix suggestions with explanations
• One-click apply for verified fixes
• Assign findings to team members
• Export security posture reports as PDF