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

Move architecture docs to main #91

Merged
merged 47 commits into from
Mar 25, 2024
Merged

Move architecture docs to main #91

merged 47 commits into from
Mar 25, 2024

Conversation

ermyas
Copy link
Collaborator

@ermyas ermyas commented Mar 25, 2024

This PR moves the architecture docs that have thus far been maintained in the documentation branch over to the main branch.

@ermyas ermyas changed the title Merge technical docs to main Move technical docs to main Mar 25, 2024
@ermyas ermyas changed the title Move technical docs to main Move architecture docs to main Mar 25, 2024
@ermyas ermyas requested a review from wcgcyx March 25, 2024 01:11
@platform-sa
Copy link

📃CI Report

Compiling 156 files with 0.8.19
Solc 0.8.19 finished in 15.14s
Compiler run �[33msuccessful with warnings:�[0m
�[1;33mWarning (9302)�[0m�[1;37m: Return value of low-level calls not used.�[0m
�[34m |�[0m
�[34m361 |�[0m �[33muser.call{value: amount}("")�[0m;
�[34m |�[0m �[1;33m^^^^^^^^^^^^^^^^^^^^^^^^^^^^�[0m

�[1;33mWarning (9302)�[0m�[1;37m: Return value of low-level calls not used.�[0m
�[34m |�[0m
�[34m174 |�[0m �[33muser.call{value: amount}("")�[0m;
�[34m |�[0m �[1;33m^^^^^^^^^^^^^^^^^^^^^^^^^^^^�[0m

Analysing contracts...
Running tests...

File % Lines % Statements % Branches % Funcs
src/child/ChildAxelarBridgeAdaptor.sol 100.00% (51/51) 100.00% (68/68) 100.00% (24/24) 100.00% (8/8)
src/child/ChildERC20.sol 100.00% (14/14) 100.00% (15/15) 100.00% (2/2) 100.00% (7/7)
src/child/ChildERC20Bridge.sol 99.23% (129/130) 99.43% (175/176) 98.44% (63/64) 100.00% (21/21)
src/child/WIMX.sol 100.00% (19/19) 100.00% (22/22) 100.00% (8/8) 100.00% (6/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 89.47% (17/19) 86.36% (19/22) 87.50% (7/8) 66.67% (4/6)
src/root/RootAxelarBridgeAdaptor.sol 100.00% (51/51) 100.00% (68/68) 100.00% (24/24) 100.00% (8/8)
src/root/RootERC20Bridge.sol 94.07% (127/135) 95.83% (184/192) 87.93% (51/58) 91.30% (21/23)
src/root/flowrate/FlowRateDetection.sol 100.00% (30/30) 100.00% (33/33) 100.00% (14/14) 100.00% (4/4)
src/root/flowrate/FlowRateWithdrawalQueue.sol 100.00% (46/46) 100.00% (60/60) 78.57% (11/14) 100.00% (7/7)
src/root/flowrate/RootERC20BridgeFlowRate.sol 100.00% (42/42) 97.96% (48/49) 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 37fc919 into main Mar 25, 2024
5 checks passed
@ermyas ermyas deleted the documentation branch April 12, 2024 05:40
@ermyas ermyas restored the documentation branch August 28, 2024 05:01
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.

4 participants