Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Address some code cleanup and refactoring issues #48

Merged
merged 5 commits into from
Nov 21, 2023
Merged

Address some code cleanup and refactoring issues #48

merged 5 commits into from
Nov 21, 2023

Conversation

ermyas
Copy link
Collaborator

@ermyas ermyas commented Nov 21, 2023

This PR makes a number of minor code cleanup and refactoring improvements:

  1. https://immutable.atlassian.net/browse/SMR-2042 Moves mock files to the test directory
  2. https://immutable.atlassian.net/browse/SMR-2043 Changes licenses for flow rate contracts from MIT to Apache 2
  3. https://immutable.atlassian.net/browse/SMR-2039 Remove unneeded slither warning disabling comment
  4. https://immutable.atlassian.net/browse/SMR-2040 Add storage gaps to AdaptorRoles and BridgeRoles
  5. https://immutable.atlassian.net/browse/SMR-2044 Document the need for the receive() fallback in bridge contracts

@platform-sa
Copy link

📃CI Report

Compiling 148 files with 0.8.19
Solc 0.8.19 finished in 19.39s
Compiler run �[32msuccessful!�[0m
Analysing contracts...
Running tests...

File % Lines % Statements % Branches % Funcs
script/DeployChildContracts.s.sol 0.00% (0/22) 0.00% (0/32) 100.00% (0/0) 0.00% (0/1)
script/DeployRootContracts.s.sol 0.00% (0/23) 0.00% (0/33) 0.00% (0/2) 0.00% (0/1)
script/InitializeChildContracts.s.sol 0.00% (0/11) 0.00% (0/17) 100.00% (0/0) 0.00% (0/1)
script/InitializeRootContracts.s.sol 0.00% (0/11) 0.00% (0/17) 100.00% (0/0) 0.00% (0/1)
script/Utils.sol 0.00% (0/12) 0.00% (0/16) 0.00% (0/2) 0.00% (0/2)
src/child/ChildAxelarBridgeAdaptor.sol 100.00% (37/37) 100.00% (55/55) 100.00% (14/14) 100.00% (6/6)
src/child/ChildERC20.sol 100.00% (14/14) 100.00% (15/15) 50.00% (1/2) 100.00% (7/7)
src/child/ChildERC20Bridge.sol 97.16% (137/141) 97.89% (186/190) 92.68% (76/82) 100.00% (16/16)
src/child/WIMX.sol 0.00% (0/19) 0.00% (0/22) 0.00% (0/8) 0.00% (0/6)
src/common/AdaptorRoles.sol 100.00% (6/6) 100.00% (6/6) 100.00% (0/0) 100.00% (6/6)
src/common/BridgeRoles.sol 100.00% (8/8) 100.00% (8/8) 100.00% (0/0) 100.00% (8/8)
src/lib/EIP712MetaTransaction.sol 8.00% (2/25) 9.68% (3/31) 8.33% (1/12) 14.29% (1/7)
src/lib/EIP712Upgradeable.sol 73.33% (11/15) 60.87% (14/23) 0.00% (0/2) 50.00% (2/4)
src/lib/WETH.sol 100.00% (19/19) 100.00% (22/22) 100.00% (8/8) 100.00% (6/6)
src/root/RootAxelarBridgeAdaptor.sol 100.00% (37/37) 100.00% (55/55) 100.00% (14/14) 100.00% (6/6)
src/root/RootERC20Bridge.sol 94.52% (138/146) 96.24% (205/213) 90.79% (69/76) 90.91% (20/22)
src/root/flowrate/FlowRateDetection.sol 90.00% (27/30) 90.91% (30/33) 78.57% (11/14) 100.00% (4/4)
src/root/flowrate/FlowRateWithdrawalQueue.sol 67.39% (31/46) 61.67% (37/60) 50.00% (7/14) 85.71% (6/7)
src/root/flowrate/RootERC20BridgeFlowRate.sol 100.00% (43/43) 98.00% (49/50) 100.00% (10/10) 100.00% (9/9)

For a full HTML report run: forge coverage --report lcov && genhtml --ignore-errors category --branch-coverage --output-dir coverage lcov.info

@ermyas ermyas merged commit 45acda3 into main Nov 21, 2023
4 checks passed
@ermyas ermyas deleted the fix/misc branch April 12, 2024 05:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants