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.0b3.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

ape_hardhat-0.1.0b3-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ape-hardhat-0.1.0b3.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for ape-hardhat-0.1.0b3.tar.gz
Algorithm Hash digest
SHA256 9ef0e1cd777ac7659bf94f412ee33addebe35e2daf32f116d8f3011ef216dc4f
MD5 44a5afb8a8a00103b720172b37d4f50a
BLAKE2b-256 737bfefdf7f735a530f5f8358116d46bf6abeac7a0f3a5f3734638e0f49e29ca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ape_hardhat-0.1.0b3-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for ape_hardhat-0.1.0b3-py3-none-any.whl
Algorithm Hash digest
SHA256 1399c1f7df33af99128428e37163f20473234edf6a7c0c83b0825f92daf271f7
MD5 5be6889004e5d7b3f56fffdc29f931eb
BLAKE2b-256 e991e09d33d85e2175b882a14c18dae7c9ebcff9be8ca69ea341054c8adb2287

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