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

Uploaded Source

Built Distribution

ape_foundry-0.5.0-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ape-foundry-0.5.0.tar.gz
  • Upload date:
  • Size: 76.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.1 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.64.1 importlib-metadata/4.12.0 keyring/23.9.1 rfc3986/2.0.0 colorama/0.4.5 CPython/3.8.13

File hashes

Hashes for ape-foundry-0.5.0.tar.gz
Algorithm Hash digest
SHA256 fd016d900bc51e7031d737841f3a292a56f059b2d456b267b78e3a4457a57a6a
MD5 7a828f7379eb6d105bbfaefd8bee49b6
BLAKE2b-256 12c9ae2dcd8eff9af4e269d83e5c5b70549669e389bfe68e6925f337e02bfc3d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ape_foundry-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.1 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.64.1 importlib-metadata/4.12.0 keyring/23.9.1 rfc3986/2.0.0 colorama/0.4.5 CPython/3.8.13

File hashes

Hashes for ape_foundry-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 98172f919058828effe010d99fc31a3474f95a9725b792f3df73abad91e0d8b8
MD5 3c68e49a63364a9827f0a61fa6c1416f
BLAKE2b-256 d995641d0ec5a972ea624553622b8b77a5a84cd367338e55df3e5c21762fd2bd

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