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

Raiden/雷电API手册:通道及代币信息查询API
龙行天下
2021-11-18 17:45:31

查询全部未结算通道 - GET /api/(version)/channels

返回所有的未结算通道

API请求

GET /api/(version)/channels

URL参数:

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

API响应

返回一个JSON数组,每个成员表示一个通道,其包含如下字段:

  • token_network_identifier:代币网络标识符
  • channel_identifier:通道标识符
  • partner_address:对手方地址
  • token_address:代币地址
  • balance:余额
  • total_deposit:存入总额
  • state:状态
  • settle_timeout:结算超时块数
  • reveal_timeout:揭示超时块数 注册代币API的http响应代码可能为以下值:

  • 200 OK – 查询成功

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

示例代码

curl请求示例:

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

响应结果如下:

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

[
    {
        "token_network_identifier": "0xE5637F0103794C7e05469A9964E4563089a5E6f2",
        "channel_identifier": 20,
        "partner_address": "0x61C808D82A3Ac53231750daDc13c777b59310bD9",
        "token_address": "0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8",
        "balance": 25000000,
        "total_deposit": 35000000,
        "state": "opened",
        "settle_timeout": 100,
        "reveal_timeout": 30
    }
]

查询指定代币的未结算通道 - GET /api/(version)/channels/(token_address)

返回指定代币的未结算通道列表。

API请求

GET /api/(version)/channels/(token_address)

URL参数:

  • version:API版本号,目前可用:v1
  • token_address:要查询的代币地址

API响应

返回一个JSON数组,每个成员表示一个通道,其包含如下字段:

  • token_network_identifier:代币网络标识符
  • channel_identifier:通道标识符
  • partner_address:对手方地址
  • token_address:代币地址
  • balance:余额
  • total_deposit:存入总额
  • state:状态
  • settle_timeout:结算超时块数
  • reveal_timeout:揭示超时块数 注册代币API的http响应代码可能为以下值:

  • 200 OK – 查询成功

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

示例代码

curl请求示例:

curl -i http://localhost:5001/api/v1/channels/0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8

响应结果如下:

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

[
    {
        "token_network_identifier": "0xE5637F0103794C7e05469A9964E4563089a5E6f2",
        "channel_identifier": 20,
        "partner_address": "0x61C808D82A3Ac53231750daDc13c777b59310bD9",
        "token_address": "0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8",
        "balance": 25000000,
        "total_deposit": 35000000,
        "state": "opened",
        "settle_timeout": 100,
        "reveal_timeout": 30
    }
]

查询指定通道信息 - GET /api/(version)/channels/(token_address)/(partner_address)

查询指定代币及对手方地址所对应的raiden通道的信息。

API请求

GET /api/(version)/channels/(token_address)/(partner_address)

URL参数:

  • version:API版本号,目前可用:v1
  • token_address:代币地址
  • partner_network:对手方地址

API响应

返回一个描述通道的JSON对象,其包含如下字段:

  • token_network_identifier:代币网络标识符
  • channel_identifier:通道标识符
  • partner_address:对手方地址
  • token_address:代币地址
  • balance:余额
  • total_deposit:存入总额
  • state:状态
  • settle_timeout:结算超时块数
  • reveal_timeout:揭示超时块数 注册代币API的http响应代码可能为以下值:

  • 200 OK – 查询成功

  • 404 Not Found – 未找到 指定的代币或对端地址无效,或者 通道不存在
  • 500 Internal Server Error – Raiden节点内部错误

示例代码

curl请求示例:

curl -i http://localhost:5001/api/v1/channels/0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8/0x61C808D82A3Ac53231750daDc13c777b59310bD9

响应结果如下:

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

{
    "token_network_identifier": "0xE5637F0103794C7e05469A9964E4563089a5E6f2",
    "channel_identifier": 20,
    "partner_address": "0x61C808D82A3Ac53231750daDc13c777b59310bD9",
    "token_address": "0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8",
    "balance": 25000000,
    "total_deposit": 35000000,
    "state": "opened",
    "settle_timeout": 100,
    "reveal_timeout": 30
}

查询已注册代币 - GET /api/(version)/tokens

返回已注册的代币地址的列表。

API请求

GET /api/(version)/tokens

URL参数:

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

API响应

返回一个JSON数组,成员为代币地址字符串。

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

  • 200 OK – 查询成功
  • 500 Internal Server Error – Raiden节点内部错误

示例代码

curl请求示例:

curl -i http://localhost:5001/api/v1/tokens 响应结果如下:

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

[
    "0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8",
    "0x61bB630D3B2e8eda0FC1d50F9f958eC02e3969F6"
]

查询指定代币的网络地址 - GET /api/(version)/tokens/(token_address)

如果指定代币已经注册,则返回其对应的代币网络地址,。

API请求

GET /api/(version)/tokens/(token_address)

URL参数:

  • version:API版本号,目前可用:v1
  • token_address:代币地址

API响应

返回代币网络地址字符串。

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

  • 200 OK – 查询成功
  • 404 Not Found – 没有找到指定代币对应的代币网络

示例代码

curl请求示例:

curl -i http://localhost:5001/api/v1/tokens/0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8

响应结果如下:

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

"0x61bB630D3B2e8eda0FC1d50F9f958eC02e3969F6"

查询指定代币的未结算对手方 - GET /api/(version)/tokens/(token_address)/partners

返回指定代币的所有包含未结算通道的对手方列表。

API请求

GET /api/(version)/tokens/(token_address)/partners

URL参数:

  • version:API版本号,目前可用:v1
  • token_address:代币地址

API响应

