Plugins are core to Ape’s architecture. Here are some plugin examples in Ape:
CompilerAPI: For supporting various languages, like Vyper or Solidity.
ProviderAPI: For connecting the blockchain, such as Alchemy, Geth, or a local Hardhat node.
EcosystemAPI: A suite of networks, such as Ethereum, Fantom, or Starknet.
CLI plugins: Extending the
clickCLI in Ape.
Ape ships with core plugins to help Ape work out-of-the-box. To see the core plugins that come with Ape, run the following command:
ape plugins list --all
ape plugins list command shows you all the plugins you have installed.
However, when you include the
--all flag, it shows the core plugins and the available plugins as well.
NOTE: The available plugins list is trusted and from the ApeWorX organization, however you can install third-party plugins from other sources as well.
To add plugins to your project, edit your
plugins: - name: solidity version: 0.6.0 - name: hardhat - name: ens - name: etherscan version: ">=0.6.2,<0.7"
name field is required.
Additionally, you may specify a
version with or without constraints.
To install the plugins listed in your project, run the following command from the project’s root directory:
ape plugins install .
To install plugins individually, run the following command:
ape plugins install vyper "solidity>=0.6,<0.7"
To install a plugin from a branch that is not yet released, you can use a
git+ prefixed value for the version:
plugins: - name: foobar version: git+https://github.com/<owner-of-plugin>/ape-foobar.git@<branch/name>
Or from the CLI like:
ape plugins install "foobar@git+https://github.com/<owner-of-plugin>/ape-foobar.git@<branch/name>"
There are many types of plugins available, including compilers, providers, networks, and CLI-based plugins. To learn more about the different types of plugins, see the Developing a Plugin Guide.