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

improve api-bn.md (#4244)

Browse Source 
## Issue Addressed

NA

## Proposed Changes

improve doc `api-bn.md` to make user convenient to copy and run the command. 

## Additional Info

NA
This commit is contained in:
int88 2023-05-05 00:51:58 +00:00
parent 6d8d212da8
commit 60d13c3fea
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
book/src/api-bn.md
View File

@ -72,8 +72,7 @@ specification][OpenAPI].
Returns the block header at the head of the canonical chain. Returns the block header at the head of the canonical chain.
```bash ```bash
curl -X GET "http://localhost:5052/eth/v1/beacon/headers/head" -H "accept: curl -X GET "http://localhost:5052/eth/v1/beacon/headers/head" -H "accept: application/json" | jq
application/json"
``` ```
```json ```json
@ -100,7 +99,7 @@ application/json"
Shows the status of validator at index `1` at the `head` state. Shows the status of validator at index `1` at the `head` state.
```bash ```bash
curl -X GET "http://localhost:5052/eth/v1/beacon/states/head/validators/1" -H "accept: application/json" curl -X GET "http://localhost:5052/eth/v1/beacon/states/head/validators/1" -H "accept: application/json" | jq
``` ```
```json ```json
@ -159,8 +158,7 @@ The API is now being served at `https://localhost:5052`.
To test connectivity, you can run the following: To test connectivity, you can run the following:
```bash ```bash
curl -X GET "https://localhost:5052/eth/v1/node/version" -H "accept: application/json" --cacert cert.pem curl -X GET "https://localhost:5052/eth/v1/node/version" -H "accept: application/json" --cacert cert.pem | jq
``` ```
### Connecting a validator client ### Connecting a validator client
In order to connect a validator client to a beacon node over TLS, the validator In order to connect a validator client to a beacon node over TLS, the validator
@ -203,7 +201,7 @@ Ensure the `--http` flag has been supplied at the CLI.
You can quickly check that the HTTP endpoint is up using `curl`: You can quickly check that the HTTP endpoint is up using `curl`:
```bash ```bash
curl -X GET "http://localhost:5052/eth/v1/node/version" -H "accept: application/json" curl -X GET "http://localhost:5052/eth/v1/node/version" -H "accept: application/json" | jq
``` ```
The beacon node should respond with its version: The beacon node should respond with its version: