CleanupBlockNumberManager#

event CleanupBlockNumberSet(
    contract IICleanable theContract,
    uint256 blockNumber,
    bool success
)

Emitted when an attempt has been made to set the cleanup block number.

event GovernanceCallTimelocked(
    bytes4 selector,
    uint256 allowedAfterTimestamp,
    bytes encodedCall
)

Emitted when a new governance call has been recorded and is now waiting for the time lock to expire.

event GovernanceInitialised(
    address initialGovernance
)

Emitted when the governance address is initialized. This address will be used until production mode is entered (see GovernedProductionModeEntered). At that point the governance address is taken from GovernanceSettings.

event GovernedProductionModeEntered(
    address governanceSettings
)

Emitted when governance is enabled and the governance address cannot be changed anymore (only through a network fork).

event RegistrationUpdated(
    contract IICleanable theContract,
    bool add
)

Emitted when a new token has been registered to have its history managed by us, or an old one unregistered.

event TimelockedGovernanceCallCanceled(
    bytes4 selector,
    uint256 timestamp
)

Emitted when a timelocked governance call is canceled before execution.

event TimelockedGovernanceCallExecuted(
    bytes4 selector,
    uint256 timestamp
)

Emitted when a timelocked governance call is executed.

function cancelGovernanceCall(
    bytes4 _selector
) external;

Cancel a timelocked governance call before it has been executed.

Only governance can call this method.

constructor(
    address _governance,
    address _addressUpdater,
    string _triggerContractName
) public;

Build a new instance.

function executeGovernanceCall(
    bytes4 _selector
) external;

Execute the timelocked governance calls once the timelock period expires.

Only executor can call this method.

function getAddressUpdater(
) public view returns (
    address _addressUpdater);

Returns the configured address updater.

function governance(
) public view returns (
    address);

Returns the current effective governance address.

function registerToken(
    contract IICleanable _cleanableToken
) external;

Register a token contract whose history cleanup index is to be managed. The registered contracts must allow calling setCleanupBlockNumber.

function setCleanUpBlockNumber(
    uint256 _blockNumber
) external;

Sets clean up block number on managed cleanable tokens.

function switchToProductionMode(
) external;

Enter the production mode after all the initial governance settings have been set. This enables timelocks and the governance can be obtained afterward by calling governanceSettings.getGovernanceAddress(). Emits GovernedProductionModeEntered.

function unregisterToken(
    contract IICleanable _cleanableToken
) external;

Unregister a token contract from history cleanup index management.

function updateContractAddresses(
    bytes32[] _contractNameHashes,
    address[] _contractAddresses
) external;

External method called from AddressUpdater only.

modifier onlyAddressUpdater()

Only the AdressUpdater contract can call this method. Its address is set at construction time but it can also update itself.

modifier onlyTrigger()

Only the trigger contract can call this method. This contract is set at construction time and updated through AddressUpdatable.

    contract IGovernanceSettings governanceSettings

Governance Settings.

    bool productionMode

When true, governance is enabled and cannot be disabled. See switchToProductionMode.

    contract IICleanable[] registeredTokens

Current list of token contracts being managed.

    mapping(bytes4 => struct GovernedBase.TimelockedCall) timelockedCalls

List of pending timelocked governance calls.

    address triggerContract

Address of the contract that can trigger a cleanup.

    string triggerContractName

Name of the contract that can trigger a cleanup. Needed to update the trigger contract address through the AddressUpdater.