Documentation

# Counterscarp — Full Audit Configuration

[project]
name = "MyDeFi Protocol"
version = "3.0.0"

[analyzers]
slither     = true
aderyn      = true
mythril     = true
ai_copilot  = true
attack_path = true
time_travel = true

[thresholds]
blocker_severity = "HIGH"
max_findings     = 0  # 0 = fail on any HIGH

[output]
html_report = true
md_report   = true
json_output = false

name: Counterscarp Audit
on:
  pull_request:
    branches: [main]

jobs:
  blocker-checks:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install Counterscarp
        run: pip install counterscarp-engine --upgrade
      - name: Counterscarp PR Check (Blockers)
        env:
          COUNTERSCARP_PRO_LICENSE: ${{ secrets.COUNTERSCARP_PRO_LICENSE }}
        run: |
          counterscarp scan ./contracts \
            --config counterscarp-pr.toml
  advisory-checks:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install Counterscarp
        run: pip install counterscarp-engine --upgrade
      - name: Counterscarp Full Audit
        env:
          COUNTERSCARP_PRO_LICENSE: ${{ secrets.COUNTERSCARP_PRO_LICENSE }}
        run: |
          counterscarp scan ./contracts \
            --config counterscarp-audit.toml \
            --report

counterscarp-engine:
  stage: test
  image: python:3.11
  variables:
    COUNTERSCARP_PRO_LICENSE: ${COUNTERSCARP_PRO_LICENSE}
  script:
    - pip install counterscarp-engine --upgrade
    - counterscarp scan ./contracts --config counterscarp-pr.toml
  only:
    - merge_requests

trigger:
  branches:
    include: [main]

pool:
  vmImage: ubuntu-latest

steps:
- task: UsePythonVersion@0
  inputs:
    versionSpec: '3.11'
- script: pip install counterscarp-engine --upgrade
  displayName: 'Install Counterscarp'
- script: counterscarp scan ./contracts --config counterscarp-pr.toml
  displayName: 'Counterscarp Scan'
  env:
    COUNTERSCARP_PRO_LICENSE: $(COUNTERSCARP_PRO_LICENSE)

pipeline {
  agent { label 'python' }
  environment {
    COUNTERSCARP_PRO_LICENSE = credentials('counterscarp-pro-license')
  }
  stages {
    stage('Security Scan') {
      steps {
        sh 'pip install counterscarp-engine --upgrade'
        sh 'counterscarp scan ./contracts --config counterscarp-pr.toml'
      }
    }
  }
}

from counterscarp import CounterscarpEngine, AuditConfig

# Initialize engine
engine = CounterscarpEngine(
    config=AuditConfig.from_file("counterscarp-audit.toml")
)

# Run audit
results = engine.audit(target="./contracts")

# Access findings
for finding in results.findings:
    print(f"{finding.severity}: {finding.title}")
    print(f"  File: {finding.file}:{finding.line}")

# Generate report
results.export_html("audit_report.html")
results.export_markdown("audit_report.md")