📂 Packages

# Overview

Airnode is a fully-serverless oracle node that is designed specifically for API providers to operate their own oracles. Its code base is a monorepo managed using Lerna (opens new window).

The Airnode monorepo (opens new window) has several packages:

adapter: (opens new window) The module that makes an API call, processes the response and returns a single value

admin: (opens new window) A package/CLI tool to interact with the Airnode contracts across chains

airnode-abi: (opens new window) Encoding and decoding utilities for Airnode according to the Airnode ABI specifications

deployer: (opens new window) Tools to automate Airnode deployment

examples: (opens new window) A public list of examples showcasing the features of Airnode

node: (opens new window) Airnode itself

ois: (opens new window) Types for Oracle Integration Specification (OIS)

operation: (opens new window) Development and testing utilities for the core parts of Airnode

protocol: (opens new window) Contracts that implement Airnode RRP (request–response protocol)

validator: (opens new window) A package that can be used to validate and convert airnode specification files

Airnode 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 there is no guarantee that the development only features (e.g. test or examples) will work out of the box.

It is recommend to use UNIX based systems for development. If you are using Windows, consider WSL2 (opens new window).

Last Updated: 3/7/2022, 8:32:47 AM