Plugins

Introduction to Plugins

written by
Dalena Dang
Date Last Updated
October 3, 2022
Download Project Files

Welcome to the first part of our plugins development tutorial. In this video we will be going over the basics of the plugin architecture and the types of plugins that you can make.

How To Plugin - Part 1

Welcome to the first part of our plugins development tutorial. In this video we will be going over the basics of the plugin architecture and the types of plugins that you can make.

Why Plugins?

Plugins are the core of ApeWorX’s foundation. We use plugins because it helps keep the software light-weight and allows for modularity for users to only install exactly what they need for their project.

Plugins for ApeWorX can be divided into three separate categories.

1. Core Plugins

Core plugins are included in the installation of the apeworx package and help it run out-of-the-box.

Some of these include:

  • networks: which manages connecting to different network providers
  • geth: Ethereum client for connecting and communicating with Ethereum nodes
  • test: an eth-tester plugin providing access to pytest and pre-funded accounts
  • console: interactive Python environment with access to ape locals

2. ApeWorX-maintained Plugins

You can view these by typing `ape plugins list --all` in the terminal.

You can install plugins by either installing all the plugins listed in the ape-config.yaml and running ape plugins install in the root directory of the project

OR

You can install plugins individually by typing `ape plugins install [plugin name]`

3. Community Plugins

Community plugins are written by the community and can be installed at your discretion

Types of Plugins

Compiler

Compiler plugins implement the CompilerAPI base class. The responsibility of a compiler plugin is to generate contract_type data. See the ethpm-types package for more information on what is expected in the contract_type data. Some examples of compiler plugins are ape-vyper, ape-solidity, and ape-cairo. Notice that ape-cairo is a compiler type for a non-EVM ecosystem. This is because the plugin system allows for this!

Provider

They implement the ProviderAPI base class and their job is to interface with the blockchain. Some providers are really great at testing, such as ape-hardhat, while others are better at mainnet / or testnet interaction, such as ape-infura or ape-alchemy

Account

Account plugins implement the AccountAPI. This supports interaction with hardware wallets which is useful for not exposing your private keys when interacting with chains. Some examples are ape-trezor and ape-ledger

Ecosystem

Ecosystem plugins will connect to the ecosystem they are designed to like ape-arbitrum and ape-polygon which connect to the Arbitrum and Polygon networks respectively.

CLI

CLI plugins change the CLI like ape-token which provides a nicer UX for providing token amounts to contract transactions

Resources:

Here is the link to our documentation on developing plugins.

SUBMIT YOUR PROJECTGET HELPLEAVE FEEDBACKAPE ACADEMY GITHUB
SHARE TUTORIAL