Package: ethpector
EthpectorEthpector extracts useful information from smart contract binaries.Smart contracts are computer programs that coordinate financial agreements on blockchain systems. Although smart contract platforms are transparent in general smart contracts can be pretty opaque if their source-code is not available.Ethpector sets out to provide tools to analyze smart contract with and without access to their source-code. Its main focus is to provide tools and heuristics for the automated analysis and classification of smart contracts.Currently the tool enables:Fetching code by addresses (via web3 rpc)Fetching source-code for addresses (Etherscan and Sourcify)Recovering interfaces including logs from binariesResolving function and event selectors (via 4bytes and more)It uses control-flow analysis and symbolic execution (mythril) to extract data like calls, stores, logs, etc. including parameters if possibleIt creates annotated disassemblyIt simple contract classification method based on interfaces and bytecodeParsing metadata like swarm and ipfs hashesFor a more advanced example of how to use this data look at the examples in the experiments folder.UsageTo install run> pip install ethpectoror build from source directly by> make installUse as follows:usage: ethpector [-h] [--version] [-r rpc] [-e etherscan_token] [-c] [-v] [-vv] [-d] [-a] [-f] [--dont_drop_metadatastring] [--output OUTPUT [OUTPUT ...]] [--output_dir OUTPUT_DIR] contract

ethpector -- getting insights into evm binaries.

positional arguments:
  contract              EVM input bytecode or address if -a is providedoptions:-h,--helpshow this help message and exit.--versionshow program’s version number and exit.-rrpc,--rpcrpcEthereum node RPC url.-eetherscan_token,--etherscanetherscan_tokenEtherscan access token.-c,--concolicSymbolic execution engine loads values (storage state, call targets) from a node via RPC.-v,--verboseset loglevel to INFO.-vv,--very-verboseset loglevel to DEBUG.-d,--deploySets if deployment code is provided. EXPERIMENTAL.-a,--addressAnalyse address: data is loaded either via RPC or Etherscan.-f,--tofileDump output as files.--offlineDo not use any online resources.--nodotenvDo not load dotenv file to initialize config values.--dont_drop_metadatastringIncludes the metadata string to the bytecode analysis.--outputOUTPUTOutput that should be produced: summary|disassembly|sourcecode|all|basicblocks|calls|storage|functions|known_interfaces. Note: Multiple OUTPUTS possible.--output_dirOUTPUT_DIRDirectory to save the results if -f is specified. Default is ethspector-output/.For improved analysis results bot an etherscan api token as well as a ethereum node is beneficial.
They can either be configured via commandline options (–rpc and –etherscan), via environment variables or .env files.An example .env file could look as follows:ETHPECTOR_ETHERSCAN_TOKEN=[YOUR ETHERSCAN TOKEN]
ETHPECTOR_RPC=https://mainnet.infura.io/v3/[YOUR INFURA TOKEN]
ETHPECTOR_CHAINID=1
ETHPECTOR_MYTHRIL_EXECUTION_TIMEOUT=100
ETHPECTOR_MYTHRIL_CREATE_TIMEOUT=60
ETHPECTOR_MYTHRIL_MAX_DEPTH=512
ETHPECTOR_MYTHRIL_SOLVER_TIMEOUT=200000A full list of configurable options can be found in src/ethpector/config/config.py.The example folder holds some interesting binaries as well as addresses to test on.Developmentit is advised to use a virtual environment (venv) for development. Run the following command to initialize one> python3 -m venv .venvand activate it (in bash) using> source .venv/bin/activate

For more information refer to (venv_). Run> make devto initialize the dev environment.
If you want to install ethpector in development mode run> make install-devBefore committing anything to the repository please format, lint and test your code in that order. Fix all linter warnings and make sure all test are passing before a commit.Use the following commands for that:> make format
> make lint
> make testor equivalently run> make pre-commitSome slow tests are excluded when running make test. Occasionally, one should run> make test-allto run the entire test-suite.Linting and formatting should be automatically executed on every git commit, using pre-commit.To create the documentation please run:> make docsCreating the docs need python dev dependencies to build see (Stackoverflow)CreditsWe thank all the developers of mythril for their great work. Without which this project would not exist.MythrilWe would like to thank the following projects for inspiration.Evmdisgsalzer s ethutilsSimilar ProjectsThe following section contains a couple of similar projects and useful libraries that could serve as an alternative or to amend ethpector when analyzing smart contract binaries.eveempakalamanticorepanoramix decompilerhevmethtxslitherFundingThis project was created in the course of the KRYPTOMONITOR project.The security research project KRYPTOMONITOR is funded by the Austrian
security research programme KIRAS of the Federal Ministry of Agriculture,
Regions and Tourism (BMLRT).Kryptomonitor Project