@erebos/api-bzz-base - npm Package Versions

v0.12.0 (2019-12-17)

Breaking change

The Timeline class has been split between the TimelineReader and TimelineWriter classes. TimelineWriter extends TimelineReader and therefore can be used as a dropped-in replacement for Timeline.

Additional features

• Support for raw Swarm feeds has been added thanks to Attila Gazso's pull request.
• @erebos/api-bzz-browser can now be used in a Web Worker thanks to Adam Uhlíř's pull request.
• The uploadData() and downloadData() methods have been added to the Bzz APIs.
• The Hex.from() static method has been added as a replacement for createHex().

Other change

HTTP error messages from Swarm are now parsed when possible thanks to Adam Uhlíř's pull request.

New package

The @erebos/feed-list package has been added, implementing lists data structures on top of raw Swarm feeds.

v0.11.0 (2019-11-28)

This release adds support for Readable streams in @erebos/api-bzz-base, thanks to Adam Uhlíř's pull request.

Breaking change

The uploadFileStream() method of @erebos/api-bzz-node has been removed, uploadFile() now supporting streams.

Additional features

• The downloadObservable() and downloadDirectoryData() methods have been added to @erebos/api-bzz-base and are therefore also available in @erebos/api-bzz-browser. Until now they were only available in @erebos/api-bzz-node.
• The downloadStream() method has been added.
• The uploadFile() and upload() methods now support a Readable stream input.

Other change

The code base and type definitions have been updated to TypeScript 3.7 thanks to Adam Uhlíř's pull request.

v0.10.0 (2019-10-01)

Breaking changes

• The PollOptions interface of the Bzz API has been changed and is now used by the Timeline API. The PollFeedOptions interface is now used for polling feeds.
• The PollOptions interface of the Timeline API has been removed, now using the interface exported by the Bzz API.

Swarm v0.5 support

Erebos v0.10 adds support for 2 new features added to the Swarm v0.5 release:

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.

v0.8.1 (2019-06-17)

• Add missing rxjs dependency to @erebos/api-bzz-base package.
• Fix TypeScript definition for @erebos/api-bzz-base package.

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.

v0.7.2 (2019-04-15)

Fix FeedParams type in @erebos/api-bzz-base.

v0.7.1 (2019-03-18)

• Add FeedTopicParams type to @erebos/api-bzz-base.
• Fix getFeedTopic() function in @erebos/api-bzz-base to use FeedTopicParams as input type.

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

v0.6.3 (2019-02-04)

Fix Swarm URLs to avoid unnecessary redirects.