A detector that identifies write-only or unused variables, fields and constants.

These variables are either assigned but never used in any meaningful computation, or they are declared and never used at all, which may indicate redundant code or an incomplete implementation of the intended logic.

// Error: the developer forgot to use the constant
const MAX_SUPPLY: Int = 1000;

fun mint(to: Address, amount: Int) {
  balances.set(to, balances.get(to)!! + amount);
  totalSupply += amount;
}

Use instead:

const MAX_SUPPLY: Int = 1000;

fun mint(to: Address, amount: Int) {
  // OK: Fixed after the analyzer highlighted this warning
  require(totalSupply + amount <= MAX_SUPPLY, "Exceeds max supply");
  balances.set(to, balances.get(to)!! + amount);
  totalSupply += amount;
}

Hierarchy (view full)

Constructors

Properties

severity: Severity = Severity.MEDIUM

Gets the severity of the detector.

Accessors

  • get id(): string
  • Gets the short identifier of the detector, used in analyzer warnings.

    Returns string

    The unique identifier of the detector.

  • get shareImportedWarnings(): WarningsBehavior
  • Defines the behavior of warnings generated by this detector when working with multiple projects within a single Tact configuration.

    Here are the available options:

    1. "union" Leave this value if you don't care about warnings generated in other projects.
    2. "intersect" If the warning is generated for some source location of the imported file, it should be generated by each of the projects. Example: Constants from an imported file should not be reported iff they are unused in all the projects, so you need "intersect".

    Returns WarningsBehavior

  • get usesSouffle(): boolean
  • Checks whether this detector needs the Soufflé binary to be executed.

    Returns boolean

Methods