Updated CHANGELOG.md files

IntersectMBO · Jun 2, 2023 · bc5e0d6 · bc5e0d6
1 parent 1e1a215
commit bc5e0d6
Show file tree

Hide file tree

Showing 3 changed files with 93 additions and 9 deletions.
diff --git a/cardano-client/CHANGELOG.md b/cardano-client/CHANGELOG.md
@@ -4,7 +4,10 @@
 
 ### Breaking changes
 
-- Updated to `ouroboros-network-0.5.0.0`.
+* Due to changes in `RunMiniProtocol`, `OuroborosApplication` and
+  `NodeToClientProtocols` data types the API provided in this package has
+  breaking changes.  For more details see recent changes in
+  [`ouroboros-network-framework`][onf-changelog].
 
 ## 0.2.0.0 -- 2023-04-25
 
@@ -20,3 +23,5 @@
 ## 0.1.0.0 -- 2020-05-18
 
 * Initial release
+
+[onf-changelog]: https://github.com/input-output-hk/ouroboros-network/blob/master/ouroboros-network-framework/CHANGELOG.md
diff --git a/ouroboros-network-framework/CHANGELOG.md b/ouroboros-network-framework/CHANGELOG.md
@@ -1,5 +1,47 @@
 # Revision history for ouroboros-network-framework
 
+## next veresion
+
+### Breaking changes
+
+* `MuxProtocolBundle` type alias was removed, since it was just reduced to
+  a list of 'MiniProtocol's.
+
+* Added `ExpandedInitiatorContext`, `MinimalInitiatorContext` and
+  `ResponderInitiatorContext` types in a new module:
+  `Ouroboros.Network.Context`.  The module also re-exports `ConnectionId`,
+  `IsBigLedgerPeer` and `ControlMessageSTM` thus an unqualified import might
+  cause some warnings.
+
+* `RunMiniProtocol` now contains callbacks which receive a context.  The type
+  is polymorphic over initiator and responder contexts.  We also provide type
+  aliases for `RunMiniProtocolWithExpandedCtx` and
+  `RunMiniProtocolWithMinimalCtx` which instatiate initiator and responider
+  contexts.
+
+* Added `OuroborosBundleWithExpandedCtx` and `OuroborosBundleWithMinimalCtx`
+  type aliases.
+
+* Added `OuroborosApplicationWithMinimalCtx` type aliases.
+
+* Added `contramMapInitiatorCtx` which contramaps the initiator context of an
+  `OuroborosApplication`.
+
+* Added `fromOuroborosBundle` which creates `OuroborosApplication` from
+  `OuroborosBundle` by forgetting the hot / warm / established distinction
+  between all mini-protocols.
+
+* Removed `MuxBundle` and `mkMuxApplicationBundle` which is no longer needed.
+
+* Due to the above changes the following APIs changed their type signatures:
+
+  - `Ouroboros.Network.Socket.connectToNode`
+  - `Ouroboros.Network.Socket.connectToNode'`
+  - `Ouroboros.Network.Socket.connectToNodeSocket`
+  - `Ouroboros.Network.Socket.SomeResponderApplication`
+  - `Ouroboros.Network.Socket.withServerNode`
+  - inbound governor API
+
 ## 0.6.0.1 -- 2023-05-15
 
 * Updated to use `ouroboros-network-api-0.5.0.0`.

diff --git a/ouroboros-network/CHANGELOG.md b/ouroboros-network/CHANGELOG.md
@@ -4,14 +4,51 @@
 
 ### Breaking
 
-* `TraceLedgerPeers` renamed some constructors:
-    - `PickedPeer  -> PickedLedgerPeer`
-    - `PickedPeers -> PickedLedgerPeers`;
-  added new ones:
-    - `PickedBigLedgerPeer`
-    - `PickedBigLedgerPeers`;
-  and `FetchingNewLedgerState` constructor has a new field: number of big
-  ledger peers.
+* Introduced big ledger peers to the outbound governor.  The breaking changes include:
+  - Added new targets to `PeerSelectionTargets` data type
+
+  - Added `requestBigLedgerPeers` to `PeerSelectionActions`.
+
+  - `establishPeerConnection` and `ativatePeerConnection` receive an
+    `IsLedgerPeer` argument (which is then passed to mini-protocols via
+    `ExtendedInitiatorContext`.
+
+  - The `PeerSelectionState` contains new fields to support big ledger peers.
+
+  - Modified `PickPolicy` type, it is now parametrised by monad `m` rather than
+    by an `stm` monad.  With this change the type alias can be used in
+   `pickPeers` type signature.
+
+  - `TraceLedgerPeers` renamed some constructors:
+      - `PickedPeer  -> PickedLedgerPeer`
+      - `PickedPeers -> PickedLedgerPeers`;
+    added new ones:
+      - `PickedBigLedgerPeer`
+      - `PickedBigLedgerPeers`;
+    and `FetchingNewLedgerState` constructor has a new field: number of big
+    ledger peers.
+
+* Propagated changes from `ouroboros-network-framework` related to the
+  introduction of initiator and responder contexts to `RunMiniProtocol` data
+  type. These changes include breaking changes to the following APIs:
+
+  - `Ouroboros.Network.Diffusion` is using: `OuroborosBundleWithExpandedCtx`
+    for node-to-node applications, `OuroborosApplicationWithMinimalCtx` for
+    node-to-client responders.
+  - `Ouroboros.Network.NodeToNode` exports `MinimalInitiatorContext` and
+    `ExpandedInitiatorContext` data types.
+  - `Ouroboros.Network.NodeToClient` exports `MinimalInitiatorContext` and
+    `ResponderContext` data types.
+  - `Ouroboros.Network.NodeToNode.NodeToNodeProtocols`,
+    `Ouroboros.Network.NodeToNode.nodeToNodeProtocols`,
+    `Ouroboros.Network.NodeToNode.versionedNodeToClientProtocols`,
+    `Ouroboros.Network.NodeToNode.withServer`  were modified.
+  - `Ouroboros.Network.NodeToClient.NodeToClientProtocols`,
+    `Ouroboros.Network.NodeToClient.nodeToClientProtocols`,
+    `Ouroboros.Network.NodeToClient.versionedNodeToClientProtocols`,
+    `Ouroboros.Network.NodeToClient.withServer`,
+    `Ouroboros.Network.NodeToClient.ipSubscriptionWorker`,
+    `Ouroboros.Network.NodeToClient.dnsSubscriptionWorker` were modified.
 
 ## 0.7.0.1