接口说明
接口描述
WeBASE-Transaction编译国密版智能合约,v1.3.1+版本已支持根据配置项的自动切换国密版soclJ jar包;
接口URL
http://localhost:5003/WeBASE-Transaction/contract/compile
调用方法
HTTP POST
请求参数
1)参数表
2)数据格式
压缩包文件
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Object | 是 |
2)数据格式
a.请求正常返回结果
b.异常返回结果示例(信息详情请参看附录1)
{
"code": 103001,
"message": "system error",
"data": null
}
1.2. 合约部署接口
接口描述
调用此接口发送合约部署相关信息,交易服务子系统会将合约部署请求信息缓存到数据库,通过轮询服务向节点发送交易请求,确保合约成功部署。
构造方法参数(funcParam)为JSON数组,多个参数以逗号分隔(参数为数组时同理),示例:
constructor(string s) -> ["aa,bb\"cc"] // 双引号要转义
constructor(uint n,bool b) -> [1,true]
constructor(bytes b,address[] a) -> ["0x1a",["0x7939E26070BE44E6c4Fc759Ce55C6C8b166d94BE","0xce867fD9afa64175bb50A4Aa0c17fC7C4A3C67D9"]]
接口URL
调用方法
HTTP POST
请求参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 群组编号 | groupId | int | 16 | 是 | |
2 | 部署业务流水号 | uuidDeploy | String | 64 | 是 | |
3 | 签名类型 | signType | int | 2 | 是 | 0-本地配置私钥签名,1-本地随机私钥签名,2-调用WeBASE-Sign签名 |
4 | 合约Bin | contractBin | String | 是 | ||
5 | 合约Abi | contractAbi | List\<Object> | 是 | JSON数组 | |
6 | 构造方法参数 | funcParam | List\<Object> | 否 | JSON数组 | |
7 | 签名用户编号 | signUserId | String | 否 | signType为2时必填 |
2)数据格式
{
"groupId":1,
"signType":0,
"contractBin":"0xXXXXX",
"contractAbi":[],
"funcParam":["hello"],
"signUserId": "458ecc77a08c486087a3dcbc7ab5a9c3"
}
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Object | 是 |
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": null
}
b.异常返回结果示例(信息详情请参看附录1)
{
"code": 103001,
"message": "system error",
"data": null
}
1.3. 合约地址查询接口
接口描述
根据群组编号和和部署业务流水号查询部署的合约地址。
接口URL
http://localhost:5003/WeBASE-Transaction/contract/address/{groupId}/{uuidDeploy}
调用方法
HTTP GET
请求参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 群组编号 | groupId | int | 16 | 是 | |
2 | 部署业务流水号 | uuidDeploy | String | 64 | 是 |
2)数据格式
http://127.0.0.1:5003/WeBASE-Transaction/contract/address/1/10001
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Object | 合约地址 |
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": "0xXXXXX"
}
b.异常返回结果示例(信息详情请参看附录1)
{
"code": 103001,
"message": "system error",
"data": null
}
1.4. 部署event查询接口
接口描述
根据群组编号和和部署业务流水号查询部署的合约的构造函数的event信息。
接口URL
调用方法
HTTP GET
请求参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 群组编号 | groupId | int | 16 | 是 | |
2 | 部署业务流水号 | uuidDeploy | String | 64 | 是 |
2)数据格式
http://127.0.0.1:5003/WeBASE-Transaction/contract/event/1/10001
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Object |
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": {
"constructorEvent1": [
"hello!"
],
"constructorEvent": [
"test",
8
]
}
}
b.异常返回结果示例(信息详情请参看附录1)
{
"code": 103001,
"message": "system error",
"data": null
}
接口描述
根据群组编号和和部署业务流水号查询部署的信息。
接口URL
调用方法
HTTP GET
请求参数
1)参数表
2)数据格式
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Object | |||
3.1 | 编号 | id | int | 是 | ||
3.2 | 群组编号 | groupId | int | 是 | ||
3.3 | 流水号 | uuidDeploy | String | 是 | ||
3.4 | 合约bin | contractBin | String | 是 | ||
3.5 | 合约abi | contractAbi | String | 是 | ||
3.6 | 合约地址 | contractAddress | String | 是 | ||
3.7 | 方法参数 | funcParam | String | 是 | ||
3.8 | 签名类型 | signType | int | 是 | ||
3.9 | 签名用户编号 | signUserId | String | 是 | ||
3.10 | 请求上链次数 | requestCount | int | 是 | ||
3.11 | 处理状态 | handleStatus | int | 是 | 0-待处理,1-处理成功 | |
3.12 | 交易hash | transHash | String | 是 | ||
3.13 | 交易回执状态 | receiptStatus | boolean | 是 | 0-异常,1-正常 | |
3.14 | 创建时间 | gmtCreate | Date | 是 |
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": {
"id": 1,
"groupId": 1,
"uuidDeploy": "10001",
"contractBin": "XXX",
"contractAbi": "XXX"
"funcParam": "[]",
"signType": 0,
"signUserId": "458ecc77a08c486087a3dcbc7ab5a9c3",
"requestCount": 1,
"handleStatus": 1,
"transHash": "XXX",
"receiptStatus": true,
"gmtCreate": 1574853659000
}
}
b.异常返回结果示例(信息详情请参看附录1)
{
"code": 103001,
"message": "system error",
"data": null
}
2.1. 查询账户地址接口
接口描述
查询本地配置私钥对应的账户地址 。
接口URL
调用方法
HTTP GET
请求参数
1)参数表
无
2)数据格式
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Object |
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": {
"0xfe12013103cf85f05b0862e5ef49da4fbdbd8f99"
}
}
b.异常返回结果示例(信息详情请参看附录1)
{
"code": 103001,
"message": "system error",
"data": null
}
3.1. 交易请求接口
接口描述
调用此接口发送无状态交易请求,交易服务子系统会将交易请求信息缓存到数据库,通过轮询服务向节点发送交易请求,确保交易成功上链。当部署业务流水号为空时(即不是调用交易子系统部署合约),合约地址和abi不能为空。
方法入参(funcParam)为JSON数组,多个参数以逗号分隔(参数为数组时同理),示例:
function set(string s) -> ["aa,bb\"cc"] // 双引号要转义
function set(uint n,bool b) -> [1,true]
function set(bytes b,address[] a) -> ["0x1a",["0x7939E26070BE44E6c4Fc759Ce55C6C8b166d94BE","0xce867fD9afa64175bb50A4Aa0c17fC7C4A3C67D9"]]
接口URL
http://localhost:5003/WeBASE-Transaction/trans/send
调用方法
HTTP POST
请求参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 群组编号 | groupId | int | 16 | 是 | |
2 | 交易业务流水号 | uuidStateless | String | 64 | 是 | |
3 | 部署业务流水号 | uuidDeploy | String | 64 | 否 | |
4 | 签名类型 | signType | int | 2 | 是 | 0-本地配置私钥签名,1-本地随机私钥签名,2-调用WeBASE-Sign签名 |
5 | 合约地址 | contractAddress | String | 是 | ||
6 | 合约Abi | contractAbi | List\<Object> | 是 | JSON数组 | |
7 | 调用方法名 | funcName | String | 是 | ||
8 | 方法参数 | funcParam | List\<Object> | 否 | JSON数组 | |
9 | 签名用户编号 | signUserId | String | 否 | signType为2时必填 |
2)数据格式
{
"groupId":1,
"uuidStateless":"XXX",
"uuidDeploy":"XXX",
"signType":0,
"contractAddress":"0xXXXXX",
"contractAbi":[],
"funcName":"set",
"signUserId":"458ecc77a08c486087a3dcbc7ab5a9c3"
}
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Object |
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": null
}
b.异常返回结果示例(信息详情请参看附录1)
{
"code": 103001,
"message": "system error",
"data": null
}
3.2. 交易查询接口
接口描述
调用此接口同步从节点查询交易信息。当部署业务流水号为空时(即不是调用交易子系统部署合约),合约地址和abi不能为空。
方法入参(funcParam)为JSON数组,多个参数以逗号分隔(参数为数组时同理),示例:
function set(string s) -> ["aa,bb\"cc"] // 双引号要转义
function set(uint n,bool b) -> [1,true]
function set(bytes b,address[] a) -> ["0x1a",["0x7939E26070BE44E6c4Fc759Ce55C6C8b166d94BE","0xce867fD9afa64175bb50A4Aa0c17fC7C4A3C67D9"]]
接口URL
调用方法
HTTP POST
请求参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 群组编号 | groupId | int | 16 | 是 | |
2 | 部署业务流水号 | uuidDeploy | String | 64 | 否 | |
3 | 合约地址 | contractAddress | String | 否 | ||
4 | 合约Abi | contractAbi | List\<Object> | 否 | JSON数组 | |
5 | 调用方法名 | funcName | String | 是 | ||
6 | 方法参数 | funcParam | List\<Object> | 否 | JSON数组 |
2)数据格式
{
"groupId":1,
"uuidDeploy":"XXX",
"contractAbi":[],
"funcName":"get",
"funcParam":[]
}
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Object |
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": [
"hello"
}
b.异常返回结果示例(信息详情请参看附录1)
接口描述
根据群组编号和交易业务流水号查询交易请求的event信息。
接口URL
调用方法
请求参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 群组编号 | groupId | int | 16 | 是 | |
2 | 交易业务流水号 | uuidStateless | String | 64 | 是 |
2)数据格式
http://127.0.0.1:5003/WeBASE-Transaction/trans/event/1/20001
响应参数
1)参数表
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": {
"setEvent": [
"test"
],
"setEvent1": [
"test"
]
}
}
b.异常返回结果示例(信息详情请参看附录1)
{
"code": 103001,
"message": "system error",
"data": null
}
3.4. 交易请求output查询接口
接口描述
根据群组编号和交易业务流水号查询交易请求的output信息。
接口URL
http://localhost:5003/WeBASE-Transaction/trans/output/{groupId}/{uuidStateless}
调用方法
HTTP GET
请求参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 群组编号 | groupId | int | 16 | 是 | |
2 | 交易业务流水号 | uuidStateless | String | 64 | 是 |
2)数据格式
http://127.0.0.1:5003/WeBASE-Transaction/trans/output/1/20001
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Object |
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": [
"hello!"
]
}
b.异常返回结果示例(信息详情请参看附录1)
{
"code": 103001,
"message": "system error",
"data": null
}
3.5. 交易信息查询接口
接口描述
根据群组编号和交易业务流水号查询交易信息。
接口URL
调用方法
HTTP GET
请求参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 群组编号 | groupId | int | 16 | 是 | |
2 | 交易业务流水号 | uuidStateless | String | 64 | 是 |
2)数据格式
http://127.0.0.1:5003/WeBASE-Transaction/trans/transInfo/1/20001
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Object | |||
3.1 | 编号 | id | int | 是 | ||
3.2 | 群组编号 | groupId | int | 是 | ||
3.3 | 交易流水号 | uuidStateless | String | 是 | ||
3.4 | 部署流水号 | uuidDeploy | String | 是 | ||
3.5 | 合约abi | contractAbi | String | 是 | ||
3.6 | 合约地址 | contractAddress | String | 是 | ||
3.7 | 方法名 | funcName | String | 是 | ||
3.8 | 方法参数 | funcParam | String | 是 | ||
3.9 | 签名类型 | signType | int | 是 | ||
3.10 | 签名用户编号 | signUserId | String | 是 | ||
3.11 | 请求上链次数 | requestCount | int | 是 | ||
3.12 | 处理状态 | handleStatus | int | 是 | 0-待处理,1-处理成功 | |
3.13 | 交易hash | transHash | String | 是 | ||
3.14 | 交易返回原文 | transOutput | String | 是 | ||
3.15 | 交易回执状态 | receiptStatus | boolean | 是 | 0-异常,1-正常 | |
3.16 | 创建时间 | gmtCreate | Date | 是 |
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": {
"id": 1,
"groupId": 1,
"uuidStateless": "20001",
"uuidDeploy": "10001",
"contractAbi": "XXX"
"contractAddress": "XXX",
"funcName": "set",
"funcParam": "XXX",
"signType": 0,
"signUserId": "458ecc77a08c486087a3dcbc7ab5a9c3",
"requestCount": 1,
"handleStatus": 1,
"transHash": "XXX",
"transOutput": "0x",
"receiptStatus": true,
"gmtCreate": 1574854118000
}
}
b.异常返回结果示例(信息详情请参看附录1)
{
"code": 103001,
"message": "system error",
"data": null
}
4.1. 获取EncryptType接口
接口描述
返回Transaction服务中web3sdk所使用的encryptType
,0:标准,1:国密
接口URL
http://localhost:5003/WeBASE-Transaction/encrypt
调用方法
HTTP GET
请求参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | - | - | - | - | - |
2)数据格式
http://127.0.0.1:5003/WeBASE-Transaction/encrypt
响应参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
1 | 返回码 | code | String | 是 | 返回码信息请附录1 | |
2 | 提示信息 | message | String | 是 | ||
3 | 返回数据 | data | Integer | encryptType: 0:标准, 1:国密 |
2)数据格式
a.请求正常返回结果
{
"code": 0,
"message": "success",
"data": 0
接口描述
获取WeBASE-Transaction的版本号
接口URL
http://localhost:5003/WeBASE-Transaction/version
调用方法
HTTP GET
请求参数
1)参数表
序号 | 中文 | 参数名 | 类型 | 最大长度 | 必填 | 说明 |
---|---|---|---|---|---|---|
- | - | - |
2)数据格式
响应参数
1)数据格式
a、成功: