Models

interface ScanResult {
  domainName: string;
  recommendedAction: RecommendedAction;
  riskFactors: RiskFactor[] | null;
  verified: boolean; // If the website is on our allowlist
  status: ScanStatus;
}

export enum RecommendedAction {
  None = 'NONE', // No threats detected
  Warn = 'WARN', // Suspicious indicators found
  Block = 'BLOCK' // Confirmed threats present
}

interface RiskFactor {
  type: WarningType;
  severity: Severity;
  message: RiskMessage;
  value?: string; // Optional. Additional risk data present on ML_INFERENCE and RECENTLY_CREATED warning types
}

export enum ScanStatus {
  Complete = 'COMPLETE', // Scan finished with results available
  InProgress = 'IN_PROGRESS', // Scan in progress, scraper gathering advanced heuristics
  Incomplete = 'INCOMPLETE' // Scan could not complete, possibly due to domain resolution issues
}

enum WarningType {
  RecentlyCreated = "RECENTLY_CREATED", 
  Blocklisted = "BLOCKLISTED", 
  MlInference = "ML_INFERENCE", 
  Drainer = "DRAINER",
}

enum Severity {
  Low = "LOW",
  High = "HIGH",
  Critical = "CRITICAL",
}

enum RiskMessage {
  RecentlyCreatedRiskMessage = "Domain recently created.",
  BlocklistedRiskMessage = "Domain flagged on blocklist.",
  MlInferenceRiskMessage = "Domain is likely a phishing attempt.",
  DrainerRiskMessage = "Domain identified as a wallet drainer.",
}