Util to facilitate smart contracts compilation.
Project description
# Crytic-compile
[![Build Status](https://travis-ci.com/crytic/crytic-compile.svg?branch=master)](https://travis-ci.com/crytic/crytic-compile)
[![Slack Status](https://empireslacking.herokuapp.com/badge.svg)](https://empireslacking.herokuapp.com)
Library to help smart contract compilation. It includes support for:
- Direct solc compilation
- [Truffle](https://truffleframework.com/)
- [Embark](https://embark.status.im/)
- [Dapp](https://dapp.tools/dapp/)
- [Etherlime](https://github.com/LimeChain/etherlime)
- [Etherscan](https://etherscan.io/)
See the [Configuration](https://github.com/crytic/crytic-compile/wiki/Configuration) documentation for advanced usages.
The plugin is used in Crytic tools, including:
- [Slither](https://github.com/crytic/slither)
- [Echidna](https://github.com/crytic/echidna)
- [Manticore](https://github.com/trailofbits/manticore/)
- [evm-cfg-builder](https://github.com/crytic/evm_cfg_builder)
## Installation
```
pip install crytic-compile
```
## Usage
### Standalone
```bash
$ crytic-compile .
```
Crytic-compile will generate `crytic-export/contracts.json` containing the AST/ABI and bytecodes of the contracts.
The file structure is:
```json
{
"asts": [],
"contracts": {
"contract_name": {
"abi": [],
"bin": "..",
"bin-runtime": "..",
"srcmap": "..",
"srcmap-runtime": "..",
"filenames": {
"absolute": "..",
"relative": "..",
"short": "..",
"used": "..",
}
}
},
"compiler": {
"compiler": "solc",
"version": "x.x.x",
"optimized": false
},
"working_dir": ".."
}
```
Run `crytic-compile --help` for more options.
### As a library
See the [library documentation](https://github.com/crytic/crytic-compile/wiki/Library-Documentation).
[![Build Status](https://travis-ci.com/crytic/crytic-compile.svg?branch=master)](https://travis-ci.com/crytic/crytic-compile)
[![Slack Status](https://empireslacking.herokuapp.com/badge.svg)](https://empireslacking.herokuapp.com)
Library to help smart contract compilation. It includes support for:
- Direct solc compilation
- [Truffle](https://truffleframework.com/)
- [Embark](https://embark.status.im/)
- [Dapp](https://dapp.tools/dapp/)
- [Etherlime](https://github.com/LimeChain/etherlime)
- [Etherscan](https://etherscan.io/)
See the [Configuration](https://github.com/crytic/crytic-compile/wiki/Configuration) documentation for advanced usages.
The plugin is used in Crytic tools, including:
- [Slither](https://github.com/crytic/slither)
- [Echidna](https://github.com/crytic/echidna)
- [Manticore](https://github.com/trailofbits/manticore/)
- [evm-cfg-builder](https://github.com/crytic/evm_cfg_builder)
## Installation
```
pip install crytic-compile
```
## Usage
### Standalone
```bash
$ crytic-compile .
```
Crytic-compile will generate `crytic-export/contracts.json` containing the AST/ABI and bytecodes of the contracts.
The file structure is:
```json
{
"asts": [],
"contracts": {
"contract_name": {
"abi": [],
"bin": "..",
"bin-runtime": "..",
"srcmap": "..",
"srcmap-runtime": "..",
"filenames": {
"absolute": "..",
"relative": "..",
"short": "..",
"used": "..",
}
}
},
"compiler": {
"compiler": "solc",
"version": "x.x.x",
"optimized": false
},
"working_dir": ".."
}
```
Run `crytic-compile --help` for more options.
### As a library
See the [library documentation](https://github.com/crytic/crytic-compile/wiki/Library-Documentation).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for crytic_compile-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d36ca96164bf9f7b7f875b638b795a20bd4f0c01149133ccaefd8e75deb160d |
|
MD5 | dec619f86feac7592409deb5d97b1b0a |
|
BLAKE2b-256 | cc7cff31e499e6de099ae074f736bb6743a141fb457549c1540467ff9dfe68aa |