Ganache network provider plugin for Ape. Ganache is a tool for creating a local blockchain for fast Ethereum development.
- python3 version 3.8 up to 3.11.
- Node.js, NPM, and Ganache. See Ganache's Installation documentation for steps.
You can install the latest release via pip:
pip install ape-ganache
You can clone the repository and use setuptools for the most up-to-date version:
git clone https://github.com/ApeWorX/ape-ganache.git
cd ape-ganache
python3 setup.py install
To use the plugin, first install Ganache locally into your Ape project directory:
cd your-ape-project
npm install --global ganache
After that, you can use the --network ethereum:local:ganache
command line flag to use the ganache network (if it's not already configured as the default).
This network provider takes additional Ganache-specific configuration options.
To use them, add these configs in your project's ape-config.yaml
:
ganache:
server:
port: 8555
To select a random port, use a value of "auto":
ganache:
server:
port: auto
This is useful for multiprocessing and starting up multiple providers.
The ape-ganache
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:ganache
Specify the upstream archive-data provider in your ape-config.yaml
:
ganache:
fork:
ethereum:
mainnet:
upstream_provider: infura
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 infura
You can unlock / impersonate accounts at genesis time using Ganache. To do this, add the accounts to your config like this:
ganache:
wallet:
unlocked_accounts:
- 0x04029baca527b69247dbe9243dfc9b5d12c7ba60