@api3/airseeker
v3.8.0
Published
> A service powering data feeds using the [signed API](https://github.com/api3dao/signed-api).
Downloads
1,259
Readme
airseeker-v2
A service powering data feeds using the signed API.
The Airseeker is a rework of the original Airseeker. The Airseeker v2 is simplified and only works with signed APIs.
Getting started
pnpm install
- To install the dependencies.cp config/airseeker.example.json config/airseeker.json
- To create the configuration file.cp config/secrets.example.env config/secrets.env
- To create the secrets file.
Flowchart and specification
A render of the flowchart can be found below. To edit this document, use diagrams.net to
edit airseeker_v2_pipeline.drawio
, preferably by cloning the repository and loading the file locally.
Link to the Airseeker specification.
Configuration
See configuration for details.
Versioning and release
Airseeker uses semantic versioning. The version is specified in the package.json
file. The
package is published to GitHub, NPM, Docker Hub.
To release a new version:
pnpm create-release:npm [major|minor|patch]
- This will bump the version throughout the repo and commit the changes.- Push to
main
. This will trigger thetag-and-release
GitHub Actions job and result in 1) the commit being tagged with the new version, 2) the release being created on GitHub and npm, and 3) the Docker image being built and pushed to Docker Hub.
Docker
Build
The docker image can be built by running the following commands from the root directory:
pnpm run docker:build
Run
Create a .env
file using cp .env.example .env
and run the docker image locally with:
pnpm run docker:run