IMakinaGovernable

Functions

operator

Address of the current operator (mechanic or security council).

function operator() external view returns (address);

Returns

Name	Type	Description
<none>	`address`

mechanic

Address of the mechanic.

function mechanic() external view returns (address);

Returns

Name	Type	Description
<none>	`address`

securityCouncil

Address of the security council.

function securityCouncil() external view returns (address);

Returns

Name	Type	Description
<none>	`address`

riskManager

Address of the risk manager.

function riskManager() external view returns (address);

Returns

Name	Type	Description
<none>	`address`

riskManagerTimelock

Address of the risk manager timelock.

function riskManagerTimelock() external view returns (address);

Returns

Name	Type	Description
<none>	`address`

recoveryMode

True if the contract is in recovery mode, false otherwise.

function recoveryMode() external view returns (bool);

Returns

Name	Type	Description
<none>	`bool`

restrictedAccountingMode

True if the contract is in restricted accounting mode, false otherwise.

function restrictedAccountingMode() external view returns (bool);

Returns

Name	Type	Description
<none>	`bool`

isAccountingAgent

User => Whether the user is an accounting agent

function isAccountingAgent(address user) external view returns (bool);

Parameters

Name	Type	Description
user	`address`

Returns

Name	Type	Description
<none>	`bool`

isAccountingAuthorized

User => Whether the user is authorized to perform accounting operations under current settings

function isAccountingAuthorized(address user) external view returns (bool);

Parameters

Name	Type	Description
user	`address`

Returns

Name	Type	Description
<none>	`bool`

setMechanic

Sets a new mechanic.

function setMechanic(address newMechanic) external;

Parameters

Name	Type	Description
newMechanic	`address`	The address of the new mechanic.

setSecurityCouncil

Sets a new security council.

function setSecurityCouncil(address newSecurityCouncil) external;

Parameters

Name	Type	Description
newSecurityCouncil	`address`	The address of the new security council.

setRiskManager

Sets a new risk manager.

function setRiskManager(address newRiskManager) external;

Parameters

Name	Type	Description
newRiskManager	`address`	The address of the new risk manager.

setRiskManagerTimelock

Sets a new risk manager timelock.

function setRiskManagerTimelock(address newRiskManagerTimelock) external;

Parameters

Name	Type	Description
newRiskManagerTimelock	`address`	The address of the new risk manager timelock.

setRecoveryMode

Sets the recovery mode.

function setRecoveryMode(bool enabled) external;

Parameters

Name	Type	Description
enabled	`bool`	True to enable recovery mode, false to disable it.

setRestrictedAccountingMode

Sets the restricted accounting mode.

function setRestrictedAccountingMode(bool enabled) external;

Parameters

Name	Type	Description
enabled	`bool`	True to enable restricted accounting mode, false to disable it.

addAccountingAgent

Adds a new accounting agent.

function addAccountingAgent(address newAgent) external;

Parameters

Name	Type	Description
newAgent	`address`	The address of the new accounting agent.

removeAccountingAgent

Removes an accounting agent.

function removeAccountingAgent(address agent) external;

Parameters

Name	Type	Description
agent	`address`	The address of the accounting agent to remove.

Events

AccountingAgentAdded

event AccountingAgentAdded(address indexed newAgent);

Parameters

Name	Type	Description
newAgent	`address`

AccountingAgentRemoved

event AccountingAgentRemoved(address indexed agent);

Parameters

Name	Type	Description
agent	`address`

MechanicChanged

event MechanicChanged(address indexed oldMechanic, address indexed newMechanic);

Parameters

Name	Type	Description
oldMechanic	`address`
newMechanic	`address`

RecoveryModeChanged

event RecoveryModeChanged(bool recoveryMode);

Parameters

Name	Type	Description
recoveryMode	`bool`

RestrictedAccountingModeChanged

event RestrictedAccountingModeChanged(bool restrictedAccountingMode);

Parameters

Name	Type	Description
restrictedAccountingMode	`bool`

RiskManagerChanged

event RiskManagerChanged(address indexed oldRiskManager, address indexed newRiskManager);

Parameters

Name	Type	Description
oldRiskManager	`address`
newRiskManager	`address`

RiskManagerTimelockChanged

event RiskManagerTimelockChanged(address indexed oldRiskManagerTimelock, address indexed newRiskManagerTimelock);

Parameters

Name	Type	Description
oldRiskManagerTimelock	`address`
newRiskManagerTimelock	`address`

SecurityCouncilChanged

event SecurityCouncilChanged(address indexed oldSecurityCouncil, address indexed newSecurityCouncil);

Parameters

Name	Type	Description
oldSecurityCouncil	`address`
newSecurityCouncil	`address`

Structs

MakinaGovernableInitParams

Initialization parameters.

struct MakinaGovernableInitParams {
        address initialMechanic;
        address initialSecurityCouncil;
        address initialRiskManager;
        address initialRiskManagerTimelock;
        address initialAuthority;
        bool initialRestrictedAccountingMode;
        address[] initialAccountingAgents;
    }

Properties

Name	Type	Description
initialMechanic	`address`	The address of the initial mechanic.
initialSecurityCouncil	`address`	The address of the initial security council.
initialRiskManager	`address`	The address of the initial risk manager.
initialRiskManagerTimelock	`address`	The address of the initial risk manager timelock.
initialAuthority	`address`	The address of the initial authority.
initialRestrictedAccountingMode	`bool`	The initial value for the restricted accounting mode.
initialAccountingAgents	`address[]`	The addresses of the initial accounting agents.

Edit this page on GitHub