Skip to content

Latest commit

 

History

History
104 lines (79 loc) · 2.94 KB

README.md

File metadata and controls

104 lines (79 loc) · 2.94 KB
Raw

Maven Central

Gradle plugin for Java Execution Environment

gradle-javaee-plugin is a Gradle plugin to automate the process of generating the optimized jar bundle. The generated jar bundle can be used for deployment to ICON networks that support the Java SCORE execution environment (a.k.a. JavaEE).

Getting Started

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'foundation.icon:gradle-javaee-plugin:0.8.5'
    }
}

repositories {
    mavenCentral()
}

apply plugin: 'java'
apply plugin: 'foundation.icon.javaee'

Configuring Tasks

The optimizedJar task type extends from Gradle's Jar type. This means that all attributes and methods available on Jar are also available on optimizedJar. Refer the Gradle User Guide for Jar for details.

Specifying a Main Class Name

mainClassName property is required to indicate the entry point that is used for the initial execution. This property will be included into the generated jar bundle with the Main-Class header in the manifest.

optimizedJar {
    mainClassName = 'com.iconloop.score.example.HelloWorld'
}

Enabling Debug Mode

optimizedJar task obfuscates the Java class names by default to reduce the output jar file size. However, this makes code analysis more difficult when debugging code by examining the stack trace. enableDebug option can be used to skip this optimization for debugging purpose.

optimizedJar {
    mainClassName = 'com.iconloop.score.example.HelloWorld'
    enableDebug = true
}

Jar Deployment

The deployJar extension can be used to deploy the optimized jar to local or remote ICON networks that support the Java SCORE execution environment.

deployJar {
    endpoints {
        local {
            uri = 'http://localhost:9082/api/v3'
            nid = 0x3
        }
    }
    keystore = './mykey.json'
    password = 'keypass'
    parameters {
        arg('name', 'Alice')
    }
}

The above extension creates deployToLocal task automatically based on the container name of the given endpoints property.

Deployment for update

Starting from version 0.7.9, you can specify to address to update an already deployed contract. to property is optional, thus omitting this is regarded as deploying a new contract.

deployJar {
    endpoints {
        local {
            uri = 'http://localhost:9082/api/v3'
            nid = 0x3
            to = 'cxe3d5237f13530bce0b936df320c0308885d062e9'
        }
    }
    ...
}

Examples

License

This project is available under the Apache License, Version 2.0.