docs: fix the escrow release: bullet describing the replaced split algorithm - #195
Open
chmm195 wants to merge 1 commit into
Open
docs: fix the escrow release: bullet describing the replaced split algorithm#195chmm195 wants to merge 1 commit into
chmm195 wants to merge 1 commit into
Conversation
The bullet said the last recipient absorbs the integer-division remainder, which was replaced by largest-remainder allocation in MergeFi#25/MergeFi#55. It contradicted the 'Split rounding and dust' section 50 lines above in the same file. Describe largest-remainder rounding and link to that section. Closes MergeFi#108
|
@chmm195 is attempting to deploy a commit to the chonilius' projects Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #108.
README only, one bullet.
The
release:bullet undercontracts/escrowstill described the pre-#25/#55 behaviour — last recipient absorbs the integer-division remainder — which the Split rounding and dust section 50 lines earlier explicitly calls out as the old algorithm. Verified againstcompute_splitincontracts/escrow/src/lib.rs: it is largest-remainder with stable input-order tie-breaking, as the earlier section describes.The replacement states the rule inline (
floor(distributable * bps / 10000), dust to the largest fractional remainders, stable tie-break) and links down to the detailed section rather than restating all of it, so the two cannot drift apart again the same way.I kept the "no dust is stranded in the contract" guarantee, since it is still true, and added that recipient order carries no economic weight — that was the actual point of the change in #25, and it is the part a reader of this bullet most needs to know.
Rewrapped the bullet to the ~72 column width the rest of the file uses; the diff is a little wider than the one changed sentence for that reason.