Skip to content

Improve total balance documentation#277

Open
jordanschalm wants to merge 3 commits intomainfrom
jord/total-balance-docs
Open

Improve total balance documentation#277
jordanschalm wants to merge 3 commits intomainfrom
jord/total-balance-docs

Conversation

@jordanschalm
Copy link
Member

This PR aims to make it clear that the total credit/debit balance fields differ from other balance tracking. In positions, we track a scaled balance, which can be converted to a true balance using a frequently-updated interest index.

The total balance fields are neither a scaled balance nor a true value. They represent actual in- and out-flows of tokens, and do not account for interest accrual. We expect them to relate to the reserve balances, but not to interest-adjust position balances.

@jordanschalm
Copy link
Member Author

This PR documents these values as they are now. Discussion on whether they should change are in this thread: https://flow-foundation.slack.com/archives/C08QF29F7TK/p1773783670640229

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.

2 participants