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

Add totalAssets(uint256 timestamp) to MockERC4626 #1049

Merged
merged 1 commit into from
Jun 13, 2024

Conversation

sentilesdal
Copy link
Contributor

Resolved Issues

Description

This helps with testing. When solidity is called using anvil in rust tests, the block is ticked by 1 second. Because there is a call to _getAccruedInterest() in totalAssets(), the only way to get the exact value is to pass the current time plus one second to totalAssets().

Review Checklists

Please check each item before approving the pull request. While going
through the checklist, it is recommended to leave comments on items that are
referenced in the checklist to make sure that they are reviewed. If there are
multiple reviewers, copy the checklists into sections titled ## [Reviewer Name].
If the PR doesn't touch Solidity, the corresponding checklist can
be removed.

[[Reviewer Name]]

  • Tokens
    • Do all approve calls use forceApprove?
    • Do all transfer calls use safeTransfer?
    • Do all transferFrom calls use msg.sender as the from address?
      • If not, is the function access restricted to prevent unauthorized
        token spend?
  • Low-level calls (call, delegatecall, staticcall, transfer, send)
    • Is the returned success boolean checked to handle failed calls?
    • If using delegatecall, are there strict access controls on the
      addresses that can be called? It shouldn't be possible to delegatecall
      arbitrary addresses, so the list of possible targets should either be
      immutable or tightly controlled by an admin.
  • Reentrancy
    • Are functions that make external calls or transfer ether marked as nonReentrant?
      • If not, is there documentation that explains why reentrancy is
        not a concern or how it's mitigated?
  • Gas Optimizations
    • Is the logic as simple as possible?
    • Are the storage values that are used repeatedly cached in stack or
      memory variables?
    • If loops are used, are there guards in place to avoid out-of-gas
      issues?
  • Visibility
    • Are all payable functions restricted to avoid stuck ether?
  • Math
    • Is all of the arithmetic checked or guarded by if-statements that will
      catch underflows?
    • If Safe functions are altered, are potential underflows and
      overflows caught so that a failure flag can be thrown?
    • Are all of the rounding directions clearly documented?
  • Testing
    • Are there new or updated unit or integration tests?
    • Do the tests cover the happy paths?
    • Do the tests cover the unhappy paths?
    • Are there an adequate number of fuzz tests to ensure that we are
      covering the full input space?

@coveralls
Copy link
Collaborator

coveralls commented Jun 6, 2024

Pull Request Test Coverage Report for Build 9409026324

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 17 unchanged lines in 3 files lost coverage.
  • Overall coverage increased (+0.4%) to 93.377%

Files with Coverage Reduction New Missed Lines %
contracts/src/internal/HyperdriveLP.sol 4 96.88%
contracts/src/internal/HyperdriveLong.sol 6 94.02%
contracts/src/internal/HyperdriveShort.sol 7 94.17%
Totals Coverage Status
Change from base Build 9408759390: 0.4%
Covered Lines: 1833
Relevant Lines: 1963

💛 - Coveralls

Copy link

github-actions bot commented Jun 6, 2024

Hyperdrive Gas Benchmark

Benchmark suite Current: 4280240 Previous: aed776f Deviation Status
addLiquidity: min 33827 gas 33827 gas 0% 🟰
addLiquidity: avg 155630 gas 155854 gas -0.1437%
addLiquidity: max 429092 gas 429092 gas 0% 🟰
checkpoint: min 40292 gas 40292 gas 0% 🟰
checkpoint: avg 142331 gas 142352 gas -0.0148%
checkpoint: max 253424 gas 253424 gas 0% 🟰
closeLong: min 31361 gas 31361 gas 0% 🟰
closeLong: avg 136036 gas 136073 gas -0.0272%
closeLong: max 2621386 gas 2625796 gas -0.1679%
closeShort: min 31349 gas 31349 gas 0% 🟰
closeShort: avg 131928 gas 132134 gas -0.1559%
closeShort: max 309547 gas 263302 gas 17.5635% 🚨
initialize: min 31371 gas 31371 gas 0% 🟰
initialize: avg 330949 gas 330923 gas 0.0079% 🚨
initialize: max 397010 gas 397010 gas 0% 🟰
openLong: min 33370 gas 33370 gas 0% 🟰
openLong: avg 173595 gas 174111 gas -0.2964%
openLong: max 306958 gas 306958 gas 0% 🟰
openShort: min 33936 gas 33936 gas 0% 🟰
openShort: avg 168594 gas 168488 gas 0.0629% 🚨
openShort: max 415838 gas 415910 gas -0.0173%
redeemWithdrawalShares: min 31251 gas 31251 gas 0% 🟰
redeemWithdrawalShares: avg 75324 gas 74759 gas 0.7558% 🚨
redeemWithdrawalShares: max 210204 gas 210204 gas 0% 🟰
removeLiquidity: min 31301 gas 31301 gas 0% 🟰
removeLiquidity: avg 214602 gas 214403 gas 0.0928% 🚨
removeLiquidity: max 403971 gas 403959 gas 0.0030% 🚨

This comment was automatically generated by workflow using github-action-benchmark.

@sentilesdal sentilesdal force-pushed the matt/total_assets_with_timestamp branch from cbd0e30 to 4280240 Compare June 12, 2024 20:33
@sentilesdal
Copy link
Contributor Author

@jalextowle updated with your suggestion to just have one _getAccruedInterest(uint256 timestamp)

@sentilesdal sentilesdal added this pull request to the merge queue Jun 12, 2024
Merged via the queue into main with commit f1ccfd4 Jun 13, 2024
32 checks passed
@sentilesdal sentilesdal deleted the matt/total_assets_with_timestamp branch June 13, 2024 00:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants