Plugin for Ape Ethereum Framework for compiling Vyper contracts
Project description
Quick Start
Ape compiler plugin around VVM
Dependencies
- python3 version 3.10 up to 3.12.
Installation
via pip
You can install the latest release via pip:
pip install ape-vyper
via setuptools
You can clone the repository and use setuptools for the most up-to-date version:
git clone https://github.com/ApeWorX/ape-vyper.git
cd ape-vyper
python3 setup.py install
Quick Usage
First, place Vyper contract source files (files with extension .vy) in your Ape project's contracts folder.
An example Vyper contract can be found here.
Then, from your root Ape project folder, run the command:
ape compile
The .vy files in your project will compile into ContractTypes that you can deploy and interact with in Ape.
Contract Flattening
For ease of publishing, validation, and some other cases it's sometimes useful to "flatten" your contract into a single file. This combines your contract and any imported interfaces together in a way the compiler can understand. You can do so with a command like this:
ape vyper flatten contracts/MyContract.vy build/MyContractFlattened.vy
[!WARNING] This feature is experimental. Please report any bugs you find when trying it out.
Compiler Version
By default, the ape-vyper plugin uses version pragma for version specification.
However, you can also configure the version directly in your ape-config.yaml file:
vyper:
version: 0.3.7
EVM Versioning
By default, ape-vyper will use whatever version of EVM rules are set as default in the compiler version that gets used,
or based on what the #pragma evm-version ... pragma comment specifies (available post-v0.3.10).
Sometimes, you might want to use a different version, such as deploying on Arbitrum or Optimism where new opcodes are not supported yet.
If you want to require a different version of EVM rules to use in the configuration of the compiler, set it in your ape-config.yaml like this:
vyper:
evm_version: paris
NOTE: The config value chosen will not override if a pragma is set in a contract.
Interfaces
You can not compile interface source files directly.
Thus, you must place interface files in a directory named interfaces in your contracts_folder e.g. contracts/interfaces/IFace.vy.
Then, these files can be imported in other .vy sources files via:
import interfaces.IFace as IFace
Alternatively, use JSON interfaces from dependency contract types by listing them under the import_remapping key:
# Use `voting` example contracts from Vyperlang repo.
dependencies:
- name: VyperVoting
github: vyperlang/vyper
contracts_folder: examples/voting/
version: v0.3.8
# Automatically allow importing voting contracts in your project.
vyper:
import_remapping:
- "voting=VyperVoting@v0.3.8"
Import the voting contract types like this:
# @version 0.3.10
import voting.ballot as ballot
Pragmas
Ape-Vyper supports Vyper 0.3.10's new pragma formats
Version Pragma
#pragma version 0.3.10
EVM Version Pragma
#pragma evm-version paris
Optimization Pragma
#pragma optimize codesize
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-vyper-0.8.3.tar.gz.
File metadata
- Download URL: ape-vyper-0.8.3.tar.gz
- Upload date:
- Size: 59.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 50dee5c109d9b66c5e6c8c5b44e8ec06f5d536c109683e97372b58a046abc12e |
|
| MD5 | ea76d2cf963c7e81cc50fddf67a0c3e9 |
|
| BLAKE2b-256 | 213fa1e193dc6a90648812cbb46d98cab50ef002dda506649c1da2de7e18ea64 |
File details
Details for the file ape_vyper-0.8.3-py3-none-any.whl.
File metadata
- Download URL: ape_vyper-0.8.3-py3-none-any.whl
- Upload date:
- Size: 32.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2626b0b7d08e0f86ce53b014bcbc2cf23a2f87cf06ff572ef4aa4bbf1807484d |
|
| MD5 | 84b9d09bbdb1ba80eb99d75258718568 |
|
| BLAKE2b-256 | 2c48bcee1dfe30a8065e8478085e8b8dbec2d1daaf79b0079218fa9e0ecc1666 |
