eolszewski / erebos

JavaScript client for Swarm and PSS

Erebos

JavaScript client for the Ethereum ecosystem, notably Swarm and PSS.

Disclaimer

This library is a work-in-progress client for technologies that are still at a proof-of-concept stage. It is intended for demonstration purposes only.
APIs are likely to be changed and even removed between releases without prior notice.

Installation

yarn add erebos-browser # browser-only
yarn add erebos-node # node-only
yarn add erebos # universal

Examples

• Postal Services over Swarm (PSS)
• Whisper (SHH)

Documentation

• Client
• APIs
  • Bzz - file storage
  • Eth - Ethereum blockchain
  • Net - network
  • Pss - Postal Services over Swarm
  • Shh - Whisper
  • Web3
• RPC client factory for the browser or node depending on the package.
• Hexadecimal-encoding utilities

Packages

Name	Version	Description
Clients
erebos		Universal Erebos library
erebos-browser		Browser-only Erebos library
erebos-node		Node-only Erebos library
Standalone APIs
erebos-api-bzz-browser		Browser-only Swarm (BZZ) APIs
erebos-api-bzz-node		Node-only Swarm (BZZ) APIs
erebos-api-eth		Ethereum (eth) APIs
erebos-api-net		Net APIs
erebos-api-pss		Postal Services over Swarm (PSS) APIs
erebos-api-shh		Whisper (SHH) APIs
erebos-api-web3		Web3 APIs
Base classes
erebos-api-bzz-base		Shared logic for Swarm (BZZ) APIs
erebos-client-base		Shared logic for Client APIs

License

MIT.
See LICENSE file.