docs: state that fee-on-transfer and rebasing tokens are unsupported - #350
Merged
Merged
Conversation
autonolas-registries carries this note in its README; tokenomics did not, so the assumption existed only in Treasury source comments - 'We assume that authorized LP tokens in the protocol are safe as they are enabled via the governance / UniswapV2ERC20 realization has a standard transferFrom()' above the deposit transfer, and again above the withdrawal. That is easy to miss without reading the contract, and the boundary matters: the reserve ledger books bond deposits at their nominal amount and reconciles against nothing, which is correct for standard LP tokens and wrong for any token whose balance moves outside a transfer. A reviewer reading only the README could reasonably conclude the ledger is meant to hold arbitrary tokens. Mirrors the registries wording verbatim so the two repos state the same assumption in the same terms, with one sentence naming where it bites.
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.
autonolas-registriesstates this in its README;autonolas-tokenomicsdoes not, so the assumption lives only inTreasurysource comments:— above the deposit transfer, and again above the withdrawal.
Why it is worth stating in the README
The boundary is load-bearing. The Treasury reserve ledger books bond deposits at their nominal amount and reconciles against nothing, which is correct for standard LP tokens and wrong for any token whose balance moves outside a transfer. Someone reading only the README could reasonably conclude the ledger is meant to hold arbitrary tokens — and then report the resulting divergence as a defect.
That has now happened, so this is a real gap rather than a hypothetical one.
What it says
The two lines are copied verbatim from the registries README so both repos state the same assumption in the same terms, plus one sentence naming where it bites:
Documentation only — no code change.