Skip to content

Commit

Permalink
Added entry in docs/interface-CHANGELOG.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
coot committed Jun 24, 2022
1 parent c583260 commit 8980452
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/interface-CHANGELOG.md
Expand Up @@ -5,6 +5,23 @@ team. See [consensus
CHANGELOG](../ouroboros-consensus/docs/interface-CHANGELOG.md) file for how
this changelog is supposed to be used.

## Circa 2022-05-23

- redesign of `typed-protocols`. Each pipelining client now tracks unsatisfied
transitions using a type level fifo. For example in the context of a simple
[`ping-poing` mini-protocol](https://input-output-hk.github.io/ouroboros-network/typed-protocols-examples/Network-TypedProtocol-PingPong-Type.html#t:PingPong)
if a pipelining clients sends two `MsgPing`, the queue will contain two yet
unsatisfied transitions `StBusy -> StIdle`. They can be taken out of the
queue in a fifo order using one of the `Collect`, `CollectSTM`, `CollectDone`
primitives which usually are packaged. In particular all pipelining clients
will need to be updated.

- `Data.Type.Nat` was moved from `typed-protocols` to `ouroboros-network` package.

- Pipeliend decisions are still using `Nat` singletons; one needs
`Data.Type.Nat.queueDepthNat` or `Data.Type.Nat.queueFDepthNat` to transform
one of the `Queue` singletons to a `Nat`.

## Circa 2022-05-19

- removed `node-to-client` versions `1` to `8`. The lowest supported version is
Expand All @@ -18,7 +35,6 @@ this changelog is supposed to be used.
- `typed-protocols`, `typed-protocols-cborg` and `typed-protocols` were moved
to https://github.com/input-output-hk/typed-protocols


## Circa 2022-04-06

- removed `node-to-node` versions `1` to `6`. The lowest supported version is
Expand Down

0 comments on commit 8980452

Please sign in to comment.