Skip to content

Releases: filecoin-project/boost

v1.6.0

08 Mar 17:28
Compare
Choose a tag to compare

Overview

We're happy to announce the Boost v1.6.0 release.

This release is compatible with Lotus v1.20.0 release. You should only upgrade to this release if you are also upgrading Lotus to v1.20.0 or higher for NV18 network upgrade. See the Boost and Lotus compatibility matrix for up to date information, and to plan your upgrade.

Please make sure to upgrade to test the new features shipped in this release. See our upgrade guide for details.

Boost v1.5.x Adopters

If you have been running the v1.5.x and want to update to this release for lotus compatibility, you can do so as long as you are also upgrading Lotus to v1.20.0 or later. This PR contains the latest 1.5.3 codebase and we will continue to update it with any subsequent releases.

🌟 Highlights

Includes updates previously noted in RC builds of this release

FVM Contract Deal Support

  • With the release of FVM, it is now possible for smart contracts to make deal proposals on-chain. This is made possible though the DealProposal FRC.
  • DataDAOs, as well as other clients who want to store data on Filecoin, can now deploy a smart contract on the FVM which adheres to the DealProposal FRC, and make deal proposals that are visible to every storage provider running Boost who monitors the chain.
  • In order to enable DealProposal FRC, you have to edit your config.toml and enable contract deal monitoring. By default it is disabled. Here is an example configuration:
[ContractDeals]
  Enabled = true
  AllowlistContracts = []
  From = "0x0000000000000000000000000000000000000000"

Cancelation of stalled retrievals

Boost now runs a background process that will cancel retrievals that have not been updated in the past 30minutes by default. You can configure this by setting the new DealMaking.StalledRetrievalTimeout property in the Boost config.

The following config will cancel all retrievals that have not changed state, or transferred bytes in the past 10minutes.

[Dealmaking]
  ...
  RetrievalLogDuration = "24h0m0s"
  StalledRetrievalTimeout = "10m0s"

Note: For efficiency of the job, Boost leverages the Retrieval Logs DB, so your RetrievalLogDuration should always exceed the StalledRetrievalTimeout.

Updated deal filter

Boost now exposes the following additional deal variables to the external deal filters like CIDgravity. This should allow more extensive filter logic for deal acceptance.

  • IsOffline
  • SkipIPNIAnnounce
  • RemoveUnsealedCopy

🤩 Upcoming Features

These features will be part of the upcoming releases.

🆕 Graphsync Retrieval Server

  • This is a simpler version of current graphsync server for retrievals
  • It should allow much faster retrievals
  • Only free retrievals will be handled by this code path. Paid retrievals will still go via the old code path

Online backup 💾

  • Boost will support online backups along with the current offline version

What's Changed

New Contributors

Full Changelog: v1.5.3...v1.6.0

v1.6.0-rc3 - Lotus v1.20.0 Compatibility

03 Mar 15:49
d756076
Compare
Choose a tag to compare

Overview

We're happy to announce the Boost v1.6.0-rc3 release.

This is a compatibility update for the Lotus v1.20.0 release. You should only upgrade to this release if you are also upgrading Lotus to v1.20.0. See the Boost and Lotus compatibility matrix for up to date information, and to plan your upgrade.

Please make sure to upgrade to test the new features shipped in this release. See our upgrade guide for details.

Boost v1.5.x Adopters

If you have been running the v1.5.x and want to update to this release for lotus compatibility, you can do so as long as you are also upgrading Lotus to v1.20.0. This PR contains the latest 1.5.3 codebase and we will continue to update it with any subsequent releases.

🌟 Highlights

Includes updates previously noted in RC builds of this release

FVM Contract Deal Support

  • With the release of FVM, it is now possible for smart contracts to make deal proposals on-chain. This is made possible though the DealProposal FRC.
  • DataDAOs, as well as other clients who want to store data on Filecoin, can now deploy a smart contract on the FVM which adheres to the DealProposal FRC, and make deal proposals that are visible to every storage provider running Boost who monitors the chain.
  • In order to enable DealProposal FRC, you have to edit your config.toml and enable contract deal monitoring. By default it is disabled. Here is an example configuration:
[ContractDeals]
  Enabled = true
  AllowlistContracts = []
  From = "0x0000000000000000000000000000000000000000"

Cancelation of stalled retrievals

Boost now runs a background process that will cancel retrievals that have not been updated in the past 30minutes by default. You can configure this by setting the new DealMaking.StalledRetrievalTimeout property in the Boost config.

The following config will cancel all retrievals that have not changed state, or transferred bytes in the past 10minutes.

[Dealmaking]
  ...
  RetrievalLogDuration = "24h0m0s"
  StalledRetrievalTimeout = "10m0s"

