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.5.tar.gz (85.3 kB view details)

Uploaded Source

Built Distribution

ape_foundry-0.6.5-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ape-foundry-0.6.5.tar.gz
  • Upload date:
  • Size: 85.3 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.5.tar.gz
Algorithm Hash digest
SHA256 a0cc59864b856aae1812f84c844695b8c6a0bcd9e662db96e8e3d3271c7db6f5
MD5 a6663a2020a7868641009473781eeba8
BLAKE2b-256 9e1fa225ae588c6c4e7fb880e43265dd8a3559cd0893e0dd04ecf8cb01fda974

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ape_foundry-0.6.5-py3-none-any.whl
  • Upload date:
  • Size: 16.3 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 eddaf01e93254fe38741fd0a916dd1d003988293d9c2952fe9aa1948b02a1fbb
MD5 bbf58485a2d576a296cb14ddb59c562a
BLAKE2b-256 ced7d0f799744d27c13b51a2c9033ebdac8022cd93939f5ed1df6c38fc518ba0

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