Skip to content
This repository has been archived by the owner on Jun 19, 2024. It is now read-only.

Commit

Permalink
fix: Add more documentation for other available endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
neithanmo committed Dec 27, 2023
1 parent b7e22a7 commit 40b6db4
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions docs/04-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The JSON server is written in Rust. It is using `axum` to create endpoints. It r
## Configuration

Settings.toml

```
log_level = "info"
Expand All @@ -21,39 +22,61 @@ serve_at = "0.0.0.0"
port = 30303
```

## Enpoints
## Block Endpoints

The list of endpoints available.

## /block/height/:block_height
### /block/height/:block_height

This enpoint look for a specific block by its `height`.

Example:

```
$ curl -H 'Content-Type: application/json' localhost:30303/block/height/1
```

## /block/hash/:block_hash
### /block/hash/:block_hash

This endpoint look for a specific block by its `hash`.
Example:

```
$ curl -H 'Content-Type: application/json' localhost:30303/block/hash/9d6dad4409536ab763c0b814379be71ad1f9176efe17292f143831fbad72109c
```

## /block/last
### /block/last

This endpoint will return the last block indexed.
Example:

```
$ curl -H 'Content-Type: application/json' localhost:30303/block/last
```

## /tx/:tx_hash
## Transaction Endpoints

### /tx/:tx_hash

This endpoint will look for a specific transaction identified by tx_hash.
Example:

```
$ curl -H 'Content-Type: application/json' localhost:30303/tx/c602b2f3b88811bfd7f3fdf866af3b1487bfd21c5b5ea7f7f9a16fb6bb915c24
```

### /tx/shielded

This endpoint returns a list of the shielded assets and their total compiled using all the shielded transactions (in, internal and out)

```
$ curl -H 'Content-Type: application/json' localhost:30303/tx/shielded
```

### /tx/vote_proposal/:proposal_id

This endpoint will look for a vote proposal identified by proposal_id(integer)

```
$ curl -H 'Content-Type: application/json' localhost:30303/tx/shielded
```

0 comments on commit 40b6db4

Please sign in to comment.