Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pinax-network/blocktime-service
gRPC service for querying block ids or numbers from timestamps and dates (and vice-versa)
https://github.com/pinax-network/blocktime-service
Last synced: about 2 months ago
JSON representation
gRPC service for querying block ids or numbers from timestamps and dates (and vice-versa)
- Host: GitHub
- URL: https://github.com/pinax-network/blocktime-service
- Owner: pinax-network
- Created: 2023-07-11T19:51:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-19T19:14:35.000Z (over 1 year ago)
- Last Synced: 2024-04-23T10:07:32.033Z (9 months ago)
- Language: Rust
- Homepage:
- Size: 5.85 MB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/pinax-network/blocktime-service/actions/workflows/grpc_tests.yml)
# Blocktime Query Service
A gRPC service for querying a block id/number from a timestamp and vice-versa.
## Setup
Make sure to have the [`substreams-sink-kv`](https://github.com/streamingfast/substreams-sink-kv) tool installed and available in your `$PATH`.
**Populate the kv-store with data from the remote endpoint and start the gRPC server**
```bash
./start-kv-sink.sh
```
You can install the [`kvdb`](https://github.com/streamingfast/kvdb) tool to inspect the data stored in the *kv-store* locally:
```bash
go install github.com/streamingfast/kvdb/cmd/kvdb@develop
```
**To inspect the *Timestamp > BlockId* data**
```bash
kvdb read prefix kblock.timestamp --dsn "badger3://$(pwd)/badger_data.db" --decoder="proto://./proto/[email protected]"
```
**To inspect the *BlockId > Timestamp* data**
```bash
kvdb read prefix kblock.number --dsn "badger3://$(pwd)/badger_data.db" --decoder="proto://./proto/[email protected]"
```
## Running the service
Make sure the `start-kv-sink` script is running before running `grpcurl` queries.
**Service query examples (make sure the `serve` script is running)**
```bash
$ grpcurl -plaintext -proto ./proto/service.proto -d '{"timestamp": "2018-06-09T11:57:19Z"}' localhost:7878 pinax.service.v1.BlockTime.BlockIdByTime
{
"id": "0000006492871283c47f6ef57b00cf534628eb818c34deb87ea68a3557254c6b",
"number": "100"
}
```
```bash
$ grpcurl -plaintext -proto ./proto/service.proto -d '{"number": "100"}' localhost:7878 pinax.service.v1.BlockTime.BlockTimeById
{
"timestamp": "2018-06-09T11:57:19Z"
}
```
**Query by date for *Timestamp > BlockId***
```bash
$ grpcurl -plaintext -proto ./proto/service.proto -d '{"timestamp": "2018-06-09"}' localhost:7878 pinax.service.v1.BlockTime.BlockIdByTime
{
"id": "00000003d93442ea55d07be4d515700e2b9737c1f485e8a13ebb3550c1a8bb44",
"number": "3"
}
```
Note that if you expect the block number to match with the start of the day (e.g. the timestamp to be exactly 2018-06-09T00:00:00Z), it might not always be the case.
What you're guaranteed is to get the first known block in the KV store for that particular date. You can check the actual timestamp with the following command.
```bash
$ kvdb read prefix kblock.timestamp:2018-06-09 --dsn "badger3://$(pwd)/badger_data.db" --decoder="proto://./proto/[email protected]" --limit 1
2023-07-12T13:21:27.121-0400 INFO (kvdb) setting up store {"dsn": "badger3:///home/user/Documents/blocktime-service/badger_data.db"}
2023-07-12T13:21:27.759-0400 INFO (kvdb) store prefix {"prefix": "kblock.timestamp:2018-06-09", "limit": 1}
keys with prefix: kblock.timestamp:2018-06-09
kblock.timestamp:2018-06-09T11:56:30.500Z -> {"id":"00000003d93442ea55d07be4d515700e2b9737c1f485e8a13ebb3550c1a8bb44","number":"3"}
Found 1 keys
```
Here the timestamp (`kblock.timestamp:2018-06-09T11:56:30.500Z`) is actually corresponding to the middle of the day as it's the first known block stored for that day.
**Query a block range from a date range**
```bash
$ grpcurl -plaintext -proto ./proto/service.proto -d '{"first_date": "2018-06-09", "second_date": "2018-06-11"}' localhost:7878 pinax.service.v1.BlockTime.BlockRangeByDate
{
"range": [
{
"id": "00000003d93442ea55d07be4d515700e2b9737c1f485e8a13ebb3550c1a8bb44",
"number": "3"
},
{
"id": "00016e7f319610db9cd1d48642b4b596f5db11c76c7a373d11ed368453a24939",
"number": "93823"
}
]
}
```
Similar behavior to the implementation of getting a `BlockId` (you can specify a single date or a full timestamp). The `second_date` is actually optional, providing only the first date will result in the block range of `[first_date, first_date + 1 day]` to be returned.