Skip to content

docs: rename slippage accounting to buffer - #6

Merged
jean-neiverth merged 2 commits into
mainfrom
docs/slippage-to-buffer-rename
Aug 17, 2026
Merged

jean-neiverth merged 2 commits into
mainfrom
docs/slippage-to-buffer-rename

Conversation

@jean-neiverth

Copy link
Copy Markdown
Contributor

Summary

Aligns docs with the naming changes from the feat/slippage-balance-endpoint branch in byos-service-ts (commits 096d508, e86c0eb, 444e297):

  • slippage → buffer in 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_token field: added to the buffer_entries table description in service.md
  • Over-delivery credits are never paid out: removed all references to collateral deposits for over-delivery credits — credits now only offset future shortfalls

References to CoW protocol-level slippage (settlement slippage returned weekly, buffer usage) are intentionally unchanged — those refer to a different concept.

Files changed

File Changes
design-document.md Renamed #post-settlement-slippage-accounting anchor to #post-settlement-buffer-accounting; updated terminology and credit semantics throughout
service.md Updated listener table, penalty loop description, and persistence table
contracts.md Updated escrow event description and "How BYOS interacts" section
guides/sub-solver-integration.md Updated risk section, API endpoints table, and pre-launch checklist
glossary.md Updated "Floor and ceiling" entry

Test plan

  • Verify all internal anchor links resolve correctly (especially #post-settlement-buffer-accounting)
  • Confirm no remaining slippage references in BYOS-accounting context (CoW-level slippage references are intentional)
  • Cross-check terminology against byos-service-ts feat/slippage-balance-endpoint branch

🤖 Generated with Claude Code

…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).
@jean-neiverth
jean-neiverth merged commit 7ddbfdf into main Aug 17, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant