https://github.com/api3dao/signed-api
A monorepo for managing signed data
https://github.com/api3dao/signed-api
Last synced: about 1 year ago
JSON representation
A monorepo for managing signed data
- Host: GitHub
- URL: https://github.com/api3dao/signed-api
- Owner: api3dao
- License: mit
- Created: 2023-09-18T06:19:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T09:59:58.000Z (about 1 year ago)
- Last Synced: 2025-05-05T10:44:37.972Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.94 MB
- Stars: 2
- Watchers: 6
- Forks: 8
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# signed-api
A monorepo for managing signed data. Consists of:
- [signed-api](./packages/signed-api/README.md) - A service for storing and accessing signed data. It provides endpoints
to handle signed data for a specific airnode.
- [airnode-feed](./packages/airnode-feed/README.md) - A service for pushing data provider signed data.
- [e2e](./packages/e2e/README.md) - End to end test utilizing Mock API, Airnode feed and signed API.
- [performance-test](./packages/performance-test/README.md) - Configurations and scripts to allow running performance
tests and benchmarks on AWS.
Read the
[specification](https://docs.google.com/document/d/1-kUPIXSD4ZW1SGs_P8HsejC9k9aHB-NXs9_6-OclnmE/edit#heading=h.i307237rdfda)
for more details on the architecture and the components.
## Getting started
The repo uses `pnpm` workspaces. To install the dependencies:
```sh
pnpm install
```
and to build the packages:
```sh
pnpm run build
```
Note, that every time you make a change to a workspace that is used as a dependency of another, you need to rebuild the
changed package (otherwise you might get weird JS/TS errors).
## Versioning and release
Signed API and Airnode feed use [semantic versioning](https://semver.org/). Packages are published to NPM to export the
configuration schemas and various utilities. The services are dockerized and published to Docker Hub.
There is a script that automates the process of creating new NPM packages and Docker images. Full release procedure:
1. `pnpm run create-release:npm [major|minor|patch]` - The script ensures publishing happens from up-to-date `main`
branch. It updates the package versions for `airnode-feed` and `signed-api`, updates fixtures and example files, does
basic checks to ensure the changes are valid and creates a version commit. The command intentionally does not do the
publishing so that the changes can be reviewed before pushing.
2. `git show` - To inspect the changes of the version commit.
3. Run the e2e tests locally. This is not automated due to implementation complexity.
4. `git push` - Push the version commit upstream. This will trigger the `tag-and-release` GitHub Actions job and result
in 1) the commit being tagged with the new version, 2) the release being created on GitHub, 3) both packages being
released on npm, and 4) both Docker images being built and pushed to Docker Hub.