/ape-hardhat

Hardhat network provider for Ape

Primary LanguagePythonApache License 2.0Apache-2.0

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 version 3.7 or greater, python3-dev
  • Node.js, NPM, and Hardhat. See Hardhat's Installation documentation for steps.

Installation

via pip

You can install the latest release via pip:

pip install ape-hardhat

via setuptools

You can clone the repository and use 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
  ethereum:
    development:
      uri: http://localhost:8555

Development

This project is in early development and should be considered an alpha. Things might not work, breaking changes are likely. Comments, questions, criticisms and pull requests are welcomed.

License

This project is licensed under the Apache 2.0.