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

To select a random port, use a value of "auto":

hardhat:
  port: auto

This is useful for multiprocessing and starting up multiple providers.

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

ape plugins install alchemy

Development

Please see the contributing guide to learn more how to contribute to this project. 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.5.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

ape_hardhat-0.1.5-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file ape-hardhat-0.1.5.tar.gz.

File metadata

  • Download URL: ape-hardhat-0.1.5.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/35.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for ape-hardhat-0.1.5.tar.gz
Algorithm Hash digest
SHA256 d47d8a9127df3397c267bf0aa91a0cde9eaa0f41d9b719445c0b0a3716aff7dd
MD5 0645dd20f0abf261c2b629cbf58a917e
BLAKE2b-256 fc07c7b2fd1fa36f0ce8396730494c56640f966087526a4bcf7af99b4f7b20bc

See more details on using hashes here.

File details

Details for the file ape_hardhat-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: ape_hardhat-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 13.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/35.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for ape_hardhat-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 cc068d4a4dfd04c2fd4bc70e67d44e39831b8f1de147ea1b41bfa12000bf192a
MD5 b0baf453b796c6baae0d154238457102
BLAKE2b-256 3dd09377643a1e5d6cdbd9a840d8c702854eb14b4db5b6490c7245e6d01ad583

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