Note: For efficiency of the job, Boost leverages the Retrieval Logs DB, so your RetrievalLogDuration should always exceed the StalledRetrievalTimeout.

Updated deal filter

Boost now exposes the following additional deal variables to the external deal filters like CIDgravity. This should allow more extensive filter logic for deal acceptance.

  • IsOffline
  • SkipIPNIAnnounce
  • RemoveUnsealedCopy

What's Changed

New Contributors

Full Changelog: v1.5.3...v1.6.0-rc3

v1.5.3

01 Mar 20:17
180b0eb
Compare
Choose a tag to compare

Overview

We're happy to announce Boost 1.5.3 which includes automatic cancelation of stalled retrievals.

Lotus 1.20.0 Users: If you have already upgraded Lotus to 1.20.0 you should be using Boost 1.6.0-rc1 or later. See the Boost and Lotus compatibility matrix for up to date information, and to plan your upgrade.

An official release of 1.6 is scheduled for March 8th.

Highlights

Cancelation of stalled retrievals

Boost now runs a background process that will cancel retrievals that have not been updated in the past 30minutes by default. You can configure this by setting the new DealMaking.StalledRetrievalTimeout property in the Boost config.

The following config will cancel all retrievals that have not changed state, or transferred bytes in the past 10minutes.

[Dealmaking]
  ...
  RetrievalLogDuration = "24h0m0s"
  StalledRetrievalTimeout = "10m0s"

Note: For efficiency of the job, Boost leverages the Retrieval Logs DB, so your RetrievalLogDuration should always exceed the StalledRetrievalTimeout.

What's Changed

Full Changelog: v1.5.2...v1.5.3

v1.6.0-rc2 - Lotus v1.20.0-rcX Compatibility

24 Feb 13:01
Compare
Choose a tag to compare

Overview

We're happy to announce the Boost v1.6.0-rc2 release.

This is a patch release to fix slow offline deal processing by Boost. You should upgrade to this release if you are currently running Boost v.1.6.0-rc1. See the Boost and Lotus compatibility matrix for up to date information, and to plan your upgrade.

Please make sure to upgrade to test the new features shipped in this release. See our upgrade guide for details.

What's Changed

Full Changelog: v1.6.0-rc1...v1.6.0-rc2

v1.5.2

24 Feb 12:36
4079f83
Compare
Choose a tag to compare

Overview

We're happy to announce the Boost v1.5.2 release.

This is a patch release to fix slow offline deal processing by Boost. You should upgrade to this release if you are currently running Boost v.1.5.1. See the Boost and Lotus compatibility matrix for up to date information, and to plan your upgrade.

Please make sure to upgrade to test the new features shipped in this release. See our upgrade guide for details.

What's Changed

  • fix: offline deal slow acceptance and ConsiderOnlineStorageDeals rejection by @LexLuthr in #1211
  • fix: send more deal params to deal filters by @LexLuthr in #1213
  • fix: basic deal filters no longer skipped #1218

Full Changelog: v1.5.1...v1.5.2

v1.6.0-rc1 - Lotus v1.20.0-rc1 Compatibility

16 Feb 12:42
dcf854a
Compare
Choose a tag to compare

Overview

We're happy to announce the Boost v1.6.0-rc1 release.

This is a compatibility update for the Lotus v1.20.0-rc1 release. You should only upgrade to this release if you are also upgrading Lotus to v1.20.0-rc1. See the Boost and Lotus compatibility matrix for up to date information, and to plan your upgrade.

Please make sure to upgrade to test the new features shipped in this release. See our upgrade guide for details.

Boost v1.5.1 RC Adopters

If you have been running the v1.5.1 RC and want to update to this release for lotus compatibility, you can do so as long as you are also upgrading Lotus to v1.20.0-rc1. This PR contains the latest 1.5.1 codebase and we will continue to update it with any subsequent releases.

What's Changed

Full Changelog: v1.5.1-rc5...v1.6.0-rc1

v1.5.1 - Bitswap support and more!

16 Feb 16:17
5aadde7
Compare
Choose a tag to compare

Overview

We're happy to announce the Boost v1.5.1 stable release, with several new features and fixes!
See our upgrade guide for details on upgrading.

Please review the Boost and Lotus compatibility matrix to plan your upgrade.

🌟 Highlights

Includes updates previously noted in RC builds of this release

IPFS retrieval support is here with Booster-bitswap!

  • booster-bitswap is a binary that runs alongside the boostd process, to serve retrievals over the Bitswap protocol, which is the data transfer protocol used in IPFS. This release provides tools for managing a bitswap service for serving retrievals.
  • Note that there is currently no payment method mechanism in booster-bitswap; this endpoint is intended to serve free content.
  • Check out the docs on how to start serving Bitswap retrievals

