Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
97 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,12 @@ | ||
# Revision history for cardano-client | ||
|
||
## next version | ||
|
||
### Breaking changes | ||
|
||
* Due to changes in `RunMiniProtocol` & `OuroborosApplication` data types the | ||
API provided in this package has breaking changes. | ||
|
||
## 0.1.0.0 -- 2020-05-18 | ||
|
||
* Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,50 @@ | ||
# Revision history for ouroboros-network-framework | ||
|
||
## next version | ||
|
||
### 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` and | ||
`OuroborosApplicationWithExpandedCtx` 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 | ||
|
||
### Non-breaking changes | ||
|
||
## 0.1.0.0 -- YYYY-mm-dd | ||
|
||
* First version. Released on an unsuspecting world. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters