Security

This directory provides the API for all Security modules.

For an overview of the module, read the Security guide.

Initializable

Initializable

import "./node_modules/@openzeppelin-compact/contracts/src/security/Initializable";

initialize() → [] circuit

Initializes the state thus ensuring the calling circuit can only be called once.

Requirements:

  • Contract must not be initialized.

Constraints:

  • k=10, rows=38

assertInitialized() → [] circuit

Asserts that the contract has been initialized, throwing an error if not.

Requirements:

  • Contract must be initialized.

Constraints:

  • k=10, rows=31

assertNotInitialized() → [] circuit

Asserts that the contract has not been initialized, throwing an error if it has.

Requirements:

  • Contract must not be initialized.

Constraints:

  • k=10, rows=35

Pausable

Pausable

import "./node_modules/@openzeppelin-compact/contracts/src/security/Pausable";

isPaused() → Boolean circuit

Returns true if the contract is paused, and false otherwise.

Constraints:

  • k=10, rows=32

assertPaused() → [] circuit

Makes a circuit only callable when the contract is paused.

Requirements:

  • Contract must be paused.

Constraints:

  • k=10, rows=31

assertNotPaused() → [] circuit

Makes a circuit only callable when the contract is not paused.

Requirements:

  • Contract must not be paused.

Constraints:

  • k=10, rows=35

_pause() → [] circuit

Triggers a stopped state.

Requirements:

  • Contract must not be paused.

Constraints:

  • k=10, rows=38

_unpause() → [] circuit

Lifts the pause on the contract.

Requirements:

  • Contract must be paused.

Constraints:

  • k=10, rows=34