Default Grafana dashboards and monitoring

  • Boost now includes configured Grafana dashboards that SP's can enable with monitoring. See the monitoring tutorial in the docs for an example on how this is set up via docker. We plan to add more dashboards over time to improve visibility into the systems performance. Reach out in #boost-help on Slack if you have any questions!
Boostd process overview dashboard Booster-bitswap retrieval dashboard
Boostd process overview dashboard Booster-bitswap retrieval dashboard

New storage deal proposal flags

  • The new storage deal proposal flags adds configurability options to indexer announcements and storing unsealed copies of data. The current default storage deal protocol behaviors remain the same.
  • Check out the details in the Propose Storage Deal Protocol docs

HTTP Retrieval Updates

  • HTTP retrieval URLs have been redesigned to support piece retrievals for Spade (previously slingshot-evergreen).
    • We've simplified the /piece endpoint for ease of use, and optimized for existing user needs
    • BREAKING CHANGE: We removed support for getting the piece by its PayloadCid and the ability to retrieve the payload. We may revisit adding support back if there is clear demand.
  • We've added a new /info endpoint that includes versioning of booster-http to make it easier to track changes
  • You can see the updated endpoints in the docs - https://boost.filecoin.io/experimental-features/http-retrieval.

And more!

  • You can now use the boost client to retrieve data similar to lotus' retrieve command, example:
    boost retrieve --provider=t01000 bafk2bzacedsnewk7clxwab2wgwyoi7u5tzdhldx7fkxpqdq7unrxz2zoy4d2g
  • Boostx now includes a utility command for unsealing a sector, example:
    boostx sector unseal --api-fullnode=$FULLNODE_API_INFO --api-storage=$MINER_API_INFO 2

What's Changed

New Contributors

Full Changelog: v1.5.0...v1.5.1

v1.5.1-rc5

09 Feb 17:01
3f848a3
Compare
Choose a tag to compare
v1.5.1-rc5 Pre-release
Pre-release

We're happy to announce the v1.5.1-rc5 release. This is the final planned RC before release.

Highlights

  • Fixes an issue with booster-bitswap request caches not getting pruned. This should improve memory usage overtime. See #1167 for config options for managing the cache size and expiry time.
  • Improves resiliency of deny filter downloads for booster-bitswap
  • You can now use the boost client to retrieve data similar to lotus' retrieve command, example:
    boost retrieve --provider=t01000 bafk2bzacedsnewk7clxwab2wgwyoi7u5tzdhldx7fkxpqdq7unrxz2zoy4d2g
  • Boostx now includes a utility command for unsealing a sector, example:
    boostx sector unseal --api-fullnode=$FULLNODE_API_INFO --api-storage=$MINER_API_INFO 2

What's Changed

  • Add more storage deal filter parameters by @dirkmc in #497
  • Fetch bitswap deny filters from remote if local cache is invalid by @ischasny in #1159
  • port boost retrieve to RC by @dirkmc in #1163
  • Port unseal command to RC @dirkmc in #1155
  • feat: use an expiry lru cache for the index backed blockstore by @jacobheun in #1167

New Contributors

Full Changelog: v1.5.1-rc4...v1.5.1-rc5

v1.5.1-rc4

27 Jan 14:42
d08a322
Compare
Choose a tag to compare
v1.5.1-rc4 Pre-release
Pre-release

What's Changed

Full Changelog: v1.5.1-rc3...v1.5.1-rc4

v1.5.1-rc3

20 Jan 08:49
065d518
Compare
Choose a tag to compare
v1.5.1-rc3 Pre-release
Pre-release

Overview

We're happy to announce Boost v1.5.1-rc3 release.
Please make sure to upgrade to test the new features shipped in this release. See our upgrade guide for details. Remember to review the Boost and Lotus compatibility matrix to plan your upgrade.

Highlights

Booster-bitswap is now available!

  • booster-bitswap is a binary that runs alongside the boostd process, to serve retrievals over the Bitswap protocol, which is the data transfer protocol used in IPFS. This release provides tools for managing a bitswap service for serving retrievals.
  • Note that there is currently no payment method mechanism in booster-bitswap; this endpoint is intended to serve free content.
  • For storage providers that want to test out the new functionality, refer to #1036 and share your results and report any issues you have.

New storage deal proposal flags

  • The new storage deal proposal flags adds configurability options to indexer announcements and storing unsealed copies of data. The current default storage deal protocol behaviors remain the same.
  • SkipIPNIAnnounce: defaults to false. This flag enables storage clients to elect to not announce deal data to IPNI(InterPlanetary Network Indexer)
  • RemoveUnsealedCopy: defaults to false. This flag enables storage clients to elect to not have an unsealed copy of their data stored

What's Changed

Full Changelog: v1.5.1-rc2...v1.5.1-rc3