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

Remote Anvil Node

To connect to a remote anvil node, set up your config like this:

foundry:
  host: https://anvil.example.com

Now, instead of launching a local process, it will attempt to connect to the remote anvil node and use this plugin as the ape interface.

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

Uploaded Source

Built Distribution

ape_foundry-0.6.8-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ape-foundry-0.6.8.tar.gz
  • Upload date:
  • Size: 91.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.8.tar.gz
Algorithm Hash digest
SHA256 727f2cff9718fc10f9faa8f092ec2bae8b0ca64c27b7ab81f439d31e98c6c38c
MD5 207a600b15e65a52638a78e229b39909
BLAKE2b-256 be52aad72363c8677016ee5791a73a2f896a2a35cd8f8278a4119ac933cd1bbb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ape_foundry-0.6.8-py3-none-any.whl
  • Upload date:
  • Size: 17.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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 bfe587bda34d6a6c9823d5b750180f52ad2659111922fdea16fef15654b5f6fd
MD5 07b97dda13d7c63d93b1c922827c51b0
BLAKE2b-256 48c33f5aeca3133b2b136fa4568ee098d4bb29cc41fb361f34f173676f643fcf

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