If you notice some outdated information please let us know!
PASS
The final review score is indicated as a percentage. The percentage is calculated as Achieved Points due to MAX Possible Points. For each element the answer can be either Yes/No or a percentage. For a detailed breakdown of the individual weights of each question, please consult this document.
Very simply, the audit looks for the following declarations from the developer's site. With these declarations, it is reasonable to trust the smart contracts.
This report is for informational purposes only and does not constitute investment advice of any kind, nor does it constitute an offer to provide investment advisory or other services. Nothing in this report shall be considered a solicitation or offer to buy or sell any security, token, future, option or other financial instrument or to offer or provide any investment advice or service to any person in any jurisdiction. Nothing contained in this report constitutes investment advice or offers any opinion with respect to the suitability of any security, and the views expressed in this report should not be taken as advice to buy, sell or hold any security. The information in this report should not be relied upon for the purpose of investing. In preparing the information contained in this report, we have not taken into account the investment needs, objectives and financial circumstances of any particular investor. This information has no regard to the specific investment objectives, financial situation and particular needs of any specific recipient of this information and investments discussed may not be suitable for all investors.
Any views expressed in this report by us were prepared based upon the information available to us at the time such views were written. The views expressed within this report are limited to DeFiSafety and the author and do not reflect those of any additional or third party and are strictly based upon DeFiSafety, its authors, interpretations and evaluation of relevant data. Changed or additional information could cause such views to change. All information is subject to possible correction. Information may quickly become unreliable for various reasons, including changes in market conditions or economic circumstances.
This completed report is copyright (c) DeFiSafety 2023. Permission is given to copy in whole, retaining this copyright label.
This section looks at the code deployed on the Mainnet that gets reviewed and its corresponding software repository. The document explaining these questions is here.
1. Are the executing code addresses readily available? (%)
They are available at website https://docs.piedao.org/technical/deployed-smart-contracts, as indicated in the Appendix.
2. Is the code actively being used? (%)
Activity is over 10 internal transactions a day on contract PV2SmartPool, as indicated in the Appendix.
3. Is there a public software repository? (Y/N)
Is there a public software repository with the code at a minimum, but also normally test and scripts. Even if the repository was created just to hold the files and has just 1 transaction, it gets a "Yes". For teams with private repositories, this answer is "No"
4. Is there a development history visible? (%)
With 181 commits and 17 branches, PieDAO's "Smart Pools" GitHub repository has a robust development history.
This metric checks if the software repository demonstrates a strong steady history. This is normally demonstrated by commits, branches and releases in a software repository. A healthy history demonstrates a history of more than a month (at a minimum).
5. Is the team public (not anonymous)? (Y/N)
Location: https://medium.com/piedao/about.
For a "Yes" in this question, the real names of some team members must be public on the website or other documentation (LinkedIn, etc). If the team is anonymous, then this question is a "No".
This section looks at the software documentation. The document explaining these questions is here.
7. Are the basic software functions documented? (Y/N)
PieDAO's basic software functions are all documented under the "Dev Docs" section of their documentation at https://docs.piedao.org/technical/architecture.
8. Does the software function documentation fully (100%) cover the deployed contracts? (%)
PieDAO's software documentation covers most of the deployed contracts at https://docs.piedao.org/technical/architecture, as well as in the README.md of their corresponding GitHub repositories. The only contract that does not have its functions documented is the "Governance" contract.
9. Are there sufficiently detailed comments for all functions within the deployed contract code (%)
The Comments to Code (CtC) ratio is the primary metric for this score.
10. Is it possible to trace from software documentation to the implementation in code (%)
There is a strong presence of non explicit traceability between the software functions' documentation and their implementation in the PieDao source code.
11. Full test suite (Covers all the deployed code) (%)
This score is guided by the Test to Code ratio (TtC). Generally a good test to code ratio is over 100%. However the reviewers best judgement is the final deciding factor.
12. Code coverage (Covers all the deployed lines of code, or explains misses) (%)
PieDAO has an average code coverage percentage of 72.5 when adding up and averaging all coverage documented in their Quantstamp v1 and v2 audits.
13. Scripts and instructions to run the tests? (Y/N)
Scripts/Instructions location: https://github.com/pie-dao/pie-smart-pools/blob/development/README.MD
14. Report of the results (%)
There is no evidence of a PieDao test result report in any of their GitHub repositories or documentation.
15. Formal Verification test done (%)
There is no evidence of a PieDAO Formal Verification test in their documentation.
16. Stress Testing environment (%)
There is evidence of PieDAO's testnet smart contract usage at https://docs.piedao.org/technical/deployed-smart-contracts.
This section looks at the 3rd party software audits done. It is explained in this document.
17. Did 3rd Party audits take place? (%)
PieDAO's has had 4 audits performed and published as seen from this GitHub repository. All of the reports were published before the specific contracts' mainnet launches.
18. Is the bug bounty acceptable high? (%)
There is no evidence of a PieDAO Bug Bounty program.
This section covers the documentation of special access controls for a DeFi protocol. The admin access controls are the contracts that allow updating contracts or coefficients in the protocol. Since these contracts can allow the protocol admins to "change the rules", complete disclosure of capabilities is vital for user's transparency. It is explained in this document.
19. Can a user clearly and quickly find the status of the access controls (%)
PieDAO's governance section can clearly be found at https://docs.piedao.org/governance/dough.
20. Is the information clear and complete (%)
21. Is the information in non-technical terms that pertain to the investments (%)
PieDAO's provides this information in software specific language; https://docs.piedao.org/technical/updating-a-smart-pool-implementation
22. Is there Pause Control documentation including records of tests (%)
Pause Controls is clearly explained at https://docs.piedao.org/technical/untitled#features-and-use-cases, but there is no evidence of any regular tests.
1contract PV2SmartPool is IPV2SmartPool, PCToken, ReentryProtection {
2 using LibSafeApprove for IERC20;
3
4 event TokensApproved();
5 event ControllerChanged(address indexed previousController, address indexed newController);
6 event PublicSwapSetterChanged(address indexed previousSetter, address indexed newSetter);
7 event TokenBinderChanged(address indexed previousTokenBinder, address indexed newTokenBinder);
8 event PublicSwapSet(address indexed setter, bool indexed value);
9 event SwapFeeSet(address indexed setter, uint256 newFee);
10 event CapChanged(address indexed setter, uint256 oldCap, uint256 newCap);
11 event CircuitBreakerTripped();
12 event JoinExitEnabledChanged(address indexed setter, bool oldValue, bool newValue);
13 event CircuitBreakerChanged(
14 address indexed _oldCircuitBreaker,
15 address indexed _newCircuitBreaker
16 );
17
18 modifier ready() {
19 require(address(PBStorage.load().bPool) != address(0), "PV2SmartPool.ready: not ready");
20 _;
21 }
22
23 modifier onlyController() {
24 require(
25 msg.sender == PBStorage.load().controller,
26 "PV2SmartPool.onlyController: not controller"
27 );
28 _;
29 }
30
31 modifier onlyPublicSwapSetter() {
32 require(
33 msg.sender == PBStorage.load().publicSwapSetter,
34 "PV2SmartPool.onlyPublicSwapSetter: not public swap setter"
35 );
36 _;
37 }
38
39 modifier onlyTokenBinder() {
40 require(
41 msg.sender == PBStorage.load().tokenBinder,
42 "PV2SmartPool.onlyTokenBinder: not token binder"
43 );
44 _;
45 }
46
47 modifier onlyPublicSwap() {
48 require(
49 PBStorage.load().bPool.isPublicSwap(),
50 "PV2SmartPool.onlyPublicSwap: swapping not enabled"
51 );
52 _;
53 }
54
55 modifier onlyCircuitBreaker() {
56 require(
57 msg.sender == P2Storage.load().circuitBreaker,
58 "PV2SmartPool.onlyCircuitBreaker: not circuit breaker"
59 );
60 _;
61 }
62
63 modifier onlyJoinExitEnabled() {
64 require(
65 P2Storage.load().joinExitEnabled,
66 "PV2SmartPool.onlyJoinExitEnabled: join and exit not enabled"
67 );
68 _;
69 }
70
71 modifier withinCap() {
72 _;
73 require(totalSupply() < PCSStorage.load().cap, "PV2SmartPool.withinCap: Cap limit reached");
74 }
75
76 /**
77 @notice Initialises the contract
78 @param _bPool Address of the underlying balancer pool
79 @param _name Name for the smart pool token
80 @param _symbol Symbol for the smart pool token
81 @param _initialSupply Initial token supply to mint
82 */
83 function init(
84 address _bPool,
85 string calldata _name,
86 string calldata _symbol,
87 uint256 _initialSupply
88 ) external override {
89 PBStorage.StorageStruct storage s = PBStorage.load();
90 require(address(s.bPool) == address(0), "PV2SmartPool.init: already initialised");
91 require(_bPool != address(0), "PV2SmartPool.init: _bPool cannot be 0x00....000");
92 require(_initialSupply != 0, "PV2SmartPool.init: _initialSupply can not zero");
93 s.bPool = IBPool(_bPool);
94 s.controller = msg.sender;
95 s.publicSwapSetter = msg.sender;
96 s.tokenBinder = msg.sender;
97 PCStorage.load().name = _name;
98 PCStorage.load().symbol = _symbol;
99
100 LibPoolToken._mint(msg.sender, _initialSupply);
101 }
102
103 /**
104 @notice Sets approval to all tokens to the underlying balancer pool
105 @dev It uses this function to save on gas in joinPool
106 */
107 function approveTokens() public override noReentry {
108 IBPool bPool = PBStorage.load().bPool;
109 address[] memory tokens = bPool.getCurrentTokens();
110 for (uint256 i = 0; i < tokens.length; i++) {
111 IERC20(tokens[i]).safeApprove(address(bPool), uint256(-1));
112 }
113 emit TokensApproved();
114 }
115
116 // POOL EXIT ------------------------------------------------
117
118 /**
119 @notice Burns pool shares and sends back the underlying assets leaving some in the pool
120 @param _amount Amount of pool tokens to burn
121 @param _lossTokens Tokens skipped on redemption
122 */
123 function exitPoolTakingloss(uint256 _amount, address[] calldata _lossTokens)
124 external
125 override
126 ready
127 noReentry
128 onlyJoinExitEnabled
129 {
130 LibPoolEntryExit.exitPoolTakingloss(_amount, _lossTokens);
131 }
132
133 /**
134 @notice Burns pool shares and sends back the underlying assets
135 @param _amount Amount of pool tokens to burn
136 */
137 function exitPool(uint256 _amount) external override ready noReentry onlyJoinExitEnabled {
138 LibPoolEntryExit.exitPool(_amount);
139 }
140
141 /**
142 @notice Burn pool tokens and redeem underlying assets. With front running protection
143 @param _amount Amount of pool tokens to burn
144 @param _minAmountsOut Minimum amounts of underlying assets
145 */
146 function exitPool(uint256 _amount, uint256[] calldata _minAmountsOut)
147 external
148 override
149 ready
150 noReentry
151 onlyJoinExitEnabled
152 {
153 LibPoolEntryExit.exitPool(_amount, _minAmountsOut);
154 }
155
156 /
157 @notice Exitswap single asset pool exit given pool amount in
158 @param _token Address of exit token
159 @param _poolAmountIn Amount of pool tokens sending to the pool
160 @return tokenAmountOut amount of exit tokens being withdrawn
161 */
162 function exitswapPoolAmountIn(
163 address _token,
164 uint256 _poolAmountIn,
165 uint256 _minAmountOut
166 )
167 external
168 override
169 ready
170 noReentry
171 onlyPublicSwap
172 onlyJoinExitEnabled
173 returns (uint256 tokenAmountOut)
174 {
175 return LibPoolEntryExit.exitswapPoolAmountIn(_token, _poolAmountIn, _minAmountOut);
176 }
177
178 /*
179 @notice Exitswap single asset pool entry given token amount out
180 @param _token Address of exit token
181 @param _tokenAmountOut Amount of exit tokens
182 @return poolAmountIn amount of pool tokens being deposited
183 */
184 function exitswapExternAmountOut(
185 address _token,
186 uint256 _tokenAmountOut,
187 uint256 _maxPoolAmountIn
188 )
Comments to Code: 573 / 1037 = 55 %
Tests to Code: 2915 / 1037 = 281 %