接口说明

    接口描述

    WeBASE-Transaction编译国密版智能合约,v1.3.1+版本已支持根据配置项的自动切换国密版soclJ jar包;

    接口URL

    调用方法

    HTTP POST

    请求参数

    1)参数表

    2)数据格式

    压缩包文件

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataObject

    2)数据格式

    a.请求正常返回结果

    b.异常返回结果示例(信息详情请参看附录1)

    1. {
    2. "code": 103001,
    3. "message": "system error",
    4. "data": null
    5. }

    1.2. 合约部署接口

    接口描述

    调用此接口发送合约部署相关信息,交易服务子系统会将合约部署请求信息缓存到数据库,通过轮询服务向节点发送交易请求,确保合约成功部署。

    构造方法参数(funcParam)为JSON数组,多个参数以逗号分隔(参数为数组时同理),示例:

    1. constructor(string s) -> ["aa,bb\"cc"] // 双引号要转义
    2. constructor(uint n,bool b) -> [1,true]
    3. constructor(bytes b,address[] a) -> ["0x1a",["0x7939E26070BE44E6c4Fc759Ce55C6C8b166d94BE","0xce867fD9afa64175bb50A4Aa0c17fC7C4A3C67D9"]]

    接口URL

    http://localhost:5003/WeBASE-Transaction/contract/deploy

    调用方法

    HTTP POST

    请求参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1群组编号groupIdint16
    2部署业务流水号uuidDeployString64
    3签名类型signTypeint20-本地配置私钥签名,1-本地随机私钥签名,2-调用WeBASE-Sign签名
    4合约BincontractBinString
    5合约AbicontractAbiList\<Object>JSON数组
    6构造方法参数funcParamList\<Object>JSON数组
    7签名用户编号signUserIdStringsignType为2时必填

    2)数据格式

    1. {
    2. "groupId":1,
    3. "signType":0,
    4. "contractBin":"0xXXXXX",
    5. "contractAbi":[],
    6. "funcParam":["hello"],
    7. "signUserId": "458ecc77a08c486087a3dcbc7ab5a9c3"
    8. }

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataObject

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": null
    5. }

    b.异常返回结果示例(信息详情请参看附录1)

    1. {
    2. "code": 103001,
    3. "message": "system error",
    4. "data": null
    5. }

    1.3. 合约地址查询接口

    接口描述

    根据群组编号和和部署业务流水号查询部署的合约地址。

    接口URL

    调用方法

    HTTP GET

    请求参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1群组编号groupIdint16
    2部署业务流水号uuidDeployString64

    2)数据格式

    1. http://127.0.0.1:5003/WeBASE-Transaction/contract/address/1/10001

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataObject合约地址

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": "0xXXXXX"
    5. }

    b.异常返回结果示例(信息详情请参看附录1)

    1. {
    2. "code": 103001,
    3. "message": "system error",
    4. "data": null
    5. }

    1.4. 部署event查询接口

    接口描述

    根据群组编号和和部署业务流水号查询部署的合约的构造函数的event信息。

    接口URL

    http://localhost:5003/WeBASE-Transaction/contract/event/{groupId}/{uuidDeploy}

    调用方法

    HTTP GET

    请求参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1群组编号groupIdint16
    2部署业务流水号uuidDeployString64

    2)数据格式

    1. http://127.0.0.1:5003/WeBASE-Transaction/contract/event/1/10001

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataObject

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": {
    5. "constructorEvent1": [
    6. "hello!"
    7. ],
    8. "constructorEvent": [
    9. "test",
    10. 8
    11. ]
    12. }
    13. }

    b.异常返回结果示例(信息详情请参看附录1)

    1. {
    2. "code": 103001,
    3. "message": "system error",
    4. "data": null
    5. }

    接口描述

    根据群组编号和和部署业务流水号查询部署的信息。

    接口URL

    调用方法

    HTTP GET

    请求参数

    1)参数表

    2)数据格式

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataObject
    3.1编号idint
    3.2群组编号groupIdint
    3.3流水号uuidDeployString
    3.4合约bincontractBinString
    3.5合约abicontractAbiString
    3.6合约地址contractAddressString
    3.7方法参数funcParamString
    3.8签名类型signTypeint
    3.9签名用户编号signUserIdString
    3.10请求上链次数requestCountint
    3.11处理状态handleStatusint0-待处理,1-处理成功
    3.12交易hashtransHashString
    3.13交易回执状态receiptStatusboolean0-异常,1-正常
    3.14创建时间gmtCreateDate

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": {
    5. "id": 1,
    6. "groupId": 1,
    7. "uuidDeploy": "10001",
    8. "contractBin": "XXX",
    9. "contractAbi": "XXX"
    10. "funcParam": "[]",
    11. "signType": 0,
    12. "signUserId": "458ecc77a08c486087a3dcbc7ab5a9c3",
    13. "requestCount": 1,
    14. "handleStatus": 1,
    15. "transHash": "XXX",
    16. "receiptStatus": true,
    17. "gmtCreate": 1574853659000
    18. }
    19. }

    b.异常返回结果示例(信息详情请参看附录1)

    1. {
    2. "code": 103001,
    3. "message": "system error",
    4. "data": null
    5. }

    2.1. 查询账户地址接口

    接口描述

    查询本地配置私钥对应的账户地址 。

    接口URL

    调用方法

    HTTP GET

    请求参数

    1)参数表

    2)数据格式

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataObject

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": {
    5. "0xfe12013103cf85f05b0862e5ef49da4fbdbd8f99"
    6. }
    7. }

    b.异常返回结果示例(信息详情请参看附录1)

    1. {
    2. "code": 103001,
    3. "message": "system error",
    4. "data": null
    5. }

    3.1. 交易请求接口

    接口描述

    调用此接口发送无状态交易请求,交易服务子系统会将交易请求信息缓存到数据库,通过轮询服务向节点发送交易请求,确保交易成功上链。当部署业务流水号为空时(即不是调用交易子系统部署合约),合约地址和abi不能为空。

    方法入参(funcParam)为JSON数组,多个参数以逗号分隔(参数为数组时同理),示例:

    1. function set(string s) -> ["aa,bb\"cc"] // 双引号要转义
    2. function set(uint n,bool b) -> [1,true]
    3. function set(bytes b,address[] a) -> ["0x1a",["0x7939E26070BE44E6c4Fc759Ce55C6C8b166d94BE","0xce867fD9afa64175bb50A4Aa0c17fC7C4A3C67D9"]]

    接口URL

    http://localhost:5003/WeBASE-Transaction/trans/send

    调用方法

    HTTP POST

    请求参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1群组编号groupIdint16
    2交易业务流水号uuidStatelessString64
    3部署业务流水号uuidDeployString64
    4签名类型signTypeint20-本地配置私钥签名,1-本地随机私钥签名,2-调用WeBASE-Sign签名
    5合约地址contractAddressString
    6合约AbicontractAbiList\<Object>JSON数组
    7调用方法名funcNameString
    8方法参数funcParamList\<Object>JSON数组
    9签名用户编号signUserIdStringsignType为2时必填

    2)数据格式

    1. {
    2. "groupId":1,
    3. "uuidStateless":"XXX",
    4. "uuidDeploy":"XXX",
    5. "signType":0,
    6. "contractAddress":"0xXXXXX",
    7. "contractAbi":[],
    8. "funcName":"set",
    9. "signUserId":"458ecc77a08c486087a3dcbc7ab5a9c3"
    10. }

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataObject

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": null
    5. }

    b.异常返回结果示例(信息详情请参看附录1)

    1. {
    2. "code": 103001,
    3. "message": "system error",
    4. "data": null
    5. }

    3.2. 交易查询接口

    接口描述

    调用此接口同步从节点查询交易信息。当部署业务流水号为空时(即不是调用交易子系统部署合约),合约地址和abi不能为空。

    方法入参(funcParam)为JSON数组,多个参数以逗号分隔(参数为数组时同理),示例:

    1. function set(string s) -> ["aa,bb\"cc"] // 双引号要转义
    2. function set(uint n,bool b) -> [1,true]
    3. function set(bytes b,address[] a) -> ["0x1a",["0x7939E26070BE44E6c4Fc759Ce55C6C8b166d94BE","0xce867fD9afa64175bb50A4Aa0c17fC7C4A3C67D9"]]

    接口URL

    调用方法

    HTTP POST

    请求参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1群组编号groupIdint16
    2部署业务流水号uuidDeployString64
    3合约地址contractAddressString
    4合约AbicontractAbiList\<Object>JSON数组
    5调用方法名funcNameString
    6方法参数funcParamList\<Object>JSON数组

    2)数据格式

    1. {
    2. "groupId":1,
    3. "uuidDeploy":"XXX",
    4. "contractAbi":[],
    5. "funcName":"get",
    6. "funcParam":[]
    7. }

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataObject

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": [
    5. "hello"
    6. }

    b.异常返回结果示例(信息详情请参看附录1)

    接口描述

    根据群组编号和交易业务流水号查询交易请求的event信息。

    接口URL

    http://localhost:5003/WeBASE-Transaction/trans/event/{groupId}/{uuidStateless}

    调用方法

    请求参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1群组编号groupIdint16
    2交易业务流水号uuidStatelessString64

    2)数据格式

    1. http://127.0.0.1:5003/WeBASE-Transaction/trans/event/1/20001

    响应参数

    1)参数表

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": {
    5. "setEvent": [
    6. "test"
    7. ],
    8. "setEvent1": [
    9. "test"
    10. ]
    11. }
    12. }

    b.异常返回结果示例(信息详情请参看附录1)

    1. {
    2. "code": 103001,
    3. "message": "system error",
    4. "data": null
    5. }

    3.4. 交易请求output查询接口

    接口描述

    根据群组编号和交易业务流水号查询交易请求的output信息。

    接口URL

    调用方法

    HTTP GET

    请求参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1群组编号groupIdint16
    2交易业务流水号uuidStatelessString64

    2)数据格式

    1. http://127.0.0.1:5003/WeBASE-Transaction/trans/output/1/20001

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataObject

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": [
    5. "hello!"
    6. ]
    7. }

    b.异常返回结果示例(信息详情请参看附录1)

    1. {
    2. "code": 103001,
    3. "message": "system error",
    4. "data": null
    5. }

    3.5. 交易信息查询接口

    接口描述

    根据群组编号和交易业务流水号查询交易信息。

    接口URL

    http://localhost:5003/WeBASE-Transaction/trans/transInfo/{groupId}/{uuidStateless}

    调用方法

    HTTP GET

    请求参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1群组编号groupIdint16
    2交易业务流水号uuidStatelessString64

    2)数据格式

    1. http://127.0.0.1:5003/WeBASE-Transaction/trans/transInfo/1/20001

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataObject
    3.1编号idint
    3.2群组编号groupIdint
    3.3交易流水号uuidStatelessString
    3.4部署流水号uuidDeployString
    3.5合约abicontractAbiString
    3.6合约地址contractAddressString
    3.7方法名funcNameString
    3.8方法参数funcParamString
    3.9签名类型signTypeint
    3.10签名用户编号signUserIdString
    3.11请求上链次数requestCountint
    3.12处理状态handleStatusint0-待处理,1-处理成功
    3.13交易hashtransHashString
    3.14交易返回原文transOutputString
    3.15交易回执状态receiptStatusboolean0-异常,1-正常
    3.16创建时间gmtCreateDate

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": {
    5. "id": 1,
    6. "groupId": 1,
    7. "uuidStateless": "20001",
    8. "uuidDeploy": "10001",
    9. "contractAbi": "XXX"
    10. "contractAddress": "XXX",
    11. "funcName": "set",
    12. "funcParam": "XXX",
    13. "signType": 0,
    14. "signUserId": "458ecc77a08c486087a3dcbc7ab5a9c3",
    15. "requestCount": 1,
    16. "handleStatus": 1,
    17. "transHash": "XXX",
    18. "transOutput": "0x",
    19. "receiptStatus": true,
    20. "gmtCreate": 1574854118000
    21. }
    22. }

    b.异常返回结果示例(信息详情请参看附录1)

    1. {
    2. "code": 103001,
    3. "message": "system error",
    4. "data": null
    5. }

    4.1. 获取EncryptType接口

    接口描述

    返回Transaction服务中web3sdk所使用的encryptType,0:标准,1:国密

    接口URL

    调用方法

    HTTP GET

    请求参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1-----

    2)数据格式

    1. http://127.0.0.1:5003/WeBASE-Transaction/encrypt

    响应参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString返回码信息请附录1
    2提示信息messageString
    3返回数据dataIntegerencryptType: 0:标准, 1:国密

    2)数据格式

    a.请求正常返回结果

    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": 0

    接口描述

    获取WeBASE-Transaction的版本号

    接口URL

    http://localhost:5003/WeBASE-Transaction/version

    调用方法

    HTTP GET

    请求参数

    1)参数表

    序号中文参数名类型最大长度必填说明
    ---

    2)数据格式

    响应参数

    1)数据格式

    a、成功:

      1. 返回码信息列表