ScoreClient

ScoreInterfaceProcessor

Gradle

Add dependency to build.gradle

dependencies {
    compileOnly 'foundation.icon:javaee-api:0.9.2'
    
    annotationProcessor 'foundation.icon:javaee-score-client:0.10.1'
    implementation 'foundation.icon:javaee-score-client:0.10.1'
}

Usage

Annotate @ScoreInterface to interface. and annotate @score.annotation.Payable to payable method.

@ScoreInterface
public interface Xxx {
    
    void externalMethod(String param);
    
    String readOnlyMethod(String param);
    
    @score.annotation.Payable
    void payableMethod(String param);
}

When java compile, implement class will be generated which has @ScoreInterface.suffix(). Then you can use generated class as follows.

For payable method, overload method will be generated with the first parameter as BigInteger valueForPayable

import score.Address;
import score.annotation.External;

import java.math.BigInteger;

public class Score {
    @External
    public void intercallExternal(Address address, String param) {
        XxxScoreInterface xxx = new XxxScoreInterface(address);
        xxx.externalMethod(param);
    }

    @External(readonly = true)
    public String intercallReadOnly(Address address, String param) {
        XxxScoreInterface xxx = new XxxScoreInterface(address);
        return xxx.readOnlyMethod(param);
    }

    @External
    public void intercallPayable(Address address, BigInteger valueForPayable, String param) {
        XxxScoreInterface xxx = new XxxScoreInterface(address);
        xxx.payableMethod(valueForPayable, param);
    }
}

ScoreClientProcessor

Gradle

Add dependency to build.gradle

dependencies {
    compileOnly 'foundation.icon:javaee-api:0.9.2'
    
    annotationProcessor 'foundation.icon:javaee-score-client:0.10.1'
    implementation 'foundation.icon:javaee-score-client:0.10.1'
}

Usage

@ScoreClient could annotate to interface or field. For example, annotate @ScoreClient to interface.

@ScoreClient
public interface Xxx {    
    void externalMethod(String param);
    
    String readOnlyMethod(String param);
    
    @score.annotation.Payable
    void payableMethod(String param);
}

When java compile, implement class will be generated which has @ScoreClient.suffix(). Then you can use generated class as follows.

For payable method, overload method will be generated with the first parameter as BigInteger valueForPayable

import java.math.BigInteger;

public class Application {

    public static void main(String[] args) {
        Xxx xxx;
        try{
            Wallet wallet = DefaultScoreClient.wallet(
                    "/PATH/TO/KEYSTORE",
                    "PASSWORD_OF_KEYSTORE");
            xxx = new XxxScoreClient(
                    "http://HOST:PORT/api/v3",
                    "NID",
                    wallet, 
                    "cx...");
        } catch (Exception e) {
            e.printStackTrace();
            System.exit(1);
        }
        
        //external call
        xxx.externalMethod("PARAM");
        
        //call
        String result = xxx.readOnlyMethod("PARAM");
        
        //payable
        ((XxxScoreClient)xxx).payableMethod(BigInteger.ONE, "PARAM");
    }    
}

For integration test in SCORE development project

Gradle

Dependencies

dependencies {
    ...
    
    testAnnotationProcessor 'foundation.icon:javaee-score-client:0.10.1'
    testImplementation 'foundation.icon:javaee-score-client:0.10.1'
    testCompileOnly 'foundation.icon:javaee-api:0.9.2'
}

Set system properties of test environment

for initialize via DefaultScoreClient.of(System.getProperties())

test {
    useJUnitPlatform()
    options {
        systemProperty 'url', 'http://HOST:PORT/api/v3'
        systemProperty 'nid', 'NID'
        systemProperty 'keyStore', '/PATH/TO/KEYSTORE'
        systemProperty 'keyPassword', 'PASSWORD_OF_KEYSTORE'
        //for exists contract
        systemProperty 'address', 'cx...'
        //for deploy
        systemProperty 'scoreFilePath', '/PATH/TO/SCORE_FILE'
        systemProperty 'params.'+'PARAM_NAME', 'PARAM_VALUE'
        systemProperty 'params.'+'PARAM_NAME2', 'PARAM_VALUE2'
        ...
    }
}

if foundation.icon:gradle-javaee-plugin applied

test {
    useJUnitPlatform()
    options {
        //if foundation.icon:gradle-javaee-plugin applied
        dependsOn optimizedJar
        systemProperty 'url', project.tasks.deployToLocal.uri.get()
        systemProperty 'nid', project.tasks.deployToLocal.nid.get()
        systemProperty 'keyStore', project.extensions.deployJar.keystore.get()
        systemProperty 'keyPassword', project.extensions.deployJar.password.get()
        //for exists contract
        systemProperty 'address', 'cx...'
        //for deploy
        systemProperty 'scoreFilePath', tasks.optimizedJar.outputJarName
        project.extensions.deployJar.arguments.each {
            arg -> systemProperty 'params.'+arg.name, arg.value
        }
    }
}

Usage

@ScoreClient could annotate to interface or field. For example, annotate @ScoreClient to field.

Xxx interface in src/main/java/...

public interface Xxx {
    void externalMethod(String param);
    String readOnlyMethod(String param);
    @score.annotation.Payable void payableMethod(String param);
}

XxxTest class in src/test/java/...

import score.Address;
import score.annotation.External;

import java.math.BigInteger;

public class XxxTest {
    
    @ScoreClient
    static Xxx xxx;

    @BeforeAll
    static void beforeAll() {
        xxx = XxxScoreClient._of(System.getProperties());
    }

    @Test
    void test() {
        xxx.externalMethod("PARAM");
        
        xxx.readOnlyMethod("PARAM");
        
        ((XxxScoreClient)xxx).payableMethod(BigInteger.ONE, "PARAM");
    }
}