nomoixyz / vulcan Goto Github PK

Use natspec comments to document Accounts.sol

It uses it's local storage so accounts is not really necessary (can just use a storage pointer)

Add tests for the Strings namespace

Currently we use the same API and a similar underlying implementation as forge-std console2. The difference is that we use a custom type constant that provides the log functions through a library and using ... for.

The reasoning was to allow extending the console by creating other libraries that add log functions for user defined types (structs, enums, etc). The downside is that it isn't consistent with the other modules (for other modules a library is imported instead of a custom type constant).

Figure out if there is a better way to achieve this.

A few things like expect(1).toEqual(1) won't compile because the compiler won't be able to determine the type.

We should probably prepend the module and function that is throwing the error, e.g. revert("accounts.impersonate: ...")

Use natspec comments to document Vulcan.sol

Currently we are using selfdestruct on the stop functions in the Watcher contract. selfdestruct is deprecated so every time the Watcher contract gets compiled a warning appears which is annoying.

We need to find a way to get the same functionality for the stop function but without using selfdestruct

Use natspec comments to document Command.sol

Use natspec comments to document Env.sol

If we could parse toml files we could improve the Config module to obtain settings from
foundry.toml

• Have a functional Script base contract
• Brainstorm future features

Do manual and automated testing

Same as https://github.com/foundry-rs/forge-std/blob/master/src/StdInvariant.sol it needs to include those view functions. The way of adding targets could be different though.

Use natspec comments to document Console.sol

Provide a way to optionally use a label prefix when generating multiple addresses.

Create a template that includes Vulcan. Something similar to https://github.com/PaulRBerg/foundry-template

Add sections to the book

Use natspec comments to document Fs.sol

Export the huff module and Huffc struct from src/script.sol

We have two options:

• Create an unsafe modifier for functions that should only be used in tests. This will make those functions revert at runtime when using them in Scripts.
• Make it similar to stdStorage, they have a safe library and an unsafe one. We can have different entrypoints like script.sol and test.sol, and only use safe libs in script.

Add tests for the Fork namespace

Same as explained in https://github.com/foundry-rs/forge-std/blob/7b4876e8de2a232a54159035f173e35421000c19/src/StdUtils.sol#L187

We probably don't want to compile the whole Console.sol contract when importing things like println, so we should have a separate function for this.

Use natspec comments to document Events.sol

Add tests for the Fs namespace

Use natspec comments to document Expect.sol

We need to show how to build a JSON object with multiple properties.

Use natspec comments to document Fork.sol

Use natspec comments to document Json.sol

Add a method to the accounts module to generate an array of addresses with an specific length

Update the readme file including:

• Link to external documentation (if that's already setup)
• How to install vulcan
• How to use vulcan
• Examples on how to use different namespaces
• How to contribute to vulcan

Figure out if a new module makes sense for rpcUrl methods. It could also include other helpers such as isTest, isScript, etc. Another alternative would be to add these to an existing module such as ctx or env.

Use natspec comments to document Watcher.sol

• Export Command struct from script.sol
• Support creating an empty command (?)

Add tests for the Env namespace

• Format the whole codebase using forge fmt.
• Update the ci configuration to either fail if the code is not formatted or to automatically create a PR with the formatted code

Use natspec comments to document Strings.sol

Add tests for the Events namespace

Add tests for the Context namespace

It would be cool to have something like:

import {Test, events} from "vulcan/lib.sol";

contract TestMyContract is Test {
      function testMyContract() external {
          events.watch("Transfer(...)");
          // Do stuff...
          Log[] memory logs = events.getWatched("Transfer(...)")
      }
}

Add tests for the Accounts namespace

Foundry's built in gas reports leave a lot to be desired. Often times what I want to test in terms of gas usage is not 1:1 with tests, so creating individual tests just for the purposes of making a call to determine gas usage feels a little silly.

In our recently overhaul of MUD internals, we've added our own gas report tooling using a special // !gasreport line in our tests that wraps the next line in a gasleft() calculation, executes the test, and then records the gas usage to a file that we check in and compare in each PR to see how gas is changing. This works but is very slow and clunky.

I'd love for some official Solidity gas reporting support, something along the lines of:

function testBehavior() public {
  // calculates gas used by next line 
  reportGas('abi encode');
  abi.encode('hello world');

  // calculates gas within the start/end calls
  // block added for readability
  startReportGas('mint and burn');
  {
    mint();
    burn();
  }
  endReportGas();
}

Related:

• foundry-rs/foundry#1795
• foundry-rs/foundry#3766

Add tests for the Console namespace

Use natspec comments to document Context.sol