Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pinax-network/substreams-clock-api
Timestamps <> Block numbers conversion for your favorite chains
https://github.com/pinax-network/substreams-clock-api
api blockchain bun clickhouse clock rest substreams
Last synced: about 2 months ago
JSON representation
Timestamps <> Block numbers conversion for your favorite chains
- Host: GitHub
- URL: https://github.com/pinax-network/substreams-clock-api
- Owner: pinax-network
- License: mit
- Created: 2023-10-12T09:03:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-17T13:43:33.000Z (11 months ago)
- Last Synced: 2024-04-23T10:07:34.470Z (9 months ago)
- Topics: api, blockchain, bun, clickhouse, clock, rest, substreams
- Language: TypeScript
- Homepage:
- Size: 162 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [`Substreams`](https://substreams.streamingfast.io/) Clock API
[](https://github.com/pinax-network/substreams-clock-api/actions/workflows/bun-test.yml)
> Block & Timestamps API
## REST API
| Pathname | Description |
|-------------------------------------------|-----------------------|
| GET `/chains` | Available `chains`
| GET `/block` | Get block by `block_number`, `block_id` or `timestamp`
| GET `/trace_calls` | Get aggregate of trace_calls for given time range filtered by `chain`
| GET `/transaction_traces` | Get aggregate of transaction_traces for given time range filtered by `chain`
| GET `/uaw` | Get daily unique active wallets for given time range filtered by `chain`
| GET `/health` | Health check
| GET `/metrics` | Prometheus metrics
| GET `/openapi` | [OpenAPI v3 JSON](https://spec.openapis.org/oas/v3.0.0)
**Important note regarding `timestamp` query parameter**
Expects **UTC** datetime or UNIX-like timestamp for matching the data in the Clickhouse DB. Passing `timestamp` data with additional timezone information (such as `...T...Z` or `±hh`) will likely fail the query to match (unless it corresponds to UTC0).
## Requirements
- [ClickHouse](clickhouse.com/)
- [Substreams Sink ClickHouse](https://github.com/pinax-network/substreams-sink-clickhouse/)
## Quickstart
```console
$ bun install
$ bun dev
```
## [`Bun` Binary Releases](https://github.com/pinax-network/substreams-sink-websockets/releases)
> Linux Only
```console
$ wget https://github.com/pinax-network/substreams-clock-api/releases/download/v0.2.0/substreams-clock-api
$ chmod +x ./substreams-clock-api
```
## `.env` Environment variables
```env
# API Server
PORT=8080
HOSTNAME=localhost
# Clickhouse Database
HOST=http://127.0.0.1:8123
DATABASE=default
USERNAME=default
PASSWORD=
TABLE=blocks
MAX_LIMIT=500
# Logging
VERBOSE=true
```
## Help
```console
$ ./substreams-clock-api -h
Usage: substreams-clock-api [options]
Block & Timestamps API
Options:
-V, --version output the version number
-p, --port HTTP port on which to attach the API (default: "8080", env: PORT)
-v, --verbose Enable verbose logging (choices: "true", "false", default: false, env: VERBOSE)
--hostname Server listen on HTTP hostname (default: "localhost", env: HOSTNAME)
--host Database HTTP hostname (default: "http://localhost:8123", env: HOST)
--username Database user (default: "default", env: USERNAME)
--password Password associated with the specified username (default: "", env: PASSWORD)
--database The database to use inside ClickHouse (default: "default", env: DATABASE)
--table Clickhouse table name (default: "blocks", env: TABLE)
--max-limit Maximum LIMIT queries (default: 500, env: MAX_LIMIT)
-h, --help display help for command
```
## Docker environment
Pull from GitHub Container registry
```bash
docker pull ghcr.io/pinax-network/substreams-clock-api:latest
```
Build from source
```bash
docker build -t substreams-clock-api .
```
Run with `.env` file
```bash
docker run -it --rm --env-file .env ghcr.io/pinax-network/substreams-clock-api
```