easy POC template generation from the command line
from the command line, call quickpoc 0x.. [folder_name] to generate a ready-to-go sandbox for running POCs for the given address against mainnet, including:
- forge template with name mirroring contract name
src/folder populated with all contracts and libraries- test file autogenerated with contract import
- test setup with contract variable and mainnet forking
cd folder_namecopied to clipboard to save you 1 extra second
you can run forge test to confirm it's working, then go into tests/POC.t.sol to interact with the contract (saved in storage as c).
- on a UNIX machine with bash installed, install all dependencies:
- foundry (follow instructions here)
- jq (
brew install jq) - graphviz (
brew install graphviz) - surya (
npm i -g surya) - sol2uml (
npm i -g sol2uml)
-
download the
quickpocfile from this repo. -
set up two environment variables by calling the following from your terminal:
export ETH_RPC_URL="..."export ETHERSCAN_API_KEY="..."
-
you can then run it directly by calling the file (
./quickpoc) -
more conveniently, install it globally:
- put it somewhere you won't touch it (usually
~/bin) - if this folder isn't already in your path, open your bash run control file (for example,
~/.zshrc) and add the following line:export PATH="$PATH:/Users/path_to_folder_holding_file - call
chmod +x path_to_fileto make the file executable - you should then be able to call
quickpoc 0x..from any folder to generate the POC folder within it.
- support non-mainnet networks
- allow inputting multiple addresses
- automatically pull all contracts listed on an immunefi page
please submit issues for any additional features you'd like to see :)
big thanks to deliriusz for adding graph viz tools, proxy checks, and professionalism.