add address filter (#225)

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

diff --git a/docs/federation/README-en.md b/docs/federation/README-en.md
index ff5628f..0b82b77 100644 (file)
--- a/docs/federation/README-en.md
+++ b/docs/federation/README-en.md
@@ -91,6 +91,7 @@ Optional:
     + Optional
         * `String` - *status*, transactions status, which can be `pending` or `completed`.
         * `String` - *source_chain_name*, transactions source chain, which can be `bytom` or `vapor`.
+        * `String` - *address*, filter cross-chain requests by address. The address can be either a mainchain or a sidechain one. Note that other requests in such a transaction will also be filtered. 
         * `String` - *source_tx_hash*, souce transaction hash string.
         * `String` - *dest_tx_hash*, destination transaction hash string.
 - `Object` - *sort*, transactions sorter.