ライトニングネットワーク公式REST APIドキュメント[中国語版]

ライトニング・ネットワーク（雷電Network）は、拡張プログラムチェーンイーサネットスクエアブロック鎖、ワイズ雷電ノードのネットワーク・アクセス・アドレスが提供する文書のRESTfulなAPI中国の公式バージョンであります：http://cw.hubwiz.com/card/c/raiden-api/

雷電APIアクセスのエンドノードのURLは通常、APIの異なるバージョンへのアクセスをサポートするために、バージョン情報が含まれている、すべてのAPIアクセスURLプレフィックスは、次のとおりです/api/<version>/。

あなたはすぐに開発ブロックチェーンアプリケーションをマスターしたい場合は、我々はEbizalネットワーク推奨ブロックチェーンアプリケーション開発チュートリアルシリーズをビットコイン、イーサネット広場、EOS、スーパーファブリック書籍、その他のtendermintブロックチェーンだけでなく、Javaのをカバーし、行きます、nodejs、パイソン、PHP、Cの＃、ダーツや他の開発言語。

図1に示すように、API要求/応答JSONエンコードされたデータ

APIアクセス要求と応答はJSONを使用してエンコードされています。以下は、共通のAPIオブジェクトです。

1.1チャンネル/チャンネル

例えばチャネルオブジェクト次のように

{
   "channel_identifier": 21,
   "token_network_identifier": "0x2a65Aca4D5fC5B5C859090a6c34d164135398226",
   "partner_address": "0x61C808D82A3Ac53231750daDc13c777b59310bD9",
   "token_address": "0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8",
   "balance": 25000000,
   "total_deposit": 35000000,
   "state": "opened",
   "settle_timeout": 500,
   "reveal_timeout": 40
}

Channelオブジェクトは、次のフィールドがあります。

channel_identifier：チャネル同定、整数
partner_address：他のアドレスは、EIP55エンコードされたアドレス文字列には、流路を開くために使用します
token_address：トークンアドレス、EIP555エンコードされたアドレス文字列トークン、チャネル上のトランザクションのために
token_network_identifier：ネットワーク識別子トークン、EIP55ネットワーク識別子コードされるトークン
バランス：バランス可能なトークン、整数
total_deposit：チャンネル量が契約を寄託されている、整数
状態：チャネル、文字列の現在の状態は、値が含まれる：opened-チャンネルオンclosed-チャネルが閉じてsettled-そしてチャネルが清算閉じています
settle_timeout：ブロックの清算チャンネルタイムアウト数、整数
reveal_timeout：開示されたタイムアウト許さブロックの最大数、整数

1.2チャンネルのイベント/イベント

JSONオブジェクトのイベント、イベントオブジェクトのプロパティとしてイベント・パラメータを符号化するチャネル。イベントの異なる種類の間の区別を容易にするために、中にイベント・オブジェクトは、さらに追加event_typeおよびblock_number属性。

2、APIのエラーメッセージ

APIリクエストが失敗したために、それはなど409または400不正な要求が競合し、として、対応するHTTPステータスコードを返すだけでなく、JSONオブジェクトは、エラーに関する詳細な情報を取得するために使用することができます返されたフィールドでエラーが付属しています。しかし、それは雷電が着信要求を処理できないと例外がスローされた場合、それはHTTPステータスコード500を返し、ことに留意すべきである、それはJSONオブジェクトがされないが戻ったが、唯一の文字列メッセージInternal server error。これは、我々がAPIを実装するために、他の開発ライブラリに依存しているため、我々は例外が発生した場合、通常の応答メッセージを処理することができないです。

いずれにせよ、私たちは、あなたがこのような現象に遭遇した場合、私達にフィードバックをお願いし、500エラーが雷電のバグであると信じています。

図3に示すように、アクセス端末ノード

アクセス雷電エンドノード以下、の開発に選択することができます。

基本となるAPI
- ライトニングクエリノード情報：GET / API /（版）/アドレス
- 登録指定されたトークン：PUT / API /（版）/トークン/（token_address）
チャンネル情報のクエリAPIとトークン
- 未決済のチャンネルリストを取得します：GET / API /（版）/チャンネル
- ：トークンリスト不定チャンネル取得GET / API /（版）/チャンネル/（token_addressを）
- クエリの特定のチャネル情報：GET / API /（版）/チャンネル/（token_address）/（partner_address）
- 登録したトークンのリストを取得します。GET / API /（版）/トークン
- ：トークンネットワークアドレス取得GET / API /（版）/トークン/（token_addressを）
- ：チャンネル相手を動揺トークン取得GET / API /（版）/トークン/（token_address）/パートナー
- 転送リストを完了していない取得：GET / API /（版）/ pending_transfers
- 指定されたトークンは、転送リストを完了していない取得します：GET / API /（版）/ pending_transfers /（token_address）
- チャネルは、転送リストを完了していない取得します：GET / API /（版）/ pending_transfers /（token_address）/（partner_address）
チャネル管理API
- ：経路開き、PUT / API /（版）/チャンネル
- 閉じるチャンネル：PATCH / API /（版）/チャンネル/（token_address）/（partner_address）
接続マネージャAPI
- クエリは、トークンのネットワークに参加した：GET / API /（版）/接続
- ：トークンは自動的にネットワークに参加PUT / API /（版）/接続/（token_addressを）
- 指定されたトークンネットワークを削除：DELETE / API /（版）/接続/（token_address）
お支払い関連のAPI
- ：支払開始POST / API /（版）/支払/（token_address）/（TARGET_ADDRESSを）
- クエリ支払い履歴：GET / API / V1 /支払/（token_address）/（TARGET_ADDRESS）

オリジナルリンク：イーサネットネットワークAPIドキュメント広場雷-ワイズネット