-
Notifications
You must be signed in to change notification settings - Fork 130
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* test(zk): add #565 repro * test(zk:565): fix invariant and use zkVmSkip * fix(zk): use constant test addr for zkvm skip test * test(zk): proper basic invariant test * test(zk:invariant): add direct invariant test * feat: `InZkVm` utility to detect if contract is running in zkVm * chore: lints & formatting * refactor(test:zk): edit runner test opts * fix(test:zk): pre-select target senders for issue565 w/o handler * fix(zk): use `get_test_contract_address` * fix(backend): don't set test contract on each init * chore: lints * fix(executor): set_test_contract even w/o setup * test(zk): filter test to specific contract * refactor(zk): simplify test contract check Co-authored-by: Nisheeth Barthwal <nbaztec@gmail.com> * chore: fmt --------- Co-authored-by: Nisheeth Barthwal <nbaztec@gmail.com>
- Loading branch information
Showing
12 changed files
with
256 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // SPDX-License-Identifier: UNLICENSED | ||
| pragma solidity >=0.8.7 <0.9.0; | ||
|
|
||
| import {Globals} from "./Globals.sol"; | ||
|
|
||
| // excerpt from system-contracts | ||
| interface ISystemContext { | ||
| function chainId() external view returns (uint256); | ||
| } | ||
|
|
||
| library InZkVmLib { | ||
| function _inZkVm() internal returns (bool) { | ||
| (bool success, bytes memory retdata) = | ||
| Globals.SYSTEM_CONTEXT_ADDR.call(abi.encodeWithSelector(ISystemContext.chainId.selector)); | ||
|
|
||
| return success; | ||
| } | ||
| } | ||
|
|
||
| abstract contract InZkVm { | ||
| modifier inZkVm() { | ||
| require(InZkVmLib._inZkVm(), "must be executed in zkVM"); | ||
| _; | ||
| } | ||
| } | ||
|
|
||
| abstract contract DeployOnlyInZkVm is InZkVm { | ||
| constructor() { | ||
| require(InZkVmLib._inZkVm(), "must be deployed in zkVM"); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| // SPDX-License-Identifier: MIT OR Apache-2.0 | ||
| pragma solidity ^0.8.18; | ||
|
|
||
| import "ds-test/test.sol"; | ||
| import "cheats/Vm.sol"; | ||
| import {Globals} from "../Globals.sol"; | ||
| import {DeployOnlyInZkVm} from "../InZkVm.sol"; | ||
|
|
||
| import "../../default/logs/console.sol"; | ||
|
|
||
| contract Counter is DeployOnlyInZkVm { | ||
| uint256 public number; | ||
|
|
||
| function inc() public inZkVm { | ||
| number += 1; | ||
| } | ||
|
|
||
| function reset() public inZkVm { | ||
| number = 0; | ||
| } | ||
| } | ||
|
|
||
| contract CounterHandler is DSTest { | ||
| Vm constant vm = Vm(HEVM_ADDRESS); | ||
|
|
||
| uint256 public incCounter; | ||
| uint256 public resetCounter; | ||
| bool public isResetLast; | ||
| Counter public counter; | ||
|
|
||
| constructor(Counter _counter) { | ||
| counter = _counter; | ||
| } | ||
|
|
||
| function inc() public { | ||
| console.log("inc"); | ||
| incCounter += 1; | ||
| isResetLast = false; | ||
|
|
||
| vm.deal(tx.origin, 1 ether); // ensure caller has funds | ||
| counter.inc(); | ||
| } | ||
|
|
||
| function reset() public { | ||
| console.log("reset"); | ||
| resetCounter += 1; | ||
| isResetLast = true; | ||
|
|
||
| vm.deal(tx.origin, 1 ether); // ensure caller has funds | ||
| counter.reset(); | ||
| } | ||
| } | ||
|
|
||
| // partial from forge-std/StdInvariant.sol | ||
| abstract contract StdInvariant { | ||
| struct FuzzSelector { | ||
| address addr; | ||
| bytes4[] selectors; | ||
| } | ||
|
|
||
| address[] internal _targetedContracts; | ||
|
|
||
| function targetContracts() public view returns (address[] memory) { | ||
| return _targetedContracts; | ||
| } | ||
|
|
||
| FuzzSelector[] internal _targetedSelectors; | ||
|
|
||
| function targetSelectors() public view returns (FuzzSelector[] memory) { | ||
| return _targetedSelectors; | ||
| } | ||
|
|
||
| address[] internal _targetedSenders; | ||
|
|
||
| function targetSenders() public view returns (address[] memory) { | ||
| return _targetedSenders; | ||
| } | ||
| } | ||
|
|
||
| // https://github.com/matter-labs/foundry-zksync/issues/565 | ||
| contract Issue565 is DSTest, StdInvariant { | ||
| Vm constant vm = Vm(HEVM_ADDRESS); | ||
| Counter cnt; | ||
| CounterHandler handler; | ||
|
|
||
| function setUp() public { | ||
| cnt = new Counter(); | ||
|
|
||
| vm.zkVmSkip(); | ||
| handler = new CounterHandler(cnt); | ||
|
|
||
| // add the handler selectors to the fuzzing targets | ||
| bytes4[] memory selectors = new bytes4[](2); | ||
| selectors[0] = CounterHandler.inc.selector; | ||
| selectors[1] = CounterHandler.reset.selector; | ||
|
|
||
| _targetedContracts.push(address(handler)); | ||
| _targetedSelectors.push(FuzzSelector({addr: address(handler), selectors: selectors})); | ||
| } | ||
|
|
||
| //FIXME: seems to not be detected, forcing values in test config | ||
| /// forge-config: default.invariant.fail-on-revert = true | ||
| /// forge-config: default.invariant.no-zksync-reserved-addresses = true | ||
| function invariant_ghostVariables() external { | ||
| uint256 num = cnt.number(); | ||
|
|
||
| if (handler.resetCounter() == 0) { | ||
| assert(handler.incCounter() == num); | ||
| } else if (handler.isResetLast()) { | ||
| assert(num == 0); | ||
| } else { | ||
| assert(num != 0); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| contract Issue565WithoutHandler is DSTest, StdInvariant { | ||
| Vm constant vm = Vm(HEVM_ADDRESS); | ||
| Counter cnt; | ||
|
|
||
| uint256 constant dealAmount = 1 ether; | ||
|
|
||
| function setUp() public { | ||
| cnt = new Counter(); | ||
|
|
||
| // so we can fund them ahead of time for fees | ||
| _targetedSenders.push(address(65536 + 1)); | ||
| _targetedSenders.push(address(65536 + 12)); | ||
| _targetedSenders.push(address(65536 + 123)); | ||
| _targetedSenders.push(address(65536 + 1234)); | ||
|
|
||
| for (uint256 i = 0; i < _targetedSenders.length; i++) { | ||
| vm.deal(_targetedSenders[i], dealAmount); | ||
| } | ||
|
|
||
| // add the handler selectors to the fuzzing targets | ||
| bytes4[] memory selectors = new bytes4[](2); | ||
| selectors[0] = Counter.inc.selector; | ||
| selectors[1] = Counter.reset.selector; | ||
|
|
||
| _targetedContracts.push(address(cnt)); | ||
| _targetedSelectors.push(FuzzSelector({addr: address(cnt), selectors: selectors})); | ||
| } | ||
|
|
||
| //FIXME: seems to not be detected, forcing values in test config | ||
| /// forge-config: default.invariant.fail-on-revert = true | ||
| /// forge-config: default.invariant.no-zksync-reserved-addresses = true | ||
| function invariant_itWorks() external {} | ||
| } |