Skip to content

Commit 3d9de76

Browse files
committed
api: documented changes in the changelog
1 parent 1a9e964 commit 3d9de76

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### Breaking
2+
3+
- Added `nodeTo{Client,Node}VersionDataCodec` to
4+
`Cardano.Network.NodeTo{Client,Node}` modules.
5+
- Removed `nodeTo{Client,Node}CodecCBORTerm`, use the above binding instead.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### Breaking
2+
3+
- Added `nodeTo{Client,Node}VersionDataCodec` to `DMQ.NodeTo{Client,Node}`
4+
modules.
5+
- Removed `nodeTo{Client,Node}CodecCBORTerm`, use the above binding instead.
6+
7+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
### Breaking
2+
3+
- `VersionDataCodec` and `cborTermVersionDataCodec` moved to
4+
`ouroboros-network:api` package (`Ouroboros.Network.CodecCBORTerm` module).
5+
- `VersionDataCodec`: removed the `bytes` polymorphic variable, since it was
6+
always instantiated to `CBOR.Term`.
7+
- `CodecCBORTerm` module provides now `VersionedCodecCBORTerm` a versioned
8+
version of `CodecCBORTerm`, and a pattern synonym `VersionDataCodec` as used
9+
in the rest of the codebase. The `cborTermVersionDataCodec` was renamed as
10+
`mkVersionedCodecCBORTerm`. Also added its inverse `unVersionCodecCBORTerm`.

0 commit comments

Comments
 (0)