Validator
Get latest data requests
GET /data-requests
Description
Retrieve the latest block headers. If at least one data request is present in a block, the block data is also returned. The notion of "latest" is determined by the query parameter oldBlockHeight
and the ledger's current height. Validators use this endpoint to get the latest relevant blocks, extract the data requests in them, and respond to the data requests accordingly.
Using the block data, one can compute the data hash and verify consistency of the block header. In addition, using the block headers, one can verify the blocks are chained.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
oldBlockHeight | query | integer | true | Number of blocks the validator has already processed |
Example
GET /data-requests?oldBlockHeight=1
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | Succeeded | Inline | |
400 | Bad Request | Request is invalid | |
401 | API key is missing or invalid |
200 OK
Successfully retrieved the blocks and block data which contain data requests.
Schema
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ok | boolean | true | none | none |
blocks | dict<BlockNumber, Block> | true | none | none |
Example
400 Bad Request
Request is malformed. Make sure:
oldBlockHeight
is present in query parameteroldBlockHeight
is a non-negative numberoldBlockHeight
is an integeroldBlockHeight
is valid - no larger than the current block height of the ledger
Example 1
Example 2
401 Unauthorized
API key is missing or incorrect.
Example
Get hashed trustee shares in an Encryption
Encryption
GET /encryptions/{token-hash}/hashed-trustee-shares
Description
Retrieves all the hashed trustee share from an Encryption
. After receiving a new data request, before the validator attempt to respond to it, it should check if the threshold number of trustees have correctly responded to the data request. It can do this by checking consistent the shares and their hashes uploaded by the encryptor at encryption time. The former are the return values of this endpoint.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
token-hash | path | true | Hash value of the token |
Example
GET /encryptions/d033713dd14552c060c55746afdb989cfee8e624ae94a932d79fd25630f728a4/hashed-trustee-shares
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | Succeeded | Inline | |
401 | API key is missing or invalid | ||
404 | Not Found | Encryption not found |
200 OK
Successfully retrieved the hashed trustee shares.
Schema
Name | Type | Required | Description |
---|---|---|---|
ok | boolean | true | none |
hashedTrusteeShare | true | A mapping from a trustee ID to its hashed share |
Example
401 Unauthorized
API key is missing or incorrect.
Example
404 Not Found
The encryption does not exist.
Example
Get encrypted validator share in an Encryption
Encryption
GET /encryptions/{token-hash}/encrypted-validator-shares/{validator-id}
Description
Retrieves an encrypted validator share from an Encryption
. After receiving a new data request, a validator should use this endpoint to get its encrypted share from the corresponding Encryption
, decrypt it with its decryption key, then post the result with postValidatorResponse.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
token-hash | path | true | Hash value of the token | |
validator-id | path | true | The validator's ID |
Example
GET /encryptions/d033713dd14552c060c55746afdb989cfee8e624ae94a932d79fd25630f728a4/encrypted-validator-shares/validator1
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | Succeeded | Inline | |
400 | Bad Request | Request is invalid | |
401 | API key is missing or invalid | ||
404 | Not Found | Encryption not found |
200 OK
Successfully retrieved the encrypted validator share.
Schema
Name | Type | Required | Description |
---|---|---|---|
ok | boolean | true | none |
encryptedValidatorShare | true | The encrypted validator share |
Example
400 Bad Request
Validator does not exist or does not reference this PAD instance.
Example
401 Unauthorized
API key is missing or incorrect.
Example
404 Not Found
The encryption does not exist.
Example
Post validator response
POST /data-requests/{token}/validator-responses
Description
Posts a validator response to the ledger.
After retrieving and finish decrypting its share, the validator needs to post the result back to the ledger so that eventually, the decryptor can decrypt a secret. The validator shares combining also reveals the identity of the decryptor.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
token | path | true | ID of the data request | |
- | body | true | The decrypted share, along with a digital signature of the validator and some metadata |
Example
POST /data-requests/e3b0c44298fc1c149afbf4c8996fb924/validator-responses
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | Succeeded | ||
400 | Bad Request | Data request and trustee response are inconsistent | |
401 | API key is missing or invalid | ||
403 | Forbidden | Trustee is not in the instance | |
404 | Not found | Data request not found | |
409 | Conflict | Response has been made before |
200 OK
Validator response is successfully post.
Example
400 Bad request
Request is invalid. Make sure that :
padName
inValidatorResponse
is consistent with the PAD instance to which the API key is pointingtoken
in path andValidatorResponse
are consistentvalidatorId
inValidatorResponse
andsignature
are consistentrole
isValidator
insignature
signature in
signature
is consistent with the payloadValidatorResponse
Example 1
example 2
example 3
401 Unauthorized
Api key is missing or invalid.
Example
403 Forbidden
The validator is not part of the instance. Recall that the list of validators is determined by the Operator at instance creation time.
Example
404 Not Found
The server cannot find a data request pointed by the token in the path parameter.
Example
409 Conflict
A response from the same validator has been made for the same data request before.
Example
Schemas
ApiResponse
Example
Schema
Name | Type | Required | Description |
---|---|---|---|
ok | boolean | true | The request is successful or not |
message | string | true | none |
BlockNumber
ID of a block. It is an incremental index starting from 0. For example, if a ledger has height 10, then it has blocks 0, 1, ..., 9. The next block has block number 10.
Schema
Type | Restrictions |
---|---|
integer | Non-negative |
Block
Blocks are put sequentially as a blockchain to form a ledger. It consists of the header (which contains the chaining information) and optionally the data (from which data requests and trustee and validator responses can be extracted).
Example 1
Example 2
Schema
Name | Type | Required | Description |
---|---|---|---|
header | true | none | |
data | false | none |
BlockHeader
Block header contains metadata of a block. They are sufficient to prove the blocks form a chain without the need of block data, because the previousHash
field in the schema refers to the hash of the previous block header, instead of the entire previous block. Thus, if the block data is irrelevant (for example not containing any data request when one is asking for them), it can be skipped.
If the block number is 0, the number
and previousHash
fields are empty. dataHash
is computed with the same block's data. Refer to code samples on how to compute hash of a block header.
Example 1
Example 2
Schema
Name | Type | Required | Description |
---|---|---|---|
number | false | Block number of the current block | |
previousHash | false | Hash of the previous block's header | |
dataHash | true | Hash of this block's data |
BlockData
Block data contains "transactions". In PAD, these are the data requests and trustee and validator responses. See code samples to see how block data are decoded.
Example
Schema
Name | Type | Required | Description |
---|---|---|---|
data | array<Base64> | true | none |
Base64
A base64-encoded binary data.
Example
Schema
Type | Restrictions |
---|---|
string | none |
Sha256
A Sha256 hash value as a hexidecimal string.
Example
Schema
Type | Restrictions |
---|---|
string |
|
TrusteeId
ID of a trustee. It contains only alphanumerical characters, underscores (_) and dashes (-). It has length inclusively between 3 and 30.
Example
Schema
Type | Restrictions |
---|---|
string |
|
ValidatorId
ID of a validator. It contains only alphanumerical characters, underscores (_) and dashes (-). It has length inclusively between 3 and 30.
Example
Schema
Type | Restrictions |
---|---|
string |
|
Token
A 128-bit random string kept secret between the encryptor and decryptor after encryption stage and before data request stage. It identifies a data request. Its hash value identifies an encryption
. The decryptor posts it on the ledger at data request stage.
Example
Schema
Type | Restrictions |
---|---|
string |
|
PadName
ID of a PAD instance. Its length must be inclusively between 4 and 30. It should contains only lowercase letters, digits, periods (.
) or dashes (-
). It must start with a lowercase letter.
It is seldom used as a request parameter because the API key in the request already identifies a PAD instance.
Example
Schema
Type | Restrictions |
---|---|
string |
|
ValidatorResponse
A validator response to a data request. It contains the decrypted validator share for the decryptor to perform a full decryption on a secret. It also consists of metadata for identifying the corresponding data request.
Example
Schema
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
padName | true | none | The instance where the data request is posted | |
token | true | none | The ID of the data request | |
validatorShare | true | none | The decrypted validator share | |
type | enum | true | none | Type of response |
validatorId | true | none | ID of the responding validator |
Enumerated Values
Property | Value |
---|---|
type |
|
SignedValidatorResponse
A validator response attached with a digital signature for everyone to validate the response's integrity.
Note that the validator response is represented as a string (instead of an object). This ensures that there is a unified way to verify the signature.
Example
Schema
Name | Type | Required | Description |
---|---|---|---|
validatorResponse | string<ValidatorResponse> | true | none |
signature | true | none |
Participant
Metadata of a participant in PAD. It can currently be used to describe a trustee or a validator.
Example
Schema
Name | Type | Required | Description |
---|---|---|---|
id | true |
| |
fullName | string | true |
|
role | enum | true | none |
Enumerated Values
Property | Value |
---|---|
role | Trustee |
role | Validator |
role | Server |
Signature
A digital signature. It consists of the metadata of the signer, including its ID, and the signature payload encoded in base64.
Schema
Schema
Name | Type | Required | Description |
---|---|---|---|
signerMetadata | false | none | |
payload | false | none |
Last updated