Package: ape-hardhat
Quick StartThis is a Hardhat network provider plugin for Ape.
Hardhat is a development framework written in Node.js for Ethereum that includes a local network implementation.
Use this plugin to manage a Hardhat node process or connect to an existing one.Dependenciespython3version 3.8 up to 3.11.Node.js, NPM, and Hardhat 2.12.0 or greater. See Hardhat'sInstallationdocumentation for steps.InstallationviapipYou can install the latest release viapip:pipinstallape-hardhatviasetuptoolsYou can clone the repository and usesetuptoolsfor the most up-to-date version:gitclonehttps://github.com/ApeWorX/ape-hardhat.gitcdape-hardhat
python3setup.pyinstallQuick UsageTo use the plugin, first install Hardhat locally into your Ape project directory:cdyour-ape-project
npminstall--save-devhardhatAfter that, you can use the--network ethereum:local:hardhatcommand 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'sape-config.yaml:hardhat:host:127.0.0.1:8555To select a random port, use a value of "auto":hardhat:host:autoNOTE: If you plan on running multiple Hardhat nodes of any kind, you likely will want to useautoor configure multiple hosts (see examples below).This is useful for multiprocessing and starting up multiple providers.You can also adjust the request timeout setting:hardhat:request_timeout:20# Defaults to 30fork_request_timeout:600# Defaults to 300Mainnet ForkTheape-hardhatplugin also includes a mainnet fork provider. It requires using another provider that has access to mainnet.Use it in most commands like this:apeconsole--network:mainnet-fork:hardhatSpecify the upstream archive-data provider in yourape-config.yaml:hardhat:fork:ethereum:mainnet:upstream_provider:alchemyOtherwise, it defaults to the default mainnet provider plugin. You can also specify ablock_number.NOTE: Make sure you have the upstream provider plugin installed for ape.If you wish to run both a forked network and the local Hardhat network simultaneously, you may configure a separate host for the forked network(s).hardhat:fork:ethereum:mainnet:upstream_provider:alchemyhost:127.0.0.1:8555polygon:mainnet:upstream_provider:alchemyhost:127.0.0.1:8556Hardhat deploymentsare disabled for forks for performance reasons. If you want your contract deployments to run on your fork, you can setenable_hardhat_deploymentstotruein your config:hardhat:fork:ethereum:mainnet:upstream_provider:alchemyenable_hardhat_deployments:trueapepluginsinstallalchemyRemote Hardhat NodeTo connect to a Hardhat node, set up your config like this:hardhat:host:https://hardhat.example.comNow, instead of launching a local process, it will attempt to connect to the remote Hardhat node and use this plugin as the ape interace.Custom Hardhat Config FileBy default, Ape generates and uses a basic config file for starting up a Hardhat node and having the same test accounts that Ape expects.
To avoid conflict with other pre-existing Hardhat config files, Ape generates one in$HOME/.ape/hardhatand always refers to that one.
To use a different one, such as the one in your local project instead, add the following to yourape-config.yaml:hardhat:hardhat_config_file:./hardhat.config.tsNOTE: You can refer to either a Hardhat JS file or a Hardhat TS file.DevelopmentPlease see thecontributing guideto learn more how to contribute to this project.
Comments, questions, criticisms and pull requests are welcomed.