接口规范¶
Truora-Service¶
查询 Truora 版本¶
接口描述¶
查询 Truora 服务版本
接口URL¶
http://localhost:5021/Oracle-Service/server/version
调用方法¶
HTTP GET
响应参数¶
1）数据格式
{
"code": 0,
"message": "success",
// 当前 Truora-Service 版本
"data": "v1.1.0",
"totalCount": 0
}
OracleCore 合约地址查询接口¶
接口描述¶
查询 OracleCore 合约地址，用户编写自定义合约时使用
接口URL¶
http://localhost:5021/Oracle-Service/oracle/address?chainId=1&groupId=1
调用方法¶
HTTP GET
响应参数¶
1）数据格式
{
"code": 0,
"message": "success",
"data": [
{
// OracleCore 合约版本
"oracleCoreVersion": "v1.1.0",
// VRFCore 合约版本
"vrfCoreVersion": "v1.1.0",
// 链 ID
"chainId": 1,
// 群组 ID
"group": 1,
// OracleCore 合约地址
"oracleCoreContractAddress": "0x1769c87d9889eee2352c9cfe61dd3ac22a80f7a7",
// VRFCore 合约地址
"vrfContractAddress": "0x28b2a1b9ead2e4cf6a7cff9372ee6da70152e484",
"fromBlock": "latest",
"toBlock": "latest"
}
.....
],
"totalCount": 0
}
查询历史请求列表¶
接口描述¶
查询所有的历史请求记录
接口URL¶
http://localhost:5021/Oracle-Service/history/list?pageNumber=1&pageSize=10&chainId=1&groupId=1&hideResult=false
调用方法¶
HTTP GET
请求参数¶
1）参数表
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| chainId | int | 否 | 1 | 链编号 |
| groupId | int | 否 | 1 | 群组编号 |
| hideResult | boolean | 否 | true |
true: 不返回 result 结果；false: 返回 |
| pageNumber | int | 否 | 1 | 第几页 |
| pageSize | int | 否 | 10，最大不超过 20 | 每页条数 |
2）数据格式 无
响应参数¶
1）数据格式
{
"code": 0,
"message": "success",
"data": [
// 多条记录
{// sourceType == 0 时，表示链下 API 获取数据
"id": 1,
//请求唯一编号
//查询详情时使用的 requestId 字段
"reqId":
"0x9f32a5e56608fd730f7ef8bc42efdc53142753a77e46287246ed2a9a39ed1994",
// 链编号和群组编号
"chainId": 1,
"groupId": 1,
// Core 合约的版本号
"oracleVersion": "v1.1.0",
// 请求类型
// 0 API 获取链下数据
"sourceType": 0,
// URL 请求求地址和数据响应格式
"reqQuery": "json(https://api.exchangerate-api.com/v4/latest/CNY).rates.JPY",
// 请求状态
// 0 成功
// 非 0，失败
"reqStatus": 0,
// 请求状态非 0 时的错误信息
"error": "",
// 发起调用的合约地址
"userContract": "0x919c4e3c50a074dbd15e6a832bc146cd288cebf4",
// 请求耗时（ms）
"processTime": 2460,
// hideResult 为 true，不返回该字段
// hideResult 为 false，返回
// URL 返回的结果
"result": "15.962067",
// 放大倍数，Truora-Service 会将 URL 返回的结果 乘以 该倍数后上传到链上
// 防止小数
"timesAmount": "1000000000000000000",
"createTime": "2020-12-11 18:48:28",
"modifyTime": "2020-12-11 18:48:31"
},
{// sourceType == 1 时，表示 VRF，获取链上随机数
"id": 53,
//请求唯一编号
//查询详情时使用的 requestId 字段
"reqId": "0x223c4a975b25b235b0f3e9830e1099cdfefeb7dcffa839b860fccd12a6cd0a51",
// 链编号和群组编号
"chainId": 1,
"groupId": 1,
// Core 合约的版本号
"oracleVersion": "v1.1.0",
//请求类型
// 1 VRF 获取可验证随机数
"sourceType": 1,
"blockNumber": 146,
"reqQuery": "",
"needProof": false,
// 请求状态
// 0 成功
// 非 0，失败
"reqStatus": 0,
// 请求状态非 0 时的错误信息
"error": "",
// 发起调用的合约地址
"userContract": "0xdd48ff8868b76dab43bd13402840bcb8c5a82853",
// 处理时长
"processTime": 495,
"createTime": "2021-03-22 16:28:56",
"modifyTime": "2021-03-22 16:28:56",
"inputSeed": "1",
"actualSeed": "BF18046A6A8801B4ABED36169F93D1C0613768EC0EDCC827A31D973D3CBE98B4"
},
......
],
// 总行数
"totalCount": 1
}
查询单个请求详情¶
接口描述¶
查询单个请求详情
接口URL¶
http://localhost:5021/Oracle-Service/history/query/{requestId}
调用方法¶
HTTP GET
请求参数¶
1）参数表
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| requestId | String | 是 | 请求编号，添加到 URL 中 |
注意：requestId 对应历史请求列表中返回记录的 reqId 字段
2）数据格式 无
响应参数¶
1）数据格式
{
"code": 0,
"message": "success",
"data": {
"id": 1,
//请求唯一编号
//查询详情时使用的 requestId 字段
"reqId": "0x9f32a5e56608fd730f7ef8bc42efdc53142753a77e46287246ed2a9a39ed1994",
// 链编号和群组编号
"chainId": 1,
"groupId": 1,
// Core 合约的版本号
"oracleVersion": "v1.1.0",
// 请求类型
// 0 链下 API 获取数据
// 1 VRF 获取可验证随机数
"sourceType": 1,
// sourceType == 0 时，表示：URL 请求地址和数据响应格式
// sourceType == 1 时，不使用
"reqQuery": "json(https://api.exchangerate-api.com/v4/latest/CNY).rates.JPY",
// 请求状态
// 0 成功
// 非 0，失败
"reqStatus": 0,
// 请求状态非 0 时的错误信息
"error": "",
// 发起调用的合约地址
"userContract": "0x919c4e3c50a074dbd15e6a832bc146cd288cebf4",
// 请求耗时（ms）
"processTime": 2460,
// hideResult 为 true，不返回该字段
// hideResult 为 false，返回
// sourceType == 0 时，表示：URL 返回的结果
// sourceType == 1 时，表示：VRF 生成的随机数，0x 开头 16 进制
"result": "15.962067",
// 放大倍数，防止小数
// sourceType == 0 时使用，Truora-Service 会将 URL 返回的结果 乘以 该倍数后上传到链上
"timesAmount": "1000000000000000000",
// sourceType == 1 时使用，VRF 生成的可验证随机数的证明
"proof": "0211c851316725ffba00e7eae4a06327214e282803379a7521ade5bbd0dc3a4ba5c69f06f471fd2349e907ca28df48ba975fb0d6c1f18e8449dbc00b6216c73ed018bc59c45d906c9cab14ee7c9af7727c"
// sourceType == 1 时使用，用户提供的随机数种子
"inputSeed": "1",
// sourceType == 1 时使用，生成随机数时使用的实际种子（包含块高 hash）
"actualSeed": "1298E2D458FA77C078D42B4B3B54441D56E4A13ECDE436E31A4899BB0D1A3D74"
// 额外字段
"createTime": "2020-12-11 18:48:28",
"modifyTime": "2020-12-11 18:48:31"
},
"totalCount": 0
}
查询 Truora-Service 服务信息¶
接口描述¶
查询 Truora-Service 服务信息，包括
keyHash和publicKeyList
接口URL¶
http://localhost:5021/Oracle-Service/center/list?chainId=1&groupId=1
调用方法¶
HTTP GET
响应参数¶
1）数据格式
{
"code": 0,
"message": "success",
"data": [
{
// 服务编号，从 0 开始，一次递增
"index": 0,
//
"oracleServiceAddress": "0x9c9c89314573086ace5a5825b33d52eee1f99a8a",
// Truora-Service 的 PublicKey
"publicKeyList": [
"1c8f2ab90b4323f182e85fcd25e4d8b17267b9decb1305592b3d66952ce3d82a",
"008e89fdc1b5807c400e6339eb5428318be0d5a09696693ce40f27eede2d162a56"
],
// Truora-Service 的 keyHash
"keyHash": "45f6483e01a8956d4ce4700d9c9c89314573086ace5a5825b33d52eee1f99a8a",
"operator": "operator",
"url": "http://localhost",
"creatTime": "2020-11-18 11:40:12",
"latestRequstProcessedTime": 0,
"status": true,
"processedRequestAmount": 0
},
// 多个
......
],
"totalCount": 0
}