Class UnusedOptional

A detector variables and fields with unused optional modifier.

Why is it bad?

Optional is a nullable value that has a special null value indicating the absence of a value. If a developer creates an optional variable or field, he should leverage its functionality by accessing the null value somewhere in his code. Otherwise, the optional type should be removed to simplify and optimize the code.

Example

contract Test {
  a: Int?; // Bad: null value is never accessed
  init() { self.a = 42; }
  get fun getA(): Int { return self.a!!; }
}

Use instead:

contract Test {
  a: Int = 42; // OK: Removed optional
  get fun getA(): Int { return self.a; }
}

Hierarchy (view full)

Constructors

constructor

Properties

ctx severity

Accessors

id kind shareImportedWarnings usesSouffle

Methods

check makeWarning skipUnused

Constructors

constructor

Properties

Readonlyctx

ctx: MistiContext

severity

severity: Severity = Severity.LOW

Gets the severity of the detector.

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

ProtectedmakeWarning

ProtectedskipUnused

Settings

Member Visibility

On This Page

Why is it bad?Example
Constructors
Properties
Accessors
Methods