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

Parameter & Variable Renames #677

Merged
merged 23 commits into from
Oct 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
6c87872
1+2
dapp-whisperer Sep 28, 2023
232da57
_computeNominalCR
dapp-whisperer Sep 28, 2023
c5aace4
_computeCR
dapp-whisperer Sep 28, 2023
fd15121
stEthFeePerUnitIndex -> cdpStEthFeePerUnitIndex
dapp-whisperer Sep 28, 2023
e9aaf22
debtRedistributionIndex cdpDebtRedistributionIndex
dapp-whisperer Sep 28, 2023
962e1a2
cdpIdsArrayLength decapitalized
dapp-whisperer Sep 28, 2023
51fcae5
fix info-level findings from spearbit/cantina audit
rayeaster Sep 29, 2023
92b08dd
fix failing foundry_test for new revert message
rayeaster Sep 29, 2023
32cb2f6
LiquityX.sol -> EbtcX.sol
Oct 3, 2023
81bbd49
recoveryModeGracePeriod → recoveryModeGracePeriodDuration
dapp-whisperer Oct 5, 2023
ab91532
ebtc -> debt consistency, liquity fuzzer removal
dapp-whisperer Oct 5, 2023
f2592b3
Merge branch 'feat/release-0.5' into feat/param-renames
dapp-whisperer Oct 5, 2023
a2da543
redemption struct param renames
dapp-whisperer Oct 6, 2023
97ce1ad
delete obselete test-report
dapp-whisperer Oct 6, 2023
12bd978
fix failing tests wrt renamed cdpManager.recoveryModeGracePeriodDurat…
rayeaster Oct 6, 2023
8c9e2f6
liquidation struct renames
dapp-whisperer Oct 6, 2023
edaba43
lint
dapp-whisperer Oct 6, 2023
13339f9
sequence liq related code removal
rayeaster Oct 9, 2023
dbe8f3d
remove stake conslidation
Oct 9, 2023
41f3999
41
Oct 9, 2023
95f2c06
Merge pull request #681 from Badger-Finance/feat/cantina-41
dapp-whisperer Oct 11, 2023
9af13e9
Merge pull request #680 from Badger-Finance/feat/remove-stake-dedup
dapp-whisperer Oct 11, 2023
963845e
Merge 'feat/release-0.5' into feat/param-renames
Oct 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
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Most of the `/Dependency` files are copy-pastes, but the following are custom or
`/packages/contracts/contracts/Dependencies/Auth.sol`
`/packages/contracts/contracts/Dependencies/AuthNoOwner.sol`
`/packages/contracts/contracts/Dependencies/ERC3156FlashLender.sol`
`/packages/contracts/contracts/Dependencies/LiquityBase.sol`
`/packages/contracts/contracts/Dependencies/LiquityMath.sol`
`/packages/contracts/contracts/Dependencies/EbtcBase.sol`
`/packages/contracts/contracts/Dependencies/EbtcMath.sol`
`/packages/contracts/contracts/Dependencies/ReentrancyGuard.sol`
`/packages/contracts/contracts/Dependencies/RolesAuthority.sol`

Expand Down Expand Up @@ -239,7 +239,7 @@ The two main contracts - `BorrowerOperations.sol` and `CdpManager.sol` - hold th

`CdpManager.sol` - contains functionality for liquidations and redemptions. It sends redemption fees to the `FeeRecipient` contract. Also contains the state of each CDP - i.e. a record of the CDP’s collateral and debt. CdpManager does not hold value (i.e. Ether / other tokens). CdpManager functions call in to the various Pools to tell them to move Ether/tokens between Pools, where necessary.

`LiquityBase.sol` - Both CdpManager and BorrowerOperations inherit from the parent contract LiquityBase, which contains global constants and some common functions.
`EbtcBase.sol` - Both CdpManager and BorrowerOperations inherit from the parent contract EbtcBase, which contains global constants and some common functions.

`EBTCToken.sol` - the eBTC token contract, which implements the ERC20 fungible token standard in conjunction with EIP-2612 and a mechanism that blocks (accidental) transfers to contracts and addresses like address(0) that are not supposed to receive funds through direct transfers. The contract mints, burns and transfers eBTC tokens.

Expand Down Expand Up @@ -394,8 +394,8 @@ Redemptions burn eBTC from the redeemer’s balance, and reduce the debt of the
| Function | eBTC Quantity | ERC20 Operation |
|-------------------------------|---------------|--------------------------------------|
| openCdp | Drawn eBTC | eBTC._mint(msg.sender, _EBTCAmount) |
| withdrawEBTC | Drawn eBTC | eBTC._mint(msg.sender, _EBTCAmount) |
| repayEBTC | Repaid eBTC | eBTC._burn(msg.sender, _EBTCAmount) |
| withdrawDebt | Drawn eBTC | eBTC._mint(msg.sender, _EBTCAmount) |
| repayDebt | Repaid eBTC | eBTC._burn(msg.sender, _EBTCAmount) |
| adjustCdp: withdrawing eBTC | Drawn eBTC | eBTC._mint(msg.sender, _EBTCAmount) |
| adjustCdp: repaying eBTC | Repaid eBTC | eBTC._burn(msg.sender, _EBTCAmount) |
| closeCdp | Repaid eBTC | eBTC._burn(msg.sender, _EBTCAmount) |
Expand Down Expand Up @@ -505,8 +505,8 @@ All data structures with the ‘public’ visibility specifier are ‘gettable
- `openCdp`
- `addColl`
- `withdrawColl`
- `withdrawEBTC`
- `repayEBTC`
- `withdrawDebt`
- `repayDebt`
- `_adjustCdp`
- `closeCdp()`
- `claimCollateral`
Expand Down Expand Up @@ -738,7 +738,7 @@ If the redemption causes a CDP's full debt to be cancelled, the CDP is then clos

### Gas compensation helper functions

Gas compensation functions are found in the parent _LiquityBase.sol_ contract:
Gas compensation functions are found in the parent _EbtcBase.sol_ contract:

`_getCompositeDebt(uint _debt)` returns the composite debt (drawn debt + gas compensation) of a CDP, for the purpose of ICR calculation.

Expand Down
2 changes: 1 addition & 1 deletion client/src/contracts/CDPManager.json
Original file line number Diff line number Diff line change
Expand Up @@ -684,7 +684,7 @@
"type": "address"
}
],
"name": "debtRedistributionIndex",
"name": "cdpDebtRedistributionIndex",
"outputs": [
{
"internalType": "uint256",
Expand Down
Loading