Added Natspec to the interfaces #751

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

Jump to bottom

Merged

jalextowle merged 5 commits into main from jalextowle/cleanup/interface-natspec

Jan 30, 2024

Contributor

jalextowle commented Jan 29, 2024

The description says it all. This is the last cleanup PR that is planned for v1.

jalextowle added 2 commits

January 29, 2024 13:48


          Documented all of the functions, events, and errors in the interfaces

e93ab00


          Added better Natspec documentation to Hyperdrive

1a348d3

jalextowle requested a review from jrhea

January 29, 2024 21:56

jrhea reviewed

View reviewed changes

contracts/src/instances/steth/StETHTarget0.sol Outdated Show resolved Hide resolved

github-actions bot commented Jan 29, 2024 •

edited

Loading

Hyperdrive Gas Benchmark

Benchmark suite	Current: `a4f4008`	Previous: `d363f42`	Deviation	Status
`addLiquidity: min`	`1546` gas	`1546` gas	`0%`	🟰
`addLiquidity: avg`	`68902` gas	`65698` gas	`4.8769%`	🚨
`addLiquidity: max`	`292728` gas	`292728` gas	`0%`	🟰
`checkpoint: min`	`1150` gas	`1150` gas	`0%`	🟰
`checkpoint: avg`	`48368` gas	`48246` gas	`0.2529%`	🚨
`checkpoint: max`	`191173` gas	`191173` gas	`0%`	🟰
`closeLong: min`	`1492` gas	`1492` gas	`0%`	🟰
`closeLong: avg`	`28422` gas	`28478` gas	`-0.1966%`	✅
`closeLong: max`	`152268` gas	`151400` gas	`0.5733%`	🚨
`closeShort: min`	`1494` gas	`1494` gas	`0%`	🟰
`closeShort: avg`	`30247` gas	`30147` gas	`0.3317%`	🚨
`closeShort: max`	`146093` gas	`146093` gas	`0%`	🟰
`initialize: min`	`1495` gas	`1495` gas	`0%`	🟰
`initialize: avg`	`213307` gas	`213307` gas	`0%`	🟰
`initialize: max`	`253585` gas	`253585` gas	`0%`	🟰
`openLong: min`	`1432` gas	`1432` gas	`0%`	🟰
`openLong: avg`	`50747` gas	`50773` gas	`-0.0512%`	✅
`openLong: max`	`187405` gas	`187405` gas	`0%`	🟰
`openShort: min`	`1520` gas	`1520` gas	`0%`	🟰
`openShort: avg`	`49958` gas	`49990` gas	`-0.0640%`	✅
`openShort: max`	`180144` gas	`180144` gas	`0%`	🟰
`redeemWithdrawalShares: min`	`1488` gas	`1488` gas	`0%`	🟰
`redeemWithdrawalShares: avg`	`21193` gas	`20050` gas	`5.7007%`	🚨
`redeemWithdrawalShares: max`	`108516` gas	`108516` gas	`0%`	🟰
`removeLiquidity: min`	`1552` gas	`1552` gas	`0%`	🟰
`removeLiquidity: avg`	`148424` gas	`150974` gas	`-1.6890%`	✅
`removeLiquidity: max`	`324881` gas	`324881` gas	`0%`	🟰

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

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IERC20.sol Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IERC20Forwarder.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveDeployerCoordinator.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveEvents.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveFactory.sol Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveFactory.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveFactory.sol Outdated Show resolved Hide resolved


          Update contracts/src/interfaces/IERC20Forwarder.sol

59b133e

Co-authored-by: Jonny Rhea <5555162+jrhea@users.noreply.github.com>

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveGovernedRegistry.sol Outdated Show resolved Hide resolved


          Update contracts/src/interfaces/IHyperdriveCore.sol

Co-authored-by: Jonny Rhea <5555162+jrhea@users.noreply.github.com>

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveGovernedRegistry.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IHyperdriveRead.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IMultiTokenCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IMultiTokenCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IMultiTokenCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IMultiTokenCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IMultiTokenCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IMultiTokenCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IMultiTokenCore.sol Outdated Show resolved Hide resolved

jalextowle force-pushed the jalextowle/cleanup/interface-natspec branch from f088afc to d6fb2db Compare

January 29, 2024 23:10

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IMultiTokenEvents.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/interfaces/IStETHHyperdriveCore.sol Outdated Show resolved Hide resolved

jrhea reviewed

View reviewed changes

contracts/src/token/ERC20ForwarderFactory.sol Outdated Show resolved Hide resolved

jrhea approved these changes

View reviewed changes

Contributor

jrhea left a comment

Some nits. I will go ahead and approve. Message me if you have a question or want clarification


          Addressed review feedback from @jrhea

a4f4008

jalextowle force-pushed the jalextowle/cleanup/interface-natspec branch from d6fb2db to a4f4008 Compare

January 29, 2024 23:29

jalextowle enabled auto-merge (squash)

January 29, 2024 23:30

jalextowle merged commit 6a5956c into main

jalextowle deleted the jalextowle/cleanup/interface-natspec branch

January 30, 2024 00:51

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet