fix: remove obsolete contracts · bgd-labs/solidity-utils@3cee8a7

sakulstra · 2024-11-15T08:47:05Z

forge 0.0.2 (48c6b1a 2024-11-15T00:25:27.138557582Z)

sakulstra · 2024-11-15T08:47:05Z

🔮 Coverage report

File	Line Coverage	Function Coverage	Branch Coverage
src/contracts/access-control/OwnableWithGuardian.sol	${\color{orange}90\%}$ $9 / 10$ 20	${\color{orange}87.5\%}$ $7 / 8$ OwnableWithGuardian.onlyOwnerOrGuardian	${\color{green}100\%}$ $4 / 4$
src/contracts/access-control/UpgradeableOwnableWithGuardian.sol	${\color{green}100\%}$ $14 / 14$	${\color{green}100\%}$ $9 / 9$	${\color{green}100\%}$ $2 / 2$
src/contracts/create3/Create3.sol	${\color{orange}92.86\%}$ $13 / 14$ 66	${\color{red}80\%}$ $4 / 5$ Create3.create3	${\color{red}33.33\%}$ $1 / 3$
src/contracts/create3/Create3Factory.sol	${\color{green}100\%}$ $4 / 4$	${\color{green}100\%}$ $2 / 2$	${\color{green}100\%}$ $0 / 0$
src/contracts/oz-common/Ownable.sol	${\color{red}80\%}$ $8 / 10$ 37, 63	${\color{red}71.43\%}$ $5 / 7$ Ownable.onlyOwner Ownable.renounceOwnership	${\color{red}50\%}$ $2 / 4$
src/contracts/oz-common/SafeERC20.sol	${\color{red}13.64\%}$ $3 / 22$ 46, 54, 55, 64, 65, 66, 68, 78, 80, 81, 82, 100, 101, 102, 103, 104, 121, 138, 139	${\color{red}25\%}$ $2 / 8$ SafeERC20.safeTransferFrom SafeERC20.safeIncreaseAllowance SafeERC20.safeDecreaseAllowance SafeERC20.forceApprove SafeERC20.safePermit SafeERC20._callOptionalReturnBool	${\color{red}0\%}$ $0 / 4$
src/contracts/transparent-proxy/Initializable.sol	${\color{red}68.42\%}$ $13 / 19$ 124, 128, 129, 131, 132, 140	${\color{red}60\%}$ $3 / 5$ Initializable.reinitializer Initializable.onlyInitializing	${\color{red}45.45\%}$ $5 / 11$
src/contracts/transparent-proxy/Proxy.sol	$^{↓-100\%}{\color{red}0\%}$ $0 / 10$ 33, 37, 40, 44, 45, 47, 48, 65, 66, 74	$^{↓-100\%}{\color{red}0\%}$ $0 / 4$ Proxy._delegate Proxy._fallback Proxy. Proxy._beforeFallback	${\color{green}100\%}$ $0 / 0$
src/contracts/transparent-proxy/ProxyAdmin.sol	${\color{red}0\%}$ $0 / 1$ 43	${\color{red}50\%}$ $1 / 2$ ProxyAdmin.upgradeAndCall	${\color{green}100\%}$ $0 / 0$
src/contracts/transparent-proxy/TransparentProxyFactory.sol	${\color{green}100\%}$ $2 / 2$	${\color{green}100\%}$ $1 / 1$	${\color{green}100\%}$ $0 / 0$
src/contracts/transparent-proxy/TransparentProxyFactoryBase.sol	$^{↑6.2\%}{\color{red}62.5\%}$ $10 / 16$ 20, 22, 23, 28, 30, 31	${\color{red}66.67\%}$ $4 / 6$ TransparentProxyFactoryBase.create TransparentProxyFactoryBase.createProxyAdmin	${\color{green}100\%}$ $0 / 0$
src/contracts/transparent-proxy/TransparentUpgradeableProxy.sol	$^{↑83\%}{\color{red}50\%}$ $5 / 10$ 105, 106, 108, 123, 124	$^{↑240\%}{\color{red}75\%}$ $3 / 4$ TransparentUpgradeableProxy._dispatchUpgradeToAndCall	$^{↓-100\%}{\color{red}0\%}$ $0 / 4$
src/contracts/utils/PermissionlessRescuable.sol	${\color{green}100\%}$ $2 / 2$	${\color{green}100\%}$ $2 / 2$	${\color{green}100\%}$ $0 / 0$
src/contracts/utils/Rescuable.sol	${\color{green}100\%}$ $4 / 4$	${\color{green}100\%}$ $3 / 3$	${\color{green}100\%}$ $1 / 1$
src/contracts/utils/Rescuable721.sol	${\color{green}100\%}$ $2 / 2$	${\color{green}100\%}$ $1 / 1$	${\color{green}100\%}$ $0 / 0$
src/contracts/utils/RescuableBase.sol	${\color{green}100\%}$ $8 / 8$	${\color{green}100\%}$ $2 / 2$	${\color{green}100\%}$ $1 / 1$

