Skip to content

Commit

Permalink
docs: add liveness endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
QEDK committed Jan 4, 2024
1 parent e09b2ca commit 423859c
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ RUSTFLAGS="-C target-cpu=native" cargo run --profile maxperf

## Usage
* The bridge API operates on the 8080 port by default (can be configured).
* To verify that the API is live, you can query the root like:
```bash
# curl <endpoint URL>
curl http://localhost:8080
# should return:
# {"name":"Avail Bridge API"}
```
* To generate a proof, simply query the `/proof` endpoint with the block hash and extrinsic index like (both are
required):
```bash
Expand Down

0 comments on commit 423859c

Please sign in to comment.