Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UTxO-HD: start documentation report #4060

Merged

Conversation

jasagredo
Copy link
Contributor

Description

Builds on top of #4049.

Starts a document that serves as an extension to the report concerning only UTxO-HD. In particular it describes how the mempool works at the moment.

Closes #4053.

@jasagredo jasagredo added documentation Network Documentation related tasks UTxO-HD 📒💽 labels Oct 6, 2022
@jasagredo jasagredo self-assigned this Oct 6, 2022
@jasagredo jasagredo requested review from jorisdral and removed request for a team, newhoggy, coot and bolt12 October 6, 2022 08:50
@jasagredo jasagredo linked an issue Oct 6, 2022 that may be closed by this pull request
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
Copy link
Member

@dnadales dnadales left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say we could merge this to the feature branch. At some point we should include into feature/utxo-hd the documents Duncan wrote.

ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
Comment on lines +727 to +1004
On Byron, some addresses existed there to be reclaimed by
investors\footnote{These were called AVVM addresses. Perhaps the Ledger team can
tell more about them}, and as some were never reclaimed, the ledger made the
decision of giving the Ada in those addresses back to the treasury. This
happened on the Allegra boundary, and therefore the ledger state has been
modified to keep track of this information so that the era transition can
consume these entries into the treasury and return a set of deletions of those
addresses on the UTxO set.

See \texttt{Cardano.Ledger.Allegra.Translation.shelleyToAllegraAVVMsToDelete}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the first version of the anti-diff integration where forwarding would still perform sanity checks on the inserts/deletes, this translation proved to be a bit hairy. In particular, the translation would emit the AVVM deletions as diffs, but flushing these diffs to the in-memory backing store would error. My understanding was that it would error because the diffs declared values to be deleted even though these values were not present in the backing store.

https://github.com/input-output-hk/ouroboros-network/tree/jdral/bugfix-shelley-allegra-translation fixes this issue by not emitting the deletions as diffs. I'm not sure if this is a correct fix though

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding was that it would error because the diffs declared values to be deleted even though these values were not present in the backing store.

This is wrong. The values are in the backing store

Copy link
Contributor

@bartfrenk bartfrenk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments. Hope they are useful. I haven't gotten to the MemPool part yet. Will do that tomorrow.

ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
@jasagredo jasagredo force-pushed the jasagredo/document-mempool-rewrite-utxo-hd branch 2 times, most recently from 034effa to cb86fd8 Compare October 19, 2022 16:54
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Outdated Show resolved Hide resolved
ouroboros-consensus/docs/utxo-hd/report.tex Show resolved Hide resolved
@jasagredo jasagredo force-pushed the jasagredo/document-mempool-rewrite-utxo-hd branch from 675b932 to 503d040 Compare November 14, 2022 10:42
@jasagredo jasagredo force-pushed the jasagredo/document-mempool-rewrite-utxo-hd branch from 503d040 to 6ec7ec6 Compare November 14, 2022 10:56
@jasagredo jasagredo merged commit aeca7b7 into feature/utxo-hd Nov 15, 2022
@iohk-bors iohk-bors bot deleted the jasagredo/document-mempool-rewrite-utxo-hd branch November 15, 2022 08:52
jasagredo added a commit that referenced this pull request Nov 17, 2022
…ool-rewrite-utxo-hd

UTxO-HD: start documentation report
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Network Documentation related tasks UTxO-HD 📒💽
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document mempool refactor and design as of UTxO-HD
6 participants