IGovernance

Author: Matter Labs

Note: security-contact: security@matterlabs.dev

Functions

function isOperation(bytes32 _id) external view returns (bool);

function isOperationPending(bytes32 _id) external view returns (bool);

function isOperationReady(bytes32 _id) external view returns (bool);

function isOperationDone(bytes32 _id) external view returns (bool);

function getOperationState(bytes32 _id) external view returns (OperationState);

function scheduleTransparent(Operation calldata _operation, uint256 _delay)
  external;

function scheduleShadow(bytes32 _id, uint256 _delay) external;

function cancel(bytes32 _id) external;

function execute(Operation calldata _operation) external payable;

function executeInstant(Operation calldata _operation) external payable;

function hashOperation(Operation calldata _operation)
  external
  pure
  returns (bytes32);

function updateDelay(uint256 _newDelay) external;

function updateSecurityCouncil(address _newSecurityCouncil) external;

Emitted when transparent operation is scheduled.

event TransparentOperationScheduled(
  bytes32 indexed _id, uint256 delay, Operation _operation
);

Emitted when shadow operation is scheduled.

event ShadowOperationScheduled(bytes32 indexed _id, uint256 delay);

Emitted when the operation is executed with delay or instantly.

event OperationExecuted(bytes32 indexed _id);

Emitted when the security council address is changed.

event ChangeSecurityCouncil(
  address _securityCouncilBefore, address _securityCouncilAfter
);

Emitted when the minimum delay for future operations is modified.

event ChangeMinDelay(uint256 _delayBefore, uint256 _delayAfter);

Emitted when the operation with specified id is cancelled.

event OperationCancelled(bytes32 indexed _id);

Defines the structure of an operation that Governance executes.

struct Operation {
  Call[] calls;
  bytes32 predecessor;
  bytes32 salt;
}

Properties

Name	Type	Description
`calls`	`Call[]`	An array of `Call` structs, each representing a call to be made during the operation.
`predecessor`	`bytes32`	The hash of the predecessor operation, that should be executed before this operation.
`salt`	`bytes32`	A bytes32 value used for creating unique operation hashes.

This enumeration includes the following states:

enum OperationState {
  Unset,
  Waiting,
  Ready,
  Done
}