Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This fixes the bug discovered in IntersectMBO/cardano-node#4826. This issue merits a full retrospective, which we will provide. For now, however, we are applying the patch to the main ledger branch, adding property tests, and providing a terse explanation in these PR notes.
The
Data.Map.Internal
functionsbalanceR
andbalanceL
expect the size difference between their two arguments to be 0 or 1, which allows them to re-balance the underlying tree in constant time. The canonical map can, however, shrink by one when it places the multi-assets in canonical form, resulting in the tree becoming unbalanced. UnlikebalanceR
andbalanceL
,link
makes no assumptions about the relative balance, at the cost of spending log time re-balancing. The performance cost will not be noticeable.The credit goes to @TimSheard for finding the problem so fast. Also many thanks to @lehins for his help in quickly narrowing things down.
replaces #3271
Checklist
CHANGELOG.md
for affected packagefourmolu
(usescripts/fourmolize.sh
)scripts/cabal-format.sh
)hie.yaml
has been updated (usescripts/gen-hie.sh
)