Skip to content

Commit e4f30b3

Browse files
authored
bsc-api-list.md: update verifiedValidatorNum doc (#572)
1 parent a498198 commit e4f30b3

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

docs/bnb-smart-chain/developers/json_rpc/bsc-api-list.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,10 @@ This will return block hashes:
6363
These methods allow you to handle block finality using a straightforward API.
6464

6565
### eth_getFinalizedHeader
66-
* `verifiedValidatorNum` must be within the range [1, len(currentValidators)].
66+
* `verifiedValidatorNum` must be within the range `[1, len(currentValidators)]`,with the exception that:
67+
- `-1` represents at least `len(currentValidators) * 1/2`
68+
- `-2` represents at least `len(currentValidators) * 2/3`
69+
- `-3` represents at least `len(currentValidators)`
6770
* This function calculates `probabilisticFinalizedHeight` as the highest height of the block verified by `verifiedValidatorNum` validators and then returns the block header with a height equal to `max(fastFinalizedHeight, probabilisticFinalizedHeight)`.
6871
* The height of the returned block header is guaranteed to increase monotonically.
6972
For example:
@@ -72,7 +75,10 @@ curl -X POST "http://localhost:8545/" -H "Content-Type: application/json" --dat
7275
```
7376

7477
### eth_getFinalizedBlock
75-
* `verifiedValidatorNum` must be within the range [1, len(currentValidators)].
78+
* `verifiedValidatorNum` must be within the range `[1, len(currentValidators)]`,with the exception that:
79+
- `-1` represents at least `len(currentValidators) * 1/2`
80+
- `-2` represents at least `len(currentValidators) * 2/3`
81+
- `-3` represents at least `len(currentValidators)`
7682
* This function calculates `probabilisticFinalizedHeight` as the highest height of the block verified by `verifiedValidatorNum` validators and then returns the block header with a height equal to `max(fastFinalizedHeight, probabilisticFinalizedHeight)`.
7783
* If `fullTx` is true, the block includes all transactions; otherwise, only transaction hashes are included.
7884
* The height of the returned block is guaranteed to be monotonically increasing.

0 commit comments

Comments
 (0)