Home

Awesome

npm version

evmc

When browsing any evm blockchain, it is often useful to be able to see the source code of a contract. This is especially true when trying to understand the behavior of a contract, or when trying to verify the behavior of a contract. You may be able to hack around and see it on etherscan but really you know your true home is your IDE (any IDE). This tool allows you to fetch the source code of a contract from the blockchain, and create you the full project files for you to view in YOUR IDE, support to deploy on a local node, compile if you choose to. This uses etherscan API to grab the verified sources of the contract. It will keep the same directory structure as how the contract was deployed, alongside all of the dependencies it uses, the project evmc fetches for you will be ready to go!

Features šŸš€

šŸš€ Fetch the source code of a contract from the blockchain and use it in your favourite editor <br/> šŸš€ Support for hardhat project instantly creating you a hardhat project template with the compile, deploy scripts and local node running all ready to go. <br/>

Chains Supported šŸŒ

šŸŒ Ethereum Mainnet - eth <br/> šŸŒ Ethereum Ropsten - eth_ropsten <br/> šŸŒ Ethereum Rinkeby - eth_rinkeby <br/> šŸŒ Ethereum Goerli - eth_goerli <br/> šŸŒ Ethereum Kovan - eth_kovan <br/> šŸŒ Binance Smart Chain Mainnet - bsc <br/> šŸŒ Binance Smart Chain Testnet - bsc_testnet <br/> šŸŒ Polygon Mainnet - polygon <br/> šŸŒ Polygon Mumbai - mumbai <br/> šŸŒ Avalanche C-Chain - avalanche <br/> šŸŒ Avalanche Fuji - avalance_testnet <br/> šŸŒ Fantom - fantom <br/> šŸŒ Fantom Testnet - fantom_testnet <br/> šŸŒ Optimism - optimism <br/> šŸŒ Optimism Goerli - optimism_goerli <br/> šŸŒ Arbitrum - arbitrum <br/> šŸŒ Arbitrum Goerli - arbitrum_goerli <br/> šŸŒ Cronos - cronos <br/> šŸŒ Cronos Testnet - cronos_testnet

Installation

npm:

$ npm install evmcontracts -g

yarn:

$ yarn global add evmcontracts

CLI usage

Once installed it will expose a command called evmc which can be executed anywhere.

Get

please note when executing these commands it will create a folder with the name of the contract in the current directory you are in, unless you use --output

Just contracts

To get just the contracts without any development tool:

$ evmc get <network> <contractAddress>

Development toolset project setup

hardhat

To get the contract and setup a hardhat development environment, with deploy scripts and compiling ready to go:

$ evmc get <network> <contractAddress> --hardhat

foundry

already supported by the foundry team already it seems.. nice work!

To change the output path

$ evmc get <network> <contractAddress> --output=PATH_DIRECTORY

Incoming features

The following features are coming soon:

šŸš€ allow you to interact with the contract without downloading them on your machine <br/> šŸš€ ability to config your main network and development kit (to avoid repeating yourself) <br/> šŸš€ ability to fetch multiple contracts at once with a yaml file <br/> šŸš€ bring your own API key

note

I have generated API keys so its plug and play but these are rate limited at 5 requests per second, this should be plenty as long as the tool does not used by thousands of people, these are free API keys so nobody has motive of stealing them. Above we bring a way to bring your own API key in anyway so if this ever happens we can migrate and make it best practice.