Compile Solidity contracts.
- python3 version 3.8 or greater, python3-dev
You can install the latest release via pip
:
pip install ape-solidity
You can clone the repository and use setuptools
for the most up-to-date version:
git clone https://github.com/ApeWorX/ape-solidity.git
cd ape-solidity
python3 setup.py install
In your project, make sure you have a contracts/
directory containing Solidity files (.sol
).
Then, while this plugin is installed, compile your contracts:
ape compile
The byte-code and ABI for your contracts should now exist in a __local__.json
file in a .build/
directory.
To configure import remapping, use your project's ape-config.yaml
file:
solidity:
import_remapping:
- "@openzeppelin=path/to/open_zeppelin/contracts"
If you are using the dependencies:
key in your ape-config.yaml
, ape
can automatically
search those dependencies for the path.
dependencies:
- name: OpenZeppelin
github: OpenZeppelin/openzeppelin-contracts
version: 4.4.2
solidity:
import_remapping:
- "@openzeppelin=OpenZeppelin/4.4.2"
Once you have your dependencies configured, you can import packages using your import keys:
import "@openzeppelin/token/ERC721/ERC721.sol";
When using ape-solidity
, your project's manifest's compiler settings will include standard JSON output.
You should have one listed compiler
per solc
version used in your project.
You can view your current project manifest, including the compiler settings, by doing:
from ape import project
manifest = project.extract_manifest()
for compiler_entry in manifest.compilers:
print(compiler_entry.version)
print(compiler_entry.settings)
NOTE: These are the settings used during contract verification when using the Etherscan plugin.