Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshstevens19/evmc
a simple cli tool to load a contract code up in your IDE instantly.
https://github.com/joshstevens19/evmc
Last synced: about 2 months ago
JSON representation
a simple cli tool to load a contract code up in your IDE instantly.
- Host: GitHub
- URL: https://github.com/joshstevens19/evmc
- Owner: joshstevens19
- License: mit
- Created: 2022-11-06T09:46:54.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-19T22:23:56.000Z (almost 2 years ago)
- Last Synced: 2024-11-11T07:45:59.206Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 623 KB
- Stars: 127
- Watchers: 2
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/evmcontracts)
# 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
🚀 Support for hardhat project instantly creating you a hardhat project template with the compile, deploy scripts and local node running all ready to go.
## Chains Supported 🌐
🌐 Ethereum Mainnet - eth
🌐 Ethereum Ropsten - eth_ropsten
🌐 Ethereum Rinkeby - eth_rinkeby
🌐 Ethereum Goerli - eth_goerli
🌐 Ethereum Kovan - eth_kovan
🌐 Binance Smart Chain Mainnet - bsc
🌐 Binance Smart Chain Testnet - bsc_testnet
🌐 Polygon Mainnet - polygon
🌐 Polygon Mumbai - mumbai
🌐 Avalanche C-Chain - avalanche
🌐 Avalanche Fuji - avalance_testnet
🌐 Fantom - fantom
🌐 Fantom Testnet - fantom_testnet
🌐 Optimism - optimism
🌐 Optimism Goerli - optimism_goerli
🌐 Arbitrum - arbitrum
🌐 Arbitrum Goerli - arbitrum_goerli
🌐 Cronos - cronos
🌐 Cronos Testnet - cronos_testnet
## Installation
### npm:
```bash
$ npm install evmcontracts -g
```
### yarn:
```bash
$ 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:
```bash
$ evmc get
```
### Development toolset project setup
#### hardhat
To get the contract and setup a hardhat development environment, with deploy scripts and compiling ready to go:
```bash
$ evmc get --hardhat
```
#### foundry
already supported by the foundry team already it seems.. nice work!
### To change the output path
```bash
$ evmc get --output=PATH_DIRECTORY
```
### Incoming features
The following features are coming soon:
🚀 allow you to interact with the contract without downloading them on your machine
🚀 ability to config your main network and development kit (to avoid repeating yourself)
🚀 ability to fetch multiple contracts at once with a yaml file
🚀 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.