Metadata-Version: 2.1
Name: ape-foundry
Version: 0.6.3
Summary: ape-foundry: Ape network provider for Foundry
Home-page: https://github.com/ApeWorX/ape-foundry
Author: ApeWorX Ltd.
Author-email: admin@apeworx.io
License: Apache-2.0
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](https://www.python.org/downloads) version 3.8 or greater, python3-dev
        - Foundry. See Foundry's [Installation](https://github.com/foundry-rs/foundry#installation) documentation for steps.
        
        ## Installation
        
        ### via `pip`
        
        You can install the latest release via [`pip`](https://pypi.org/project/pip/):
        
        ```bash
        pip install ape-foundry
        ```
        
        ### via `setuptools`
        
        You can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:
        
        ```bash
        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`:
        
        ```yaml
        foundry:
          port: 8555
        ```
        
        To select a random port, use a value of "auto":
        
        ```yaml
        foundry:
          port: auto
        ```
        
        This is useful for multiprocessing and starting up multiple providers.
        
        You can also adjust the request timeout setting:
        
        ```yaml
        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:
        
        ```bash
        ape console --network :mainnet-fork:foundry
        ```
        
        Specify the upstream archive-data provider in your `ape-config.yaml`:
        
        ```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.
        
        ```bash
        ape plugins install alchemy
        ```
        
Keywords: ethereum
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8,<3.11
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: lint
Provides-Extra: doc
Provides-Extra: release
Provides-Extra: dev
