Skip to content

CrossChain Bridge API

cross-chain edited this page Aug 4, 2020 · 1 revision

crossChain-Bridge API

JSON RPC API Reference

RESTful API Reference

JSON RPC API Reference

JSON PRC API 通用调用格式:

curl -X POST -H "Content-Type:application/json" --data '{"jsonrpc":"2.0","method":"方法名","params":参数,"id":1}' SERVER_URL

其中,SERVER_URL格式为http://host:port/rpc

成功返回的通用格式:

{"jsonrpc":"2.0","result":返回值,"id":1}

错误返回的通用格式:

{"jsonrpc":"2.0","error":{"code":错误码,"message":"错误信息","data":附加备注},"id":1}

以下为了简洁对每个 API 说明只列出参数返回值两项

swap.GetServerInfo
swap.Swapin
swap.Swapout
swap.GetSwapin
swap.GetSwapout
swap.GetSwapinHistory
swap.GetSwapoutHistory

swap.GetServerInfo

查询服务信息

参数:
[] (空)
返回值:
成功返回服务信息,失败返回错误。

swap.Swapin

申请换进置换

参数:
["充值交易哈希"]
返回值:
成功返回`Success`,失败返回错误。

swap.Swapout

申请换出置换

参数:
["销毁交易哈希"]
返回值:
成功返回`Success`,失败返回错误。

swap.GetSwapin

查询换进置换

参数:
["充值交易哈希"]
返回值:
成功返回换进置换信息,失败返回错误。

swap.GetSwapout

查询换出置换

参数:
["销毁交易哈希"]
返回值:
成功返回换出置换信息,失败返回错误。

swap.GetSwapinHistory

查询换进置换历史,支持分页,从 offset (默认0) 开始选取前 limit (默认20) 项

参数:
[{"address":"账户地址", "offset":offset, "limit":limit}]

address 为 all 表示所有历史

limit 最大值为 100

返回值:
成功返回换进置换历史,失败返回错误。

swap.GetSwapoutHistory

查询换出置换历史,支持分页,从 offset (默认0) 开始选取前 limit (默认20) 项

参数:
[{"address":"账户地址", "offset":offset, "limit":limit}]

address 为 all 表示所有历史

limit 最大值为 100

返回值:
成功返回换出置换历史,失败返回错误。

RESTful API Reference

GEt /serverinfo

查询服务信息

GET /swapin/{txid}

查询换进置换,txid 为充值交易哈希

GET /swapout/{txid}

查询换出置换,txid 为销毁交易哈希

GET /swapin/history/{address}?offset=0&limit=20

查询换进置换历史,支持分页,addess 为账户地址

address 为 all 表示所有历史

limit 最大值为 100

GET /swapout/history/{address}?offset=0&limit=20

查询换出置换历史,支持分页,addess 为账户地址

address 为 all 表示所有历史

limit 最大值为 100

POST /swapin/post/{txid}

申请换进置换,txid 为充值交易哈希

POST /swapout/post/{txid}

申请换出置换,txid 为销毁交易哈希