ape-cairo: A compiler plugin for the cairo programming language
Project description
Quick Start
Ape compiler plugin around the Cairo language.
Dependencies
- python3 version 3.8 or greater, python3-dev
Installation
via pip
You can install the latest release via pip:
pip install ape-cairo
via setuptools
You can clone the repository and use setuptools for the most up-to-date version:
git clone https://github.com/ApeWorX/ape-cairo.git
cd ape-cairo
python3 setup.py install
Quick Usage
In a project directory where there are .cairo files in your contracts/ directory, run the compile command:
ape compile
Configure Dependencies
You can configure dependencies, such as from GitHub, using your ape-config.yaml file.
There are two things you need to add:
- Add your dependency to Ape's root
dependencies:key to trigger downloading and compiling it. - Configure the
ape-cairoplugin to load that dependency in your project.
For more information on dependencies, see this guide.
Your resulting ape-config.yaml will look something like:
dependencies:
- name: OpenZeppelinCairo
github: OpenZeppelin/cairo-contracts
version: 0.1.0
contracts_folder: src
cairo:
dependencies:
- OpenZeppelinCairo@0.1.0
NOTE: We are changing the contracts/ folder to be src for this dependency.
Now, in my contracts/ folder, I can import from openzeppelin:
from openzeppelin.token.erc20.library import (
ERC20_name,
ERC20_symbol,
ERC20_totalSupply,
ERC20_decimals,
ERC20_balanceOf,
ERC20_allowance,
ERC20_mint,
ERC20_burn,
ERC20_initializer,
ERC20_approve,
ERC20_increaseAllowance,
ERC20_decreaseAllowance,
ERC20_transfer,
ERC20_transferFrom
)
Development
This project is in development and should be considered a beta. Things might not be in their final state and breaking changes may occur. Comments, questions, criticisms and pull requests are welcomed.
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 Distribution
Built Distribution
File details
Details for the file ape-cairo-0.5.0a2.tar.gz.
File metadata
- Download URL: ape-cairo-0.5.0a2.tar.gz
- Upload date:
- Size: 21.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cc3bd61f0461dba30c3c4a62718e1f50d78d406614153f4a249e9926504a8369 |
|
| MD5 | c4360057021e28f0d21c6edc25dc7228 |
|
| BLAKE2b-256 | 73666e4efdfc18beab78211eb1a7d01644ac03e62c8863acc6fbcda894a3156c |
File details
Details for the file ape_cairo-0.5.0a2-py3-none-any.whl.
File metadata
- Download URL: ape_cairo-0.5.0a2-py3-none-any.whl
- Upload date:
- Size: 9.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 50acd2e30d58b947d684054c4778bd97acb04c9ba59a4918a947e25d624c46f6 |
|
| MD5 | 06883624e3105904b8c748a674154fc9 |
|
| BLAKE2b-256 | d4ce639aca2d15ce4e9679c1c12c1a78bf9cca806937f60ce1fc3c2a2a57243c |
