Skip to content

Commit

Permalink
refactor(curve): "calculate" to "view" within curve
Browse files Browse the repository at this point in the history
  • Loading branch information
@zgorizzo69
Carl Farterson authored and zgorizzo69 committed Nov 17, 2021
1 parent 7c3e04f commit 886ea77
Show file tree
Hide file tree
Showing 9 changed files with 147 additions and 149 deletions.
134 changes: 66 additions & 68 deletions contracts/Foundry.sol
View file

Large diffs are not rendered by default.

88 changes: 44 additions & 44 deletions contracts/curves/BancorZeroCurve.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,123 +85,123 @@ contract BancorZeroCurve is ICurve {
}

/// @inheritdoc ICurve
function calculateMintReturn(
uint256 _tokensDeposited,
function viewMeTokensMinted(
uint256 _assetsDeposited,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view override returns (uint256 meTokensReturned) {
) external view override returns (uint256 meTokensMinted) {
Details.Bancor memory bancorDetails = _bancors[_hubId];
if (_supply > 0) {
meTokensReturned = _calculateMintReturn(
_tokensDeposited,
meTokensMinted = _viewMeTokensMinted(
_assetsDeposited,
bancorDetails.reserveWeight,
_supply,
_balancePooled
);
} else {
meTokensReturned = _calculateMintReturnFromZero(
_tokensDeposited,
meTokensMinted = _viewMeTokensMintedFromZero(
_assetsDeposited,
bancorDetails.reserveWeight,
bancorDetails.baseY
);
}
}

/// @inheritdoc ICurve
function calculateTargetMintReturn(
uint256 _tokensDeposited,
function viewTargetMeTokensMinted(
uint256 _assetsDeposited,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view override returns (uint256 meTokensReturned) {
) external view override returns (uint256 meTokensMinted) {
Details.Bancor memory bancorDetails = _bancors[_hubId];
if (_supply > 0) {
meTokensReturned = _calculateMintReturn(
_tokensDeposited,
meTokensMinted = _viewMeTokensMinted(
_assetsDeposited,
bancorDetails.targetReserveWeight,
_supply,
_balancePooled
);
} else {
meTokensReturned = _calculateMintReturnFromZero(
_tokensDeposited,
meTokensMinted = _viewMeTokensMintedFromZero(
_assetsDeposited,
bancorDetails.targetReserveWeight,
bancorDetails.targetBaseY
);
}
}

/// @inheritdoc ICurve
function calculateBurnReturn(
function viewAssetsReturned(
uint256 _meTokensBurned,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view override returns (uint256 tokensReturned) {
) external view override returns (uint256 assetsReturned) {
Details.Bancor memory bancorDetails = _bancors[_hubId];
tokensReturned = _calculateBurnReturn(
assetsReturned = _viewAssetsReturned(
_meTokensBurned,
bancorDetails.reserveWeight,
_supply,
_balancePooled
);
}

function calculateTargetBurnReturn(
function viewTargetAssetsReturned(
uint256 _meTokensBurned,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view override returns (uint256 tokensReturned) {
) external view override returns (uint256 assetsReturned) {
Details.Bancor memory bancorDetails = _bancors[_hubId];
tokensReturned = _calculateBurnReturn(
assetsReturned = _viewAssetsReturned(
_meTokensBurned,
bancorDetails.targetReserveWeight,
_supply,
_balancePooled
);
}

function calculateTokensDeposited(
function viewAssetsDeposited(
uint256 _desiredMeTokens,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view override returns (uint256 tokensDeposited) {
) external view override returns (uint256 assetsDeposited) {
Details.Bancor memory bancor_ = _bancors[_hubId];
if (_supply > 0) {
tokensDeposited = _calculateTokensDeposited(
assetsDeposited = _viewAssetsDeposited(
_desiredMeTokens,
bancor_.reserveWeight,
bancor_.baseY,
_balancePooled
);
} else {
tokensDeposited = _calculateTokensDepositedFromZero(
assetsDeposited = _viewAssetsDepositedFromZero(
_desiredMeTokens,
bancor_.reserveWeight,
bancor_.baseY
);
}
}

function calculateTargetTokensDeposited(
function viewTargetAssetsDeposited(
uint256 _desiredMeTokens,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view override returns (uint256 tokensDeposited) {
) external view override returns (uint256 assetsDeposited) {
Details.Bancor memory bancor_ = _bancors[_hubId];
if (_supply > 0) {
tokensDeposited = _calculateTokensDeposited(
assetsDeposited = _viewAssetsDeposited(
_desiredMeTokens,
bancor_.targetReserveWeight,
bancor_.targetBaseY,
_balancePooled
);
} else {
tokensDeposited = _calculateTokensDepositedFromZero(
assetsDeposited = _viewAssetsDepositedFromZero(
_desiredMeTokens,
bancor_.targetReserveWeight,
bancor_.targetBaseY
Expand All @@ -211,14 +211,14 @@ contract BancorZeroCurve is ICurve {

/// @notice Given a deposit (in the connector token), reserve weight, meToken supply and
/// balance pooled, calculate the return for a given conversion (in the meToken)
/// @dev _supply * ((1 + _tokensDeposited / _balancePooled) ^ (_reserveWeight / 1000000) - 1)
/// @param _tokensDeposited amount of collateral tokens to deposit
/// @dev _supply * ((1 + _assetsDeposited / _balancePooled) ^ (_reserveWeight / 1000000) - 1)
/// @param _assetsDeposited amount of collateral tokens to deposit
/// @param _reserveWeight connector weight, represented in ppm, 1 - 1,000,000
/// @param _supply current meToken supply
/// @param _balancePooled total connector balance
/// @return amount of meTokens minted
function _calculateMintReturn(
uint256 _tokensDeposited,
function _viewMeTokensMinted(
uint256 _assetsDeposited,
uint32 _reserveWeight,
uint256 _supply,
uint256 _balancePooled
Expand All @@ -230,12 +230,12 @@ contract BancorZeroCurve is ICurve {
_reserveWeight <= maxWeight
);
// special case for 0 deposit amount
if (_tokensDeposited == 0) {
if (_assetsDeposited == 0) {
return 0;
}
// special case if the weight = 100%
if (_reserveWeight == maxWeight) {
return (_supply * _tokensDeposited) / _balancePooled;
return (_supply * _assetsDeposited) / _balancePooled;
}

bytes16 exponent = uint256(_reserveWeight).fromUInt().div(
Expand All @@ -244,7 +244,7 @@ contract BancorZeroCurve is ICurve {
// 1 + balanceDeposited/connectorBalance
// TODO: name for `part1`?
bytes16 part1 = _one.add(
_tokensDeposited.fromUInt().div(_balancePooled.fromUInt())
_assetsDeposited.fromUInt().div(_balancePooled.fromUInt())
);
//Instead of calculating "base ^ exp", we calculate "e ^ (log(base) * exp)".
bytes16 res = _supply.fromUInt().mul(
Expand All @@ -255,21 +255,21 @@ contract BancorZeroCurve is ICurve {

/// @notice Given a deposit (in the collateral token) meToken supply of 0, constant x and
/// constant y, calculates the return for a given conversion (in the meToken)
/// @dev _baseX / (_baseY ^ (MAX_WEIGHT/reserveWeight -1)) * tokensDeposited ^(MAX_WEIGHT/reserveWeight -1)
/// @dev _baseX / (_baseY ^ (MAX_WEIGHT/reserveWeight -1)) * assetsDeposited ^(MAX_WEIGHT/reserveWeight -1)
/// @dev _baseX and _baseY are needed as Bancor formula breaks from a divide-by-0 when supply=0
/// @param _tokensDeposited amount of collateral tokens to deposit
/// @param _assetsDeposited amount of collateral tokens to deposit
/// @param _baseY constant x
/// @return amount of meTokens minted
function _calculateMintReturnFromZero(
uint256 _tokensDeposited,
function _viewMeTokensMintedFromZero(
uint256 _assetsDeposited,
uint256 _reserveWeight,
uint256 _baseY
) private view returns (uint256) {
bytes16 reserveWeight = _reserveWeight.fromUInt().div(
uint256(maxWeight).fromUInt()
);
// _tokensDeposited * baseY ^ (1/connectorWeight)
bytes16 numerator = _tokensDeposited.fromUInt().mul(
// _assetsDeposited * baseY ^ (1/connectorWeight)
bytes16 numerator = _assetsDeposited.fromUInt().mul(
_baseY.fromUInt().ln().mul(_one.div(reserveWeight)).exp()
);
// as baseX == 1 ether and we want to result to be in ether too we simply remove
Expand All @@ -295,7 +295,7 @@ contract BancorZeroCurve is ICurve {
/// @param _supply current meToken supply
/// @param _balancePooled total connector balance
/// @return amount of collateral tokens received
function _calculateBurnReturn(
function _viewAssetsReturned(
uint256 _meTokensBurned,
uint32 _reserveWeight,
uint256 _supply,
Expand Down Expand Up @@ -341,7 +341,7 @@ contract BancorZeroCurve is ICurve {

// (baseY * desiredMeTokens^2 * reserveWeight) / baseX
// Or (baseY * reserveWeight) / baseX * desiredMeTokens^2
function _calculateTokensDepositedFromZero(
function _viewAssetsDepositedFromZero(
uint256 _desiredMeTokens,
uint256 _reserveWeight,
uint256 _baseY
Expand All @@ -361,7 +361,7 @@ contract BancorZeroCurve is ICurve {
}

// (baseY * (supply + desiredMeTokens)^2 * reserveWeight / baseX - pooledBalance
function _calculateTokensDeposited(
function _viewAssetsDeposited(
uint256 _desiredMeTokens,
uint256 _reserveWeight,
uint256 _supply,
Expand Down
32 changes: 16 additions & 16 deletions contracts/interfaces/ICurve.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,47 +21,47 @@ interface ICurve {
function initReconfigure(uint256 _hubId, bytes calldata _encodedDetails)
external;

function calculateMintReturn(
uint256 _tokensDeposited,
function viewMeTokensMinted(
uint256 _assetsDeposited,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view returns (uint256 meTokensReturned);
) external view returns (uint256 meTokensMinted);

function calculateBurnReturn(
function viewAssetsReturned(
uint256 _meTokensBurned,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view returns (uint256 tokensReturned);
) external view returns (uint256 assetsReturned);

function calculateTargetMintReturn(
uint256 _tokensDeposited,
function viewTargetMeTokensMinted(
uint256 _assetsDeposited,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view returns (uint256 meTokensReturned);
) external view returns (uint256 meTokensMinted);

function calculateTargetBurnReturn(
function viewTargetAssetsReturned(
uint256 _meTokensBurned,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view returns (uint256 tokensReturned);
) external view returns (uint256 assetsReturned);

function calculateTokensDeposited(
uint256 _desiredMeTokensReturned,
function viewAssetsDeposited(
uint256 _desiredMeTokensMinted,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view returns (uint256 tokensDeposited);
) external view returns (uint256 assetsDeposited);

function calculateTargetTokensDeposited(
uint256 _desiredMeTokensReturned,
function viewTargetAssetsDeposited(
uint256 _desiredMeTokensMinted,
uint256 _hubId,
uint256 _supply,
uint256 _balancePooled
) external view returns (uint256 tokensDeposited);
) external view returns (uint256 assetsDeposited);

function finishReconfigure(uint256 id) external;
}
6 changes: 3 additions & 3 deletions contracts/interfaces/IFoundry.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ interface IFoundry {
address token,
address depositor,
address recipient,
uint256 tokensDeposited,
uint256 assetsDeposited,
uint256 meTokensMinted
);

Expand All @@ -17,12 +17,12 @@ interface IFoundry {
address burner,
address recipient,
uint256 meTokensBurned,
uint256 tokensReturned
uint256 assetsReturned
);

function mint(
address _meToken,
uint256 _tokensDeposited,
uint256 _assetsDeposited,
address _recipient
) external;

Expand Down
2 changes: 1 addition & 1 deletion contracts/registries/MeTokenRegistry.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ contract MeTokenRegistry is Ownable, IMeTokenRegistry {
// Mint meToken to user
uint256 _meTokensMinted;
if (_assetsDeposited > 0) {
_meTokensMinted = ICurve(hub_.curve).calculateMintReturn(
_meTokensMinted = ICurve(hub_.curve).viewMeTokensMinted(
_assetsDeposited, // _deposit_amount
_hubId, // _hubId
0, // _supply
Expand Down
2 changes: 1 addition & 1 deletion test/contracts/Foundry.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ describe("Foundry.sol", () => {
// gas savings
const totalSupply = await meToken.totalSupply();

const meTokensMinted = await bancorZeroCurve.calculateMintReturn(
const meTokensMinted = await bancorZeroCurve.viewMeTokensMinted(
amount,
hubId,
totalSupply,
Expand Down
Loading

0 comments on commit 886ea77

Please sign in to comment.