README
¶
CrossChain-Bridge API
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.GetVersionInfo
swap.GetTokenPairInfo
swap.GetTokenPairsInfo
swap.Swapin
swap.P2shSwapin
swap.RetrySwapin
swap.Swapout
swap.GetSwapin
swap.GetSwapout
swap.GetSwapinHistory
swap.GetSwapoutHistory
swap.RegisterP2shAddress
swap.GetP2shAddressInfo
swap.RegisterAddress
swap.GetRegisteredAddress
And the following APIs are for developing and debuging, you can ignore them
- swap.GetNonceInfo
- swap.GetRawSwapin
- swap.GetRawSwapinResult
- swap.GetRawSwapout
- swap.GetRawSwapoutResult
- swap.IsValidSwapinBindAddress
- swap.IsValidSwapoutBindAddress
- swap.GetLatestScanInfo
swap.GetServerInfo
查询服务信息
[] (空)
成功返回服务信息，失败返回错误。
swap.GetVersionInfo
查询版本信息
[] (空)
成功返回版本信息，失败返回错误。
swap.GetTokenPairInfo
查询交易对信息
["交易对"]
成功返回交易对信息，失败返回错误。
swap.GetTokenPairsInfo
批量查询交易对信息 pairids 为 pairid 通过逗号拼接在一起的字符串 当 pairids 为 all 时查询所有交易对信息
["pairids"]
成功返回指定的交易对信息，失败返回错误。
swap.Swapin
申请换进置换
[{"txid":"充值交易哈希", "pairid":"交易对"}]
成功返回`Success`，失败返回错误。
swap.P2shSwapin
申请换进置换 (BTC 专用接口)
支持每个用户一个专用充值地址
[{"txid":"充值交易哈希", "bind":"绑定地址"}]
成功返回`Success`，失败返回错误。
swap.RetrySwapin
重新申请换进置换 (ETH like 专用接口)
只有账户由于没有注册而申请置换失败的情形下才可以重新申请置换。
[{"txid":"充值交易哈希", "pairid":"交易对"}]
成功返回`Success`，失败返回错误。
swap.Swapout
申请换出置换
[{"txid":"销毁交易哈希", "pairid":"交易对"}]
成功返回`Success`，失败返回错误。
swap.GetSwapin
查询换进置换
[{"txid":"充值交易哈希", "pairid":"交易对", "bind":"绑定地址"}]
成功返回换进置换信息，失败返回错误。
swap.GetSwapout
查询换出置换
[{"txid":"销毁交易哈希", "pairid":"交易对", "bind":"绑定地址"}]
成功返回换出置换信息，失败返回错误。
swap.GetSwapinHistory
查询换进置换历史，支持分页，从 offset (默认0) 开始选取前 limit (默认20) 项
status 为状态码通过逗号的拼接字符串，默认为空。
[{"address":"账户地址", "pairid":"交易对", "offset":offset, "limit":limit, "status":"9,10"}]
address 为 all 表示所有历史
limit 最大值为 100
成功返回换进置换历史，失败返回错误。
swap.GetSwapoutHistory
查询换出置换历史，支持分页，从 offset (默认0) 开始选取前 limit (默认20) 项
status 为状态码通过逗号的拼接字符串，默认为空。
[{"address":"账户地址", "pairid":"交易对", "offset":offset, "limit":limit, "status":"9,10"}]
address 为 all 表示所有历史
limit 最大值为 100
成功返回换出置换历史，失败返回错误。
swap.RegisterP2shAddress
注册Ps2h充值地址 (BTC 专用接口)
["绑定地址"]
成功返回绑定地址对应的Ps2h充值地址信息，失败返回错误。
swap.GetP2shAddressInfo
获取Ps2h充值地址信息 (BTC 专用接口)
["P2sh地址"]
成功返回Ps2h充值地址信息，失败返回错误。
swap.RegisterAddress
注册账户地址 (ETH like 专用接口)
["账户地址"]
成功返回`Success`，失败返回错误。
swap.GetRegisteredAddress
获取注册账户地址
["账户地址"]
成功返回注册账户信息，失败返回错误。
RESTful API Reference
GEt /serverinfo
查询服务信息
GEt /versioninfo
查询版本信息
GEt /pairinfo/{pairid}
查询交易对信息
GEt /pairsinfo/{pairids}
批量查询交易对信息 pairids 为 pairid 通过逗号拼接在一起的字符串 当 pairids 为 all 时查询所有交易对信息
GET /swapin/{pairid}/{txid}?bind=绑定地址
查询换进置换，txid 为充值交易哈希
GET /swapout/{pairid}/{txid}?bind=绑定地址
查询换出置换，txid 为销毁交易哈希
GET /swapin/history/{pairid}/{address}?offset=0&limit=20&&status=9,10
查询换进置换历史，支持分页，addess 为账户地址
pairid 为 all 表示所有交易对
address 为 all 表示所有账户
limit 最大值为 100
status 为状态码通过逗号的拼接字符串，默认为空。
GET /swapout/history/{pairid}/{address}?offset=0&limit=20&&status=9,10
查询换出置换历史，支持分页，addess 为账户地址
pairid 为 all 表示所有交易对
address 为 all 表示所有账户
limit 最大值为 100
status 为状态码通过逗号的拼接字符串，默认为空。
POST /swapin/post/{pairid}/{txid}
申请换进置换，txid 为充值交易哈希
POST /swapout/post/{pairid}/{txid}
申请换出置换，txid 为销毁交易哈希
POST /swapin/p2sh/{txid}/{bind}
申请 P2sh 换进置换，txid 为充值交易哈希， bind 为对应的绑定地址。（BTC 专用）
POST /swapin/retry/{pairid}/{txid}
重新申请换进置换 (ETH like 专用接口)
只有账户由于没有注册而申请置换失败的情形下才可以重新申请置换。
GET /p2sh/{address}
获取 P2sh 地址信息，address 为 P2sh 地址。（BTC 专用）
POST /p2sh/bind/{address}
注册 P2sh 地址，address 为绑定地址。（BTC 专用）
GET /registered/{address}
获取注册账户地址信息
POST /register/{address}
注册账户地址 (ETH like 专用接口)
And the following APIs are for developing and debuging, you can ignore them
- GET /nonceinfo
- GET /swapin/{pairid}/{txid}/raw
- GET /swapout/{pairid}/{txid}/raw
- GET /swapin/{pairid}/{txid}/rawresult
- GET /swapout/{pairid}/{txid}/rawresult
Directories
¶
| Path | Synopsis |
|---|---|
|
Package client provides methods to do http GET / POST request.
|
Package client provides methods to do http GET / POST request. |
|
Package restapi provides RESTful RPC service.
|
Package restapi provides RESTful RPC service. |
|
Package rpcapi provides JSON RPC service.
|
Package rpcapi provides JSON RPC service. |
|
Package server provides JSON/RESTful RPC service.
|
Package server provides JSON/RESTful RPC service. |