docs: replace buyAmount with minBuyAmount/maxBuyAmount split - #4
Open
jean-neiverth wants to merge 2 commits into
Open
docs: replace buyAmount with minBuyAmount/maxBuyAmount split#4jean-neiverth wants to merge 2 commits into
jean-neiverth wants to merge 2 commits into
Conversation
Reflects the on-chain change from bleu/byos-contracts#38 and the design decisions from the byos-service-ts grill-me session. Key changes across all docs: - ProposalData struct goes from 6 to 7 fields - minBuyAmount is the on-chain revert floor (delta check) - maxBuyAmount is the clearing-price commitment (scoring, gas cut, settlement) - New envelope rules: sell orders enforce order.buyAmount <= minBuyAmount <= maxBuyAmount; buy orders hard-reject minBuyAmount != maxBuyAmount - New post-settlement slippage accounting section under penalties - solutions table stores buy_token_ref_price for ETH conversion - Glossary adds "Floor and ceiling" term - Sub-solver integration guide updated with aggressive-slippage guidance
… claim functions Document the slippage ledger model (threshold clearing, credit payouts, GET /slippage-balance endpoint) from byos-service-ts#48 across all docs. Fix the stale nonce paragraph that claimed the Trampoline was storage-free when nonces are enforced on-chain. Correct the residue section to reflect that claimToken/claimTokens exist for non-trade-token strays. Add the post-settlement-slippage-accounting anchor, fix the contracts.md link, and explicitly call out partial-fill order support.
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.
Summary
Reflects the on-chain change from bleu/byos-contracts#38 and the design decisions from the byos-service-ts grill-me session.
buyAmountwithminBuyAmount/maxBuyAmountacross proposal schema, order-flow diagrams, envelope check, simulation, scoring, solution shape, and residue. Add "Floor and ceiling" subsection under order-flow and "Post-settlement slippage accounting" subsection under penalties.Executedevent signature (3 → 4 fields),FloorNotMeterror description, and add post-settlement accounting to interaction description.buy_token_ref_pricein solutions table, update surplus definition.Test plan
buyAmountreferences remain (grep -rP '(?<!min)(?<!max)(?<!order\.)(?<!\.)buyAmount' **/*.mdreturns nothing)Executedevent signature in contracts.md matches feat(trampoline): split buyAmount into minBuyAmount/maxBuyAmount (COW-1261) byos-contracts#38