cerc-io/lighthouse
15
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Flesh spec. & update display bugs.

Browse Source 
- Add correct string formatting when incorrect parameters provided.
 - Fill /beacon/block and /beacon/block_root endpoints
 - Add 500 error responses to endpoints as appropriate
This commit is contained in:
Luke Anderson 2019-08-29 13:36:51 +10:00
parent 5b5e458938
commit b9276da9db
No known key found for this signature in database
GPG Key ID: 44408169EC61E228
2 changed files with 69 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
beacon_node/rest_api/src/beacon.rs
View File

@ -81,7 +81,7 @@ pub fn get_block<T: BeaconChainTypes + 'static>(req: Request<Body>) -> ApiResult
let target = parse_slot(&value)?;
block_root_at_slot(&beacon_chain, target).ok_or_else(|| {
ApiError::NotFound(format!("Unable to find BeaconBlock for slot {}", target))
ApiError::NotFound(format!("Unable to find BeaconBlock for slot {:?}", target))
})?
}
("root", value) => parse_root(&value)?,
@ -93,7 +93,7 @@ pub fn get_block<T: BeaconChainTypes + 'static>(req: Request<Body>) -> ApiResult
.get::<BeaconBlock<T::EthSpec>>(&block_root)?
.ok_or_else(|| {
ApiError::NotFound(format!(
"Unable to find BeaconBlock for root {}",
"Unable to find BeaconBlock for root {:?}",
block_root
))
})?;
@ -121,7 +121,7 @@ pub fn get_block_root<T: BeaconChainTypes + 'static>(req: Request<Body>) -> ApiR
let target = parse_slot(&slot_string)?;
let root = block_root_at_slot(&beacon_chain, target).ok_or_else(|| {
ApiError::NotFound(format!("Unable to find BeaconBlock for slot {}", target))
ApiError::NotFound(format!("Unable to find BeaconBlock for slot {:?}", target))
})?;
let json: String = serde_json::to_string(&root)
@ -174,7 +174,7 @@ pub fn get_state<T: BeaconChainTypes + 'static>(req: Request<Body>) -> ApiResult
let state = beacon_chain
.store
.get(root)?
.ok_or_else(|| ApiError::NotFound(format!("No state for root: {}", root)))?;
.ok_or_else(|| ApiError::NotFound(format!("No state for root: {:?}", root)))?;
(*root, state)
}

69
docs/api_spec.yaml
View File

@ -248,9 +248,6 @@ paths:
format: uint64
description: "UNIX time in milliseconds that the block was first discovered, either from a network peer or the validator client."
/beacon/head:
get:
tags:
@ -307,13 +304,75 @@ paths:
format: bytes
pattern: "^0x[a-fA-F0-9]{64}$"
description: "The block root of the second most recent justified block."
500:
$ref: '#/components/responses/InternalError'
#TODO Fill out block endpoint
/beacon/block:
get:
tags:
- Phase0
summary: 'Retrieve blocks by root or slot.'
description: "Request that the beacon node return beacon chain blocks that match the provided criteria (a block root or beacon chain slot). Only one of the parameters can be be provided at a time."
parameters:
- name: root
description: "Filter by block root."
in: query
required: false
schema:
type: string
format: bytes
pattern: "^0x[a-fA-F0-9]{64}$"
- name: slot
description: "Filter blocks by slot number. Only one block which has been finalized, or is believed to be the canonical block for that slot, is returned."
in: query
required: false
schema:
type: integer
format: uint64
responses:
200:
description: Success response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BeaconBlock'
400:
$ref: '#/components/responses/InvalidRequest'
500:
$ref: '#/components/responses/InternalError'
#TODO Fill out block_root endpoint
/beacon/block_root:
get:
tags:
- Phase0
summary: "Retrieve the canonical block root, given a particular slot."
description: "Request that the beacon node return the root of the canonical beacon chain block, which matches the provided slot number."
parameters:
- name: slot
description: "Filter blocks by slot number. Only one block which has been finalized, or is believed to be the canonical block for that slot, is returned."
in: query
required: true
schema:
type: integer
format: uint64
responses:
200:
description: Success response.
content:
application/json:
schema:
type: string
format: byte
pattern: "^0x[a-fA-F0-9]{64}$"
description: "The 0x prefixed block root."
400:
$ref: '#/components/responses/InvalidRequest'
500:
$ref: '#/components/responses/InternalError'
/beacon/blocks:
get:
@ -373,6 +432,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Fork'
500:
$ref: '#/components/responses/InternalError'
/beacon/attestations: