@erebos/api-bzz-base

@erebos/api-bzz-base

Base class for Swarm (BZZ) APIs interactions. Used by @erebos/api-bzz-browser and @erebos/api-bzz-node.

Installation

yarn add @erebos/api-bzz-base

API

See the library documentation.

License

MIT

Changelog

v0.7.0 (2019-03-18)

Breaking changes

• The feed parameters object has been changed to include the required user field and remove the signature one. The added feed update parameters object should be used for feed updates.
• The feed-related Bzz methods arguments have changed as the result of the feed parameters object change: rather than having a mandatory "user or hash" argument and a separate feed parameters argument, a single "hash or feed parameters" argument is now used. This change affects the getFeedURL(), createFeedManifest(), getFeedMetadata(), getFeedValue(), pollFeedValue(), postSignedFeedValue(), postFeedValue(), updateFeedValue() and uploadFeedValue() methods.
• The feed digest signing function in the Bzz class configuration has been renamed from signFeedDigest to signBytes, to reflect the fact it could be used in other contexts.
• The second argument of the createKeyPair() function in @erebos/secp256k1 has been removed, as hex is the only supported value it is set by default.

Additional features

• The @erebos/hex module now supports bytes array (Array<number>) as an input type and output using the .toBytesArray() method.
• The createPublic() and verify() functions have been added to the @erebos/secp256k1 package.
• The @erebos/timeline package has been added, providing an implementation of the Timeline protocol. Its API is available in the documentation website.

Other changes

The website has been redesigned and additional examples have been added: erebos.js.org