Defi Saver

1pragma solidity =0.7.6;
2
3import "../auth/AdminAuth.sol";
4import "../utils/DefisaverLogger.sol";
5import "./helpers/CoreHelper.sol";
6
7/// @title Stores all the important DFS addresses and can be changed (timelock)
8contract DFSRegistry is AdminAuth, CoreHelper {
9    DefisaverLogger public constant logger = DefisaverLogger(
10        DEFI_SAVER_LOGGER_ADDR
11    );
12
13    string public constant ERR_ENTRY_ALREADY_EXISTS = "Entry id already exists";
14    string public constant ERR_ENTRY_NON_EXISTENT = "Entry id doesn't exists";
15    string public constant ERR_ENTRY_NOT_IN_CHANGE = "Entry not in change process";
16    string public constant ERR_WAIT_PERIOD_SHORTER = "New wait period must be bigger";
17    string public constant ERR_CHANGE_NOT_READY = "Change not ready yet";
18    string public constant ERR_EMPTY_PREV_ADDR = "Previous addr is 0";
19    string public constant ERR_ALREADY_IN_CONTRACT_CHANGE = "Already in contract change";
20    string public constant ERR_ALREADY_IN_WAIT_PERIOD_CHANGE = "Already in wait period change";
21
22    struct Entry {
23        address contractAddr;
24        uint256 waitPeriod;
25        uint256 changeStartTime;
26        bool inContractChange;
27        bool inWaitPeriodChange;
28        bool exists;
29    }
30
31    mapping(bytes32 => Entry) public entries;
32    mapping(bytes32 => address) public previousAddresses;
33
34    mapping(bytes32 => address) public pendingAddresses;
35    mapping(bytes32 => uint256) public pendingWaitTimes;
36
37    /// @notice Given an contract id returns the registered address
38    /// @dev Id is keccak256 of the contract name
39    /// @param _id Id of contract
40    function getAddr(bytes32 _id) public view returns (address) {
41        return entries[_id].contractAddr;
42    }
43
44    /// @notice Helper function to easily query if id is registered
45    /// @param _id Id of contract
46    function isRegistered(bytes32 _id) public view returns (bool) {
47        return entries[_id].exists;
48    }
49
50    /////////////////////////// OWNER ONLY FUNCTIONS ///////////////////////////
51
52    /// @notice Adds a new contract to the registry
53    /// @param _id Id of contract
54    /// @param _contractAddr Address of the contract
55    /// @param _waitPeriod Amount of time to wait before a contract address can be changed
56    function addNewContract(
57        bytes32 _id,
58        address _contractAddr,
59        uint256 _waitPeriod
60    ) public onlyOwner {
61        require(!entries[_id].exists, ERR_ENTRY_ALREADY_EXISTS);
62
63        entries[_id] = Entry({
64            contractAddr: _contractAddr,
65            waitPeriod: _waitPeriod,
66            changeStartTime: 0,
67            inContractChange: false,
68            inWaitPeriodChange: false,
69            exists: true
70        });
71
72        // Remember tha address so we can revert back to old addr if needed
73        previousAddresses[_id] = _contractAddr;
74
75        logger.Log(
76            address(this),
77            msg.sender,
78            "AddNewContract",
79            abi.encode(_id, _contractAddr, _waitPeriod)
80        );
81    }
82
83    /// @notice Reverts to the previous address immediately
84    /// @dev In case the new version has a fault, a quick way to fallback to the old contract
85    /// @param _id Id of contract
86    function revertToPreviousAddress(bytes32 _id) public onlyOwner {
87        require(entries[_id].exists, ERR_ENTRY_NON_EXISTENT);
88        require(previousAddresses[_id] != address(0), ERR_EMPTY_PREV_ADDR);
89
90        address currentAddr = entries[_id].contractAddr;
91        entries[_id].contractAddr = previousAddresses[_id];
92
93        logger.Log(
94            address(this),
95            msg.sender,
96            "RevertToPreviousAddress",
97            abi.encode(_id, currentAddr, previousAddresses[_id])
98        );
99    }
100
101    /// @notice Starts an address change for an existing entry
102    /// @dev Can override a change that is currently in progress
103    /// @param _id Id of contract
104    /// @param _newContractAddr Address of the new contract
105    function startContractChange(bytes32 _id, address _newContractAddr) public onlyOwner {
106        require(entries[_id].exists, ERR_ENTRY_NON_EXISTENT);
107        require(!entries[_id].inWaitPeriodChange, ERR_ALREADY_IN_WAIT_PERIOD_CHANGE);
108
109        entries[_id].changeStartTime = block.timestamp; // solhint-disable-line
110        entries[_id].inContractChange = true;
111
112        pendingAddresses[_id] = _newContractAddr;
113
114        logger.Log(
115            address(this),
116            msg.sender,
117            "StartContractChange",
118            abi.encode(_id, entries[_id].contractAddr, _newContractAddr)
119        );
120    }
121
122    /// @notice Changes new contract address, correct time must have passed
123    /// @param _id Id of contract
124    function approveContractChange(bytes32 _id) public onlyOwner {
125        require(entries[_id].exists, ERR_ENTRY_NON_EXISTENT);
126        require(entries[_id].inContractChange, ERR_ENTRY_NOT_IN_CHANGE);
127        require(
128            block.timestamp >= (entries[_id].changeStartTime + entries[_id].waitPeriod), // solhint-disable-line
129            ERR_CHANGE_NOT_READY
130        );
131
132        address oldContractAddr = entries[_id].contractAddr;
133        entries[_id].contractAddr = pendingAddresses[_id];
134        entries[_id].inContractChange = false;
135        entries[_id].changeStartTime = 0;
136
137        pendingAddresses[_id] = address(0);
138        previousAddresses[_id] = oldContractAddr;
139
140        logger.Log(
141            address(this),
142            msg.sender,
143            "ApproveContractChange",
144            abi.encode(_id, oldContractAddr, entries[_id].contractAddr)
145        );
146    }
147
148    /// @notice Cancel pending change
149    /// @param _id Id of contract
150    function cancelContractChange(bytes32 _id) public onlyOwner {
151        require(entries[_id].exists, ERR_ENTRY_NON_EXISTENT);
152        require(entries[_id].inContractChange, ERR_ENTRY_NOT_IN_CHANGE);
153
154        address oldContractAddr = pendingAddresses[_id];
155
156        pendingAddresses[_id] = address(0);
157        entries[_id].inContractChange = false;
158        entries[_id].changeStartTime = 0;
159
160        logger.Log(
161            address(this),
162            msg.sender,
163            "CancelContractChange",
164            abi.encode(_id, oldContractAddr, entries[_id].contractAddr)
165        );
166    }
167
168    /// @notice Starts the change for waitPeriod
169    /// @param _id Id of contract
170    /// @param _newWaitPeriod New wait time
171    function startWaitPeriodChange(bytes32 _id, uint256 _newWaitPeriod) public onlyOwner {
172        require(entries[_id].exists, ERR_ENTRY_NON_EXISTENT);
173        require(!entries[_id].inContractChange, ERR_ALREADY_IN_CONTRACT_CHANGE);
174
175        pendingWaitTimes[_id] = _newWaitPeriod;
176
177        entries[_id].changeStartTime = block.timestamp; // solhint-disable-line
178        entries[_id].inWaitPeriodChange = true;
179
180        logger.Log(
181            address(this),
182            msg.sender,
183            "StartWaitPeriodChange",
184            abi.encode(_id, _newWaitPeriod)
185        );
186    }
187
188    /// @notice Changes new wait period, correct time must have passed
189    /// @param _id Id of contract
190    function approveWaitPeriodChange(bytes32 _id) public onlyOwner {
191        require(entries[_id].exists, ERR_ENTRY_NON_EXISTENT);
192        require(entries[_id].inWaitPeriodChange, ERR_ENTRY_NOT_IN_CHANGE);
193        require(
194            block.timestamp >= (entries[_id].changeStartTime + entries[_id].waitPeriod), // solhint-disable-line
195            ERR_CHANGE_NOT_READY
196        );
197

JavaScript Tests