relaynet-core-js

This library implements the core of Awala and is meant to be used by anyone using the network from a Node.js application. Read the docs online.

Please note that this documentation is mostly incomplete because the interface exposed by this library is changing rapidly as of this writing.

Install

@relaycorp/relaynet-core requires Node.js v12 or newer, and the latest stable release can be installed as follows:

npm install --save @relaycorp/relaynet-core

Specs supported

This library supports the following Awala specs:

• RS-000 (Awala Core).
• RS-001 (RAMF v1).
• RS-002 (Awala PKI).
• RS-003 (Awala Channel Session Protocol).
• RS-018 (Awala Cryptographic Algorithms, Version 1). In addition to the required algorithms, the following are also supported:
  • Hashing functions: SHA-384 and SHA-512.
  • Ciphers: AES-192 and AES-256.
  • ECDH curves: P-384 and P-521.

Updates

Releases are automatically published on GitHub and NPM, and the changelog can be found on GitHub. This project uses semantic versioning.