Improve delegators rpc by adding count, start, and threshold parameters

#597
nanocurrency · Nov 24, 2021 · 320c37c · 320c37c
1 parent 8fc0500
commit 320c37c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/docs/commands/rpc-protocol.md b/docs/commands/rpc-protocol.md
@@ -1416,7 +1416,7 @@ Returns a list of open database transactions which are equal or greater than the
 
 ### delegators  
 _version 8.0+_   
-Returns a list of pairs of delegator names given **account** a representative and its balance  
+Returns a list of pairs of delegator accounts and balances given a representative **account**
 
 **Request:**
 ```json
@@ -1435,6 +1435,13 @@ Returns a list of pairs of delegator names given **account** a representative an
 }
 ```   
 
+**Optional parameters:**  
+_since V23.0_  
+
+* `threshold`: minimum required balance for a delegating account to be included in the response
+* `count`: number of delegators to return
+* `start`: account in the list you would like to start after, to allow for paging responses
+
 ---
 
 ### delegators_count  

diff --git a/docs/releases/release-v23-0.md b/docs/releases/release-v23-0.md
@@ -22,6 +22,7 @@ description: Details of the V23.0 nano node release including upgrade notices, m
 * [`account_history`](../commands/rpc-protocol.md#account_history) RPC now includes whether the block was `confirmed` in the response, allowing more efficient confirmation validation in some cases.
 * **NEW** [`accounts_representatives`](../commands/rpc-protocol.md#accounts_representatives) RPC allows requesting representatives from multiple accounts in a single call.
 * [`block_info`](../commands/rpc-protocol.md#block_info) and [`blocks_info`](../commands/rpc-protocol.md#blocks_info) RPCs now include the `successor` block hash in responses for easier ledger walking.
+* [`delegators`](../commands/rpc-protocol.md#delegators) now allows for optional parameters `count` (to limit number of returned accounts), `threshold` (to require a minimum balance for returned delegators) and `start` (to allow paging by providing account to start after).
 
 ---