icon-project / gradle-javaee-plugin

Gradle plugin for Java Execution Environment

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

• Java SCORE Examples

License

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

gradle-javaee-plugin's Issues

Pass an array as parameter

Hello,

I got a contract with the following constructor :

class MyClass {

  MyClass (Address[] whitelist) {
    ...
  }
}

I'm trying to figure out how to pass the array "whitelist" in the gradle.build deployJar task :

deployJar {
    keystore = rootProject.hasProperty('keystoreName') ? "$keystoreName" 
        : 'Z:/Work/ICON/config/keystores/sejong/operator.icx'
    password = rootProject.hasProperty('keystorePass') ? "$keystorePass"
        : 'gochain'

    endpoints {
        sejong {
            uri = 'https://sejong.net.solidwallet.io/api/v3'
            nid = 83
        }
        local {
            uri = 'http://localhost:9082/api/v3'
            nid = 3
        }
    }
    parameters {
        arg('whitelist', ???) <- what to put here ?
    }
}

Whatever the value I try, it fails.

I noticed the multisig wallet contract uses a split on a String.
Is there any way to achieve what I want using the native Address array type ?

Update an already deployed Jar

Hello,

Is there any way to deploy an update to an already deployed Jar ? I can't see the Gradle task for that.

Thank you!

Optimized Jar doesn't detect give java/util/Objects as non allowed method

While optimizing the jar, it should detect java.util.Objects as non allowed method but it doesn't detect. Which is only found later while deploying the contracts.

@Eventlog annotation outside of main class is not working

Eventlogs created in classes other than the main one does not work during runtime, however complies and deploys without any issue.
Usage of Context.logEvent works as expected. So not entirely sure where the problem arises.

Different Key/password fields for each network

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

The current format allows a keystore and a password field which is useful, but it becomes useless whenever you need to manage multiple keys on different networks.

Would it be possible to move this field in the network section, in order to be able to use different keys without modifying the gradle.build file ?

Suggestion :

deployJar {
    endpoints {
        local {
            uri = 'http://localhost:9082/api/v3'
            nid = 0x3
            keystore = './mykey-local.json'
            password = 'keypass'
        }

        sejong {
            uri = 'https://sejong.net.solidwallet.io/api/v3'
            nid = 0x83
            keystore = './mykey-sejong.json'
            password = 'keypass'
        }
    }
    parameters {
        arg('name', 'Alice')
    }
}