Skip to main content

ape-hardhat: Ape network provider for Hardhat

Project description

ape-hardhat

Hardhat network provider plugin for Ape. Hardhat is a development framework written in Node.js for Ethereum that includes a local network implementation.

Dependencies

  • python3 <https://www.python.org/downloads>_ version 3.7 or greater, python3-dev
  • Node.js, NPM, and Hardhat. See Hardhat's Installation <https://hardhat.org/getting-started/#installation>_ documentation for steps.

Installation

via pip

You can install the latest release via pip <https://pypi-hypernode.com/project/pip/>_:

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:

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:

cd your-ape-project
npm install --save-dev hardhat

After that, you can use the --network ethereum:development: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:

hardhat:
  port: 8555

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:

ape console --network :mainnet-fork:hardhat

Specify the upstream archive-data provider in your ape-config.yaml:

hardhat:
  mainnet_fork:
    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.

ape plugins add alchemy

Development

This project is in development and should be considered a beta. Things might not be in their final state and breaking changes may occur. Comments, questions, criticisms and pull requests are welcomed.

License

This project is licensed under the Apache 2.0.

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-hardhat-0.1.0b1.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

ape_hardhat-0.1.0b1-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file ape-hardhat-0.1.0b1.tar.gz.

File metadata

  • Download URL: ape-hardhat-0.1.0b1.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for ape-hardhat-0.1.0b1.tar.gz
Algorithm Hash digest
SHA256 39d87e5f108f88d00fe2903a4d6a46a3a8a145dba9ccedc7adca5b7a61522d28
MD5 4979bd2afee6421a10ad4ce5a75d3246
BLAKE2b-256 5e294ba4ebe2f3d54bc00abb4d403f624b7e7131d94319792f4b8354a5312cae

See more details on using hashes here.

File details

Details for the file ape_hardhat-0.1.0b1-py3-none-any.whl.

File metadata

  • Download URL: ape_hardhat-0.1.0b1-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for ape_hardhat-0.1.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 cff66d3d655e558fa36289ebb988248450b5b53d33ef42afdd7f288f6eed769b
MD5 9a3fb169c16b538c5385d9805e2e1285
BLAKE2b-256 664cfb2bc7363cb68cbe1fdc6fb08dae062c2d137932830542ebc39c95ae2db8

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