Skip to main content

ape-foundry: Ape network provider for Foundry

Project description

Quick Start

Foundry network provider plugin for Ape. Foundry is a development framework written in Rust for Ethereum that includes a local network implementation.

Dependencies

  • python3 version 3.8 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

Use the --network ethereum:local: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.

You can also adjust the request timeout setting:

foundry:
  request_timeout: 20  # Defaults to 30
  fork_request_timeout: 600  # Defaults to 300

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 and evm_version.

If the block number is specified, but no EVM version is specified, it is automatically set based on the block height for known networks.

NOTE: Make sure you have the upstream provider plugin installed for ape.

ape plugins install alchemy

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ape-foundry-0.6.4.tar.gz (85.0 kB view details)

Uploaded Source

Built Distribution

ape_foundry-0.6.4-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file ape-foundry-0.6.4.tar.gz.

File metadata

  • Download URL: ape-foundry-0.6.4.tar.gz
  • Upload date:
  • Size: 85.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for ape-foundry-0.6.4.tar.gz
Algorithm Hash digest
SHA256 2172e6485911da14ae4beb5b3917ae77715297210a61b9eccb3065747cf503eb
MD5 b8abd8d1d7f7dcce992ac62ca9f7d9ec
BLAKE2b-256 1654d245a7ec7d49970c2fde64ea29c3bd65a96f5edc87c56dda7e390a4298db

See more details on using hashes here.

File details

Details for the file ape_foundry-0.6.4-py3-none-any.whl.

File metadata

  • Download URL: ape_foundry-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for ape_foundry-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cc07f753f2183d355d165d28de086160dff69457ec861a62bbb98d57c44a35e5
MD5 72500508f9abfafae5d9399200d8b789
BLAKE2b-256 92db115a5f518c09eb1c7e49f98e1d40f68e16c2f3be0827e256efa925823372

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page