# EthSential - Security analysis for Ethereum smart contracts
[](https://github.com/1140251/Ethsential/actions)
[](https://github.com/1140251/Ethsential/actions)
[](https://pypi.python.org/pypi/ethsential)
[](https://marketplace.visualstudio.com/items?itemName=1140251.ethsential)
EthSential is a security analysis framework for Ethereum smart contracts. It bundles security analysis tools to find vulnerabilities in smart contracts code.
## Features
- A system that uses analysis tools based on Docker images.
- Provides two types of interfaces for the command-line interface and language server protocol ([lsp](https://microsoft.github.io/language-server-protocol/)).
- Normalize the output of the tools in a single file or lsp response.
## Supported Tools
- [Mythril](https://github.com/ConsenSys/mythril)
- [Securify](https://github.com/eth-sri/securify2)
- [Slither](https://github.com/crytic/slither)
## Prerequisites
EthSential requires [Docker](https://docs.docker.com/install) and [Python3](https://www.python.org) to be installed in the system.
## Install
Install from Pypi:
```bash
$ pip install ethsential
```
## Usage
Run `ethsent -h` to get more information:
```text
Usage: solhint [actions] [options] <file>
Actions:
tcp Use TCP server
cli Use command line interface
install, i, isntall, add Install tools
tcp optional arguments:
-h, --help show this help message and exit
--host HOST Bind to address (default=127.0.0.1)
-p, --port PORT Bind to port (default=2087)
cli arguments:
-h, --help show this help message and exit
-f, --file FILE [FILE ...] select file(s) or directories to be analysed
-t, --tools [{all,mythril,securify,slither} ...] select tool(s)
-op, --outputPath The full path for the new output directory, relative to the current workspace. (default=result/).
```
## IDE Integrations
- **[VS Code](https://marketplace.visualstudio.com/items?itemName=1140251.ethsential)**
## How to contribute
Please read [CONTRIBUTING.md](https://github.com/1140251/Ethsential/blob/master/CONTRIBUTING.md) for details about how to proceed.
Everyone interacting in Ethsential and its sub-projects' codebases and issue trackers, is expected to follow the Contributor Covenant [code of conduct](https://github.com/1140251/Ethsential/blob/master/CODE_OF_CONDUCT.md).
## License
This project is licensed under the Apache-2.0 license - see the [LICENSE.md](https://github.com/1140251/Ethsential/blob/master/LICENSE.md) file for details.
