feat: add root and single commitment levels

This commit is contained in:
Justin Starry
2020-05-20 17:12:09 +08:00
committed by Michael Vines
parent 1e1c9de367
commit 3b71ec1ff6
4 changed files with 18 additions and 11 deletions

View File

@ -89,12 +89,16 @@ function notificationResultAndContext(resultDescription: any) {
/**
* The level of commitment desired when querying state
* 'max': Query the most recent block which has reached max voter lockout
* 'recent': Query the most recent block
* <pre>
* 'max': Query the most recent block which has been finalized by the cluster
* 'recent': Query the most recent block which has reached 1 confirmation by the connected node
* 'root': Query the most recent block which has been rooted by the connected node
* 'single': Query the most recent block which has reached 1 confirmation by the cluster
* </pre>
*
* @typedef {'max' | 'recent'} Commitment
* @typedef {'max' | 'recent' | 'root' | 'single'} Commitment
*/
export type Commitment = 'max' | 'recent';
export type Commitment = 'max' | 'recent' | 'root' | 'single';
/**
* Configuration object for changing query behavior