Skip to content

Document virtual borrow assets behavior #639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 11, 2023
Merged

Document virtual borrow assets behavior #639

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d3e785a
docs(shares-math): document borrow share price
Rubilmax Dec 7, 2023
38070e3
docs(shares-math): fix wording
Rubilmax Dec 7, 2023
c5f6c94
docs(shares-math): change wording
Rubilmax Dec 7, 2023
7ab8eb5
docs(shares-math): capitalize natspec
Rubilmax Dec 7, 2023
867ca89
docs(shares-math): fix wording
Rubilmax Dec 8, 2023
d10c4e5
docs(shares-math): complete warning
Rubilmax Dec 11, 2023
dfe479e
docs(shares-math): generalize doc
Rubilmax Dec 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/libraries/SharesMathLib.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ library SharesMathLib {

/// @dev The number of virtual shares has been chosen low enough to prevent overflows, and high enough to ensure
/// high precision computations.
/// @dev Warning: The assets to which virtual borrow shares are entitled behave like unrealizable bad debt, but it
/// is assumed the borrow share price stays low enough to not inflate these assets.
uint256 internal constant VIRTUAL_SHARES = 1e6;

/// @dev A number of virtual assets of 1 enforces a conversion rate between shares and assets when a market is
Expand Down