Skip to content

Commit d363f42

Browse files
jrheajrhea
authored
misc-cleanup (#749)
* add frank, update readme, natspec mods
1 parent 1d96a66 commit d363f42

4 files changed

Lines changed: 127 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[![Tests](https://github.com/delvtech/hyperdrive/actions/workflows/solidity_test.yml/badge.svg)](https://github.com/delvtech/hyperdrive/actions/workflows/solidity_test.yml)
22
[![Coverage](https://coveralls.io/repos/github/delvtech/hyperdrive/badge.svg?branch=main&t=vnW3xG&kill_cache=1&service=github)](https://coveralls.io/github/delvtech/hyperdrive?branch=main)
3+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/delvtech/elf-contracts/blob/master/LICENSE)
34

45
# Hyperdrive
56

‎contracts/src/external/Hyperdrive.sol‎

Lines changed: 46 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,46 @@ import { HyperdriveLP } from "../internal/HyperdriveLP.sol";
1212
import { HyperdriveShort } from "../internal/HyperdriveShort.sol";
1313
import { HyperdriveStorage } from "../internal/HyperdriveStorage.sol";
1414

15+
/// ______ __ _________ _____
16+
/// ___ / / /____ ___________________________ /_________(_)__ ______
17+
/// __ /_/ /__ / / /__ __ \ _ \_ ___/ __ /__ ___/_ /__ | / / _ \
18+
/// _ __ / _ /_/ /__ /_/ / __/ / / /_/ / _ / _ / __ |/ // __/
19+
/// /_/ /_/ _\__, / _ ___/\___//_/ \__,_/ /_/ /_/ _____/ \___/
20+
/// /____/ /_/
21+
/// XXX ++ ++ XXX
22+
/// ############ XXXXX ++0+ +0++ XXXXX ###########
23+
/// ##////////////######## ++00++ ++00++ ########///////////##
24+
/// ##////////////########## ++000++ ++000++ ##########///////////##
25+
/// ##%%%%%%///// ###### ++0000+ +0000++ ###### /////%%%%%%##
26+
/// %%%%%%%%&& ## ++0000+ +0000++ ## &&%%%%%%%%%
27+
/// %&&& ## +o000+ +000o+ ## &&&%
28+
/// ## ++00+- -+00++ ##
29+
/// #% ++0+ +0++ %#
30+
/// ###-:Oo.++++.oO:-###
31+
/// ##: 00++++++00 :##
32+
/// #S###########* 0++00+++00++0 *##########S#
33+
/// #S % $ 0+++0 $ % S#
34+
/// #S ---------- %+++++:#:+++++%----------- S#
35+
/// #S ------------- %++++: ### :++++%------------ S#
36+
/// S ---------------%++++*\ | /*++++%------------- S
37+
/// #S --------------- %++++ ~W~ ++++%666--o UUUU o- S#
38+
/// #S? --------------- %+++++~+++++%&&&8 o \ / o ?S#
39+
/// ?*????**+++;::,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,::;+++**????*?
40+
/// #?+////////////////////////////////////////////////////////////////+?#
41+
/// #;;;;;//////////////////////////////////////////////////////////////;;;;;#
42+
/// S;;;;;;;;;//////////////////////////////////////////////////////////;;;;;;;;;S
43+
/// /;;;;;;;;;;;///////////////////////////////////////////////////////;;;;;;;;;;;;\
44+
/// |||OOOOOOOO||OOOOOOOO=========== __ ___ ===========OOOOOOOO||OOOOOOOO|||
45+
/// |||OOOOOOOO||OOOOOOOO===========| \[__ | \ /===========OOOOOOOO||OOOOOOOO|||
46+
/// |||OOOOOOOO||OOOOOOOO===========|__/[___|___ \/ ===========OOOOOOOO||OOOOOOOO|||
47+
/// ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
48+
/// |||////////000000000000\\\\\\\\|:::::::::::::::|////////00000000000\\\\\\\\\\|||
49+
/// SSS\\\\\\\\000000000000////////|:::::0x666:::::|\\\\\\\\00000000000//////////SSS
50+
/// SSS|||||||||||||||||||||||||||||:::::::::::::::||||||||||||||||||||||||||||||SSS
51+
/// SSSSSSSS|_______________|______________||_______________|______________|SSSSSSSS
52+
/// SSSSSSSS SSSSSSSS
53+
/// SSSSSSSS SSSSSSSS
54+
///
1555
/// @author DELV
1656
/// @title Hyperdrive
1757
/// @notice A fixed-rate AMM that mints bonds on demand for longs and shorts.
@@ -31,16 +71,16 @@ abstract contract Hyperdrive is
3171
/// functions.
3272
address public immutable target0;
3373

34-
/// @notice The target1 address. This is a logic contract that contains all
35-
/// some stateful functions.
74+
/// @notice The target1 address. This is a logic contract that contains
75+
/// stateful functions.
3676
address public immutable target1;
3777

38-
/// @notice The target2 address. This is a logic contract that contains all
39-
/// some stateful functions.
78+
/// @notice The target2 address. This is a logic contract that contains
79+
/// stateful functions.
4080
address public immutable target2;
4181

42-
/// @notice The target3 address. This is a logic contract that contains all
43-
/// some stateful functions.
82+
/// @notice The target3 address. This is a logic contract that contains
83+
/// stateful functions.
4484
address public immutable target3;
4585

4686
/// @notice The target4 address. This is a logic contract that contains all

‎contracts/src/instances/erc4626/ERC4626Hyperdrive.sol‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,46 @@ import { IERC4626Hyperdrive } from "../../interfaces/IERC4626Hyperdrive.sol";
1111
import { FixedPointMath } from "../../libraries/FixedPointMath.sol";
1212
import { ERC4626Base } from "./ERC4626Base.sol";
1313

14+
/// ______ __ _________ _____
15+
/// ___ / / /____ ___________________________ /_________(_)__ ______
16+
/// __ /_/ /__ / / /__ __ \ _ \_ ___/ __ /__ ___/_ /__ | / / _ \
17+
/// _ __ / _ /_/ /__ /_/ / __/ / / /_/ / _ / _ / __ |/ // __/
18+
/// /_/ /_/ _\__, / _ ___/\___//_/ \__,_/ /_/ /_/ _____/ \___/
19+
/// /____/ /_/
20+
/// XXX ++ ++ XXX
21+
/// ############ XXXXX ++0+ +0++ XXXXX ###########
22+
/// ##////////////######## ++00++ ++00++ ########///////////##
23+
/// ##////////////########## ++000++ ++000++ ##########///////////##
24+
/// ##%%%%%%///// ###### ++0000+ +0000++ ###### /////%%%%%%##
25+
/// %%%%%%%%&& ## ++0000+ +0000++ ## &&%%%%%%%%%
26+
/// %&&& ## +o000+ +000o+ ## &&&%
27+
/// ## ++00+- -+00++ ##
28+
/// #% ++0+ +0++ %#
29+
/// ###-:Oo.++++.oO:-###
30+
/// ##: 00++++++00 :##
31+
/// #S###########* 0++00+++00++0 *##########S#
32+
/// #S % $ 0+++0 $ % S#
33+
/// #S ---------- %+++++:#:+++++%----------- S#
34+
/// #S ------------- %++++: ### :++++%------------ S#
35+
/// S ---------------%++++*\ | /*++++%------------- S
36+
/// #S --------------- %++++ ~W~ ++++%666--o UUUU o- S#
37+
/// #S? --------------- %+++++~+++++%&&&8 o \ / o ?S#
38+
/// ?*????**+++;::,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,::;+++**????*?
39+
/// #?+////////////////////////////////////////////////////////////////+?#
40+
/// #;;;;;//////////////////////////////////////////////////////////////;;;;;#
41+
/// S;;;;;;;;;//////////////////////////////////////////////////////////;;;;;;;;;S
42+
/// /;;;;;;;;;;;///////////////////////////////////////////////////////;;;;;;;;;;;;\
43+
/// |||OOOOOOOO||OOOOOOOO=========== __ ___ ===========OOOOOOOO||OOOOOOOO|||
44+
/// |||OOOOOOOO||OOOOOOOO===========| \[__ | \ /===========OOOOOOOO||OOOOOOOO|||
45+
/// |||OOOOOOOO||OOOOOOOO===========|__/[___|___ \/ ===========OOOOOOOO||OOOOOOOO|||
46+
/// ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
47+
/// |||////////000000000000\\\\\\\\|:::::::::::::::|////////00000000000\\\\\\\\\\|||
48+
/// SSS\\\\\\\\000000000000////////|:::::0x666:::::|\\\\\\\\00000000000//////////SSS
49+
/// SSS|||||||||||||||||||||||||||||:::::::::::::::||||||||||||||||||||||||||||||SSS
50+
/// SSSSSSSS|_______________|______________||_______________|______________|SSSSSSSS
51+
/// SSSSSSSS SSSSSSSS
52+
/// SSSSSSSS SSSSSSSS
53+
///
1454
/// @author DELV
1555
/// @title ERC4626Hyperdrive
1656
/// @notice A Hyperdrive instance that uses a ERC4626 vault as the yield source.

‎contracts/src/instances/steth/StETHHyperdrive.sol‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,46 @@ import { IERC20 } from "../../interfaces/IERC20.sol";
77
import { ILido } from "../../interfaces/ILido.sol";
88
import { StETHBase } from "./StETHBase.sol";
99

10+
/// ______ __ _________ _____
11+
/// ___ / / /____ ___________________________ /_________(_)__ ______
12+
/// __ /_/ /__ / / /__ __ \ _ \_ ___/ __ /__ ___/_ /__ | / / _ \
13+
/// _ __ / _ /_/ /__ /_/ / __/ / / /_/ / _ / _ / __ |/ // __/
14+
/// /_/ /_/ _\__, / _ ___/\___//_/ \__,_/ /_/ /_/ _____/ \___/
15+
/// /____/ /_/
16+
/// XXX ++ ++ XXX
17+
/// ############ XXXXX ++0+ +0++ XXXXX ###########
18+
/// ##////////////######## ++00++ ++00++ ########///////////##
19+
/// ##////////////########## ++000++ ++000++ ##########///////////##
20+
/// ##%%%%%%///// ###### ++0000+ +0000++ ###### /////%%%%%%##
21+
/// %%%%%%%%&& ## ++0000+ +0000++ ## &&%%%%%%%%%
22+
/// %&&& ## +o000+ +000o+ ## &&&%
23+
/// ## ++00+- -+00++ ##
24+
/// #% ++0+ +0++ %#
25+
/// ###-:Oo.++++.oO:-###
26+
/// ##: 00++++++00 :##
27+
/// #S###########* 0++00+++00++0 *##########S#
28+
/// #S % $ 0+++0 $ % S#
29+
/// #S ---------- %+++++:#:+++++%----------- S#
30+
/// #S ------------- %++++: ### :++++%------------ S#
31+
/// S ---------------%++++*\ | /*++++%------------- S
32+
/// #S --------------- %++++ ~W~ ++++%666--o UUUU o- S#
33+
/// #S? --------------- %+++++~+++++%&&&8 o \ / o ?S#
34+
/// ?*????**+++;::,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,::;+++**????*?
35+
/// #?+////////////////////////////////////////////////////////////////+?#
36+
/// #;;;;;//////////////////////////////////////////////////////////////;;;;;#
37+
/// S;;;;;;;;;//////////////////////////////////////////////////////////;;;;;;;;;S
38+
/// /;;;;;;;;;;;///////////////////////////////////////////////////////;;;;;;;;;;;;\
39+
/// |||OOOOOOOO||OOOOOOOO=========== __ ___ ===========OOOOOOOO||OOOOOOOO|||
40+
/// |||OOOOOOOO||OOOOOOOO===========| \[__ | \ /===========OOOOOOOO||OOOOOOOO|||
41+
/// |||OOOOOOOO||OOOOOOOO===========|__/[___|___ \/ ===========OOOOOOOO||OOOOOOOO|||
42+
/// ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
43+
/// |||////////000000000000\\\\\\\\|:::::::::::::::|////////00000000000\\\\\\\\\\|||
44+
/// SSS\\\\\\\\000000000000////////|:::::0x666:::::|\\\\\\\\00000000000//////////SSS
45+
/// SSS|||||||||||||||||||||||||||||:::::::::::::::||||||||||||||||||||||||||||||SSS
46+
/// SSSSSSSS|_______________|______________||_______________|______________|SSSSSSSS
47+
/// SSSSSSSS SSSSSSSS
48+
/// SSSSSSSS SSSSSSSS
49+
///
1050
/// @author DELV
1151
/// @title StETHHyperdrive
1252
/// @notice A Hyperdrive instance that uses StETH as the yield source.

0 commit comments

Comments
 (0)