链眼社区:专注于区块链安全,区块链数据分析, 区块链信息整合,区块链技术服务和区块链技术咨询。

Raiden/雷电API手册:连接管理API
龙行天下
2021-11-18 18:13:26

查询已加入的代币网络 - GET /api/(version)/connections

查询已加入的代币网络详情。

API请求

GET /api/(version)/connections

URL参数:

  • version:API版本号,目前可用:v1

API响应

返回一个JSON对象,键为代币地址,值为该地址的描述对象,包含以下键:

  • funds:自上次连接请求后的金额汇总
  • sum_deposits:所有当前打开的通道中存入金额的汇总
  • channels:该代币当前打开的通道数量 注册代币API的http响应代码可能为以下值:

  • 200 OK – 查询成功

  • 500 Internal Server Error – Raiden节点内部错误

示例代码

curl请求示例:

curl -i http://localhost:5001/api/v1/connections

响应结果如下:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "0x2a65Aca4D5fC5B5C859090a6c34d164135398226": {
        "funds": 100,
        "sum_deposits": 67,
        "channels": 3
    },
    "0x0f114A1E9Db192502E7856309cc899952b3db1ED": {
        "funds": 49
        "sum_deposits": 31,
        "channels": 1
    }
}

自动加入代币网络 - PUT /api/(version)/connections/(token_address)

自动加入代币网络。只有所有区块链调用请求完成后,该请求才会返回。

API请求

PUT /api/(version)/connections/(token_address)

URL参数:

  • version:API版本号,目前可用:v1
  • token_address:代币地址 BODY参数对象:

  • funds:要加入网络的资金数量,整数

  • initial_channel_target : 要打开的通道数量,整数
  • joinable_funds_target :用于加入其他人创建的通道的资金比例,浮点数

API响应

返回一个JSON对象,键为代币地址,值为该地址的描述对象,包含以下键:

  • funds:自上次连接请求后的金额汇总
  • sum_deposits:所有当前打开的通道中存入金额的汇总
  • channels:该代币当前打开的通道数量 http响应的状态码可能为以下值:

  • 204 No Content – 成功

  • 402 Payment Required – 发起地址ETH余额不足
  • 404 Not Found – 指定的代币地址不是有效的EIP55以太坊地址
  • 408 Request Timeout – 请求超时
  • 409 Conflict – 输入参数无效
  • 500 Internal Server Error – Raiden节点内部错误

示例代码

curl请求示例:

curl -i -X PUT http://localhost:5001/api/v1/connections/0x2a65Aca4D5fC5B5C859090a6c34d164135398226 \
      -H 'Content-Type: application/json' --data-raw '{"funds": 1337}'

删除指定的代币网络 - DELETE /api/(version)/connections/(token_address)

退出代币网络。只有所有区块链调用请求完成后,该请求才会返回。

API请求

DELETE /api/(version)/connections/(token_address)

URL参数:

  • version:API版本号,目前可用:v1
  • token_address:代币地址 BODY参数对象:

  • funds:要加入网络的资金数量,整数

  • initial_channel_target : 要打开的通道数量,整数
  • joinable_funds_target :用于加入其他人创建的通道的资金比例,浮点数

API响应

返回一个JSON数组。

http响应的状态码可能为以下值:

  • 200 OK – 退出代币网络成功
  • 404 Not Found – 指定的代币地址不是有效的eip55以太坊地址
  • 500 Internal Server Error – Raiden节点内部错误

示例代码

curl请求示例:

curl -i -X DELETE http://localhost:5001/api/v1/connections/0x2a65Aca4D5fC5B5C859090a6c34d164135398226 \
      -H 'Content-Type: application/json'

响应结果如下:

HTTP/1.1 200 OK
Content-Type: application/json

[
    "0x41BCBC2fD72a731bcc136Cf6F7442e9C19e9f313",
    "0x5A5f458F6c1a034930E45dC9a64B99d7def06D7E",
    "0x8942c06FaA74cEBFf7d55B79F9989AdfC85C6b85"
]

合作伙伴