doc(federation): add /list-crosschain-txs docs (#222)

[bytom/vapor.git] / docs / federation / README-en.md

diff --git a/docs/federation/README-en.md b/docs/federation/README-en.md
index cbec063..907ee83 100644 (file)
--- a/docs/federation/README-en.md
+++ b/docs/federation/README-en.md
@@ -46,3 +46,118 @@ A `fed_cfg.json` would look like this:
     }
 }
 ```
+## API
+A federation node can function as an api server for querying cross-chain transactions.
+
+The default JSON-RPC endpoint is: [http://host:port/api/v1/federation/](http://host:port/api/v1/federation/)
+
+The response contains some meta data of:
+
++ success/error status, which can be told from `code` and `msg`;
++ pagination info, which can be told from `start`, `limit` and `_links` (`_links` is used to look up the preceding and the succeeding items);
+
+and looks like:
+```
+{
+  "code":200,
+  "msg":"",
+  "result":{
+    "_links":{
+    },
+    "data":...,
+    "limit":10,
+    "start":0
+  }
+}
+```
+
+If a request succeed, `data` field contains the detailed result as an object or as an array of objects.
+
+### Pagination
+
+Append `?start=<integer>&limit=<integer>` to the url in order to use pagination.
+
+### Methods
+
+#### `/list-crosschain-txs`
+
+To list cross-chain transactions and filter the transactions.
+
+##### Parameters
+
+<!--  -->
+
+Optional:
+
+- `Object` - *filter*, transactions filter.
+    + Optional
+        * `String` - *status*, transactions status, which can be `pending` or `completed`.
+        * `String` - *from_chain*, transactions source chain, which can be `bytom` or `vapor`.
+        * `String` - *source_tx_hash*, souce transaction hash string.
+        * `String` - *dest_tx_hash*, destination transaction hash string.
+- `Object` - *sort*, transactions sorter.
+    + Optional
+        * `String` - *order*, transactions order sorter, which can be `asc` or `desc`.
+
+
+##### Returns
+
+
+`Object`:
+
+- `String` - *from_chain*, source chain name of the cross-chain transaction.
+- `Integer` - *source_block_height*, block height of the cross-chain transaction on the source chain.
+- `String` - *source_block_hash*, block hash of the cross-chain transaction on the source chain.
+- `Integer` - *source_tx_index*, transaction index in the source block.
+- `String` - *source_tx_hash*, source transaction hash.
+- `Integer` - *dest_block_height*, block height of the cross-chain transaction on the destination chain, `0` if `status` is `pending`.
+- `String` - *dest_block_hash*, block hash of the cross-chain transaction on the destination chain, empty string if `status` is `pending`.
+- `Integer` - *dest_tx_index*, transaction index in the destination block, `0` if `status` is `pending`.
+- `String` - *dest_tx_hash*, destination transaction hash, empty string if `status` is `pending`.
+- `String` - *status*, cross-chain transaction status, can be `pending` or `completed`.
+- `Array of objects` - *crosschain_requests*, asset transfer details per request included in the cross-chain transaction.
+    + `Integer` - *amount*, asset transfer amount.
+    + `Object` - *asset*, asset detail.
+        * `String` - *asset_id*, asset id string.
+
+##### Example
+
+```js
+// Request
+curl -X POST 127.0.0.1:3000/api/v1/federation/list-crosschain-txs -d '{}'
+
+// Result
+{
+  "code":200,
+  "msg":"",
+  "result":{
+    "_links":{
+
+    },
+    "data":[
+      {
+        "from_chain":"bytom",
+        "source_block_height":174,
+        "source_block_hash":"569a3a5a43910ea634a947fd092bb3085359db451235ae59c20daab4e4b0d274",
+        "source_tx_index":1,
+        "source_tx_hash":"584d1dcc4dfe741bb3ae5b193896b08db469169e6fd76098eac132af628a3183",
+        "dest_block_height":0,
+        "dest_block_hash":"",
+        "dest_tx_index":0,
+        "dest_tx_hash":"",
+        "status":"pending",
+        "crosschain_requests":[
+          {
+            "amount":1000000,
+            "asset":{
+              "asset_id":"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+            }
+          }
+        ]
+      }
+    ],
+    "limit":10,
+    "start":0
+  }
+}
+```