sakulstra · 2024-11-15T08:47:05Z

🔧 Build logs

Compiling 86 files with Solc 0.8.28
installing solc version "0.8.28"
Successfully installed solc 0.8.28
Solc 0.8.28 finished in 3.32s
Compiler run successful with warnings:
Warning (5667): Unused function parameter. Remove or comment out the variable name to silence this warning.
   --> src/mocks/ERC721.sol:933:23:
    |
933 |     function tokenURI(uint256 id) public view override returns (string memory) {
    |                       ^^^^^^^^^^

Warning (2018): Function state mutability can be restricted to pure
   --> src/mocks/ERC721.sol:923:5:
    |
923 |     function name() public view override returns (string memory) {
    |     ^ (Relevant source part starts here and spans across multiple lines).

Warning (2018): Function state mutability can be restricted to pure
   --> src/mocks/ERC721.sol:928:5:
    |
928 |     function symbol() public view override returns (string memory) {
    |     ^ (Relevant source part starts here and spans across multiple lines).

Warning (2018): Function state mutability can be restricted to pure
   --> src/mocks/ERC721.sol:933:5:
    |
933 |     function tokenURI(uint256 id) public view override returns (string memory) {
    |     ^ (Relevant source part starts here and spans across multiple lines).

Warning (2018): Function state mutability can be restricted to view
  --> test/PermissionlessRescuable.t.sol:63:3:
   |
63 |   function test_whoShouldReceiveFunds() public {
   |   ^ (Relevant source part starts here and spans across multiple lines).

Warning (2018): Function state mutability can be restricted to view
  --> test/UpgradeableOwnableWithGuardian.t.sol:29:3:
   |
29 |   function test_initializer() external {
   |   ^ (Relevant source part starts here and spans across multiple lines).

| Contract                    | Runtime Size (B) | Initcode Size (B) | Runtime Margin (B) | Initcode Margin (B) |
|-----------------------------|------------------|-------------------|--------------------|---------------------|
| Address                     |               85 |               135 |             24,491 |              49,017 |
| ChainHelpers                |               85 |               135 |             24,491 |              49,017 |
| ChainIds                    |               85 |               135 |             24,491 |              49,017 |
| Create2Utils                |              162 |               212 |             24,414 |              48,940 |
| Create3                     |               85 |               135 |             24,491 |              49,017 |
| Create3Factory              |            1,094 |             1,122 |             23,482 |              48,030 |
| ERC1967Proxy                |              163 |             1,014 |             24,413 |              48,138 |
| ERC1967Utils                |               85 |               135 |             24,491 |              49,017 |
| ERC20                       |            2,331 |             3,020 |             22,245 |              46,132 |
| EnumerableSet               |               85 |               135 |             24,491 |              49,017 |
| ImplOwnableWithGuardian     |            1,464 |             1,492 |             23,112 |              47,660 |
| MockContract                |              759 |             1,021 |             23,817 |              48,131 |
| MockERC721                  |            2,421 |             2,449 |             22,155 |              46,703 |
| MockImpl                    |              465 |               690 |             24,111 |              48,462 |
| PermissionlessRescuable     |            1,908 |             2,081 |             22,668 |              47,071 |
| ProxyAdmin                  |            1,039 |             1,275 |             23,537 |              47,877 |
| Rescuable                   |            1,807 |             1,958 |             22,769 |              47,194 |
| Rescuable721                |            2,043 |             2,201 |             22,533 |              46,951 |
| SafeCast                    |               85 |               135 |             24,491 |              49,017 |
| SafeERC20                   |               85 |               135 |             24,491 |              49,017 |
| StorageSlot                 |               85 |               135 |             24,491 |              49,017 |
| TestNetChainIds             |               85 |               135 |             24,491 |              49,017 |
| TransparentProxyFactory     |            5,314 |             5,342 |             19,262 |              43,810 |
| TransparentUpgradeableProxy |            1,137 |             2,266 |             23,439 |              46,886 |

🔧 Build logs zksync

Compiling 47 files with zksolc and ZKsync solc 0.8.24
zksolc and ZKsync solc 0.8.24 finished in 11.16s
Compiler run successful with warnings:
Warning (2519)
Warning: This declaration shadows an existing declaration.
  --> zksync/test/TransparentProxyFactoryZkSync.t.sol:88:5:
   |
88 |     address proxyAdmin = factory.createDeterministicProxyAdmin(proxyAdminOwner, proxyAdminSalt);
   |     ^^^^^^^^^^^^^^^^^^
Note: The shadowed declaration is here:
  --> zksync/test/TransparentProxyFactoryZkSync.t.sol:14:3:
   |
14 |   ProxyAdmin internal proxyAdmin;
   |   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Warning (2519)
Warning: This declaration shadows an existing declaration.
   --> zksync/test/TransparentProxyFactoryZkSync.t.sol:106:5:
    |
106 |     address proxyAdmin = factory.createDeterministicProxyAdmin(proxyAdminOwner, proxyAdminSalt);
    |     ^^^^^^^^^^^^^^^^^^
Note: The shadowed declaration is here:
  --> zksync/test/TransparentProxyFactoryZkSync.t.sol:14:3:
   |
14 |   ProxyAdmin internal proxyAdmin;
   |   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Warning

┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Warning: Your code or one of its dependencies uses the 'extcodesize' instruction, which is       │
│ usually needed in the following cases:                                                           │
│   1. To detect whether an address belongs to a smart contract.                                   │
│   2. To detect whether the deploy code execution has finished.                                   │
│ zkSync Era comes with native account abstraction support (so accounts are smart contracts,       │
│ including private-key controlled EOAs), and you should avoid differentiating between contracts   │
│ and non-contract addresses.                                                                      │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
--> lib/forge-std/src/StdCheats.sol
Warning

┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Warning: Your code or one of its dependencies uses the 'extcodesize' instruction, which is       │
│ usually needed in the following cases:                                                           │
│   1. To detect whether an address belongs to a smart contract.                                   │
│   2. To detect whether the deploy code execution has finished.                                   │
│ zkSync Era comes with native account abstraction support (so accounts are smart contracts,       │
│ including private-key controlled EOAs), and you should avoid differentiating between contracts   │
│ and non-contract addresses.                                                                      │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
--> lib/forge-std/src/StdUtils.sol
Warning

┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Warning: It looks like you are using 'ecrecover' to validate a signature of a user account.      │
│ zkSync Era comes with native account abstraction support, therefore it is highly recommended NOT │
│ to rely on the fact that the account has an ECDSA private key attached to it since accounts might│
│ implement other signature schemes.                                                               │
│ Read more about Account Abstraction at https://v2-docs.zksync.io/dev/developer-guides/aa.html    │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
--> lib/forge-std/src/mocks/MockERC20.sol
Warning

┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Warning: Your code or one of its dependencies uses the 'extcodesize' instruction, which is       │
│ usually needed in the following cases:                                                           │
│   1. To detect whether an address belongs to a smart contract.                                   │
│   2. To detect whether the deploy code execution has finished.                                   │
│ zkSync Era comes with native account abstraction support (so accounts are smart contracts,       │
│ including private-key controlled EOAs), and you should avoid differentiating between contracts   │
│ and non-contract addresses.                                                                      │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
--> lib/forge-std/src/mocks/MockERC721.sol
| Contract                      | Runtime Size (B) | Initcode Size (B) | Runtime Margin (B) | Initcode Margin (B) |
|-------------------------------|------------------|-------------------|--------------------|---------------------|
| Address                       |              224 |               224 |            450,775 |             450,775 |
| Create2UtilsZkSync            |              480 |               480 |            450,519 |             450,519 |
| ERC1967Proxy                  |            4,192 |             4,192 |            446,807 |             446,807 |
| ERC1967Utils                  |              224 |               224 |            450,775 |             450,775 |
| MockImpl                      |            2,272 |             2,272 |            448,727 |             448,727 |
| ProxyAdmin                    |            4,512 |             4,512 |            446,487 |             446,487 |
| StorageSlot                   |              224 |               224 |            450,775 |             450,775 |
| TransparentProxyFactoryZkSync |            8,032 |             8,032 |            442,967 |             442,967 |
| TransparentUpgradeableProxy   |            7,136 |             7,136 |            443,863 |             443,863 |

sakulstra · 2024-11-15T08:47:15Z

⛽ Gas report

Create3Factory

gas: 219061
| Method | min | mean | median | max | calls |
| --- | ---: | ---: | ---: | ---: | ---: |
create(bytes32,bytes) | ^↓-1.8%41507 | ^↓-0.18%209905 | ^↓-0.12%293726 | ^↓-0.0041%294482 | 3 |

ProxyAdmin

gas: 0
| Method | min | mean | median | max | calls |
| --- | ---: | ---: | ---: | ---: | ---: |
owner() | ^↓-25%288 | ^↓-25%288 | ^↓-25%288 | ^↓-25%288 | 2 |

TransparentProxyFactory

gas: ^↓-24%1201403
| Method | min | mean | median | max | calls |
| --- | ---: | ---: | ---: | ---: | ---: |
createDeterministic(address,address,bytes,bytes32) | ^↓-32%384550 | ^↓-32%384724 | ^↓-32%384724 | ^↓-32%384898 | 2 |
createDeterministicProxyAdmin(address,bytes32) | ^↓-30%288380 | ^↓-30%288656 | ^↓-30%288656 | ^↓-30%288932 | 2 |
predictCreateDeterministic(address,address,bytes,bytes32) | ^↓-27%8698 | ^↓-27%8698 | ^↓-27%8698 | ^↓-27%8698 | 2 |
predictCreateDeterministicProxyAdmin(bytes32,address) | 4876 | 4876 | 4876 | 4876 | 2 |

TransparentUpgradeableProxy

gas: 0
| Method | min | mean | median | max | calls |
| --- | ---: | ---: | ---: | ---: | ---: |
getFoo() | ^↓-34%682 | ^↓-34%682 | ^↓-34%682 | ^↓-34%682 | 2 |

ImplOwnableWithGuardian

gas: 314524
| Method | min | mean | median | max | calls |
| --- | ---: | ---: | ---: | ---: | ---: |
updateGuardian(address) | 26169 | ^↑0.06%30016 | 30519 | 30519 | 9 |

Rescuable721

gas: 495549
| Method | min | mean | median | max | calls |
| --- | ---: | ---: | ---: | ---: | ---: |
emergency721TokenTransfer(address,address,uint256) | ^↓-0.91%22219 | ^↓-0.25%40964 | ^↓-0.25%40964 | 59709 | 2 |

ImplOwnableWithGuardian

gas: 369723
| Method | min | mean | median | max | calls |
| --- | ---: | ---: | ---: | ---: | ---: |
updateGuardian(address) | ^↓-0.77%26139 | 29136 | ^↑0.67%30532 | 30739 | 3 |

sakulstra · 2024-11-15T08:47:21Z

🌈 Test Results

No files changed, compilation skipped

Ran 6 tests for test/PermissionlessRescuable.t.sol:PermissionlessRescuableTest
[PASS] test_emergencyEtherTransfer() (gas: 59257)
[PASS] test_emergencyEtherTransferInsufficientBalance_shouldRevert() (gas: 45456)
[PASS] test_emergencyTokenTransfer() (gas: 81017)
[PASS] test_emergencyTokenTransferInsufficientBalance_shouldRevert() (gas: 21438)
[PASS] test_emergencyTokenTransfer_withTransferRestriction() (gas: 115750)
[PASS] test_whoShouldReceiveFunds() (gas: 12734)
Suite result: ok. 6 passed; 0 failed; 0 skipped; finished in 944.48µs (550.56µs CPU time)

Ran 1 test for test/ChainHelperTest.t.sol:TestChainHelpers
[PASS] test_selectChain_shouldRevert() (gas: 3293)
Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 7.38ms (64.10µs CPU time)

Ran 6 tests for test/OwnableWithGuardian.t.sol:TestOfOwnableWithGuardian
[PASS] testConstructorLogic() (gas: 18202)
[PASS] testGuardianUpdateNoAccess() (gas: 14902)
[PASS] testGuardianUpdateViaGuardian(address) (runs: 256, μ: 19419, ~: 19419)
[PASS] testGuardianUpdateViaOwner(address) (runs: 256, μ: 19236, ~: 19236)
[PASS] test_onlyGuardianGuard() (gas: 12577)
[PASS] test_onlyGuardianGuard_shouldRevert() (gas: 10566)
Suite result: ok. 6 passed; 0 failed; 0 skipped; finished in 26.17ms (25.66ms CPU time)

Ran 5 tests for test/Rescuable.t.sol:RescueTest
[PASS] testEmergencyEtherTransfer() (gas: 57744)
[PASS] testEmergencyEtherTransferWhenNotOwner() (gas: 17666)
[PASS] testEmergencyTokenTransfer() (gas: 231216)
[PASS] testEmergencyTokenTransferWhenNotOwner() (gas: 203504)
[PASS] testToken() (gas: 2392)
Suite result: ok. 5 passed; 0 failed; 0 skipped; finished in 27.78ms (1.78ms CPU time)

Ran 6 tests for test/UpgradeableOwnableWithGuardian.t.sol:TestOfUpgradableOwnableWithGuardian
[PASS] test_initializer() (gas: 18304)
[PASS] test_onlyGuardian() (gas: 11066)
[PASS] test_onlyOwnerOrGuardian() (gas: 13262)
[PASS] test_updateGuardian_eoa(address,address) (runs: 256, μ: 18703, ~: 18703)
[PASS] test_updateGuardian_guardian(address) (runs: 256, μ: 19684, ~: 19684)
[PASS] test_updateGuardian_owner(address) (runs: 256, μ: 19400, ~: 19400)
Suite result: ok. 6 passed; 0 failed; 0 skipped; finished in 29.86ms (29.65ms CPU time)

Ran 3 tests for test/Rescuable721.t.sol:Rescue721Test
[PASS] testFuzzEmergencyTokenTransfer(address) (runs: 256, μ: 79081, ~: 79081)
[PASS] testFuzzEmergencyTokenTransferWhenNotOwner(address,address) (runs: 256, μ: 71841, ~: 71859)
[PASS] testToken() (gas: 2458)
Suite result: ok. 3 passed; 0 failed; 0 skipped; finished in 51.10ms (50.61ms CPU time)

Ran 2 tests for test/create3Test.t.sol:Create3FactoryTest
[PASS] testCreate3WithValue(address,address,address) (runs: 256, μ: 280857, ~: 280857)
[PASS] testCreate3WithoutValue(address,address,bytes32) (runs: 256, μ: 283786, ~: 283786)
Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 76.73ms (119.81ms CPU time)

Ran 4 tests for test/TransparentProxyFactory.t.sol:TestTransparentProxyFactory
[PASS] testCreateDeterministic(address,bytes32) (runs: 256, μ: 384826, ~: 384826)
[PASS] testCreateDeterministicProxyAdmin(address,bytes32) (runs: 256, μ: 282376, ~: 282376)
[PASS] testCreateDeterministicWithDeterministicProxy(bytes32,bytes32) (runs: 256, μ: 391377, ~: 391377)
[PASS] testCreateProxyAdmin(address,bytes32) (runs: 256, μ: 276438, ~: 276438)
Suite result: ok. 4 passed; 0 failed; 0 skipped; finished in 127.43ms (199.82ms CPU time)

Ran 8 test suites in 136.73ms (347.38ms CPU time): 33 tests passed, 0 failed, 0 skipped (33 total tests)

🌈 Test Results zksync

Compiling 45 files with Solc 0.8.24
Solc 0.8.24 finished in 1.52s
Compiler run successful with warnings:
Warning (2519): This declaration shadows an existing declaration.
  --> zksync/test/TransparentProxyFactoryZkSync.t.sol:88:5:
   |
88 |     address proxyAdmin = factory.createDeterministicProxyAdmin(proxyAdminOwner, proxyAdminSalt);
   |     ^^^^^^^^^^^^^^^^^^
Note: The shadowed declaration is here:
  --> zksync/test/TransparentProxyFactoryZkSync.t.sol:14:3:
   |
14 |   ProxyAdmin internal proxyAdmin;
   |   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Warning (2519): This declaration shadows an existing declaration.
   --> zksync/test/TransparentProxyFactoryZkSync.t.sol:106:5:
    |
106 |     address proxyAdmin = factory.createDeterministicProxyAdmin(proxyAdminOwner, proxyAdminSalt);
    |     ^^^^^^^^^^^^^^^^^^
Note: The shadowed declaration is here:
  --> zksync/test/TransparentProxyFactoryZkSync.t.sol:14:3:
   |
14 |   ProxyAdmin internal proxyAdmin;
   |   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


No files changed, compilation skipped

Ran 5 tests for zksync/test/TransparentProxyFactoryZkSync.t.sol:TestTransparentProxyFactoryZkSync
[PASS] testCreate() (gas: 2776054)
[PASS] testCreateDeterministic(bytes32) (runs: 256, μ: 3201204, ~: 3201204)
[PASS] testCreateDeterministicProxyAdmin(address,bytes32) (runs: 256, μ: 2024017, ~: 2103572)
[PASS] testCreateDeterministicWithDeterministicProxy(bytes32,bytes32) (runs: 256, μ: 3408076, ~: 3408342)
[PASS] testCreateProxyAdmin(address,bytes32) (runs: 256, μ: 1811188, ~: 1895923)
Suite result: ok. 5 passed; 0 failed; 0 skipped; finished in 9.17s (29.55s CPU time)

Ran 1 test suite in 9.17s (9.17s CPU time): 5 tests passed, 0 failed, 0 skipped (5 total tests)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Commit

There are no files selected for viewing

5 comments on commit `3cee8a7`

sakulstra commented on `3cee8a7` Nov 15, 2024

sakulstra commented on `3cee8a7` Nov 15, 2024

sakulstra commented on `3cee8a7` Nov 15, 2024

sakulstra commented on `3cee8a7` Nov 15, 2024

sakulstra commented on `3cee8a7` Nov 15, 2024

Commit

There are no files selected for viewing

5 comments on commit 3cee8a7

sakulstra commented on 3cee8a7 Nov 15, 2024

Choose a reason for hiding this comment

sakulstra commented on 3cee8a7 Nov 15, 2024

Choose a reason for hiding this comment

sakulstra commented on 3cee8a7 Nov 15, 2024

Choose a reason for hiding this comment

sakulstra commented on 3cee8a7 Nov 15, 2024

Choose a reason for hiding this comment

Create3Factory

ProxyAdmin

TransparentProxyFactory

TransparentUpgradeableProxy

ImplOwnableWithGuardian

Rescuable721

ImplOwnableWithGuardian

sakulstra commented on 3cee8a7 Nov 15, 2024

Choose a reason for hiding this comment

5 comments on commit `3cee8a7`

sakulstra commented on `3cee8a7` Nov 15, 2024

sakulstra commented on `3cee8a7` Nov 15, 2024

sakulstra commented on `3cee8a7` Nov 15, 2024

sakulstra commented on `3cee8a7` Nov 15, 2024

sakulstra commented on `3cee8a7` Nov 15, 2024