Erebos

JavaScript client and CLI for Swarm.

Installation

Node.js v10+ is required to use the Node.js APIs and run the CLI.

Client library

yarn add @erebos/swarm-browser # browser-only
yarn add @erebos/swarm-node # node-only
yarn add @erebos/swarm # universal

CLI

npm install -g @erebos/cli

Documentation

• Getting started
• API reference

Packages

Name	Version	Description
Clients
@erebos/swarm		Universal Erebos library for Swarm
@erebos/swarm-browser		Browser-only Erebos library for Swarm
@erebos/swarm-node		Node-only Erebos library for Swarm
Individual APIs
@erebos/api-bzz-browser		Browser-only Swarm (BZZ) APIs
@erebos/api-bzz-node		Node-only Swarm (BZZ) APIs
@erebos/api-pss		Postal Services over Swarm (PSS) APIs
@erebos/timeline		Feed-based Timeline APIs
Utilities
@erebos/hex		Hexadecimal values encoding and decoding
@erebos/keccak256		Keccak256 hashing
@erebos/secp256k1		ECDSA key creation and signing using the SECP256k1 curve
@erebos/wallet-hd		Hierarchical Deterministic wallet
CLI
@erebos/cli
Base classes
@erebos/api-bzz-base		Shared logic for Swarm (BZZ) APIs
@erebos/client-base		Shared logic for Client APIs

Development

Prerequisites

• Node v10+ (includes npm)
• Yarn (optional - faster alternative to npm)
• Docker

Setup

yarn install
yarn bootstrap
yarn build

Running tests

In one terminal window run:

./start_swarm_node.sh

And in the second one run:

yarn test:all

License

MIT.
See LICENSE file.