ape-foundry: Ape network provider for Foundry
Project description
ape-foundry
Foundry network provider plugin for Ape. Foundry is a development framework written in Node.js for Ethereum that includes a local network implementation.
Dependencies
- python3 version 3.7.2 or greater, python3-dev
- Foundry. See Foundry's Installation documentation for steps.
Installation
via pip
You can install the latest release via pip:
pip install ape-foundry
via setuptools
You can clone the repository and use setuptools for the most up-to-date version:
git clone https://github.com/ApeWorX/ape-foundry.git
cd ape-foundry
python3 setup.py install
Quick Usage
To use the plugin, first install Foundry locally into your Ape project directory:
cd your-ape-project
npm install --save-dev foundry
After that, you can use the --network ethereum:development:foundry command line flag to use the foundry network (if it's not already configured as the default).
This network provider takes additional Foundry-specific configuration options. To use them, add these configs in your project's ape-config.yaml:
foundry:
port: 8555
To select a random port, use a value of "auto":
foundry:
port: auto
This is useful for multiprocessing and starting up multiple providers.
Mainnet Fork
The ape-foundry plugin also includes a mainnet fork provider. It requires using another provider that has access to mainnet.
Use it in most commands like this:
ape console --network :mainnet-fork:foundry
Specify the upstream archive-data provider in your ape-config.yaml:
foundry:
fork:
ethereum:
mainnet:
upstream_provider: alchemy
Otherwise, it defaults to the default mainnet provider plugin. You can also specify a block_number.
NOTE: Make sure you have the upstream provider plugin installed for ape.
ape plugins install alchemy
Development
Please see the contributing guide to learn more how to contribute to this project. Comments, questions, criticisms and pull requests are welcomed.
License
This project is licensed under the Apache 2.0.
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-foundry-0.4.0.tar.gz.
File metadata
- Download URL: ape-foundry-0.4.0.tar.gz
- Upload date:
- Size: 22.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/36.0 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.11 tqdm/4.64.0 importlib-metadata/4.12.0 keyring/23.8.2 rfc3986/2.0.0 colorama/0.4.5 CPython/3.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d6a4c449a28307de7c517422dbc427c611570318a362fb783f3a8f5741379524 |
|
| MD5 | ae3065e121a5a6eb8de46d3eb847a277 |
|
| BLAKE2b-256 | e32a7a4675eb323e1701cb7a6c9e30c5405918db0171a1d38dd95cd62f81de39 |
File details
Details for the file ape_foundry-0.4.0-py3-none-any.whl.
File metadata
- Download URL: ape_foundry-0.4.0-py3-none-any.whl
- Upload date:
- Size: 12.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/36.0 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.11 tqdm/4.64.0 importlib-metadata/4.12.0 keyring/23.8.2 rfc3986/2.0.0 colorama/0.4.5 CPython/3.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ae4ca4b59a3f4fb398d4a9f7358dade86776f00d9735dcc175396eaa0b51754c |
|
| MD5 | 325e61d9e9bc3dad59cf5ae434078b43 |
|
| BLAKE2b-256 | 9e2b37f36495835095c71aebe8bc540b39fa8bd513a532e44f2ca8267ad6beb6 |
