ape-hardhat 0.1.0b3

ape-hardhat: Ape network provider for Hardhat

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.org/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.