From 0ff6929cc9a1b143c10860936858d268d5a4897b Mon Sep 17 00:00:00 2001 From: Jorropo Date: Thu, 1 Jun 2023 13:45:06 +0200 Subject: [PATCH] provider: add breaking changes to the changelog (#330) Co-authored-by: Henrique Dias --- CHANGELOG.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index efc2c6c12..056791e0b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,15 @@ The following emojis are used to highlight certain changes: - Updated, higher-definition icons in directory listings. - Customizable menu items next to "About IPFS" and "Install IPFS". - Valid DAG-CBOR and DAG-JSON blocks now provide a preview, where links can be followed. +- 🛠 Provider API refactor + - `provider/queue` has been moved to `provider/internal/queue`. + - `provider/batched.New` has been moved to `provider.New` and arguments has been changed: + - a routing system is now passed with the `provider.Online` option, by default the system run in offline mode (push stuff onto the queue); and + - you do not have to pass a queue anymore, you pass a `datastore.Datastore` exclusively. + - `provider/simple` has been removed, now instead `provider.New` will accept non batched routing systems and use type assertion for the `ProvideMany` call, giving a single implementation. + - `provider.NewOfflineProvider` has been renamed to `provider.NewNoopProvider` to show more clearly that is does nothing. + - `provider.NewSystem` has been removed, `provider.New` now returns a `provider.System` directly. + - `provider.Provider` and `provider.Reprovider` has been merged under one `provider.System` ## [0.8.0] - 2023-04-05 ### Added