Skip to content

Commit 1201acc

Browse files
committed
Slightly improve the beginning of the introduction
1 parent d0b1533 commit 1201acc

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

doc/final-report/final-report.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -113,25 +113,26 @@ references:
113113

114114
# Introduction
115115

116-
As part of the project to reduce `cardano-node`’s memory use [@utxo-db], by
117-
storing the bulk of the ledger state on disk (colloquially known as
118-
"UTxO-HD"[^1]), a high-performance disk backend has been developed as an
119-
arm’s-length project by Well-Typed LLP on behalf of Intersect MBO[^2]. The
120-
intent is for the backend to be integrated into the consensus layer of
121-
`cardano-node`, specifically to be used for storing the large parts of the
122-
Cardano ledger state.
123-
124-
This backend is now complete. It satisfies all its functional requirements, and
125-
meets all its performance requirements, including stretch targets.
126-
127-
[^1]: "UTxO-HD" is a classic project-manager's misnomer. It is not just about
128-
the UTxO, but all of the ledger state, and it is not about hard drives.
129-
Indeed the performance of hard drives is too low to support the feature.
130-
A better project name would be "On-disk ledger state", but there's no way
131-
to remove poorly chosen names from people's heads once they're firmly
116+
As part of the project to reduce `cardano-node`’s memory use [@utxo-db] by
117+
storing the bulk of the ledger state on disk, colloquially known as UTxO-HD[^1],
118+
a high-performance disk backend was developed as an arm’s-length project by
119+
Well-Typed LLP on behalf of Intersect MBO[^2]. The intent is for the backend to
120+
be integrated into the consensus layer of `cardano-node`, specifically to be
121+
used for storing the larger parts of the Cardano ledger state.
122+
123+
[^1]: ‘UTxO-HD’ is a classic project-manager’s misnomer. The project is not just
124+
about the UTxO but also other parts of the ledger state, and it is not
125+
about hard drives. Indeed, the performance of hard drives is too low to
126+
support the feature; faster drives like SSDs are needed instead. A better
127+
project name would be ‘On-disk ledger state’, but there is no way to
128+
remove poorly chosen names from people’s heads once they are firmly
132129
engrained.
133130

134-
[^2]: And previously on behalf of Input Output Global, Inc. (IOG).
131+
[^2]: In its early stages, it was developed on behalf of Input Output Global,
132+
Inc. (IOG).
133+
134+
This backend is now complete. It satisfies all its functional requirements and
135+
meets all its performance requirements, including stretch targets.
135136

136137
The backend is implemented as a Haskell library called `lsm-tree` [@lsm-tree],
137138
which provides efficient on-disk key–value storage using log-structured

0 commit comments

Comments
 (0)