Skip to content
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.

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

Cleanup OUSD rebasing/nonrebasing accounting changes #1239

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open
Changes from 4 commits
Commits
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
77 changes: 41 additions & 36 deletions contracts/contracts/token/OUSD.sol
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@ contract OUSD is Initializable, InitializableERC20Detailed, Governable {
function _isNonRebasingAccount(address _account) internal returns (bool) {
bool isContract = Address.isContract(_account);
if (isContract && rebaseState[_account] == RebaseOptions.NotSet) {
_ensureRebasingMigration(_account);
_ensureMigrationToNonRebasing(_account);
DanielVF marked this conversation as resolved.
Show resolved Hide resolved
}
return nonRebasingCreditsPerToken[_account] > 0;
}
Expand All @@ -466,24 +466,33 @@ contract OUSD is Initializable, InitializableERC20Detailed, Governable {
* @dev Ensures internal account for rebasing and non-rebasing credits and
* supply is updated following deployment of frozen yield change.
*/
function _ensureRebasingMigration(address _account) internal {
if (nonRebasingCreditsPerToken[_account] == 0) {
if (_creditBalances[_account] == 0) {
// Since there is no existing balance, we can directly set to
// high resolution, and do not have to do any other bookkeeping
nonRebasingCreditsPerToken[_account] = 1e27;
} else {
// Migrate an existing account:

// Set fixed credits per token for this account
nonRebasingCreditsPerToken[_account] = _rebasingCreditsPerToken;
// Update non rebasing supply
nonRebasingSupply = nonRebasingSupply.add(balanceOf(_account));
// Update credit tallies
_rebasingCredits = _rebasingCredits.sub(
_creditBalances[_account]
);
}
function _ensureMigrationToNonRebasing(address _account) internal {
if (nonRebasingCreditsPerToken[_account] != 0) {
return; // Account already is non-rebasing
}
if (_creditBalances[_account] == 0) {
// Since there is no existing balance, we can directly set to
DanielVF marked this conversation as resolved.
Show resolved Hide resolved
// high resolution, and do not have to do any other bookkeeping
nonRebasingCreditsPerToken[_account] = 1e27;
} else {
// Get old values, so we can use them unaffected by changes
uint256 oldBalance = balanceOf(_account);
uint256 oldCredits = _creditBalances[_account];

// Atomicly update account information:
// It is important that balanceOf not be called inside updating
// account data, since it will give wrong answers if it does
// not have all an account's data in a consistent state.
nonRebasingCreditsPerToken[_account] = 1e27;
// difference between the 1e18 balance and the new 1e27 resolution
_creditBalances[_account] = oldBalance * 1e9;
DanielVF marked this conversation as resolved.
Show resolved Hide resolved

// Verify perfect acccount accounting update
require(oldBalance == balanceOf(_account), "Balances do not match");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to better sleep at night :)


// Update global totals:
nonRebasingSupply = nonRebasingSupply.add(oldBalance);
_rebasingCredits = _rebasingCredits.sub(oldCredits);
}
}

Expand All @@ -495,24 +504,28 @@ contract OUSD is Initializable, InitializableERC20Detailed, Governable {
function rebaseOptIn() public nonReentrant {
require(_isNonRebasingAccount(msg.sender), "Account has not opted out");

// Precalculate new credits, so that we avoid internal calls when
// atomicly updating account.
// Convert balance into the same amount at the current exchange rate
uint256 newCreditBalance = _creditBalances[msg.sender]
.mul(_rebasingCreditsPerToken)
.div(_creditsPerToken(msg.sender));

// Decreasing non rebasing supply
nonRebasingSupply = nonRebasingSupply.sub(balanceOf(msg.sender));

// Atomicly update this account:
// Important that no internal calls happen during this.
// Remove pinned fixed credits per token
delete nonRebasingCreditsPerToken[msg.sender];
// New credits
_creditBalances[msg.sender] = newCreditBalance;
// Mark explicitly opted out of rebasing
DanielVF marked this conversation as resolved.
Show resolved Hide resolved
rebaseState[msg.sender] = RebaseOptions.OptIn;

// Update global totals:
// Decrease non rebasing supply
nonRebasingSupply = nonRebasingSupply.sub(balanceOf(msg.sender));
// Increase rebasing credits, totalSupply remains unchanged so no
// adjustment necessary
_rebasingCredits = _rebasingCredits.add(_creditBalances[msg.sender]);
DanielVF marked this conversation as resolved.
Show resolved Hide resolved

rebaseState[msg.sender] = RebaseOptions.OptIn;

// Delete any fixed credits per token
delete nonRebasingCreditsPerToken[msg.sender];
}

/**
Expand All @@ -521,16 +534,8 @@ contract OUSD is Initializable, InitializableERC20Detailed, Governable {
function rebaseOptOut() public nonReentrant {
require(!_isNonRebasingAccount(msg.sender), "Account has not opted in");

// Increase non rebasing supply
nonRebasingSupply = nonRebasingSupply.add(balanceOf(msg.sender));
// Set fixed credits per token
nonRebasingCreditsPerToken[msg.sender] = _rebasingCreditsPerToken;

// Decrease rebasing credits, total supply remains unchanged so no
// adjustment necessary
_rebasingCredits = _rebasingCredits.sub(_creditBalances[msg.sender]);
_ensureMigrationToNonRebasing(msg.sender);

// Mark explicitly opted out of rebasing
rebaseState[msg.sender] = RebaseOptions.OptOut;
}

Expand Down