Airnode is a fully-serverless oracle node that is designed specifically for API providers to operate their own oracles. See the docs for deployment and usage instructions.
This is a monorepo managed using Lerna. It houses the following packages:
adapter: The module that makes an API call, processes the response and returns a single value
admin: A package/CLI tool to interact with the Airnode contracts across chains
airnode-abi: Encoding and decoding utilities for Airnode according to the Airnode ABI specifications
deployer: Tools to automate Airnode deployment
examples: A public list of examples showcasing the features of Airnode
node: Airnode itself
ois: Types for Oracle Integration Specification (OIS)
operation: Development and testing utilities for the core parts of Airnode
protocol: Contracts that implement Airnode RRP (request–response protocol)
validator: A package that can be used to validate and convert airnode specification files
To install dependencies, run this at the repository root:
yarn run bootstrapTo build all the packages, run this at the repository root:
yarn run buildAirnode packages are cross platform, available as npm packages or docker containers. You should also be able to clone, build and use the packages on any platform. However we do not guarantee that the development only features (e.g. test or examples) will work out of the box.
We heavily recommend using UNIX based systems for development. If you are using Windows, consider WSL.
We use changesets to manage the changelog for us. What that means for
contributors is that you need to add a changeset by running yarn changeset which contains what packages should be
bumped, their associated semver bump types and some markdown which will be inserted into changelogs.
A changeset is required to merge a PR if it changes one of the monorepo packages. If you really do not want to include a
changeset, you have to generate an empty one by running yarn changeset:empty. Note that a changeset is not required
for dependabot PRs.
Tip: Add
export EDITOR="code --wait"to.bashrcto make it possible to write changelog description in VS Code (you can adapt the configuration for other editor similarly).
To request/propose new features, fixes, etc. create an issue. If you wish to contribute to the project, contact us over our Telegram.