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

Uploaded Source

Built Distribution

ape_foundry-0.6.1-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ape-foundry-0.6.1.tar.gz
  • Upload date:
  • Size: 84.2 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.1.tar.gz
Algorithm Hash digest
SHA256 e1c179a3366a0024d0d2ad261dd2ecd12cb6f81f163fa40e41da36ae25ca996a
MD5 cee46abc8eaa237b4662d9580039dd20
BLAKE2b-256 702eb736afe7038763374574ad89230f0e5604d931d77fa7fe606597ec1a06d0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ape_foundry-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 15.4 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bdb89986fa09a7423f54c9c30f428337b3eeac5ffe5bd7fcbb712f33d34e3b96
MD5 12dc84857fe835250f17524a927b997f
BLAKE2b-256 4b52a7c21d4adef6a22ed6a108f44a996dca2c4f012b92d923a6fa84bd315c1a

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