https://github.com/crytic/crytic-compile

Abstraction layer for smart contract build systems
https://github.com/crytic/crytic-compile

Last synced: about 1 year ago
JSON representation

Abstraction layer for smart contract build systems

• Host: GitHub
• URL: https://github.com/crytic/crytic-compile
• Owner: crytic
• License: agpl-3.0
• Created: 2019-04-08T17:48:03.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2025-05-02T17:11:03.000Z (about 1 year ago)
• Last Synced: 2025-05-07T23:35:38.015Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 1.24 MB
• Stars: 171
• Watchers: 2
• Forks: 83
• Open Issues: 112
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# Crytic-compile

[![Build Status](https://img.shields.io/github/actions/workflow/status/crytic/crytic-compile/ci.yml?branch=master)](https://github.com/crytic/crytic-compile/actions?query=workflow%3ACI)

[![Slack Status](https://slack.empirehacking.nyc/badge.svg)](https://slack.empirehacking.nyc)

[![PyPI version](https://badge.fury.io/py/crytic-compile.svg)](https://badge.fury.io/py/crytic-compile)

Library to help smart contract compilation. It includes support for:

- Direct solc compilation

- [Foundry](https://github.com/foundry-rs/foundry/)

- [Hardhat](https://github.com/nomiclabs/hardhat)

- [Brownie](https://github.com/iamdefinitelyahuman/brownie)

- [Buidler](https://github.com/nomiclabs/buidler)

- [Dapp](https://dapp.tools/dapp/)

- [Embark](https://embark.status.im/)

- [Etherlime](https://github.com/LimeChain/etherlime)

- [Etherscan](https://etherscan.io/) (including several alt-chain explorers and testnets)

- [Truffle](https://truffleframework.com/)

- [Waffle](https://github.com/EthWorks/Waffle)

To force compilation with a specific framework, use the `--compile-force-framework` flag. For example, to force compilation with Hardhat:

```shell

crytic-compile . --compile-force-framework hardhat

```

See the [Configuration](https://github.com/crytic/crytic-compile/wiki/Configuration) documentation for advanced usages.

The plugin is used in Trail of Bits 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

```shell

pip3 install crytic-compile

```

## Usage

In the root directory of your project e.g. same directory as `hardhat.config.js` or `foundry.toml`, run:

```shell

crytic-compile .

```

Crytic-compile will generate `crytic-export/contracts.json` containing the AST/ABI and bytecodes of the contracts.

Run `crytic-compile --help` for more options.

## Library Linking

If your project uses [libraries](https://docs.soliditylang.org/en/latest/contracts.html#libraries) with external functions, they can be linked to their deployed address with the `--compile-libraries` flag. For example, if you have a library `SafeMath` deployed at `0xff`, you can link it with:

```shell

crytic-compile . --compile-libraries "(SafeMath, 0xff)"

```

If you are fuzzing with Echidna or Medusa, follow this [tutorial on linking libraries](https://secure-contracts.com/program-analysis/echidna/advanced/working-with-libraries.html?highlight=library#linking-libraries).

### As a library

See the [library documentation](https://github.com/crytic/crytic-compile/wiki/Library-Documentation).