Getting Started




Development Guides


Version Guides


Managing Plugins

Core itself is composed of multiple plugins that once stitched together provide the full system needed to interact with the ARK blockchain but any developer can create their own plugins and publish them.


The first step to make your plugin available to the world after completing development is to publish it to the npm registry. We recommend to use yarn for this, check the official step-by-step guide by the yarn team.


Once your plugin is published it will be available to everyone via yarn global add. Let’s use the official, but optional, package @arkecosystem/core-vote-report as an example of how to install and configure a plugin.


First we will need to install the package using yarn global add. Since Release 2.2.0 Core is a global package that exposes a CLI, this is why we need to use yarn global add instead of yarn add, which is meant to be used during development.

yarn global add @arkecosystem/core-vote-report

Give it a second to download and install the plugin, once finished you can continue to the registration and configuration.


Now that the plugin is downloaded and installed, we can go ahead and register it in our ~/.config/ark-core/{NETWORK}/app.json file. Open the file in your editor of choice, append the following contents and save the changes.

    // some plugins...
    "@arkecosystem/core-vote-report": {},

Now run ark relay:restart and visit http://ip:4006/ and you should see a vote report, that’s it.

2021 © | All rights reserved An Product