If you notice some outdated information please let us know!
FAIL
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? (%)
2. Is the code actively being used? (%)
Activity is 90 transactions a day on contract Exchange.sol, as indicated in the Appendix.
3. Is there a public software repository? (Y/N)
GitHub: /orion-exchange https://github.com/orionprotocol/.
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 226 commits and 5 branches in their main contracts repository, this is a healthy 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)
Orion Protocol's team member information can be found at https://www.orionprotocol.io/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.
6. Is there a whitepaper? (Y/N)
7. Are the basic software functions documented? (Y/N)
There are basic Orion Protocol software functions documented here (p.34-35) and here.
8. Does the software function documentation fully (100%) cover the deployed contracts? (%)
Orion Protocol has documented the software functions (code) of the most major of their contracts, which are those of their exchange. In addition, there is robust Orion API documentation here.
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 (%)
Orion Protocol's documentation lists all the major functions while non-explicitly tracing them back to their source code in their API documentation.
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) (%)
Orion Protocol has a passing CI and a robust set of tests (95% TtC), but the CL does not link to a coverage report.
13. Scripts and instructions to run the tests? (Y/N)
14. Report of the results (%)
No test report was found in the Orion Protocol GitHub repository or any of their documentation.
15. Formal Verification test done (%)
No evidence of a Orion Protocol Formal Verification test was found in their documentation or in web searches.
16. Stress Testing environment (%)
There is evidence of Orion Protocol's test-net smart contract usage at https://github.com/orionprotocol/orion-exchange/blob/master/Deployment.md.
This section looks at the 3rd party software audits done. It is explained in this document.
17. Did 3rd Party audits take place? (%)
18. Is the bug bounty acceptable high? (%)
Orion protocol previously had a Bug Hunter Program that rewarded beta testers with up to 100,000 USDT for the most critical of bug finds.
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 (%)
Access controls were found in the "Orion Protocol and Foundation" section of the Orion Protocol whitepaper (p.31), as well as https://github.com/orionprotocol/orion-exchange/tree/master/docs.
20. Is the information clear and complete (%)
21. Is the information in non-technical terms that pertain to the investments (%)
All access control descriptions in the Orion Protocol documentation are all written in a very technical fashion that could be difficult for users to understand.
22. Is there Pause Control documentation including records of tests (%)
No evidence of Pause Control or similar functions found in the Orion Protocol documentation.
1/**
2 * @title Exchange
3 * @dev Exchange contract for the Orion Protocol
4 * @author @wafflemakr
5 */
6
7/*
8 Overflow safety:
9 We do not use SafeMath and control overflows by
10 not accepting large ints on input.
11 Balances inside contract are stored as int192.
12 Allowed input amounts are int112 or uint112: it is enough for all
13 practically used tokens: for instance if decimal unit is 1e18, int112
14 allow to encode up to 2.5e15 decimal units.
15 That way adding/subtracting any amount from balances won't overflow, since
16 minimum number of operations to reach max int is practically infinite: ~1e24.
17 Allowed prices are uint64. Note, that price is represented as
18 price per 1e8 tokens. That means that amount*price always fit uint256,
19 while amount*price/1e8 not only fit int192, but also can be added, subtracted
20 without overflow checks: number of malicion operations to overflow ~1e13.
21*/
22contract Exchange is OrionVault, ReentrancyGuard {
23
24 using LibValidator for LibValidator.Order;
25 using SafeERC20 for IERC20;
26
27 / Flags for updateOrders
28 / All flags are explicit
29 uint8 constant kSell = 0;
30 uint8 constant kBuy = 1; // if 0 - then sell
31 uint8 constant kCorrectMatcherFeeByOrderAmount = 2;
32
33 // EVENTS
34 event NewAssetTransaction(
35 address indexed user,
36 address indexed assetAddress,
37 bool isDeposit,
38 uint112 amount,
39 uint64 timestamp
40 );
41
42 event NewTrade(
43 address indexed buyer,
44 address indexed seller,
45 address baseAsset,
46 address quoteAsset,
47 uint64 filledPrice,
48 uint192 filledAmount,
49 uint192 amountQuote
50 );
51
52 // MAIN FUNCTIONS
53
54 /**
55 * @dev Since Exchange will work behind the Proxy contract it can not have constructor
56 */
57 function initialize() public payable initializer {
58 OwnableUpgradeSafe.__Ownable_init();
59 }
60
61 /**
62 * @dev set basic Exchange params
63 * @param orionToken - base token address
64 * @param priceOracleAddress - adress of PriceOracle contract
65 * @param allowedMatcher - address which has authorization to match orders
66 */
67 function setBasicParams(address orionToken, address priceOracleAddress, address allowedMatcher) public onlyOwner {
68 require((orionToken != address(0)) && (priceOracleAddress != address(0)), "E15");
69 _orionToken = IERC20(orionToken);
70 _oracleAddress = priceOracleAddress;
71 _allowedMatcher = allowedMatcher;
72 }
73
74
75 /**
76 * @dev set marginal settings
77 * @param _collateralAssets - list of addresses of assets which may be used as collateral
78 * @param _stakeRisk - risk coefficient for staken orion as uint8 (0=0, 255=1)
79 * @param _liquidationPremium - premium for liquidator as uint8 (0=0, 255=1)
80 * @param _priceOverdue - time after that price became outdated
81 * @param _positionOverdue - time after that liabilities became overdue and may be liquidated
82 */
83
84 function updateMarginalSettings(address[] calldata _collateralAssets,
85 uint8 _stakeRisk,
86 uint8 _liquidationPremium,
87 uint64 _priceOverdue,
88 uint64 _positionOverdue) public onlyOwner {
89 collateralAssets = _collateralAssets;
90 stakeRisk = _stakeRisk;
91 liquidationPremium = _liquidationPremium;
92 priceOverdue = _priceOverdue;
93 positionOverdue = _positionOverdue;
94 }
95
96 /**
97 * @dev set risk coefficients for collateral assets
98 * @param assets - list of assets
99 * @param risks - list of risks as uint8 (0=0, 255=1)
100 */
101 function updateAssetRisks(address[] calldata assets, uint8[] calldata risks) public onlyOwner {
102 for(uint256 i; i< assets.length; i++)
103 assetRisks[assets[i]] = risks[i];
104 }
105
106 /**
107 * @dev Deposit ERC20 tokens to the exchange contract
108 * @dev User needs to approve token contract first
109 * @param amount asset amount to deposit in its base unit
110 */
111 function depositAsset(address assetAddress, uint112 amount) external {
112 //require(asset.transferFrom(msg.sender, address(this), uint256(amount)), "E6");
113 IERC20(assetAddress).safeTransferFrom(msg.sender, address(this), uint256(amount));
114 generalDeposit(assetAddress,amount);
115 }
116
117 /**
118 * @notice Deposit ETH to the exchange contract
119 * @dev deposit event will be emitted with the amount in decimal format (10^8)
120 * @dev balance will be stored in decimal format too
121 */
122 function deposit() external payable {
123 generalDeposit(address(0), uint112(msg.value));
124 }
125
126 /**
127 * @dev internal implementation of deposits
128 */
129 function generalDeposit(address assetAddress, uint112 amount) internal {
130 address user = msg.sender;
131 bool wasLiability = assetBalances[user][assetAddress]<0;
132 int112 safeAmountDecimal = LibUnitConverter.baseUnitToDecimal(
133 assetAddress,
134 amount
135 );
136 assetBalances[user][assetAddress] += safeAmountDecimal;
137 if(amount>0)
138 emit NewAssetTransaction(user, assetAddress, true, uint112(safeAmountDecimal), uint64(block.timestamp));
139 if(wasLiability)
140 MarginalFunctionality.updateLiability(user, assetAddress, liabilities, uint112(safeAmountDecimal), assetBalances[user][assetAddress]);
141
142 }
143 /**
144 * @dev Withdrawal of remaining funds from the contract back to the address
145 * @param assetAddress address of the asset to withdraw
146 * @param amount asset amount to withdraw in its base unit
147 */
148 function withdraw(address assetAddress, uint112 amount)
149 external
150 nonReentrant
151 {
152 int112 safeAmountDecimal = LibUnitConverter.baseUnitToDecimal(
153 assetAddress,
154 amount
155 );
156
157 address user = msg.sender;
158
159 assetBalances[user][assetAddress] -= safeAmountDecimal;
160
161 require(assetBalances[user][assetAddress]>=0, "E1w1"); //TODO
162 require(checkPosition(user), "E1w2"); //TODO
163
164 uint256 _amount = uint256(amount);
165 if(assetAddress == address(0)) {
166 (bool success, ) = user.call{value:_amount}("");
167 require(success, "E6w");
168 } else {
169 IERC20(assetAddress).safeTransfer(user, _amount);
170 }
171
172
173 emit NewAssetTransaction(user, assetAddress, false, uint112(safeAmountDecimal), uint64(block.timestamp));
174 }
175
Comments to Code: 917 / 3561 = 26 %
Tests to Code: 3375 / 3561 = 95 %