ape-ganache: Ape network provider for Ganache
Project description
Quick Start
Ganache network provider plugin for Ape. Ganache is a tool for creating a local blockchain for fast Ethereum development.
Dependencies
- python3 version 3.8 or greater, python3-dev
- Node.js, NPM, and Ganache. See Ganache's Installation documentation for steps.
Installation
via pip
You can install the latest release via pip:
pip install ape-ganache
via setuptools
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
Quick Usage
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.
Mainnet Fork
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
Unlocking Accounts
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ape_ganache-0.6.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 677b3dd4d478642500ef4853e8fb5b4aa3eacc0bcec2a3de41068fa2bc84aeaa |
|
MD5 | d032e83100dc72b84c5a0f4c6f5969f7 |
|
BLAKE2b-256 | 46b81a7e62d458f20f6634fcc52d66a584fcecf1147378eb49706e58db89c11e |