Releases: ethersphere/bee-js
v5.2.0
v5.1.2
v5.1.1
v5.1.0
v5.0.0
5.0.0 (2022-07-28)
This is a breaking release that brings support for Bee 1.7 and cleans up some long awaiting breaking changes that we had lined up:
- We have removed interfaces
DebugPostageBatch
(forPostageBatch
) andNodesInfo
(forNodeInfo
). - We have changed the
cid
property of theUploadResultWithCid
interface to be a function instead of getter as this property is not available for encrypted references which caused some troubles when serializing the whole object. - We have enabled by default waiting for the newly created postage batches to be usable (originally the
waitForUsable
property of theBeeDebug.createPostageBatch()
defaulted tofalse
, now it istrue
). - We have added support for the
Bee. createFeedManifest()
to return object instead of directly reference that also has support for getting CID with the.cid()
function.
⚠ BREAKING CHANGES
- enable waiting for postage batch to be usable by default (#746)
- adds support for Feed Manifest CID (#745)
- drop node 12 support (#741)
- drop DebugPostageBatch in favor of PostageBatch inteface (#743)
- drop NodesInfo in favor of NodeInfo inteface (#742)
- convert cid getter to function (#740)
Features
- adds support for Feed Manifest CID (#745) (37c5b55)
- enable waiting for postage batch to be usable by default (#746) (cb05d22)
Bug Fixes
Code Refactoring
- drop DebugPostageBatch in favor of PostageBatch inteface (#743) (3f66764)
- drop NodesInfo in favor of NodeInfo inteface (#742) (acddb14)
Miscellaneous Chores
v4.1.1
v4.1.0
4.1.0 (2022-05-24)
Shortly after the last release, we bring you another release that brings some nice improvements and new features together with some fixes.
✅ Node 18
We have verified the support for Node 18. It introduces a native implementation of fetch
API that we use as HTTP client. This implementation wraps the errors that it throws into a nested Error object, so we unwrap these errors for better error handling.
⏳ Waiting for postage stamps to be usable
When a postage stamp is created the (BeeDebug.createPostageStamp()
method is called), Bee creates an on-chain transaction that creates this transaction in the smart contract, but the stamp is not immediately "usable" as Bee waits for several blockchain blocks in order to be sure that the postage stamp won't disappear from the blockchain. During this period Bee won't accept this stamp and will return the error stamp is not usable
. After this period Bee pronounces it as usable and the users can upload content using it.
In most use cases, when you create the postage stamp you want to actually wait until the stamp is usable and only then return it to the user. For that, you had to implement your own waiting logic, but no more!
The BeeDebug.createPostageStamp()
method has a new option waitForUsable
which if specified, then the Promise this method returns is resolved only after the Bee confirms the postage stamp to be usable. Be aware that if used, then the call time of this method raises dramatically!
In the next breaking release this option will be turned on, by default!
🔐 Wallet endpoint support
The Bee 1.6.0 release introduced /wallet
endpoint that exposes the balance of the node's wallet and some other related metrics. In this release we add support for this endpoint.
Features
- cids support (#681) (02d8f9c)
- expose underlying undici error messages (#694) (b164b70)
- support for waiting on stamp to be usable (#678) (f675dc3)
- wallet endpoint support (#683) (2af84c0)
Bug Fixes
v4.0.0
4.0.0 (2022-05-18)
This release brings several new features and one ad-hoc breaking fix that is passed on from the new Bee version 1.6.0, but affects only the BeeDebug.getReserveState()
method.
💮 ENS support
Bee supports ENS for resolution of ENS domains into Swarm references. bee-js
was until now refusing ENS domains with the input validation. Now we are bringing support for all the download*
methods and a few other ones as well.
🗂. Get Feed's specific update
The FeedReader.download()
function now accepts an option index
where you can specify which of the feed's updates you want to download.
❓ Is Feed Retrievable?
There is a new method Bee.isFeedRetrievable()
that helps you to check whether a given feed is available.
It operates in two modes. If you know the last index of the feed update then you can use it as an optional parameter and then be sure that this update is present in the network. If you won't specify the index
parameter, then it will check for the "latest" update by traversing all the known updates from the start. This does not guarantee though that the found "latest" update is indeed the latest one though and hence provides a weaker guarantee.
⚠ BREAKING CHANGES
- updated interface returned by
BeeDebug.getReserveState()
based on Bee 1.6.0 (#675)
Features
- ens support for download methods (#659) (e72c4b4)
- fetch specific feed index update (#629) (a4672dc)
- is feed retrievable support (#641) (e1071b0)