Implemented a circuit breaker APR

delvtech / hyperdrive

An automated market maker for fixed and variable yield with on-demand terms.

Apache License 2.0

25 stars 3 forks source link

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]]

[x] 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?

[x] 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.

[x] 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?

[x] 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?

[x] Visibility

[ ] Are all payable functions restricted to avoid stuck ether?

[x] 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?

[x] 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?

Hyperdrive Gas Benchmark

Benchmark suite	Current: 9a76fb63af26848667eb1adbaaaa50b7af200d1e	Previous: 7bc914ff4f80a017d14a35d9cb5c5dd99987bd20	Deviation	Status
`addLiquidity: min`	`33937` gas	`33937` gas	`0%`	🟰
`addLiquidity: avg`	`156398` gas	`155757` gas	`0.4115%`	🚨
`addLiquidity: max`	`429290` gas	`429262` gas	`0.0065%`	🚨
`checkpoint: min`	`40316` gas	`40316` gas	`0%`	🟰
`checkpoint: avg`	`144694` gas	`144703` gas	`-0.0062%`	✅
`checkpoint: max`	`255940` gas	`255940` gas	`0%`	🟰
`closeLong: min`	`31361` gas	`31361` gas	`0%`	🟰
`closeLong: avg`	`135976` gas	`135769` gas	`0.1525%`	🚨
`closeLong: max`	`2539376` gas	`2539376` gas	`0%`	🟰
`closeShort: min`	`31327` gas	`31327` gas	`0%`	🟰
`closeShort: avg`	`131140` gas	`131221` gas	`-0.0617%`	✅
`closeShort: max`	`271599` gas	`271348` gas	`0.0925%`	🚨
`initialize: min`	`31349` gas	`31349` gas	`0%`	🟰
`initialize: avg`	`333507` gas	`333439` gas	`0.0204%`	🚨
`initialize: max`	`400255` gas	`399978` gas	`0.0693%`	🚨
`openLong: min`	`33370` gas	`33370` gas	`0%`	🟰
`openLong: avg`	`173293` gas	`173218` gas	`0.0433%`	🚨
`openLong: max`	`334313` gas	`334062` gas	`0.0751%`	🚨
`openShort: min`	`33936` gas	`33936` gas	`0%`	🟰
`openShort: avg`	`168403` gas	`168476` gas	`-0.0433%`	✅
`openShort: max`	`414974` gas	`415110` gas	`-0.0328%`	✅
`redeemWithdrawalShares: min`	`31251` gas	`31251` gas	`0%`	🟰
`redeemWithdrawalShares: avg`	`74940` gas	`75114` gas	`-0.2316%`	✅
`redeemWithdrawalShares: max`	`305949` gas	`305698` gas	`0.0821%`	🚨
`removeLiquidity: min`	`31301` gas	`31301` gas	`0%`	🟰
`removeLiquidity: avg`	`215568` gas	`215048` gas	`0.2418%`	🚨
`removeLiquidity: max`	`403870` gas	`403641` gas	`0.0567%`	🚨

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

delvtech / hyperdrive