Class StateMutationInGetter

An optional detector that identifies cases where a state-mutating function is called within a getter method.

Why is it important?

While getter methods are generally expected to be pure functions that don’t modify state, they sometimes contain state-modifying logic (directly or indirectly). This can lead to misunderstandings for developers who assume getters are read-only. This detector is intended for auditors to highlight such cases as potential design concerns.

Example

contract Example {
  value: Int = 0;

  get fun getValue(): Int {
    self.updateCounter(); // Suspicious: calls a function that modifies state
    return self.value;
  }

  fun updateCounter() {
    self.value = self.value + 1; // Modifies state
  }
}

Use instead:

contract Example {
  value: Int = 0;
  get fun getValue(): Int {
    return self.value; // OK: Pure getter
  }

  fun getAndIncrement(): Int {
    let current = self.value;
    self.value = self.value + 1;
    return current;
  }
}

Hierarchy (view full)

Constructors

constructor

Properties

category ctx severity

Accessors

id kind shareImportedWarnings usesSouffle

Methods

check getCategory getSeverity makeWarning skipUnused

Constructors

constructor

Properties

category

category: Category = Category.SECURITY

Readonlyctx

ctx: MistiContext

severity

severity: Severity = Severity.INFO

Accessors

id

  • get id(): string

  • Gets the short identifier of the detector, used in analyzer warnings.

    Returns string

    The unique identifier of the detector.

kind

shareImportedWarnings

  • 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

usesSouffle

  • get usesSouffle(): boolean

  • Checks whether this detector needs the Soufflé binary to be executed.

    Returns boolean

Methods

check

getCategory

getSeverity

ProtectedmakeWarning

ProtectedskipUnused

Settings

Member Visibility

On This Page

Why is it important?Example
Constructors
Properties
Accessors
Methods