ciaranmcveigh5 / ethernaut-x-foundry Goto Github PK

Hi, we recently have conducted a systematic study about Solidity event usage, evolution, and impact, and we are attempting to build a tool to improve the practice of Solidity event use based on our findings. We have tried our prototype tool on some of the most popular GitHub Solidity repositories, and for your repository, we find a potential optimization of gas consumption arisen from event use.

The point is that when we use emit operation to store the value of a certain variable, local memory type variable would be preferable to global storage type (state) variable if they hold the same value. The reason is that an extra SLOAD operation would be needed to access the variable if it is storage type, and the SLOAD operation costs 800 gas.

For your repository, we find that the following event use can be improved:

• NaughtCoin.sol
  function name: constructor
  event name:  Transfer
  variable:    player->_player

  constructor(address _player) 
  ERC20('NaughtCoin', '0x0')
  public {
    player = _player;
    INITIAL_SUPPLY = 1000000 * (10**uint256(decimals()));
    // _totalSupply = INITIAL_SUPPLY;
    // _balances[player] = INITIAL_SUPPLY;
    _mint(player, INITIAL_SUPPLY);
    emit Transfer(address(0), player, INITIAL_SUPPLY);
  }

Do you find our results useful? Your reply and invaluable suggestions would be greatly appreciated, and are vital for improving our tool. Thanks a lot for your time!

Problem

When an engineer forks and uses this repo to start solving Ethernaut exercises, all solutions are present in the fork.

Proposal

Remove the solutions from the main branch but preserve them on a separate branch (perhaps calls solutions). I think it makes sense to preserve the solutions in case developers get stuck and want to refer to a reference example.

Summary

Tests are failing in the latest version of foundry-cli (v0.1.0). Recommended CLI command is also outdated.

Steps to reproduce:

1. git clone --recursive https://github.com/ciaranmcveigh5/ethernaut-x-foundry.git
2. forge build
3. forge test -m Fallback --verbosity 3

Output:

➜ forge test -m Fallback --verbosity 3
no files changed, compilation skippped.
Running 1 test for "FallbackTest.json":FallbackTest
[FAIL. Reason: Invalid data] testFallbackHack() (gas: 921345)

Failure: testFallbackHack()

Preface

Thanks for creating this repo, it's made tackling Ethernaut challenges more enjoyable!

Question

Are maintainers open to taking a dependency on forge-std? That way we can remove Vm.sol and import forge-std's Vm.sol. If maintainers are open to the idea, I can create a PR.