@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 website.

License

MIT

Changelog

v0.8.0 (2019-05-28)

Breaking changes

• The FeedMode and FeedOptions types have been removed, their use cases are implemented by new methods.
• The mode and contentChangedOnly fields have been removed from the PollOptions object.
• The xxxFeedValue() methods of the Bzz class have been changed as follows:
  • getFeedValue()
    • getFeedChunk() to load the chunk itself
    • getFeedContentHash() to load the chunk and parse the response as a Swarm hash
    • getFeedContent() to load the chunk, parse the response as a Swarm hash and load the referenced resource
  • pollFeedValue()
    • pollFeedChunk() to poll the chunk itself
    • pollFeedContentHash() to poll the chunk and parse the response as a Swarm hash
    • pollFeedContent() to poll the chunk, parse the response as a Swarm hash and load the referenced resource
  • postSignedFeedValue() -> postSignedFeedChunk()
  • postFeedValue() -> postFeedChunk()
  • updateFeedValue() -> setFeedChunk()
  • uploadFeedValue() -> setFeedContent()
• Various Timeline methods have been renamed to be more explicit:
  • download() -> getChapter()
  • upload() -> postChapter()
  • getChapterID() -> getLatestChapterID()
  • loadChapter() -> getLatestChapter()
  • updateChapterID() -> setLatestChapterID()
  • createUpdater() -> createAddChapter()
  • loadChapters() -> getChapters()

Additional features

• The @erebos/wallet-hd utility package has been added, providing a simple way to use Hierarchical Deterministic wallets.
• The PollContentHashOptions and PollContentOptions have been added for the pollFeedContentHash() and pollFeedContent() methods, respectively.
• The setFeedContentHash() method has been added to the Bzz class.
• New methods have been added to the Timeline class:
  • setLatestChapter(): sets the latest chapter without checking the previous field, while the logic of addChapter() has been changed to retrieve the latest chapter ID before adding the new chapter when the previous field is not provided.
  • createLoader(): returns an Observable of chapters.
  • pollLatestChapter(): returns an Observable of the latest chapter.
• Additional commands have been added in the CLI to interact with feeds and timelines.

Other changes

The library is now tested against Swarm v0.4.0, using the Docker image provided by ethersphere.