智能合约编译插件（solc-gradle-plugin）使用方法

智能合约编译插件可以大大简化从solidity源码到java代码的过程，帮助开发者快速编译调用合约。

本文记录了编译0.4.25版本和0.8.11版本的使用方法。

文档： 快速开始 — WeBankBlockchain-SmartDev-Doc v2.6.0 文档

1  创建gradle工程项目

用IDEA直接创建gradle项目：

创建后的build.gradle配置文件如下：

plugins {
    id 'java'
}

group 'org.example'
version '1.0-SNAPSHOT'

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
}

test {
    useJUnitPlatform()
}

2 引入合约编译插件

修改后的build.gradle如下，黄色标记部分是新添加的内容。

pkg参数指定了编译后的java代码包路径，可以自己修改定义。

buildscript {
    repositories {
        mavenCentral()
        maven { url "https://maven.aliyun.com/nexus/content/groups/public/"}
        maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
        mavenLocal()
    }
    dependencies {
        classpath 'com.webank:solc-gradle-plugin:3.0.1-SNAPSHOT'
        //classpath 'com.webank:solc-gradle-plugin:1.0.2-SNAPSHOT'
        //默认编译0.8.11.0版本，如果想编译0.4.25版本，请添加下述依赖
        //classpath 'org.fisco-bcos:solcJ:0.4.25.0'
        //classpath 'com.webank:solc-gradle-plugin:1.0.1'
        //默认编译0.8.11.0版本，如果想编译0.6.10.0版本，请添加下述依赖
        //classpath 'org.fisco-bcos:solcJ:0.6.10.0'
        //默认编译0.8.11.0版本，如果想编译0.5.2.0版本，请添加下述依赖
        //classpath 'org.fisco-bcos:solcJ:0.5.2.0'
    }
}

plugins {
    id 'java'
}

apply plugin: 'solc-gradle-plugin'

solc{
    pkg = 'org.example.contracts'
}

group 'org.example'
version '1.0-SNAPSHOT'

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
}

test {
    useJUnitPlatform()
}

版本说明：

引入0.8.11版本： 只需要一行，默认就是0.8.11.  

classpath 'com.webank:solc-gradle-plugin:3.0.1-SNAPSHOT'

【注意】 我试验了用这行语句不能再编译其他低版本的合约。

classpath 'com.webank:solc-gradle-plugin:1.0.2-SNAPSHOT' 这个版本编译出错，合约函数不能返回结构体类型。

引入0.4.25，需要这一行，默认是0.4.25.   

classpath 'com.webank:solc-gradle-plugin:1.0.1'

文档上的这句话是不行的 classpath 'org.fisco-bcos:solcJ:0.4.25.0',会报告错误缺少solc-gradle-plugin。

引入0.5.2/0.6.10版本，需要两行，

classpath 'com.webank:solc-gradle-plugin:1.0.1'

classpath 'org.fisco-bcos:solcJ:0.5.2.0'

3 添加合约源码

智能合约源码拷贝到/src/main/contracts/下面， 以后编译成功后悔自动创建/src/main/abi，/src/main/bin目录。

打开终端，输入编译命令：

PS E:\codes\solc-example> .\gradlew.bat solc

> Task :solc
Entering solc task, pid 12344@User-20220909JV
Solidity contracts compile complete


BUILD SUCCESSFUL in 1s
1 actionable task: 1 executed
PS E:\codes\solc-example>

4  指定插件运行参数

solc-gradle-plugin插件解析后生成solc任务，在终端执行solc任务时自动调用配置文件build.gradle中的指定的任务参数，针对solc的参数说明如下：

配置项	必选	说明
pkg	如果指定onlyAbiBin为false， 则必须设置。否则无需设置	java合约包名
contracts	否	智能合约文件路径，默认为src/main/contracts
output	否	编译输出路径，默认为src/main
onlyAbiBin	否	是否只输出abi和bin默认false
selector	否	默认为空，选择所有合约； 若选择指定合约，可填所需合约文件名称，按逗号分隔，例如A.sol,B.sol

solc{
    pkg = 'org.example.contract'
    contracts='src/main/contracts'
    selector ='Users'
    output = 'src/main'
}

每次运行任务时（ .\gradlew.bat solc ）是对上述参数自动加载执行。

因此，如果我们只修改了部分合约，只针对生成部分合约文件，就需要手动修改上述配置参数，在终端下重新运行。