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.

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

move token burn prep into the shares logic #63

Open
wants to merge 1 commit into
base: merge-train-r4-test
Choose a base branch
from
Open

move token burn prep into the shares logic #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
100 changes: 99 additions & 1 deletion ...enderCommitmentForwarder/extensions/LenderCommitmentGroup/LenderCommitmentGroupShares.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,25 @@ pragma solidity >=0.8.0 <0.9.0;
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/access/Ownable.sol";



contract LenderCommitmentGroupShares is ERC20, Ownable {
uint8 private immutable DECIMALS;


mapping(address => uint256) public poolSharesPreparedToWithdrawForLender;
mapping(address => uint256) public poolSharesPreparedTimestamp;


event SharesPrepared(
address recipient,
uint256 sharesAmount,
uint256 preparedAt

);



constructor(string memory _name, string memory _symbol, uint8 _decimals)
ERC20(_name, _symbol)
Ownable()
Expand All @@ -18,11 +34,93 @@ contract LenderCommitmentGroupShares is ERC20, Ownable {
_mint(_recipient, _amount);
}

function burn(address _burner, uint256 _amount) external onlyOwner {
function burn(address _burner, uint256 _amount, uint256 withdrawDelayTimeSeconds) external onlyOwner {


//require prepared
require(poolSharesPreparedToWithdrawForLender[_burner] >= _amount,"Shares not prepared for withdraw");
require(poolSharesPreparedTimestamp[_burner] <= block.timestamp - withdrawDelayTimeSeconds,"Shares not prepared for withdraw");


//reset prepared
poolSharesPreparedToWithdrawForLender[_burner] = 0;
poolSharesPreparedTimestamp[_burner] = block.timestamp;


_burn(_burner, _amount);
}

function decimals() public view virtual override returns (uint8) {
return DECIMALS;
}


// ----

function _afterTokenTransfer(
address from,
address to,
uint256 amount
) internal override {


//reset prepared
poolSharesPreparedToWithdrawForLender[from] = 0;
poolSharesPreparedTimestamp[from] = block.timestamp;

}


// ----


/**
* @notice Prepares shares for withdrawal, allowing the user to burn them later for principal tokens + accrued interest.
* @param _amountPoolSharesTokens Amount of pool shares to prepare for withdrawal.
* @return True if the preparation is successful.
*/
function prepareSharesForBurn(
address _recipient,
uint256 _amountPoolSharesTokens
) external onlyOwner
returns (bool) {

return _prepareSharesForBurn(_recipient, _amountPoolSharesTokens);
}


/**
* @notice Internal function to prepare shares for withdrawal using the required delay to mitigate sandwich attacks.
* @param _recipient Address of the user preparing their shares.
* @param _amountPoolSharesTokens Amount of pool shares to prepare for withdrawal.
* @return True if the preparation is successful.
*/

function _prepareSharesForBurn(
address _recipient,
uint256 _amountPoolSharesTokens
) internal returns (bool) {

require( balanceOf(_recipient) >= _amountPoolSharesTokens );

poolSharesPreparedToWithdrawForLender[_recipient] = _amountPoolSharesTokens;
poolSharesPreparedTimestamp[_recipient] = block.timestamp;


emit SharesPrepared(
_recipient,
_amountPoolSharesTokens,
block.timestamp

);

return true;
}







}
88 changes: 17 additions & 71 deletions ...enderCommitmentForwarder/extensions/LenderCommitmentGroup/LenderCommitmentGroup_Smart.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,8 @@ contract LenderCommitmentGroup_Smart is



mapping(address => uint256) public poolSharesPreparedToWithdrawForLender;
mapping(address => uint256) public poolSharesPreparedTimestamp;
uint256 immutable public DEFAULT_WITHDRAWL_DELAY_TIME_SECONDS = 300;
uint256 immutable public MAX_WITHDRAWL_DELAY_TIME = 86400;
uint256 immutable public DEFAULT_WITHDRAW_DELAY_TIME_SECONDS = 300;
uint256 immutable public MAX_WITHDRAW_DELAY_TIME = 86400;

//mapping(address => uint256) public principalTokensCommittedByLender;
mapping(uint256 => bool) public activeBids;
Expand All @@ -152,7 +150,7 @@ contract LenderCommitmentGroup_Smart is
int256 tokenDifferenceFromLiquidations;

bool public firstDepositMade;
uint256 public withdrawlDelayTimeSeconds;
uint256 public withdrawDelayTimeSeconds;

IUniswapPricingLibrary.PoolRouteConfig[] public poolOracleRoutes;

Expand Down Expand Up @@ -218,12 +216,6 @@ contract LenderCommitmentGroup_Smart is
uint256 totalInterestCollected
);

