infrastructure-upgrade/coverage/v1/tornado-proxy/InstanceRegistry.sol.gcov.html
AlienTornadosaurusHex 1a6a4ebfbb mostly testing finalized design
Signed-off-by: AlienTornadosaurusHex <>
2023-06-20 21:04:29 +00:00

238 lines
20 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LCOV - lcov.info - v1/tornado-proxy/InstanceRegistry.sol</title>
<link rel="stylesheet" type="text/css" href="../../gcov.css">
</head>
<body>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="title">LCOV - code coverage report</td></tr>
<tr><td class="ruler"><img src="../../glass.png" width=3 height=3 alt=""></td></tr>
<tr>
<td width="100%">
<table cellpadding=1 border=0 width="100%">
<tr>
<td width="10%" class="headerItem">Current view:</td>
<td width="35%" class="headerValue"><a href="../../index.html">top level</a> - <a href="index.html">v1/tornado-proxy</a> - InstanceRegistry.sol<span style="font-size: 80%;"> (source / <a href="InstanceRegistry.sol.func-sort-c.html">functions</a>)</span></td>
<td width="5%"></td>
<td width="15%"></td>
<td width="10%" class="headerCovTableHead">Hit</td>
<td width="10%" class="headerCovTableHead">Total</td>
<td width="15%" class="headerCovTableHead">Coverage</td>
</tr>
<tr>
<td class="headerItem">Test:</td>
<td class="headerValue">lcov.info</td>
<td></td>
<td class="headerItem">Lines:</td>
<td class="headerCovTableEntry">0</td>
<td class="headerCovTableEntry">37</td>
<td class="headerCovTableEntryLo">0.0 %</td>
</tr>
<tr>
<td class="headerItem">Date:</td>
<td class="headerValue">2023-06-20 21:04:08</td>
<td></td>
<td class="headerItem">Functions:</td>
<td class="headerCovTableEntry">0</td>
<td class="headerCovTableEntry">9</td>
<td class="headerCovTableEntryLo">0.0 %</td>
</tr>
<tr>
<td class="headerItem">Legend:</td>
<td class="headerValueLeg"> Lines:
<span class="coverLegendCov">hit</span>
<span class="coverLegendNoCov">not hit</span>
</td>
<td></td>
</tr>
<tr><td><img src="../../glass.png" width=3 height=3 alt=""></td></tr>
</table>
</td>
</tr>
<tr><td class="ruler"><img src="../../glass.png" width=3 height=3 alt=""></td></tr>
</table>
<table cellpadding=0 cellspacing=0 border=0>
<tr>
<td><br></td>
</tr>
<tr>
<td>
<pre class="sourceHeading"> Line data Source code</pre>
<pre class="source">
<a name="1"><span class="lineNum"> 1 </span> : // SPDX-License-Identifier: MIT</a>
<a name="2"><span class="lineNum"> 2 </span> : </a>
<a name="3"><span class="lineNum"> 3 </span> : pragma solidity ^0.6.12;</a>
<a name="4"><span class="lineNum"> 4 </span> : pragma experimental ABIEncoderV2;</a>
<a name="5"><span class="lineNum"> 5 </span> : </a>
<a name="6"><span class="lineNum"> 6 </span> : import { Initializable } from &quot;@openzeppelin/contracts/proxy/Initializable.sol&quot;;</a>
<a name="7"><span class="lineNum"> 7 </span> : import { EnsResolve } from &quot;torn-token/contracts/ENS.sol&quot;;</a>
<a name="8"><span class="lineNum"> 8 </span> : import &quot;@openzeppelin/contracts/token/ERC20/IERC20.sol&quot;;</a>
<a name="9"><span class="lineNum"> 9 </span> : import &quot;@openzeppelin/contracts/token/ERC20/SafeERC20.sol&quot;;</a>
<a name="10"><span class="lineNum"> 10 </span> : import &quot;tornado-anonymity-mining/contracts/interfaces/ITornadoInstance.sol&quot;;</a>
<a name="11"><span class="lineNum"> 11 </span> : import &quot;./FeeManager.sol&quot;;</a>
<a name="12"><span class="lineNum"> 12 </span> : import &quot;./TornadoRouter.sol&quot;;</a>
<a name="13"><span class="lineNum"> 13 </span> : </a>
<a name="14"><span class="lineNum"> 14 </span> : contract InstanceRegistry is Initializable, EnsResolve {</a>
<a name="15"><span class="lineNum"> 15 </span> : using SafeERC20 for IERC20;</a>
<a name="16"><span class="lineNum"> 16 </span> : </a>
<a name="17"><span class="lineNum"> 17 </span> : enum InstanceState {</a>
<a name="18"><span class="lineNum"> 18 </span> : DISABLED,</a>
<a name="19"><span class="lineNum"> 19 </span> : ENABLED</a>
<a name="20"><span class="lineNum"> 20 </span> : }</a>
<a name="21"><span class="lineNum"> 21 </span> : </a>
<a name="22"><span class="lineNum"> 22 </span> : struct Instance {</a>
<a name="23"><span class="lineNum"> 23 </span> : bool isERC20;</a>
<a name="24"><span class="lineNum"> 24 </span> : IERC20 token;</a>
<a name="25"><span class="lineNum"> 25 </span> : InstanceState state;</a>
<a name="26"><span class="lineNum"> 26 </span> : // the fee of the uniswap pool which will be used to get a TWAP</a>
<a name="27"><span class="lineNum"> 27 </span> : uint24 uniswapPoolSwappingFee;</a>
<a name="28"><span class="lineNum"> 28 </span> : // the fee the protocol takes from relayer, it should be multiplied by PROTOCOL_FEE_DIVIDER from FeeManager.sol</a>
<a name="29"><span class="lineNum"> 29 </span> : uint32 protocolFeePercentage;</a>
<a name="30"><span class="lineNum"> 30 </span> : }</a>
<a name="31"><span class="lineNum"> 31 </span> : </a>
<a name="32"><span class="lineNum"> 32 </span> : struct Tornado {</a>
<a name="33"><span class="lineNum"> 33 </span> : ITornadoInstance addr;</a>
<a name="34"><span class="lineNum"> 34 </span> : Instance instance;</a>
<a name="35"><span class="lineNum"> 35 </span> : }</a>
<a name="36"><span class="lineNum"> 36 </span> : </a>
<a name="37"><span class="lineNum"> 37 </span> : address public immutable governance;</a>
<a name="38"><span class="lineNum"> 38 </span> : TornadoRouter public router;</a>
<a name="39"><span class="lineNum"> 39 </span> : </a>
<a name="40"><span class="lineNum"> 40 </span> : mapping(ITornadoInstance =&gt; Instance) public instances;</a>
<a name="41"><span class="lineNum"> 41 </span> : ITornadoInstance[] public instanceIds;</a>
<a name="42"><span class="lineNum"> 42 </span> : </a>
<a name="43"><span class="lineNum"> 43 </span> : event InstanceStateUpdated(ITornadoInstance indexed instance, InstanceState state);</a>
<a name="44"><span class="lineNum"> 44 </span> : event RouterRegistered(address tornadoRouter);</a>
<a name="45"><span class="lineNum"> 45 </span> : </a>
<a name="46"><span class="lineNum"> 46 </span> : modifier onlyGovernance() {</a>
<a name="47"><span class="lineNum"> 47 </span> : require(msg.sender == governance, &quot;Not authorized&quot;);</a>
<a name="48"><span class="lineNum"> 48 </span> : _;</a>
<a name="49"><span class="lineNum"> 49 </span> : }</a>
<a name="50"><span class="lineNum"> 50 </span> : </a>
<a name="51"><span class="lineNum"> 51 </span> : constructor(address _governance) public {</a>
<a name="52"><span class="lineNum"> 52 </span> : governance = _governance;</a>
<a name="53"><span class="lineNum"> 53 </span> : }</a>
<a name="54"><span class="lineNum"> 54 </span> : </a>
<a name="55"><span class="lineNum"> 55 </span> : function initialize(Tornado[] memory _instances, bytes32 _router) external initializer {</a>
<a name="56"><span class="lineNum"> 56 </span><span class="lineNoCov"> 0 : router = TornadoRouter(resolve(_router));</span></a>
<a name="57"><span class="lineNum"> 57 </span><span class="lineNoCov"> 0 : for (uint256 i = 0; i &lt; _instances.length; i++) {</span></a>
<a name="58"><span class="lineNum"> 58 </span><span class="lineNoCov"> 0 : _updateInstance(_instances[i]);</span></a>
<a name="59"><span class="lineNum"> 59 </span><span class="lineNoCov"> 0 : instanceIds.push(_instances[i].addr);</span></a>
<a name="60"><span class="lineNum"> 60 </span> : }</a>
<a name="61"><span class="lineNum"> 61 </span> : }</a>
<a name="62"><span class="lineNum"> 62 </span> : </a>
<a name="63"><span class="lineNum"> 63 </span> : /**</a>
<a name="64"><span class="lineNum"> 64 </span> : * @dev Add or update an instance.</a>
<a name="65"><span class="lineNum"> 65 </span> : */</a>
<a name="66"><span class="lineNum"> 66 </span> : function updateInstance(Tornado calldata _tornado) external virtual onlyGovernance {</a>
<a name="67"><span class="lineNum"> 67 </span><span class="lineNoCov"> 0 : require(_tornado.instance.state != InstanceState.DISABLED, &quot;Use removeInstance() for remove&quot;);</span></a>
<a name="68"><span class="lineNum"> 68 </span><span class="lineNoCov"> 0 : if (instances[_tornado.addr].state == InstanceState.DISABLED) {</span></a>
<a name="69"><span class="lineNum"> 69 </span><span class="lineNoCov"> 0 : instanceIds.push(_tornado.addr);</span></a>
<a name="70"><span class="lineNum"> 70 </span> : }</a>
<a name="71"><span class="lineNum"> 71 </span><span class="lineNoCov"> 0 : _updateInstance(_tornado);</span></a>
<a name="72"><span class="lineNum"> 72 </span> : }</a>
<a name="73"><span class="lineNum"> 73 </span> : </a>
<a name="74"><span class="lineNum"> 74 </span> : /**</a>
<a name="75"><span class="lineNum"> 75 </span> : * @dev Remove an instance.</a>
<a name="76"><span class="lineNum"> 76 </span> : * @param _instanceId The instance id in `instanceIds` mapping to remove.</a>
<a name="77"><span class="lineNum"> 77 </span> : */</a>
<a name="78"><span class="lineNum"> 78 </span> : function removeInstance(uint256 _instanceId) external virtual onlyGovernance {</a>
<a name="79"><span class="lineNum"> 79 </span><span class="lineNoCov"> 0 : ITornadoInstance _instance = instanceIds[_instanceId];</span></a>
<a name="80"><span class="lineNum"> 80 </span><span class="lineNoCov"> 0 : (bool isERC20, IERC20 token) = (instances[_instance].isERC20, instances[_instance].token);</span></a>
<a name="81"><span class="lineNum"> 81 </span> : </a>
<a name="82"><span class="lineNum"> 82 </span><span class="lineNoCov"> 0 : if (isERC20) {</span></a>
<a name="83"><span class="lineNum"> 83 </span><span class="lineNoCov"> 0 : uint256 allowance = token.allowance(address(router), address(_instance));</span></a>
<a name="84"><span class="lineNum"> 84 </span><span class="lineNoCov"> 0 : if (allowance != 0) {</span></a>
<a name="85"><span class="lineNum"> 85 </span><span class="lineNoCov"> 0 : router.approveExactToken(token, address(_instance), 0);</span></a>
<a name="86"><span class="lineNum"> 86 </span> : }</a>
<a name="87"><span class="lineNum"> 87 </span> : }</a>
<a name="88"><span class="lineNum"> 88 </span> : </a>
<a name="89"><span class="lineNum"> 89 </span><span class="lineNoCov"> 0 : delete instances[_instance];</span></a>
<a name="90"><span class="lineNum"> 90 </span><span class="lineNoCov"> 0 : instanceIds[_instanceId] = instanceIds[instanceIds.length - 1];</span></a>
<a name="91"><span class="lineNum"> 91 </span><span class="lineNoCov"> 0 : instanceIds.pop();</span></a>
<a name="92"><span class="lineNum"> 92 </span><span class="lineNoCov"> 0 : emit InstanceStateUpdated(_instance, InstanceState.DISABLED);</span></a>
<a name="93"><span class="lineNum"> 93 </span> : }</a>
<a name="94"><span class="lineNum"> 94 </span> : </a>
<a name="95"><span class="lineNum"> 95 </span> : /**</a>
<a name="96"><span class="lineNum"> 96 </span> : * @notice This function should allow governance to set a new protocol fee for relayers</a>
<a name="97"><span class="lineNum"> 97 </span> : * @param instance the to update</a>
<a name="98"><span class="lineNum"> 98 </span> : * @param newFee the new fee to use</a>
<a name="99"><span class="lineNum"> 99 </span> : * */</a>
<a name="100"><span class="lineNum"> 100 </span> : function setProtocolFee(ITornadoInstance instance, uint32 newFee) external onlyGovernance {</a>
<a name="101"><span class="lineNum"> 101 </span><span class="lineNoCov"> 0 : instances[instance].protocolFeePercentage = newFee;</span></a>
<a name="102"><span class="lineNum"> 102 </span> : }</a>
<a name="103"><span class="lineNum"> 103 </span> : </a>
<a name="104"><span class="lineNum"> 104 </span> : /**</a>
<a name="105"><span class="lineNum"> 105 </span> : * @notice This function should allow governance to set a new tornado proxy address</a>
<a name="106"><span class="lineNum"> 106 </span> : * @param routerAddress address of the new proxy</a>
<a name="107"><span class="lineNum"> 107 </span> : * */</a>
<a name="108"><span class="lineNum"> 108 </span> : function setTornadoRouter(address routerAddress) external onlyGovernance {</a>
<a name="109"><span class="lineNum"> 109 </span><span class="lineNoCov"> 0 : router = TornadoRouter(routerAddress);</span></a>
<a name="110"><span class="lineNum"> 110 </span><span class="lineNoCov"> 0 : emit RouterRegistered(routerAddress);</span></a>
<a name="111"><span class="lineNum"> 111 </span> : }</a>
<a name="112"><span class="lineNum"> 112 </span> : </a>
<a name="113"><span class="lineNum"> 113 </span> : function _updateInstance(Tornado memory _tornado) internal virtual {</a>
<a name="114"><span class="lineNum"> 114 </span><span class="lineNoCov"> 0 : instances[_tornado.addr] = _tornado.instance;</span></a>
<a name="115"><span class="lineNum"> 115 </span><span class="lineNoCov"> 0 : if (_tornado.instance.isERC20) {</span></a>
<a name="116"><span class="lineNum"> 116 </span><span class="lineNoCov"> 0 : IERC20 token = IERC20(_tornado.addr.token());</span></a>
<a name="117"><span class="lineNum"> 117 </span><span class="lineNoCov"> 0 : require(token == _tornado.instance.token, &quot;Incorrect token&quot;);</span></a>
<a name="118"><span class="lineNum"> 118 </span><span class="lineNoCov"> 0 : uint256 allowance = token.allowance(address(router), address(_tornado.addr));</span></a>
<a name="119"><span class="lineNum"> 119 </span> : </a>
<a name="120"><span class="lineNum"> 120 </span><span class="lineNoCov"> 0 : if (allowance == 0) {</span></a>
<a name="121"><span class="lineNum"> 121 </span><span class="lineNoCov"> 0 : router.approveExactToken(token, address(_tornado.addr), type(uint256).max);</span></a>
<a name="122"><span class="lineNum"> 122 </span> : }</a>
<a name="123"><span class="lineNum"> 123 </span> : }</a>
<a name="124"><span class="lineNum"> 124 </span><span class="lineNoCov"> 0 : emit InstanceStateUpdated(_tornado.addr, _tornado.instance.state);</span></a>
<a name="125"><span class="lineNum"> 125 </span> : }</a>
<a name="126"><span class="lineNum"> 126 </span> : </a>
<a name="127"><span class="lineNum"> 127 </span> : /**</a>
<a name="128"><span class="lineNum"> 128 </span> : * @dev Returns all instance configs</a>
<a name="129"><span class="lineNum"> 129 </span> : */</a>
<a name="130"><span class="lineNum"> 130 </span> : function getAllInstances() public view returns (Tornado[] memory result) {</a>
<a name="131"><span class="lineNum"> 131 </span><span class="lineNoCov"> 0 : result = new Tornado[](instanceIds.length);</span></a>
<a name="132"><span class="lineNum"> 132 </span><span class="lineNoCov"> 0 : for (uint256 i = 0; i &lt; instanceIds.length; i++) {</span></a>
<a name="133"><span class="lineNum"> 133 </span><span class="lineNoCov"> 0 : ITornadoInstance _instance = instanceIds[i];</span></a>
<a name="134"><span class="lineNum"> 134 </span><span class="lineNoCov"> 0 : result[i] = Tornado({ addr: _instance, instance: instances[_instance] });</span></a>
<a name="135"><span class="lineNum"> 135 </span> : }</a>
<a name="136"><span class="lineNum"> 136 </span> : }</a>
<a name="137"><span class="lineNum"> 137 </span> : </a>
<a name="138"><span class="lineNum"> 138 </span> : /**</a>
<a name="139"><span class="lineNum"> 139 </span> : * @dev Returns all instance addresses</a>
<a name="140"><span class="lineNum"> 140 </span> : */</a>
<a name="141"><span class="lineNum"> 141 </span> : function getAllInstanceAddresses() public view returns (ITornadoInstance[] memory result) {</a>
<a name="142"><span class="lineNum"> 142 </span><span class="lineNoCov"> 0 : result = new ITornadoInstance[](instanceIds.length);</span></a>
<a name="143"><span class="lineNum"> 143 </span><span class="lineNoCov"> 0 : for (uint256 i = 0; i &lt; instanceIds.length; i++) {</span></a>
<a name="144"><span class="lineNum"> 144 </span><span class="lineNoCov"> 0 : result[i] = instanceIds[i];</span></a>
<a name="145"><span class="lineNum"> 145 </span> : }</a>
<a name="146"><span class="lineNum"> 146 </span> : }</a>
<a name="147"><span class="lineNum"> 147 </span> : </a>
<a name="148"><span class="lineNum"> 148 </span> : /// @notice get erc20 tornado instance token</a>
<a name="149"><span class="lineNum"> 149 </span> : /// @param instance the interface (contract) key to the instance data</a>
<a name="150"><span class="lineNum"> 150 </span> : function getPoolToken(ITornadoInstance instance) external view returns (address) {</a>
<a name="151"><span class="lineNum"> 151 </span><span class="lineNoCov"> 0 : return address(instances[instance].token);</span></a>
<a name="152"><span class="lineNum"> 152 </span> : }</a>
<a name="153"><span class="lineNum"> 153 </span> : }</a>
</pre>
</td>
</tr>
</table>
<br>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="ruler"><img src="../../glass.png" width=3 height=3 alt=""></td></tr>
<tr><td class="versionInfo">Generated by: <a href="https://github.com/linux-test-project/lcov" target="_parent">LCOV version 1.16</a></td></tr>
</table>
<br>
</body>
</html>