diff --git a/src/agent0/hyperfuzz/fork_fuzz/accrue_interest_ezeth.py b/src/agent0/hyperfuzz/fork_fuzz/accrue_interest_ezeth.py index 5871e6ab46..b432083a66 100644 --- a/src/agent0/hyperfuzz/fork_fuzz/accrue_interest_ezeth.py +++ b/src/agent0/hyperfuzz/fork_fuzz/accrue_interest_ezeth.py @@ -18,7 +18,18 @@ DEPOSIT_QUEUE_ADDR = "0xf2F305D14DCD8aaef887E0428B3c9534795D0d60" -def accrue_interest_ezeth(interface: HyperdriveReadWriteInterface, variable_rate: FixedPoint): +def accrue_interest_ezeth(interface: HyperdriveReadWriteInterface, variable_rate: FixedPoint) -> None: + """ + Function to accrue interest in the ezeth pool when fork fuzzing. + + Arguments + --------- + interface: HyperdriveReadWriteInterface + The interface to the Hyperdrive pool. + variable_rate: FixedPoint + The variable rate of the pool. + """ + assert variable_rate > FixedPoint(0) # TODO we may want to build these objects once and store them diff --git a/src/agent0/hyperfuzz/fork_fuzz/accrue_interest_fork.py b/src/agent0/hyperfuzz/fork_fuzz/accrue_interest_fork.py index 613b5cecf1..72c357c3b2 100644 --- a/src/agent0/hyperfuzz/fork_fuzz/accrue_interest_fork.py +++ b/src/agent0/hyperfuzz/fork_fuzz/accrue_interest_fork.py @@ -7,7 +7,19 @@ from .accrue_interest_ezeth import accrue_interest_ezeth -def accrue_interest_fork(interface: HyperdriveReadWriteInterface, variable_rate: FixedPoint): +def accrue_interest_fork(interface: HyperdriveReadWriteInterface, variable_rate: FixedPoint) -> None: + """Function to accrue interest in underlying yields when fork fuzzing. + This function looks at the kind of pool defined in the interface, and + matches the correct accrual function to call. + + Arguments + --------- + interface: HyperdriveReadWriteInterface + The interface to the Hyperdrive pool. + variable_rate: FixedPoint + The variable rate of the pool. + """ + # Switch case for pool types for interest accrual # TODO do we need to switch chain? hyperdrive_kind = interface.hyperdrive_kind