Skip to content

Commit cffebc3

Browse files
mDuo13shekenahglory
mDuo13
authored and
shekenahglory
committed
Clean up README for v2.4.0 changes
1 parent 5b7cbd2 commit cffebc3

File tree

1 file changed

+73
-27
lines changed

1 file changed

+73
-27
lines changed

‎README.md‎

Lines changed: 73 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ The Ripple Data API v2 replaces the Historical Database v1 and the [Charts API](
2626
[v2.3.0]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.0
2727
[v2.3.2]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.2
2828
[v2.3.5]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.5
29+
[v2.3.7]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.7
30+
[v2.4.0]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.4.0
2931

3032

3133
# API Method Reference
@@ -82,10 +84,8 @@ Validation Network Methods:
8284
* [Get Topology Nodes - `GET /v2/network/topology/nodes`](#get-topology-nodes)
8385
* [Get Topology Node - `GET /v2/network/topology/nodes/{pubkey}`](#get-topology-node)
8486
* [Get Topology Links - `GET /v2/network/topology/links`](#get-topology-links)
85-
* [Get Validations - `GET /v2/network/validations`](#get-validations)
8687
* [Get Validator - `GET /v2/network/validators/{pubkey}`](#get-validator)
8788
* [Get Validators - `GET /v2/network/validators`](#get-validators)
88-
* [Get Validator Validations - `GET /v2/network/validators/{pubkey}/validations`](#get-validator-validations)
8989
* [Get Validator Manifests - `GET /v2/network/validators/{pubkey}/manifests`](#get-validator-manifests)
9090
* [Get Single Validator Reports - `GET /v2/network/validators/{pubkey}/reports`](#get-single-validator-reports)
9191
* [Get Daily Validator Reports - `GET /v2/network/validator_reports`](#get-daily-validator-reports)
@@ -2642,7 +2642,7 @@ Response:
26422642
## Get Validator
26432643
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routes/network/getValidators.js "Source")
26442644

2645-
Get details of a single validator in the [consensus network](https://developers.ripple.com/consensus.html). _(New in [v2.2.0][])_
2645+
Get details of a single validator in the [consensus network](https://developers.ripple.com/consensus.html). _(Updated in [v2.4.0][])_
26462646

26472647

26482648
#### Request Format
@@ -2657,6 +2657,8 @@ GET /v2/network/validators/{pubkey}
26572657

26582658
<!-- MULTICODE_BLOCK_END -->
26592659

2660+
[Try it! >](https://developers.ripple.com/data-api-v2-tool.html#get-validator)
2661+
26602662
This method requires the following URL parameters:
26612663

26622664
| Field | Value | Description |
@@ -2678,12 +2680,12 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
26782680
| `result` | String | The value `success` indicates that the body represents a successful response. |
26792681
| `validation_public_key` | String - Base-58 [Public Key][] | This validator's validator public key. |
26802682
| `domain` | String | (May be omitted) The DNS domain associated with this validator. |
2681-
| `chain` | String | Ledger hash chain which this validator is currently following. |
2683+
| `chain` | String | Ledger hash chain which this validator is currently following. The value `main` indicates the main network and `altnet` indicates the XRP Test Network. Other forks are named `chain.{NUMBER}`, where `{NUMBER}` is a unique number for each fork. |
26822684
| `unl` | Bool | True if the validator is part of the ledger chain's recommended UNL. |
26832685
| `current_index` | Number | Ledger index of most recently validated ledger. |
26842686
| `partial` | Bool | True if the most recent validation was a partial one. |
26852687
| `agreement_1h` | Agreement Object | Object containing agreement stats for the most recent hour. |
2686-
| `aggreement_24h` | Agreement Object | Object containing agreement stats for the most recent 24 hour period. |
2688+
| `agreement_24h` | Agreement Object | Object containing agreement stats for the most recent 24 hour period. |
26872689

26882690
#### Agreement Objects
26892691

@@ -2699,7 +2701,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
26992701
Request:
27002702

27012703
```
2702-
GET /v2/network/validators/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7
2704+
GET /v2/network/validators/nHBidG3pZK11zQD6kpNDoAhDxH6WLGui6ZxSbUx7LSqLHsgzMPec
27032705
```
27042706

27052707
Response:
@@ -2734,7 +2736,7 @@ Response:
27342736
## Get Validators
27352737
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routes/network/getValidators.js "Source")
27362738

2737-
Get a list of known validators active in the last 24 hours. _(New in [v2.2.0][])_
2739+
Get a list of known validators active in the last 24 hours. _(Updated in [v2.4.0][])_
27382740

27392741

27402742
#### Request Format
@@ -2768,17 +2770,18 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
27682770
| `validators` | Array of [Validator Objects][] | List of validators active in the last 24 hours. |
27692771

27702772
#### Validator Objects
2773+
[Validator Objects]: #validator-objects
27712774

27722775
| Field | Value | Description |
27732776
|:------------------------|:--------------------------------|:-----------------|
27742777
| `validation_public_key` | String - Base-58 [Public Key][] | This validator's validator public key. |
27752778
| `domain` | String | (May be omitted) The DNS domain associated with this validator. |
2776-
| `chain` | String | Ledger hash chain which this validator is currently following. |
2777-
| `unl` | Bool | True if the validator is part of the ledger chain's UNL. |
2779+
| `chain` | String | Ledger hash chain which this validator is currently following. The value `main` indicates the main network and `altnet` indicates the XRP Test Network. Other forks are named `chain.{NUMBER}`, where `{NUMBER}` is a unique number for each fork. |
2780+
| `unl` | Bool | True if the validator is part of the ledger chain's recommended UNL. |
27782781
| `current_index` | Number | Ledger index of most recently validated ledger. |
27792782
| `partial` | Bool | True if the most recent validation was a partial one. |
27802783
| `agreement_1h` | Agreement Object | Object containing agreement stats for the most recent hour. |
2781-
| `aggreement_24h` | Agreement Object | Object containing agreement stats for the most recent 24 hour period. |
2784+
| `agreement_24h` | Agreement Object | Object containing agreement stats for the most recent 24 hour period. |
27822785

27832786
#### Agreement Objects
27842787

@@ -2824,7 +2827,29 @@ Response:
28242827
},
28252828
"partial": false,
28262829
"unl": true
2827-
}
2830+
},
2831+
{
2832+
"validation_public_key": "nHUStq4qu3NXaL6T42wbtpR8mare8gWMVYrUzek227c6QeUn6QGN",
2833+
"domain": "blockchain.korea.ac.kr",
2834+
"chain": "main",
2835+
"current_index": 42860792,
2836+
"agreement_1h": {
2837+
"missed": 0,
2838+
"total": 995,
2839+
"score": "1.0000",
2840+
"incomplete": false
2841+
},
2842+
"agreement_24h": {
2843+
"missed": 0,
2844+
"total": 23478,
2845+
"score": "1.0000",
2846+
"incomplete": false
2847+
},
2848+
"partial": false,
2849+
"unl": true
2850+
},
2851+
2852+
...
28282853
]
28292854
}
28302855
```
@@ -2834,7 +2859,7 @@ Response:
28342859
## Get Validator Manifests
28352860
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routes/network/getManifests.js "Source")
28362861

2837-
Retrieve manifests signed by a specified validator, used to designate ephemeral key to sign proposals and validations. _(New in [v2.3.7][])_
2862+
Retrieve manifests signed by a specified validator. (Manifests, also called _subkey authorizations_, designate the ephemeral key a validator uses to sign proposals and validations.) _(New in [v2.3.7][])_
28382863

28392864
**Note:** The Data API does not have a comprehensive record of all manifests. The response only includes data that the Data API has recorded.
28402865

@@ -2850,6 +2875,8 @@ GET /v2/network/validators/{pubkey}/manifests
28502875

28512876
<!-- MULTICODE_BLOCK_END -->
28522877

2878+
[Try it! >](https://developers.ripple.com/data-api-v2-tool.html#get-validator-manifests)
2879+
28532880
This method requires the following URL parameters:
28542881

28552882
| Field | Value | Description |
@@ -2875,6 +2902,21 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
28752902
| `marker` | String | (May be omitted) [Pagination](#pagination) marker. |
28762903
| `manifests` | Array of [Manifest Objects][] | The requested manifests. |
28772904

2905+
#### Manifest Objects
2906+
[Manifest Objects]: #manifest-objects
2907+
2908+
Each manifest object contains the following:
2909+
2910+
| Field | Value | Description |
2911+
|:-----------------------|:--------------------------------|:------------------|
2912+
| `count` | Number | How many times the Data API has seen this manifest. Lower numbers mean the manifest is more recent. |
2913+
| `ephemeral_public_key` | String - Base-58 [Public Key][] | The ephemeral public key for this validator encoded in this manifest. |
2914+
| `first_datetime` | String - [Timestamp][] | The time the Data API first saw this manifest. |
2915+
| `last_datetime` | String - [Timestamp][] | The time the Data API most recently saw this manifest. |
2916+
| `master_public_key` | String - Base-58 [Public Key][] | The master public key that identifies this validator. |
2917+
| `master_signature` | String - Hexadecimal | Signature from the validator master key authorizing this manifest. |
2918+
| `sequence` | Number | The sequence number of this manifest. Higher-sequence manifests replace older manifests, rotating the ephemeral keys. |
2919+
| `signature` | String - Hexadecimal | Signature from ephemeral key authorized by this manifest. |
28782920

28792921
#### Example
28802922

@@ -2924,7 +2966,7 @@ Response:
29242966
## Get Single Validator Reports
29252967
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routes/network/getValidatorReports.js "Source")
29262968

2927-
Get a single validator's validation vote stats for 24-hour intervals.
2969+
Get a single validator's validation vote stats for 24-hour intervals. _(Updated in [v2.4.0][])_
29282970

29292971
#### Request Format
29302972

@@ -2962,16 +3004,19 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
29623004
| Field | Value | Description |
29633005
|:-------------|:-----------------------------------------|:-------------------|
29643006
| `result` | String | The value `success` indicates that the body represents a successful response. |
2965-
| `count` | Integer | Number of validators returned. |
2966-
| `reports` | Array of Single Validator Report Objects | Daily reports of this validator's validation votes. |
3007+
| `count` | Integer | Number of validator daily reports returned. |
3008+
| `reports` | Array of [Single Validator Report Objects][] | Daily reports of each validator's performance on that day. |
3009+
3010+
##### Single Validator Report Objects
3011+
[Single Validator Report Objects]: #single-validator-report-objects
29673012

2968-
Each member in the `reports` array is a Single Validator Report Object with data on that validator's performance on that day. Each has the following fields:
3013+
Each Single Validator Report Object describes a validator's performance on a given day and has the following fields:
29693014

29703015
| Field | Value | Description |
29713016
|:---------------------|:--------------------------------|:-----------------------------|
2972-
| `validation_public` | String - Base-58 [Public Key][] | Validator public key. |
3017+
| `validation_public_key` | String - Base-58 [Public Key][] | Validator public key. |
29733018
| `date` | String - [Timestamp][] | The start time of the date this object describes. |
2974-
| `chain` | String | Ledger hash chain which this validator is currently following. |
3019+
| `chain` | String | Ledger hash chain which this validator is currently following. The value `main` indicates the main network and `altnet` indicates the XRP Test Network. Other forks are named `chain.{NUMBER}`, where `{NUMBER}` is a unique number for each fork. |
29753020
| `score` | String | Score of agreement with the ledger chain being followed. |
29763021
| `missed` | Integer | Number of ledgers not validated during the time period. |
29773022
| `total` | Integer | Number of ledgers that could have been validated during the time period. |
@@ -3021,7 +3066,7 @@ Response:
30213066
## Get Daily Validator Reports
30223067
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routes/network/getValidatorReports.js "Source")
30233068

3024-
Get a validation vote stats and validator information for all known validators in a 24-hour period.
3069+
Get validation vote stats and validator information for all known validators in a 24-hour period.
30253070

30263071
#### Request Format
30273072

@@ -3052,17 +3097,18 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
30523097
|:----------|:----------------------------------------|:-----------------------|
30533098
| `result` | String | The value `success` indicates that the body represents a successful response. |
30543099
| `count` | Integer | Number of reports returned. |
3055-
| `reports` | Array of Daily Validator Report Objects | Summaries of activity for each validator active during this time period. |
3100+
| `reports` | Array of [Daily Validator Report Objects][] | Daily summaries of validator performance for each validator active during this time period. |
30563101

3057-
Daily Validator Report Object fields:
3102+
#### Daily Validator Report Objects
3103+
[Daily Validator Report Objects]: #daily-validator-report-objects
30583104

3059-
Each member in the `reports` array is a Single Validator Report Object with data on that validator's performance on that day. Each has the following fields:
3105+
Each member in the `reports` array describes one validator's performance on that day and has the following fields:
30603106

30613107
| Field | Value | Description |
30623108
|:---------------------|:--------------------------------|:-----------------------------|
3063-
| `validation_public` | String - Base-58 [Public Key][] | Validator public key. |
3109+
| `validation_public_key` | String - Base-58 [Public Key][] | Validator public key. |
30643110
| `date` | String - [Timestamp][] | The start time of the date this object describes. |
3065-
| `chain` | String | Ledger hash chain which this validator is currently following. |
3111+
| `chain` | String | Ledger hash chain which this validator is currently following. The value `main` indicates the main network and `altnet` indicates the XRP Test Network. Other forks are named `chain.{NUMBER}`, where `{NUMBER}` is a unique number for each fork. |
30663112
| `score` | String | Score of agreement with the ledger chain being followed. |
30673113
| `missed` | Integer | Number of ledgers not validated during the time period. |
30683114
| `total` | Integer | Number of ledgers that could have been validated during the time period. |
@@ -3091,7 +3137,7 @@ Response:
30913137
"score": "0.6909",
30923138
"total": "16127",
30933139
"missed": "7216"
3094-
},
3140+
}
30953141
]
30963142
}
30973143
```
@@ -3306,7 +3352,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
33063352
| `start_date` | String - [Timestamp][] | The approximate date of the first time exchanges for this gateway's currencies appeared in the ledger. |
33073353
| `accounts` | Array | A list of [issuing addresses](https://developers.ripple.com/issuing-and-operational-addresses.html) used by this gateway. (Gateways may use different issuing accounts for different currencies.) |
33083354
| `hotwallets` | Array of [Address][]es | This gateway's [operational addresses](https://developers.ripple.com/issuing-and-operational-addresses.html). |
3309-
| `domain` | String | The domain name where this gateway does business. Typically the gateway hosts a [`ripple.txt`](https://wiki.ripple.com/Ripple.txt) there. |
3355+
| `domain` | String | The domain name where this gateway does business. |
33103356
| `normalized` | String | A normalized version of the `name` field suitable for including in URLs. |
33113357
| `assets` | Array of Strings | Graphics filenames available for this gateway, if any. (Mostly, these are logos used by XRP Charts.) |
33123358

@@ -5403,4 +5449,4 @@ Example usage:
54035449
```
54045450
// get ledgers #1,000,000 to #2,000,000 (inclusive) and store in HBase
54055451
node import/hbase/backfill --startIndex 2000000 --stopIndex 1000000
5406-
```
5452+
```

0 commit comments

Comments
 (0)