@erebos/api-bzz-browser

@erebos/api-bzz-browser

Swarm (BZZ) APIs for the browser.

Installation

yarn add @erebos/api-bzz-browser

API

See the library documentation website.

License

MIT

Changelog

v0.9.0 (2019-08-12)

Breaking changes

TypeScript rewrite

The main change in this release is the code base being rewritten in TypeScript. As part of these changes, the library no longer uses ES modules default exports but only named exports, such as:

• import { Bzz } from '@erebos/api-bzz-node'
• import { Pss } from '@erebos/api-pss'
• import { createHex } from '@erebos/hex'

Pss module changes

• The EMPTY_HEX constant has been renamed to EMPTY_ADDRESS.
• The sendRaw(), setPeerPublicKey() and setSymmetricKey() methods of the Pss class no longer set a default address value, use EMPTY_ADDRESS if needed.

Browser module namespacing

The @erebos/swarm-browser package now exports its contents in the Erebos.swarm namespace instead of Erebos. For example Erebos.swarm.SwarmClient() should be used instead of Erebos.SwarmClient().
The browser builds (in the dist folder) have been renamed from erebos.development.js and erebos.production.js to erebos.swarm.development.js and erebos.swarm.production.js to better reflect this change.

Additional features

• The downloadTarTo() method has been added to @erebos/api-bzz-node.
• The experimental @erebos/api-bzz-react-native has been added by Mark Vujevits in PR #98.

Other changes

• The sign() and verify() functions exported by the @erebos/secp256k1 package now accept a BNInput input value as exported by the elliptic package.
• The addChapter() method of the Timeline class now calls createChapter(), so default values for the chapter will be injected.
• Fixed links to Swarm install & run (by thecryptofruit in PR #108).
• Docs have been updated to expose TypeScript interfaces rather than Flow types.