Skip to content

Commit 17eb0d6

Browse files
committed
Add changelog entries
1 parent 78639a1 commit 17eb0d6

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-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+
- The changes in `ouroboros-consensus-cardano` renamed `DiskSnapshot` to `DiskSnapshotName` and introduced a new type `DiskSnapshot` that carries a checksum. This change is propagated here as well.
4+
5+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Breaking
2+
3+
- Rename `DiskSnapshot` to `DiskSnapshotName`; `DiskSnapshot` is now a record of a `DiskSnapshotName` and a CRC checksum of the data.
4+
- When writing a ledger state snapshot to disk, calculate the state's CRC checksum and write it to a separate file, which is named the same as the snapshot file, plus the `.crc` extension.
5+
- When reading a snapshot file, calculate its checksum and compare it to the value in the corresponding `.crc` file. Return an error if either the checksum file does not exist or the checksum is wrong.
6+
- To support the previous item, change the error type of the `readSnapshot` from `ReadIncrementalErr` to the extended `ReadSnaphotErr`.
7+
8+
- Make `Ouroboros.Consensus.Util.CBOR.readIncremental` compute the checksum of the data as it is read.
9+
10+
### Non-breaking
11+
12+
- Introduce an explicit `Ord` instance for `DiskSnapshotName` that compares the values on `dsnNumber`.
13+

0 commit comments

Comments
 (0)