Archive Notice

This project is no longer under active development and has been archived. The repository is kept for historical purposes and read-only access. No further updates or pull requests will be considered.

Epirus Gradle Plugin

Gradle Plugin for the Epirus Platform enabling the automation of smart contract lifecycle within your development environment.

Plugin configuration

The minimum Gradle version to run the plugin is 5.+.

Using the buildscript convention

To install the Epirus Plugin using the old Gradle buildscript convention, you should add the following to the first line of your build file:

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'com.web3labs.epirus:epirus-gradle-plugin:1.0.0-SNAPSHOT'
    }
}

apply plugin: 'com.web3labs.epirus'

Using the plugins DSL

Alternatively, if you are using the more modern plugins DSL, add the following line to your build file:

plugins {
    id 'com.web3labs.epirus' version '1.0.0-SNAPSHOT'
}

Plugin tasks

The plugin depends on the web3j and the Solidity plugins so they will add tasks for compilation and generation of web3j contract wrappers.

In addition, this plugin registers the task uploadMetadata, which will upload automatically the Solidity contract metadata files to your Epirus node.

To customize the plugin with your node URL you can use the plugin extension DSL:

epirus {
    url = 'http://user:password@your.epirus.node:port'
}

To obtain a list and description of all added tasks, run the command:

./gradlew tasks --all