event PoolSharesPrepared(
address lender,
uint256 sharesAmount,
uint256 preparedAt

);

event WithdrawFromEscrow(

Expand Down Expand Up @@ -312,7 +304,7 @@ contract LenderCommitmentGroup_Smart is

marketId = _commitmentGroupConfig.marketId;

withdrawlDelayTimeSeconds = DEFAULT_WITHDRAWL_DELAY_TIME_SECONDS;
withdrawDelayTimeSeconds = DEFAULT_WITHDRAW_DELAY_TIME_SECONDS;

//in order for this to succeed, first, the SmartCommitmentForwarder needs to be a trusted forwarder for the market
ITellerV2Context(TELLER_V2).approveMarketForwarder(
Expand Down Expand Up @@ -362,12 +354,12 @@ contract LenderCommitmentGroup_Smart is
* @notice Sets the delay time for withdrawing funds. Only Protocol Owner.
* @param _seconds Delay time in seconds.
*/
function setWithdrawlDelayTime(uint256 _seconds)
function setWithdrawDelayTime(uint256 _seconds)
external
onlyProtocolOwner {
require( _seconds < MAX_WITHDRAWL_DELAY_TIME );
require( _seconds < MAX_WITHDRAW_DELAY_TIME );

withdrawlDelayTimeSeconds = _seconds;
withdrawDelayTimeSeconds = _seconds;
}


Expand Down Expand Up @@ -476,22 +468,12 @@ contract LenderCommitmentGroup_Smart is
require( principalTokenBalanceAfter == principalTokenBalanceBefore + _amount, "Token balance was not added properly" );

sharesAmount_ = _valueOfUnderlying(_amount, sharesExchangeRate());




totalPrincipalTokensCommitted += _amount;


//mint shares equal to _amount and give them to the shares recipient !!!

//mint shares equal to _amount and give them to the shares recipient
poolSharesToken.mint(_sharesRecipient, sharesAmount_);



// prepare current balance
uint256 sharesBalance = poolSharesToken.balanceOf(address(_sharesRecipient));
_prepareSharesForWithdraw(_sharesRecipient,sharesBalance);



emit LenderAddedPrincipal(

msg.sender,
Expand Down Expand Up @@ -609,48 +591,16 @@ contract LenderCommitmentGroup_Smart is

}

/**
* @notice Prepares shares for withdrawal, allowing the user to burn them later for principal tokens + accrued interest.
* @param _amountPoolSharesTokens Amount of pool shares to prepare for withdrawal.
* @return True if the preparation is successful.
*/
function prepareSharesForWithdraw(

function prepareSharesForBurn(
uint256 _amountPoolSharesTokens
) external whenForwarderNotPaused whenNotPaused nonReentrant
returns (bool) {

return _prepareSharesForWithdraw(msg.sender, _amountPoolSharesTokens);
return poolSharesToken.prepareSharesForBurn(msg.sender, _amountPoolSharesTokens);
}


/**
* @notice Internal function to prepare shares for withdrawal using the required delay to mitigate sandwich attacks.
* @param _recipient Address of the user preparing their shares.
* @param _amountPoolSharesTokens Amount of pool shares to prepare for withdrawal.
* @return True if the preparation is successful.
*/

function _prepareSharesForWithdraw(
address _recipient,
uint256 _amountPoolSharesTokens
) internal returns (bool) {

require( poolSharesToken.balanceOf(_recipient) >= _amountPoolSharesTokens );

poolSharesPreparedToWithdrawForLender[_recipient] = _amountPoolSharesTokens;
poolSharesPreparedTimestamp[_recipient] = block.timestamp;


emit PoolSharesPrepared(

_recipient,
_amountPoolSharesTokens,
block.timestamp

);

return true;
}


/**
Expand All @@ -668,21 +618,17 @@ contract LenderCommitmentGroup_Smart is
) external whenForwarderNotPaused whenNotPaused nonReentrant onlyOracleApprovedAllowEOA
returns (uint256) {

require(poolSharesPreparedToWithdrawForLender[msg.sender] >= _amountPoolSharesTokens,"Shares not prepared for withdraw");
require(poolSharesPreparedTimestamp[msg.sender] <= block.timestamp - withdrawlDelayTimeSeconds,"Shares not prepared for withdraw");

//require(poolSharesPreparedToWithdrawForLender[msg.sender] >= _amountPoolSharesTokens,"Shares not prepared for withdraw");
// require(poolSharesPreparedTimestamp[msg.sender] <= block.timestamp - withdrawlDelayTimeSeconds,"Shares not prepared for withdraw");

poolSharesPreparedToWithdrawForLender[msg.sender] = 0;
poolSharesPreparedTimestamp[msg.sender] = block.timestamp;


//this should compute BEFORE shares burn
uint256 principalTokenValueToWithdraw = _valueOfUnderlying(
_amountPoolSharesTokens,
sharesExchangeRateInverse()
);

poolSharesToken.burn(msg.sender, _amountPoolSharesTokens);
poolSharesToken.burn(msg.sender, _amountPoolSharesTokens, withdrawDelayTimeSeconds);

totalPrincipalTokensWithdrawn += principalTokenValueToWithdraw;

Expand Down
2 changes: 1 addition & 1 deletion packages/contracts/contracts/interfaces/ILenderCommitmentGroup.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ interface ILenderCommitmentGroup {



function prepareSharesForWithdraw(
function prepareSharesForBurn(
uint256 _amountPoolSharesTokens
) external returns (bool);

Expand Down
4 changes: 2 additions & 2 deletions packages/contracts/contracts/penetrationtesting/LenderGroupMockInteract.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ contract LenderGroupMockInteract {
* @param _target The LenderCommitmentGroup contract address.
* @param _amountPoolSharesTokens The amount of share tokens to prepare for withdrawal.
*/
function prepareSharesForWithdraw(
function prepareSharesForBurn(
address _target,
uint256 _amountPoolSharesTokens
) external {
ILenderCommitmentGroup(_target).prepareSharesForWithdraw(
ILenderCommitmentGroup(_target).prepareSharesForBurn(
_amountPoolSharesTokens
);
}
Expand Down
4 changes: 2 additions & 2 deletions packages/contracts/tests/SmartCommitmentForwarder/LenderCommitmentGroup_Smart_Override.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ contract LenderCommitmentGroup_Smart_Override is LenderCommitmentGroup_Smart {



function mock_prepareSharesForWithdraw(
/* function mock_prepareSharesForWithdraw(
uint256 _amountPoolSharesTokens
) external {
poolSharesPreparedToWithdrawForLender[msg.sender] = _amountPoolSharesTokens;
poolSharesPreparedTimestamp[msg.sender] = block.timestamp;

}
} */


function getMinimumAmountDifferenceToCloseDefaultedLoan(
Expand Down
6 changes: 3 additions & 3 deletions packages/contracts/tests/SmartCommitmentForwarder/LenderCommitmentGroup_Smart_Test.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ contract LenderCommitmentGroup_Smart_Test is Testable {

vm.prank(address(lender));

lenderCommitmentGroupSmart.prepareSharesForWithdraw(sharesAmount);
lenderCommitmentGroupSmart.prepareSharesForBurn(sharesAmount);

vm.warp(1000);

Expand Down Expand Up @@ -391,7 +391,7 @@ contract LenderCommitmentGroup_Smart_Test is Testable {

vm.prank(address(lender));

lenderCommitmentGroupSmart.prepareSharesForWithdraw(sharesAmount);
lenderCommitmentGroupSmart.prepareSharesForBurn(sharesAmount);

vm.warp(1000);

Expand Down Expand Up @@ -445,7 +445,7 @@ contract LenderCommitmentGroup_Smart_Test is Testable {

vm.prank(address(lender));

lenderCommitmentGroupSmart.prepareSharesForWithdraw(sharesAmount);
lenderCommitmentGroupSmart.prepareSharesForBurn(sharesAmount);

vm.warp(1000);

Expand Down