crytic-compile-master


Namecrytic-compile-master JSON
Version 0.2.4 PyPI version JSON
download
home_pagehttps://github.com/crytic/crytic-compile
SummaryUtil to facilitate smart contracts compilation.
upload_time2023-01-01 14:06:52
maintainer
docs_urlNone
authorTrail of Bits
requires_python>=3.8
licenseAGPL-3.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Crytic-compile
[![Build Status](https://img.shields.io/github/workflow/status/crytic/crytic-compile/CI/master)](https://github.com/crytic/crytic-compile/actions?query=workflow%3ACI)
[![Slack Status](https://empireslacking.herokuapp.com/badge.svg)](https://empireslacking.herokuapp.com)
[![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
- [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)
- [Foundry](https://github.com/foundry-rs/foundry/)
- [Hardhat](https://github.com/nomiclabs/hardhat)
- [Truffle](https://truffleframework.com/)
- [Waffle](https://github.com/EthWorks/Waffle)

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

```bash
pip3 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.

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

### As a library

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/crytic/crytic-compile",
    "name": "crytic-compile-master",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Trail of Bits",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/e0/51/3cee924beaa1fbdc383f32c546dea636a1c85ae2fe45b07e4f818cee940e/crytic-compile-master-0.2.4.tar.gz",
    "platform": null,
    "description": "# Crytic-compile\n[![Build Status](https://img.shields.io/github/workflow/status/crytic/crytic-compile/CI/master)](https://github.com/crytic/crytic-compile/actions?query=workflow%3ACI)\n[![Slack Status](https://empireslacking.herokuapp.com/badge.svg)](https://empireslacking.herokuapp.com)\n[![PyPI version](https://badge.fury.io/py/crytic-compile.svg)](https://badge.fury.io/py/crytic-compile)\n\nLibrary to help smart contract compilation. It includes support for:\n- Direct solc compilation\n- [Brownie](https://github.com/iamdefinitelyahuman/brownie)\n- [Buidler](https://github.com/nomiclabs/buidler)\n- [Dapp](https://dapp.tools/dapp/)\n- [Embark](https://embark.status.im/)\n- [Etherlime](https://github.com/LimeChain/etherlime)\n- [Etherscan](https://etherscan.io/) (including several alt-chain explorers and testnets)\n- [Foundry](https://github.com/foundry-rs/foundry/)\n- [Hardhat](https://github.com/nomiclabs/hardhat)\n- [Truffle](https://truffleframework.com/)\n- [Waffle](https://github.com/EthWorks/Waffle)\n\nSee the [Configuration](https://github.com/crytic/crytic-compile/wiki/Configuration) documentation for advanced usages.\n\nThe plugin is used in Trail of Bits tools, including:\n- [Slither](https://github.com/crytic/slither)\n- [Echidna](https://github.com/crytic/echidna)\n- [Manticore](https://github.com/trailofbits/manticore/)\n- [evm-cfg-builder](https://github.com/crytic/evm_cfg_builder)\n\n\n## Installation\n\n```bash\npip3 install crytic-compile\n```\n\n## Usage\n\n### Standalone\n```bash\ncrytic-compile .\n```\n\nCrytic-compile will generate `crytic-export/contracts.json` containing the AST/ABI and bytecodes of the contracts.\n\nRun `crytic-compile --help` for more options.\n\n### As a library\n\nSee the [library documentation](https://github.com/crytic/crytic-compile/wiki/Library-Documentation).\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0",
    "summary": "Util to facilitate smart contracts compilation.",
    "version": "0.2.4",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "33ccdad8ca9b352ca00f65562c7fc120",
                "sha256": "309d5f573fcce848867fe34a2c16d9a6ed31fb80acd9f9e0abea84ea3c29bc6e"
            },
            "downloads": -1,
            "filename": "crytic_compile_master-0.2.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "33ccdad8ca9b352ca00f65562c7fc120",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 88571,
            "upload_time": "2023-01-01T14:06:49",
            "upload_time_iso_8601": "2023-01-01T14:06:49.424364Z",
            "url": "https://files.pythonhosted.org/packages/fb/63/81cadbc1fc99119c7c9a838a2c1351d508752d410f9f97c7391fbb2166ba/crytic_compile_master-0.2.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "3838ccaf949bf19deb6fff96a80ddcbe",
                "sha256": "684f679e5f31c34e16f2f24fe3f3dfe1edbc989298f283bb758e52e1875f7990"
            },
            "downloads": -1,
            "filename": "crytic-compile-master-0.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "3838ccaf949bf19deb6fff96a80ddcbe",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 64803,
            "upload_time": "2023-01-01T14:06:52",
            "upload_time_iso_8601": "2023-01-01T14:06:52.043409Z",
            "url": "https://files.pythonhosted.org/packages/e0/51/3cee924beaa1fbdc383f32c546dea636a1c85ae2fe45b07e4f818cee940e/crytic-compile-master-0.2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-01 14:06:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "crytic",
    "github_project": "crytic-compile",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "crytic-compile-master"
}
        
Elapsed time: 0.04139s