Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Reports

Reports are the primary output of Odin Scan analyses. Each report contains a detailed breakdown of security findings discovered in your smart contract code.

Report Contents

A completed analysis report includes:

  • Summary – total number of findings grouped by severity level.
  • Findings list – individual security issues discovered during the scan.
  • Markdown report – a formatted, human-readable version of the full report.

Findings

Each finding in a report includes the following details:

FieldDescription
TitleShort description of the security issue
DescriptionDetailed explanation of the vulnerability and its impact
SeverityCritical, High, Medium, Low, or Informational
ConfidenceHow certain the analyzer is about the finding: High, Medium, or Low
CategoryClassification of the issue (e.g., Input Validation, Access Control, Reentrancy)
FileSource file where the issue was found
Line numbersStart and end line of the affected code
RemediationSuggested fix or mitigation strategy

Some findings also include:

  • Proof of Concept (PoC) – example code or steps demonstrating how the vulnerability could be exploited.
  • References – links to relevant security advisories, documentation, or standards.

Severity Levels

SeverityDescription
CriticalImmediate risk of fund loss or contract takeover. Requires urgent remediation.
HighSignificant security risk that could lead to loss of funds or unauthorized access under certain conditions.
MediumModerate risk that could cause unintended behavior or partial loss of functionality.
LowMinor issue with limited security impact. Should be addressed but is not urgent.
InformationalBest practice suggestion or code quality observation. No direct security impact.

Report Statuses

Each analysis (and its associated report) has a status indicating where it is in the lifecycle:

StatusMeaning
PendingThe analysis is queued and waiting to start
RunningThe analysis is currently in progress
CompletedThe analysis finished successfully and results are available
FailedThe analysis encountered an error (e.g., compilation failure)

Failed analyses can be retried from the report view or via the API.

Viewing a Report

  1. Navigate to Reports from the sidebar.
  2. Click on any completed analysis to open the full report.
  3. The report view shows the summary at the top, followed by individual findings.
  4. Click on a finding to expand its details, including the affected code location and remediation guidance.

Markdown Report View

Each report includes a rendered Markdown view that presents the findings in a readable document format. This is the same content available through the markdownReport field in the API response.

The Markdown view is useful for:

  • Sharing reports with team members who do not have dashboard access.
  • Copying findings into issue trackers or documentation.
  • Quick review without navigating individual findings.

Next Steps

  • Filters – narrow down reports by status, date, or severity
  • Exports – download reports in JSON, Markdown, or SARIF format
  • Audit Logs – track who viewed or acted on reports