IMakinaXGovernable

Functions

safe

Address of the Safe.

function safe() external view returns (address);

Returns

Name	Type	Description
<none>	`address`

provider

Address of the MakinaX service account.

function provider() external view returns (address);

Returns

Name	Type	Description
<none>	`address`

isOperator

Account => Whether the account is an operator.

function isOperator(address account) external view returns (bool);

Parameters

Name	Type	Description
account	`address`

Returns

Name	Type	Description
<none>	`bool`

isGuardian

Account => Whether the account is a guardian.

function isGuardian(address account) external view returns (bool);

Parameters

Name	Type	Description
account	`address`

Returns

Name	Type	Description
<none>	`bool`

operatingMode

Current operating mode of the contract.

function operatingMode() external view returns (OperatingMode);

Returns

Name	Type	Description
<none>	`OperatingMode`

suspendedByProvider

True if the contract is suspended by the provider, false otherwise.

function suspendedByProvider() external view returns (bool);

Returns

Name	Type	Description
<none>	`bool`

paused

True if the contract is paused by a guardian, false otherwise.

function paused() external view returns (bool);

Returns

Name	Type	Description
<none>	`bool`

setProvider

Sets the provider address.

function setProvider(address newProvider) external;

Parameters

Name	Type	Description
newProvider	`address`	The address of the new provider.

addOperator

Adds a new operator.

function addOperator(address newOperator) external;

Parameters

Name	Type	Description
newOperator	`address`	The address of the new operator.

removeOperator

Removes an operator.

function removeOperator(address operator) external;

Parameters

Name	Type	Description
operator	`address`	The address of the operator to remove.

addGuardian

Adds a new guardian.

function addGuardian(address newGuardian) external;

Parameters

Name	Type	Description
newGuardian	`address`	The address of the new guardian.

removeGuardian

Removes a guardian.

function removeGuardian(address guardian) external;

Parameters

Name	Type	Description
guardian	`address`	The address of the guardian to remove.

setOperatingMode

Sets the operating mode.

function setOperatingMode(OperatingMode newMode) external;

Parameters

Name	Type	Description
newMode	`OperatingMode`	The operating mode to set.

suspend

Suspends operations. Used by the provider to enforce service restrictions.

function suspend() external;

unsuspend

Restores operations after a provider suspension.

function unsuspend() external;

pause

Pauses operations. Used by a guardian in case of emergency.

function pause() external;

unpause

Unpauses operations after an emergency pause.

function unpause() external;

Events

GuardianAdded

event GuardianAdded(address indexed newGuardian);

Parameters

Name	Type	Description
newGuardian	`address`

GuardianRemoved

event GuardianRemoved(address indexed guardian);

Parameters

Name	Type	Description
guardian	`address`

OperatingModeChanged

event OperatingModeChanged(OperatingMode indexed mode);

Parameters

Name	Type	Description
mode	`OperatingMode`

OperatorAdded

event OperatorAdded(address indexed newOperator);

Parameters

Name	Type	Description
newOperator	`address`

OperatorRemoved

event OperatorRemoved(address indexed operator);

Parameters

Name	Type	Description
operator	`address`

Paused

event Paused(address indexed guardian);

Parameters

Name	Type	Description
guardian	`address`

Unpaused

event Unpaused(address indexed guardian);

Parameters

Name	Type	Description
guardian	`address`

ProviderChanged

event ProviderChanged(address indexed oldProvider, address indexed newProvider);

Parameters

Name	Type	Description
oldProvider	`address`
newProvider	`address`

Suspended

event Suspended();

Unsuspended

event Unsuspended();

Enums

OperatingMode

Operating modes of a module, ordered by increasing restriction.

enum OperatingMode {
        OPEN,
        FENCED,
        WALLED
    }

Variants

Name	Description
OPEN
FENCED
WALLED