# Quick Start
This is a Hardhat network provider plugin for Ape.
Hardhat is a development framework written in Node.js for Ethereum that includes a local network implementation.
Use this plugin to manage a Hardhat node process or connect to an existing one.
## Dependencies
- [python3](https://www.python.org/downloads) version 3.9 up to 3.12.
- Node.js, NPM, and Hardhat 2.12.0 or greater. See Hardhat's [Installation](https://hardhat.org/getting-started/#installation%3E) documentation for steps.
## Installation
### via `pip`
You can install the latest release via [`pip`](https://pypi.org/project/pip/):
```bash
pip install ape-hardhat
```
### 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-hardhat.git
cd ape-hardhat
python3 setup.py install
```
## Quick Usage
To use the plugin, first install Hardhat locally into your Ape project directory:
```bash
cd your-ape-project
npm install --save-dev hardhat
```
After that, you can use the `--network ethereum:local:hardhat` command line flag to use the hardhat network (if it's not already configured as the default).
This network provider takes additional Hardhat-specific configuration options. To use them, add these configs in your project's `ape-config.yaml`:
```yaml
hardhat:
host: 127.0.0.1:8555
```
To select a random port, use a value of "auto":
```yaml
hardhat:
host: auto
```
**NOTE**: If you plan on running multiple Hardhat nodes of any kind, you likely will want to use `auto` or configure multiple hosts (see examples below).
This is useful for multiprocessing and starting up multiple providers.
You can also adjust the request timeout setting:
```yaml
hardhat:
request_timeout: 20 # Defaults to 30
fork_request_timeout: 600 # Defaults to 300
```
## Mainnet Fork
The `ape-hardhat` 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:hardhat
```
Specify the upstream archive-data provider in your `ape-config.yaml`:
```yaml
hardhat:
fork:
ethereum:
mainnet:
upstream_provider: alchemy
```
Otherwise, it defaults to the default mainnet provider plugin. You can also specify a `block_number`.
**NOTE**: Make sure you have the upstream provider plugin installed for ape.
If you wish to run both a forked network and the local Hardhat network simultaneously, you may configure a separate host for the forked network(s).
```yaml
hardhat:
fork:
ethereum:
mainnet:
upstream_provider: alchemy
host: 127.0.0.1:8555
polygon:
mainnet:
upstream_provider: alchemy
host: 127.0.0.1:8556
```
[Hardhat deployments](https://github.com/wighawag/hardhat-deploy#deploy-scripts-tags-and-dependencies) are disabled for forks for performance reasons. If you want your contract deployments to run on your fork, you can set `enable_hardhat_deployments` to `true` in your config:
```yaml
hardhat:
fork:
ethereum:
mainnet:
upstream_provider: alchemy
enable_hardhat_deployments: true
```
```bash
ape plugins install alchemy
```
## Remote Hardhat Node
To connect to a Hardhat node, set up your config like this:
```yaml
hardhat:
host: https://hardhat.example.com
```
Now, instead of launching a local process, it will attempt to connect to the remote Hardhat node and use this plugin as the ape interace.
## Custom Hardhat Config File
By default, Ape generates and uses a basic config file for starting up a Hardhat node and having the same test accounts that Ape expects.
To avoid conflict with other pre-existing Hardhat config files, Ape generates one in `$HOME/.ape/hardhat` and always refers to that one.
To use a different one, such as the one in your local project instead, add the following to your `ape-config.yaml`:
```yaml
hardhat:
hardhat_config_file: ./hardhat.config.ts
```
**NOTE**: You can refer to either a Hardhat JS file or a Hardhat TS file.
## Development
Please see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project.
Comments, questions, criticisms and pull requests are welcomed.
Raw data
{
"_id": null,
"home_page": "https://github.com/ApeWorX/ape-hardhat",
"name": "ape-hardhat",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "ethereum",
"author": "ApeWorX Ltd.",
"author_email": "admin@apeworx.io",
"download_url": "https://files.pythonhosted.org/packages/8f/7b/ab6b9b94bd5833220cec59e47510871c32f0829f041e435909c5533576f3/ape_hardhat-0.8.5.tar.gz",
"platform": null,
"description": "# Quick Start\n\nThis is a Hardhat network provider plugin for Ape.\nHardhat is a development framework written in Node.js for Ethereum that includes a local network implementation.\nUse this plugin to manage a Hardhat node process or connect to an existing one.\n\n## Dependencies\n\n- [python3](https://www.python.org/downloads) version 3.9 up to 3.12.\n- Node.js, NPM, and Hardhat 2.12.0 or greater. See Hardhat's [Installation](https://hardhat.org/getting-started/#installation%3E) 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-hardhat\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-hardhat.git\ncd ape-hardhat\npython3 setup.py install\n```\n\n## Quick Usage\n\nTo use the plugin, first install Hardhat locally into your Ape project directory:\n\n```bash\ncd your-ape-project\nnpm install --save-dev hardhat\n```\n\nAfter that, you can use the `--network ethereum:local:hardhat` command line flag to use the hardhat network (if it's not already configured as the default).\n\nThis network provider takes additional Hardhat-specific configuration options. To use them, add these configs in your project's `ape-config.yaml`:\n\n```yaml\nhardhat:\n host: 127.0.0.1:8555\n```\n\nTo select a random port, use a value of \"auto\":\n\n```yaml\nhardhat:\n host: auto\n```\n\n**NOTE**: If you plan on running multiple Hardhat nodes of any kind, you likely will want to use `auto` or configure multiple hosts (see examples below).\n\nThis is useful for multiprocessing and starting up multiple providers.\n\nYou can also adjust the request timeout setting:\n\n```yaml\nhardhat:\n request_timeout: 20 # Defaults to 30\n fork_request_timeout: 600 # Defaults to 300\n```\n\n## Mainnet Fork\n\nThe `ape-hardhat` plugin also includes a mainnet fork provider. It 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:hardhat\n```\n\nSpecify the upstream archive-data provider in your `ape-config.yaml`:\n\n```yaml\nhardhat:\n fork:\n ethereum:\n mainnet:\n upstream_provider: alchemy\n```\n\nOtherwise, it defaults to the default mainnet provider plugin. You can also specify a `block_number`.\n\n**NOTE**: Make sure you have the upstream provider plugin installed for ape.\n\nIf you wish to run both a forked network and the local Hardhat network simultaneously, you may configure a separate host for the forked network(s).\n\n```yaml\nhardhat:\n fork:\n ethereum:\n mainnet:\n upstream_provider: alchemy\n host: 127.0.0.1:8555\n polygon:\n mainnet:\n upstream_provider: alchemy\n host: 127.0.0.1:8556\n```\n\n[Hardhat deployments](https://github.com/wighawag/hardhat-deploy#deploy-scripts-tags-and-dependencies) are disabled for forks for performance reasons. If you want your contract deployments to run on your fork, you can set `enable_hardhat_deployments` to `true` in your config:\n\n```yaml\nhardhat:\n fork:\n ethereum:\n mainnet:\n upstream_provider: alchemy\n enable_hardhat_deployments: true\n```\n\n```bash\nape plugins install alchemy\n```\n\n## Remote Hardhat Node\n\nTo connect to a Hardhat node, set up your config like this:\n\n```yaml\nhardhat:\n host: https://hardhat.example.com\n```\n\nNow, instead of launching a local process, it will attempt to connect to the remote Hardhat node and use this plugin as the ape interace.\n\n## Custom Hardhat Config File\n\nBy default, Ape generates and uses a basic config file for starting up a Hardhat node and having the same test accounts that Ape expects.\nTo avoid conflict with other pre-existing Hardhat config files, Ape generates one in `$HOME/.ape/hardhat` and always refers to that one.\nTo use a different one, such as the one in your local project instead, add the following to your `ape-config.yaml`:\n\n```yaml\nhardhat:\n hardhat_config_file: ./hardhat.config.ts\n```\n\n**NOTE**: You can refer to either a Hardhat JS file or a Hardhat TS file.\n\n## Development\n\nPlease see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project.\nComments, questions, criticisms and pull requests are welcomed.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "ape-hardhat: Ape network provider for Hardhat",
"version": "0.8.5",
"project_urls": {
"Homepage": "https://github.com/ApeWorX/ape-hardhat"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ec98eeb0e8687b3dac6123d84f4ce03d7b4d6e731311953f210c9d77e4567bf7",
"md5": "2e4bbbe794b6966459a64b45037cf5b5",
"sha256": "b5f1fcc37ed7a2133d0aa6571207b593f008966db50e4400a240ca4a22ae523d"
},
"downloads": -1,
"filename": "ape_hardhat-0.8.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e4bbbe794b6966459a64b45037cf5b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 20207,
"upload_time": "2024-12-09T22:04:08",
"upload_time_iso_8601": "2024-12-09T22:04:08.099364Z",
"url": "https://files.pythonhosted.org/packages/ec/98/eeb0e8687b3dac6123d84f4ce03d7b4d6e731311953f210c9d77e4567bf7/ape_hardhat-0.8.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f7bab6b9b94bd5833220cec59e47510871c32f0829f041e435909c5533576f3",
"md5": "b251381f03c26586909ef8614fa192e7",
"sha256": "c56eebb01c6f19c70c1551fa060b6c6444e27e2b8d9e0dba7fa48b0623dbf6d9"
},
"downloads": -1,
"filename": "ape_hardhat-0.8.5.tar.gz",
"has_sig": false,
"md5_digest": "b251381f03c26586909ef8614fa192e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 124984,
"upload_time": "2024-12-09T22:04:09",
"upload_time_iso_8601": "2024-12-09T22:04:09.888122Z",
"url": "https://files.pythonhosted.org/packages/8f/7b/ab6b9b94bd5833220cec59e47510871c32f0829f041e435909c5533576f3/ape_hardhat-0.8.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-09 22:04:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ApeWorX",
"github_project": "ape-hardhat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ape-hardhat"
}
JSON
