# 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.9 up to 3.12.
- 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:
host: https://127.0.0.1:8555
```
To select a random port, use a value of "auto":
```yaml
foundry:
host: 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
```
## Remote Anvil Node
To connect to a remote anvil node, set up your config like this:
```yaml
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.
To connect to a remote anvil node using an environment variable, set `APE_FOUNDRY_HOST`:
```bash
export APE_FOUNDRY_HOST=https://your-anvil.example.com`
```
## Impersonate Accounts
You can impersonate accounts using the `ape-foundry` plugin.
To impersonate an account, do the following:
```python
import pytest
@pytest.fixture
def whale(accounts):
return accounts["example.eth"]
```
To transact, your impersonated account must have a balance.
You can achieve this by using a forked network and impersonating an account with a balance.
Alternatively, you can set your node's base fee and priority fee to `0`.
To programtically set an account's balance, do the following:
```python
from ape import accounts
account = accounts["example.eth"]
account.balance = "1000 ETH" # This calls `anvil_setBalance` under-the-hood.
```
## Base Fee and Priority Fee
Configure your node's base fee and priority fee using the `ape-config.yaml` file.
```yaml
foundry:
base_fee: 0
priority_fee: 0
```
## Auto-mining
Anvil nodes by default auto-mine.
However, you can disable auto-mining on startup by configuring the foundry plugin like so:
```yaml
foundry:
auto_mine: false
```
Else, you can disable auto-mining using the provider instance:
```python
from ape import chain
anvil = chain.provider
anvil.auto_mine = False # calls `anvil_setAutomine` RPC.
```
### Mine on an interval
By default, Anvil will mine a new block every time a transaction is submitted.
To mine on an interval instead, set the `block_time` config:
```yaml
foundry:
block_time: 10 # mine a new block every 10 seconds
```
## EVM Version (hardfork)
To change the EVM version for local foundry networks, use the `evm_version` config:
```yaml
foundry:
evm_version: shanghai
```
To change the EVM version for forked networks, set it the specific forked-network config(s):
```yaml
foundry:
fork:
ethereum:
mainnet:
evm_version: shanghai
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ApeWorX/ape-foundry",
"name": "ape-foundry",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "ethereum",
"author": "ApeWorX Ltd.",
"author_email": "admin@apeworx.io",
"download_url": "https://files.pythonhosted.org/packages/de/78/5ae9a1392389af6c17d1d7100d1e9381b85cf816e88261a2d725a1dd5df8/ape-foundry-0.8.4.tar.gz",
"platform": null,
"description": "# Quick Start\n\nFoundry network provider plugin for Ape.\nFoundry is a development framework written in Rust for Ethereum that includes a local network implementation.\n\n## Dependencies\n\n- [python3](https://www.python.org/downloads) version 3.9 up to 3.12.\n- Foundry. See Foundry's [Installation](https://github.com/foundry-rs/foundry#installation) documentation for steps.\n\n## Installation\n\n### via `pip`\n\nYou can install the latest release via [`pip`](https://pypi.org/project/pip/):\n\n```bash\npip install ape-foundry\n```\n\n### via `setuptools`\n\nYou can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:\n\n```bash\ngit clone https://github.com/ApeWorX/ape-foundry.git\ncd ape-foundry\npython3 setup.py install\n```\n\n## Quick Usage\n\nUse the `--network ethereum:local:foundry` command line flag to use the foundry network (if it's not already configured as the default).\n\nThis network provider takes additional Foundry-specific configuration options. To use them, add these configs in your project's `ape-config.yaml`:\n\n```yaml\nfoundry:\n host: https://127.0.0.1:8555\n```\n\nTo select a random port, use a value of \"auto\":\n\n```yaml\nfoundry:\n host: auto\n```\n\nThis is useful for multiprocessing and starting up multiple providers.\n\nYou can also adjust the request timeout setting:\n\n```yaml\nfoundry:\n request_timeout: 20 # Defaults to 30\n fork_request_timeout: 600 # Defaults to 300\n```\n\n## Mainnet Fork\n\nThe `ape-foundry` plugin also includes a mainnet fork provider.\nIt requires using another provider that has access to mainnet.\n\nUse it in most commands like this:\n\n```bash\nape console --network :mainnet-fork:foundry\n```\n\nSpecify the upstream archive-data provider in your `ape-config.yaml`:\n\n```yaml\nfoundry:\n fork:\n ethereum:\n mainnet:\n upstream_provider: alchemy\n```\n\nOtherwise, it defaults to the default mainnet provider plugin.\nYou can also specify a `block_number` and `evm_version`.\n\nIf the block number is specified, but no EVM version is specified, it is automatically set based on the block height for known networks.\n\n**NOTE**: Make sure you have the upstream provider plugin installed for ape.\n\n```bash\nape plugins install alchemy\n```\n\n## Remote Anvil Node\n\nTo connect to a remote anvil node, set up your config like this:\n\n```yaml\nfoundry:\n host: https://anvil.example.com\n```\n\nNow, instead of launching a local process, it will attempt to connect to the remote anvil node and use this plugin as the ape interface.\n\nTo connect to a remote anvil node using an environment variable, set `APE_FOUNDRY_HOST`:\n\n```bash\nexport APE_FOUNDRY_HOST=https://your-anvil.example.com`\n```\n\n## Impersonate Accounts\n\nYou can impersonate accounts using the `ape-foundry` plugin.\nTo impersonate an account, do the following:\n\n```python\nimport pytest\n\n@pytest.fixture\ndef whale(accounts):\n return accounts[\"example.eth\"]\n```\n\nTo transact, your impersonated account must have a balance.\nYou can achieve this by using a forked network and impersonating an account with a balance.\nAlternatively, you can set your node's base fee and priority fee to `0`.\n\nTo programtically set an account's balance, do the following:\n\n```python\nfrom ape import accounts\n\naccount = accounts[\"example.eth\"]\naccount.balance = \"1000 ETH\" # This calls `anvil_setBalance` under-the-hood.\n```\n\n## Base Fee and Priority Fee\n\nConfigure your node's base fee and priority fee using the `ape-config.yaml` file.\n\n```yaml\nfoundry:\n base_fee: 0\n priority_fee: 0\n```\n\n## Auto-mining\n\nAnvil nodes by default auto-mine.\nHowever, you can disable auto-mining on startup by configuring the foundry plugin like so:\n\n```yaml\nfoundry:\n auto_mine: false\n```\n\nElse, you can disable auto-mining using the provider instance:\n\n```python\nfrom ape import chain\n\nanvil = chain.provider\nanvil.auto_mine = False # calls `anvil_setAutomine` RPC.\n```\n\n### Mine on an interval\n\nBy default, Anvil will mine a new block every time a transaction is submitted.\nTo mine on an interval instead, set the `block_time` config:\n\n```yaml\nfoundry:\n block_time: 10 # mine a new block every 10 seconds\n```\n\n## EVM Version (hardfork)\n\nTo change the EVM version for local foundry networks, use the `evm_version` config:\n\n```yaml\nfoundry:\n evm_version: shanghai\n```\n\nTo change the EVM version for forked networks, set it the specific forked-network config(s):\n\n```yaml\nfoundry:\n fork:\n ethereum:\n mainnet:\n evm_version: shanghai\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "ape-foundry: Ape network provider for Foundry",
"version": "0.8.4",
"project_urls": {
"Homepage": "https://github.com/ApeWorX/ape-foundry"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ca4dd3f16b1fe0ebe448abd8baa736c5e1157bea8669fe1a863126a79221ce4",
"md5": "21bad9f7f50b5ce6b027554844297f1e",
"sha256": "de7b3fde5fb0b887a541bbd3d9e3166b837df7ad3e5c39b47396e29287956333"
},
"downloads": -1,
"filename": "ape_foundry-0.8.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21bad9f7f50b5ce6b027554844297f1e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 17897,
"upload_time": "2024-08-20T15:17:23",
"upload_time_iso_8601": "2024-08-20T15:17:23.833171Z",
"url": "https://files.pythonhosted.org/packages/9c/a4/dd3f16b1fe0ebe448abd8baa736c5e1157bea8669fe1a863126a79221ce4/ape_foundry-0.8.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de785ae9a1392389af6c17d1d7100d1e9381b85cf816e88261a2d725a1dd5df8",
"md5": "17f9b7c2b19851d019d56ac3e5f74264",
"sha256": "ba8e838cec06115ecfa67db6c5e953ded7ba677305ace834576ffaed45bae998"
},
"downloads": -1,
"filename": "ape-foundry-0.8.4.tar.gz",
"has_sig": false,
"md5_digest": "17f9b7c2b19851d019d56ac3e5f74264",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 101746,
"upload_time": "2024-08-20T15:17:25",
"upload_time_iso_8601": "2024-08-20T15:17:25.608952Z",
"url": "https://files.pythonhosted.org/packages/de/78/5ae9a1392389af6c17d1d7100d1e9381b85cf816e88261a2d725a1dd5df8/ape-foundry-0.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 15:17:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ApeWorX",
"github_project": "ape-foundry",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ape-foundry"
}
JSON
