docs: rename slippage accounting to buffer - #6
Merged
Merged
Conversation
…n_amount Align docs with byos-service-ts naming changes: - slippage_entries → buffer_entries, slippage → buffer in accounting context - eth_amount → native_token_amount - GET /slippage-balance → GET /buffer-balance - slippageDebited → bufferDebited - Over-delivery credits now offset future shortfalls only (never paid out) - Add buy_token to buffer_entries table description
…ounting 'Loose slippage' describes the feature of accepting wider price slippage — it stays. 'Buffer' replaces 'slippage' only for the concrete accounting artifacts (table, endpoint, events, ledger).
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
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
Aligns docs with the naming changes from the
feat/slippage-balance-endpointbranch inbyos-service-ts(commits096d508,e86c0eb,444e297):slippage→bufferin all accounting contexts: table names (slippage_entries→buffer_entries), endpoint (GET /slippage-balance→GET /buffer-balance), audit events (slippageDebited→bufferDebited), and terminology ("loose slippage" → "loose buffer", "slippage clearing" → "buffer clearing")eth_amount→native_token_amount: all references to "converted to ETH" updated to "converted to native token"buy_tokenfield: added to thebuffer_entriestable description inservice.mdReferences to CoW protocol-level slippage (settlement slippage returned weekly, buffer usage) are intentionally unchanged — those refer to a different concept.
Files changed
design-document.md#post-settlement-slippage-accountinganchor to#post-settlement-buffer-accounting; updated terminology and credit semantics throughoutservice.mdcontracts.mdguides/sub-solver-integration.mdglossary.mdTest plan
#post-settlement-buffer-accounting)slippagereferences in BYOS-accounting context (CoW-level slippage references are intentional)byos-service-tsfeat/slippage-balance-endpointbranch🤖 Generated with Claude Code