search

immutable / zkevm-bridge-contracts

Smart contracts for the Immutable zkEVM native bridge
https://toolkit.immutable.com/ethereum-bridge/
Apache License 2.0
8 stars 6 forks source link

comments updated as per feedback #55

Closed proletesseract closed 11 months ago

proletesseract commented 11 months ago

resolves

ChildERC20: Revise documentation to indicate the bridge controls minting and burning: "@ dev All child tokens are clones of this contract. Burning and minting is controlled by respective predicates only."

ChildERC20: Add some documentation explaining why the contract is upgradeable and how the system of cloning, and then initializing works.

platform-sa commented 11 months ago

📃CI Report

Compiling 141 files with 0.8.19 Solc 0.8.19 finished in 16.92s Compiler run successful! Analysing contracts... Running tests... File % Lines % Statements % Branches % Funcs
src/child/ChildAxelarBridgeAdaptor.sol 100.00% (48/48) 100.00% (65/65) 100.00% (22/22) 100.00% (7/7)
src/child/ChildERC20.sol 100.00% (14/14) 100.00% (15/15) 50.00% (1/2) 100.00% (7/7)
src/child/ChildERC20Bridge.sol 96.97% (128/132) 97.75% (174/178) 94.29% (66/70) 100.00% (21/21)
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% (48/48) 100.00% (65/65) 100.00% (22/22) 100.00% (7/7)
src/root/RootERC20Bridge.sol 93.65% (118/126) 95.58% (173/181) 87.50% (49/56) 90.91% (20/22)
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