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 relevant chain that gets reviewed and its corresponding software repository. The document explaining these questions is here.
1. Are the smart contract addresses easy to find? (%)
2. How active is the primary contract? (%)
Contract SynapseBridge on Ethereum is used well over 100 times a day, as indicated in the Appendix.
3. Does the protocol have a public software repository? (Y/N)
Synapse is fully open-source here
4. Is there a development history visible? (%)
With 614 commits and 62 branches, Synapse has an exceptional development history
5. Is the team public (not anonymous)?
Synapse is comprised of anonymous contributors.
This section looks at the software documentation. The document explaining these questions is here.
6. Is there a whitepaper? (Y/N)
Location: https://docs.synapseprotocol.com/
7. Is the protocol's software architecture documented? (Y/N)
This protocol's software architecture is extensively documented in their GitHub docs.
8. Does the software documentation fully cover the deployed contracts' source code? (%)
There is 100% coverage of deployed contracts by software function documentation.
9. Is it possible to trace the documented software to its implementation in the protocol's source code? (%)
There is implicit traceability between software documentation and implemented code insofar as the documentation does not contain direct hyperlinks to the source code, but only cites it.
10. Has the protocol tested their deployed code? (%)
Code examples are in the Appendix at the end of this report.. As per the SLOC, there is 124% testing to code (TtC). This score is guided by the Test to Code ratio (TtC). Generally a good test to code ratio is over 100%. However, the reviewer's best judgement is the final deciding factor.
11. How covered is the protocol's code? (%)
While Synapse's official coveralls report obtained a mere score of 27%, their GitHub runs consist in frequent and consistent coverall runs. In combination with their above average testing suite, we are confident in giving Synapse a 80% score for this question. Synapse should fix their currently failing runs on GitHub to get the remaining points.
12. Does the protocol provide scripts and instructions to run their tests? (Y/N)
Scripts/Instructions location: https://github.com/synapsecns/synapse-contracts/tree/master/scripts
13. Is there a detailed report of the protocol's test results?(%)
Since most of Synapse's recent GitHub runs have failed, and the ones that have passed are old enough to have had their logs expire, there is inherently a lack of visible test results in Synapse's software repository. And, while there is a coveralls report, it is very outdated.
14. Has the protocol undergone Formal Verification? (Y/N)
Synapse has not undergone formal verification.
15. Were the smart contracts deployed to a testnet? (Y/N)
There is no evidence of Synapse deploying to a testnet.
This section looks at the 3rd party software audits done. It is explained in this document.
16. Is the protocol sufficiently audited? (%)
All of the public audits pertaining to the Synapse AMM are of the obsolete Nerve Finance contracts, or are Saddle Finance ones performed by Quantstamp and OpenZeppelin. However, Synapse is not a 1:1 fork of Saddle, and therefore certain aspects of Synapse do not have their audits viewable publicly. And, because no additional context is provided via a changelog or an otherwise detailed explanation of what was forked, what wasn't, and which specific components are audited/unaudited, we are giving a 0% here. Note that no Synapse audits of the bridging smart contracts are publicly available, and this is concerning.
17. Is the bounty value acceptably high (%)
Synapse currently does not offer an active 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.
18. Is the protocol's admin control information easy to find?
Synapse's admin control information isn't really explicitly established via documentation. The protocol is clearly upgradeable, but this is communicated via the technical docs and previous governance votes. Synapse does not clearly established which contracts are upgradeable or not, what the extent of upgradeability is, what kind of power the admins have, etc.
19. Are relevant contracts clearly labelled as upgradeable or immutable? (%)
Again, although protocol upgradeability is evident, Synapse does not formally detail which contracts are upgradeable or not. It is very informal, and fundamentally lacks clarity. No points can be given here.
20. Is the type of smart contract ownership clearly indicated? (%)
While it is clear that the protocol is controlled by the DAO, it is unclear if admins have completely relinquished any powers of their own. In any case, the code certainly contains defined ownership parameters. Synapse should create a concrete doc in which they formally and explicitly go over this.
21. Are the protocol's smart contract change capabilities described? (%)
A semblance of smart contract upgrade capability is visible in Synapse's past governance votes. However, the parameters of the upgradeability extent is not clearly defined anywhere.
22. Is the protocol's admin control information easy to understand? (%)
This information is all in software specific language.
23. Is there sufficient Pause Control documentation? (%)
Synapse's pause control is mentioned but not clearly detailed.
24. Is there sufficient Timelock documentation? (%)
A timelock is identified in Synapse's docs, but its duration and the smart contracts it applies to are not clearly defined.
25. Is the Timelock of an adequate length? (Y/N)
The Synapse timelock is of an undefined duration.
This section goes over the documentation that a protocol may or may not supply about their Oracle usage. Oracles are a fundamental part of DeFi as they are responsible for relaying tons of price data information to thousands of protocols using blockchain technology. Not only are they important for price feeds, but they are also an essential component of transaction verification and security. These questions are explained in this document.
26. Is the protocol's Oracle sufficiently documented? (%)
Synapse uses the stableswap equations in order to regulate price information.
27. Is front running mitigated by this protocol? (Y/N)
Synapse does not explain how they mitigate the possibility of front running within the protocol.
28. Can flashloan attacks be applied to the protocol, and if so, are those flashloan attack risks mitigated? (Y/N)
Synapse does not document how they mitigate the possibility or extent of a liquidity manipulation/flash loan attack.
1contract SynapseBridge is Initializable, AccessControlUpgradeable, ReentrancyGuardUpgradeable, PausableUpgradeable {
2 using SafeERC20 for IERC20;
3 using SafeERC20 for IERC20Mintable;
4 using SafeMath for uint256;
5
6 bytes32 public constant NODEGROUP_ROLE = keccak256("NODEGROUP_ROLE");
7 bytes32 public constant GOVERNANCE_ROLE = keccak256("GOVERNANCE_ROLE");
8
9 mapping(address => uint256) private fees;
10
11 uint256 public startBlockNumber;
12 uint256 public constant bridgeVersion = 6;
13 uint256 public chainGasAmount;
14 address payable public WETH_ADDRESS;
15
16 mapping(bytes32 => bool) private kappaMap;
17
18 receive() external payable {}
19
20 function initialize() external initializer {
21 startBlockNumber = block.number;
22 _setupRole(DEFAULT_ADMIN_ROLE, msg.sender);
23 __AccessControl_init();
24 }
25
26 function setChainGasAmount(uint256 amount) external {
27 require(hasRole(GOVERNANCE_ROLE, msg.sender), "Not governance");
28 chainGasAmount = amount;
29 }
30
31 function setWethAddress(address payable _wethAddress) external {
32 require(hasRole(DEFAULT_ADMIN_ROLE, msg.sender), "Not admin");
33 WETH_ADDRESS = _wethAddress;
34 }
35
36 function addKappas(bytes32[] calldata kappas) external {
37 require(hasRole(GOVERNANCE_ROLE, msg.sender), "Not governance");
38 for (uint256 i = 0; i < kappas.length; ++i) {
39 kappaMap[kappas[i]] = true;
40 }
41 }
42
43 event TokenDeposit(address indexed to, uint256 chainId, IERC20 token, uint256 amount);
44 event TokenRedeem(address indexed to, uint256 chainId, IERC20 token, uint256 amount);
45 event TokenWithdraw(address indexed to, IERC20 token, uint256 amount, uint256 fee, bytes32 indexed kappa);
46 event TokenMint(address indexed to, IERC20Mintable token, uint256 amount, uint256 fee, bytes32 indexed kappa);
47 event TokenDepositAndSwap(
48 address indexed to,
49 uint256 chainId,
50 IERC20 token,
51 uint256 amount,
52 uint8 tokenIndexFrom,
53 uint8 tokenIndexTo,
54 uint256 minDy,
55 uint256 deadline
56 );
57 event TokenMintAndSwap(
58 address indexed to,
59 IERC20Mintable token,
60 uint256 amount,
61 uint256 fee,
62 uint8 tokenIndexFrom,
63 uint8 tokenIndexTo,
64 uint256 minDy,
65 uint256 deadline,
66 bool swapSuccess,
67 bytes32 indexed kappa
68 );
69 event TokenRedeemAndSwap(
70 address indexed to,
71 uint256 chainId,
72 IERC20 token,
73 uint256 amount,
74 uint8 tokenIndexFrom,
75 uint8 tokenIndexTo,
76 uint256 minDy,
77 uint256 deadline
78 );
79 event TokenRedeemAndRemove(
80 address indexed to,
81 uint256 chainId,
82 IERC20 token,
83 uint256 amount,
84 uint8 swapTokenIndex,
85 uint256 swapMinAmount,
86 uint256 swapDeadline
87 );
88 event TokenWithdrawAndRemove(
89 address indexed to,
90 IERC20 token,
91 uint256 amount,
92 uint256 fee,
93 uint8 swapTokenIndex,
94 uint256 swapMinAmount,
95 uint256 swapDeadline,
96 bool swapSuccess,
97 bytes32 indexed kappa
98 );
99
100 // v2 events
101 event TokenRedeemV2(bytes32 indexed to, uint256 chainId, IERC20 token, uint256 amount);
102
103 // VIEW FUNCTIONS ***/
104 function getFeeBalance(address tokenAddress) external view returns (uint256) {
105 return fees[tokenAddress];
106 }
107
108 function kappaExists(bytes32 kappa) external view returns (bool) {
109 return kappaMap[kappa];
110 }
111
112 // FEE FUNCTIONS ***/
113 /**
114 * * @notice withdraw specified ERC20 token fees to a given address
115 * * @param token ERC20 token in which fees acccumulated to transfer
116 * * @param to Address to send the fees to
117 */
118 function withdrawFees(IERC20 token, address to) external whenNotPaused {
119 require(hasRole(GOVERNANCE_ROLE, msg.sender), "Not governance");
120 require(to != address(0), "Address is 0x000");
121 if (fees[address(token)] != 0) {
122 token.safeTransfer(to, fees[address(token)]);
123 fees[address(token)] = 0;
124 }
125 }
126
127 // PAUSABLE FUNCTIONS ***/
128 function pause() external {
129 require(hasRole(GOVERNANCE_ROLE, msg.sender), "Not governance");
130 _pause();
131 }
132
133 function unpause() external {
134 require(hasRole(GOVERNANCE_ROLE, msg.sender), "Not governance");
135 _unpause();
136 }
137
138 /**
139 * @notice Relays to nodes to transfers an ERC20 token cross-chain
140 * @param to address on other chain to bridge assets to
141 * @param chainId which chain to bridge assets onto
142 * @param token ERC20 compatible token to deposit into the bridge
143 * @param amount Amount in native token decimals to transfer cross-chain pre-fees
144 **/
145 function deposit(
146 address to,
147 uint256 chainId,
148 IERC20 token,
149 uint256 amount
150 ) external nonReentrant whenNotPaused {
151 emit TokenDeposit(to, chainId, token, amount);
152 token.safeTransferFrom(msg.sender, address(this), amount);
153 }
154
Tests to Code: 5834 / 4700 = 124 %