Skip to content

Commit 736ff01

Browse files
committed
Added changelog
1 parent e3deb7f commit 736ff01

File tree

4 files changed

+82
-6
lines changed

4 files changed

+82
-6
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
### Non-Breaking
2+
3+
- Dependencies updated to `ouroboros-network` and `cardano-diffusion`.
4+
Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,30 @@
11
### Breaking
22

3-
- Initial release of `cardano-diffusion` package which is based on
3+
- Initial release of the `cardano-diffusion` package, which is based on
44
`ourorboros-network:cardano-diffusion` with the following modifications:
55
- Removed `Cardano.Network.Types` module. `LedgerStateJudgement` is available
6-
from `cardano-diffusion:api` package in
6+
from the `cardano-diffusion:api` package in
77
`Cardano.Network.LedgerStateJudgement` module. `NumberOfBigLedgerPeers` is
8-
avaialble from `cardano-diffusion` in `Cardano.Network.PeerSelection` module.
9-
- Added `Cardano.Network.PeerSelection` module which exports most of cardano
10-
related `PeerSelection` APIs - you can simplify your imports with it. It
11-
might be a good idea to imports this module qualified.
8+
available from `cardano-diffusion` in `Cardano.Network.PeerSelection` module.
9+
- Added `Cardano.Network.PeerSelection` module, which exports most of the
10+
Cardano-related `PeerSelection` APIs - you can simplify your imports with it.
11+
It might be a good idea to import this module qualified.
1212

13+
- `Cardano.Network.FetchMode` exports `ConsensusMode` and
14+
`LedgerStateJudgement` as these are arguments of `mkReadFetchMode`.
15+
16+
- `Cardano.Network.Types` module was removed. `LedgerStateJudgement` is
17+
available from the `cardano-diffusion:api` package in
18+
`Cardano.Network.LedgerStateJudgement` module. `NumberOfBigLedgerPeers` is
19+
available from `cardano-diffusion` in `Cardano.Network.PeerSelection` module.
20+
21+
- `Cardano.Network.PeerSelection.PeerSelectionActions.requestPublicRootPeers`
22+
was renamed as `requestPublicRootPeersImpl` to avoid a name clash with
23+
`PeerSelectionActions{requestPublicRootPeers}`.
24+
25+
- `Cardano.Network.LedgerPeerConsensusInterface` re-exports `FetchMode`,
26+
`LedgerStateJudgement` and `OutboundConnectionsState` since these types are
27+
appear in `LedgerPeerConsensusInterface` record.
28+
29+
- `Cardano.Network.PeerSelection.Churn` exports `PeerChurnArgs` for the
30+
completeness sake.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
### Non-Breaking
2+
3+
- Dependencies updated to `ouroboros-network` and `cardano-diffusion`.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
### Breaking
2+
3+
- All `ouroboros-*` where incorporated into `ouroboros-network`, at the same
4+
time all **Cardano** specific components were pulled into `cardano-diffusion`:
5+
6+
* `ouroboros-network-protocols` -> `ouroboros-network:protocols`
7+
* `ouroboros-network-protocols:testlib` -> `ouroboros-network:protocols-tests-lib`
8+
* `ouroboros-network-protocols:test` -> `ouroboros-network:protocols-tests`
9+
* `ouroboros-network-protocols:bench` -> `ouroboros-network:protocols-bench`
10+
* `ouroboros-network-framework` -> `ouroboros-network:framework`
11+
* `ouroboros-network-framework:testlib` -> `ouroboros-network:framework-tests-lib`
12+
* `ouroboros-network-framework:sim-tests` -> `ouroboros-network:framework-sim-tests`
13+
* `ouroboros-network-framework:io-tests` -> `ouroboros-network:framework-io-tests`
14+
* `ouroboros-network-framework:demo-connection-manager` -> `ouroboros-network:demo-connection-manager`
15+
* `ouroboros-network-framework:demo-ping-pong` -> `ouroboros-network:demo-ping-pong`
16+
* `ouroboros-newtork-mock` -> `ouroboros-network:mock`
17+
* `ouroboros-network:testlib` -> `ouroboros-network:ouroboros-network-tests-lib`
18+
* `ouroboros-network:sim-tests` -> `ouroboros-network:ouroboros-network-sim-tests`
19+
* `ouroboros-network:io-tests` -> `ouroboros-network:ouroboros-network-io-tests`
20+
* `ouroboros-network-testing` -> `ouroboros-network:tests-lib`
21+
* `ouroboros-network-testing:test` -> `ouroboros-network:tests-lib`
22+
* `ouroboros-network-api` -> `ouroboros-network:api`
23+
* `ouroboros-network-api:test` -> `ouroboros-network:api-tests`
24+
* `ouroboros-network-api:bench-anchored-fragment` -> `ouroboros-network:api-bench`
25+
26+
- The following modules were moved to a different namespace:
27+
* `ouroboros-network:api` - moved `NodeTo{Node,Client}` modules under `Cardano` namespace
28+
* `ouroboros-network:api-tests` - moved `NodeTo{Client,Node}.Version` tests
29+
* `ouroboros-network:api-tests` - moved Test.Cardano.Network.Version
30+
* `ouroboros-network:mock` - moved its last module to protocols-tests-lib
31+
32+
- Introduced `cardano-diffusion` package. It contains all `Cardano.Network`
33+
namespace.
34+
35+
- Added exports to `Ouroboros.Network.PeerSelection`, quite likely you can
36+
simplify your imports. If you need Cardano-specific peer selection, try
37+
importing from `Cardano.Network.PeerSelection` from `cardano-diffusion`
38+
package. It re-exports almost all of `Ouroboros.Network.PeerSelection`.
39+
40+
- `PeerChurnArgs{getLedgerStateCtx}` was renamed to
41+
`PeerChurnArgs{getLedgerPeersAPI}`, to avoid a name clash with
42+
`PeerSelectionActions{getLedgerStateCtx}`.
43+
44+
- `LocalRootConfig{extraFlags}` was renamed to
45+
`LocalRootConfig{extraLocalRootFlags}` to avoid a name clash with
46+
`LocalRootPeersGroup{extraFlags}` field in the `Ouroboros.Network.Topology`
47+
module.
48+
49+
- `Ouroboros.Network.PeerSelection.PeerSelectionActions.requestPublicRootPeers`
50+
was renamed as `requestPublicRootPeersImpl` to avoid a name clash with
51+
`PeerSelectionActions{requestPublicRootPeers}`.

0 commit comments

Comments
 (0)