返回一个JSON数组,每个成员对象包含如下字段:

  • partner_address:对手方地址
  • channel:通道url http响应的状态代码可能为以下值:

  • 200 OK – 查询成功

  • 302 Found – 如果用户访问通道链接端结点
  • 404 Not Found – 未找到 指定的代币不存在 指定的代币地址不是有效的EIP55编码以太坊地址

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

示例代码

curl请求示例:

curl -i http://localhost:5001/api/v1/tokens/0x61bB630D3B2e8eda0FC1d50F9f958eC02e3969F6/partners

响应结果如下:

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

[
   {
       "partner_address": "0x2a65aca4d5fc5b5c859090a6c34d164135398226",
       "channel": "/api/<version>/channels/0x61C808D82A3Ac53231750daDc13c777b59310bD9/0x2a65aca4d5fc5b5c859090a6c34d164135398226"
   }
]

查询未完成转账交易 - GET /api/(version)/pending_transfers

返回所有未完成的转账交易。

API请求

GET /api/(version)/pending_transfers

URL参数:

  • version:API版本号,目前可用:v1 API响应 返回一个JSON数组,每个交易对象包含以下字段:

  • channel_identifier:通道标识符

  • initiator:发起地址
  • locked_amount:锁定金额
  • payment_identifier:支付标识符
  • role:交易中的角色
  • target:目标地址
  • token_address:代币地址
  • token_network_identifier:代币网络标识符
  • transferred_amount:转账金额 http响应的状态代码可能为以下值:

  • 200 OK – 查询成功

  • 404 Not Found – 未找到所查询的通道或代币
  • 500 Internal Server Error – Raiden节点内部错误

示例代码

curl请求示例:

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

响应结果如下:

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

[
   {
      "channel_identifier": "255",
      "initiator": "0x5E1a3601538f94c9e6D2B40F7589030ac5885FE7",
      "locked_amount": "119",
      "payment_identifier": "1",
      "role": "initiator",
      "target": "0x00AF5cBfc8dC76cd599aF623E60F763228906F3E",
      "token_address": "0xd0A1E359811322d97991E03f863a0C30C2cF029C",
      "token_network_identifier": "0x111157460c0F41EfD9107239B7864c062aA8B978",
      "transferred_amount": "331"
   }

]

查询指定代币的未完成转账交易 - GET /api/(version)/pending_transfers/(token_address)

返回指定代币的所有未完成的转账交易。

API请求

GET /api/(version)/pending_transfers/(token_address)

URL参数:

  • version:API版本号,目前可用:v1
  • token_address:代币地址

API响应

返回一个JSON数组,每个交易对象包含以下字段:

  • channel_identifier:通道标识符
  • initiator:发起地址
  • locked_amount:锁定金额
  • payment_identifier:支付标识符
  • role:交易中的角色
  • target:目标地址
  • token_address:代币地址
  • token_network_identifier:代币网络标识符
  • transferred_amount:转账金额 http响应的状态代码可能为以下值:

  • 200 OK – 查询成功

  • 404 Not Found – 未找到所查询的通道或代币
  • 500 Internal Server Error – Raiden节点内部错误

示例代码

curl请求示例:

curl -i http://localhost:5001/api/v1/pending_transfers/0xd0A1E359811322d97991E03f863a0C30C2cF029C

响应结果如下:

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

[
   {
      "channel_identifier": "255",
      "initiator": "0x5E1a3601538f94c9e6D2B40F7589030ac5885FE7",
      "locked_amount": "119",
      "payment_identifier": "1",
      "role": "initiator",
      "target": "0x00AF5cBfc8dC76cd599aF623E60F763228906F3E",
      "token_address": "0xd0A1E359811322d97991E03f863a0C30C2cF029C",
      "token_network_identifier": "0x111157460c0F41EfD9107239B7864c062aA8B978",
      "transferred_amount": "331"
   }

]

查询指定通道的未完成转账交易 - GET /api/(version)/pending_transfers/(token_address)/(partner_address)

返回指定通道的所有未完成的转账交易。

API请求

GET /api/(version)/pending_transfers/(token_address)/(partner_address)

URL参数:

  • version:API版本号,目前可用:v1
  • token_address:代币地址
  • partner_address:对手方地址

API响应

返回一个JSON数组,每个交易对象包含以下字段:

  • channel_identifier:通道标识符
  • initiator:发起地址
  • locked_amount:锁定金额
  • payment_identifier:支付标识符
  • role:交易中的角色
  • target:目标地址
  • token_address:代币地址
  • token_network_identifier:代币网络标识符
  • transferred_amount:转账金额 http响应的状态代码可能为以下值:

  • 200 OK – 查询成功

  • 404 Not Found – 未找到所查询的通道或代币
  • 500 Internal Server Error – Raiden节点内部错误

示例代码

curl请求示例:

curl -i http://localhost:5001/api/v1/pending_transfers/0xd0A1E359811322d97991E03f863a0C30C2cF029C/0x2c4b0Bdac486d492E3cD701F4cA87e480AE4C685

响应结果如下:

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

[
   {
      "channel_identifier": "255",
      "initiator": "0x5E1a3601538f94c9e6D2B40F7589030ac5885FE7",
      "locked_amount": "119",
      "payment_identifier": "1",
      "role": "initiator",
      "target": "0x00AF5cBfc8dC76cd599aF623E60F763228906F3E",
      "token_address": "0xd0A1E359811322d97991E03f863a0C30C2cF029C",
      "token_network_identifier": "0x111157460c0F41EfD9107239B7864c062aA8B978",
      "transferred_amount": "331"
   }

]

合作伙伴