Merge remote-tracking branch 'origin/master' into nicka/oz-audit-fixes-oeth-withdrawal-queue

Author: naddison36

contracts/docs/plantuml/curveIncentiveFlows.puml

@@ -0,0 +1,87 @@
+@startuml
+
+title "Current Curve Incentives Flows"
+
+actor "Treasury" as treasury <<Origin>>
+participant "Vote Maket" as vm
+participant "Rewards" as cr <<Curve>>
+participant "Gauge" as cg <<Curve>>
+participant "Pool" as cp <<Convex>>
+participant "AMO Strategy" as strat <<Origin>>
+participant "Harvester" as harv <<Origin>>
+participant "Swapper" as swap <<Origin>>
+participant "Dripper" as drip <<Origin>>
+participant "OETH Vault" as vault <<Origin>>
+actor "Voters" as voters
+actor "Staked DAO" as sd
+actor "Convex" as cvx
+
+treasury -> vm: $19.3k OGN
+note left : bribe
+vm -> voters: $17k OGN
+note left: claim
+
+vm -> sd : 1.7k OGN
+note left: 10% fee
+
+voters -> treasury: $5k OGN
+note right: treasury portion
+
+cr -> cg : $22.6k CRV
+note left: rewards
+
+cg -> cp : $22.6k CRV
+note left: rewards
+
+cp -> cvx : $3.955 CRV
+note left: 17.5% fee
+
+cp -> strat: $16.8k CRV
+note left: collect
+
+strat -> harv: $16.8k CRV
+note left: harvest
+harv -> swap: $16.8k CRV
+note left: swap
+swap -> harv: $16.8k WETH
+harv -> drip: $16.8k WETH
+drip -> vault: $16.8k WETH
+note left: stream over 7 days
+
+' title "Directly fund the Dripper"
+
+' actor "Treasury" as treasury <<Origin>>
+' participant "Rewards" as cr <<Curve>>
+' participant "Gauge" as cg <<Curve>>
+' participant "Pool" as cp <<Convex>>
+' participant "AMO Strategy" as strat <<Origin>>
+' participant "Harvester" as harv <<Origin>>
+' participant "Swapper" as swap <<Origin>>
+' participant "Dripper" as drip <<Origin>>
+' participant "OETH Vault" as vault <<Origin>>
+' actor "Convex" as cvx
+
+' treasury -> drip: $19.3k WETH
+
+' cr -> cg : $5.5k CRV
+' note left: Curve rewards from\nTreasury's locked CVX
+
+' cg -> cp : $5.5k CRV
+' note left: rewards
+
+' cp -> cvx : $0.96k CRV
+' note left: 17.5% fee
+
+' cp -> strat: $4.5k CRV
+' note left: collect
+
+' strat -> harv: $4.5k CRV
+' note left: harvest
+' harv -> swap: $4.5k CRV
+' note left: swap
+' swap -> harv: $4.5k WETH
+' harv -> drip: $4.5k WETH
+' drip -> vault: $4.5k WETH
+' note left: stream over 7 days
+
+@enduml

contracts/docs/plantuml/curveIncentiveFlowsCurrent.png

@@ -0,0 +1,126 @@
+@startuml
+
+title "SuperOETH Flow of Value"
+
+actor "User" as user
+
+box Base
+participant "Strategist" as strategist <<Origin>> #DeepSkyBlue
+participant "Zapper" as zap <<Origin>> #DeepSkyBlue
+participant "Super OETH\nVault" as vault <<Origin>> #DeepSkyBlue
+participant "Bridged WOETH\nStrategy" as woethStrat <<Origin>> #DeepSkyBlue
+
+participant "Bridged\nWrapped ETH" as weth <<WETH>>
+participant "Harvester" as harv <<Origin>> #DeepSkyBlue
+participant "Dripper" as drip <<Origin>> #DeepSkyBlue
+
+participant "SuperOETH /\nWETH" as aeroPool <<Aerodrome>>
+end box
+
+box Mainnet
+participant "Strategist" as mainStrategist <<Origin>> #DeepSkyBlue
+participant "OETH\nVault" as mainVault <<Origin>> #DeepSkyBlue
+participant "Wrapper OETH" as woeth <<Origin>><<OWETH>> #DeepSkyBlue
+end box
+
+' Deposit ETH via Zapper
+group User deposit ETH [> 10 OETH]
+user -> zap : ETH
+note left : ETH in user tx
+
+zap -> weth : ETH
+note left : swap ETH for WETH
+weth o-> zap : WETH
+
+' vault o-> strategist : SuperOETH
+' note left : 20% performance\nfee from rebase
+
+zap -> vault : WETH
+note left : mint SuperOETH
+
+vault o-> user : SuperOETH
+note right : SuperOETH matches ETH
+end
+
+' Mint
+group User mint
+' vault o-> strategist : OETH
+' note left : 20% performance\nfee from rebase
+
+user -> vault : WETH
+note left : mint SuperOETH
+vault o-> user : SuperOETH
+note right : SuperOETH matches WETH
+end
+
+' Redeem
+group User redeem SuperOETH
+' vault o-> strategist : SuperOETH
+' note left : 20% performance\nfee from rebase
+
+user -x vault : SuperOETH
+note left : burn User's SuperOETH
+
+vault -> user : WETH
+' note right : 0.1% fee applied to redeemed assets.\nThis adds to the yield in the next rebase.
+end
+
+' Withdraw
+group User withdrawal of SuperOETH
+' vault o-> strategist : SuperOETH
+' note left : 20% performance\nfee from rebase
+
+user -x vault : SuperOETH
+note left : user requests withdrawal
+
+... 10 minute minimum ...
+
+vault -> user : WETH
+note left : user claims WETH
+end
+
+
+group Strategist moves WETH to Mainnet
+
+strategist -> mainStrategist : WETH
+note left : Bridge WETH to Mainnet
+
+mainStrategist -> mainVault : WETH
+note left : mint OETH using WETH
+mainVault o-> mainStrategist : OETH
+
+mainStrategist -> woeth : OETH
+note left : deposit OETH into Wrapper
+woeth o-> mainStrategist : WOETH
+
+mainStrategist -> strategist : WOETH
+note left : bridge WOETH to\nBase using CCIP
+
+strategist -> woethStrat : WOETH
+note left : deposit bridged WOETH
+woethStrat o-> strategist : SuperOETH
+
+alt redeem from vault
+strategist ->x vault : SuperOETH
+note left : redeem
+vault -> strategist : WETH
+else swap using Aero pool
+strategist -> aeroPool : SuperOETH
+note left : swap SuperOETH for WETH\nusing Aerodrome Pool
+aeroPool -> strategist : WETH
+end
+end
+
+' Collect and Rebase
+group Collect and Rebase
+
+drip -> vault : WETH
+note left : stream harvested WETH\nto Vault over 14 days
+
+group Rebase [increase in underlying assets]
+vault o-> vault : SuperOETH
+note left : 100% of value\nto SuperOETH holders
+end 
+end
+
+@enduml

contracts/docs/plantuml/oethBaseValueFlows.png

@@ -9,14 +9,16 @@ actor "Anyone" as sender
 actor "Block\nBuilder\n(MEV)" as mev
 actor "Registrator\n(Relayer)" as reg <<Origin>>
 actor "Admin\n(5/8 Safe)" as admin <<Origin>>
-actor "Strategist\n(2/9 Safe)" as strategist <<Origin>>
+actor "Strategist\n(2/8 Safe)" as strategist <<Origin>>
 actor "Governor\n(Timelock)" as gov <<Origin>>
 actor "Treasury" as treasury <<Origin>>
 participant "API" as api <<P2P>>
 actor "Operators" as ssvOp <<SSV>>
 
 box "Execution Chain"
 participant "Harvester" as harv <<Origin>>
+participant "Dripper" as drip <<Origin>>
+participant "Vault" as vault <<Origin>>
 participant "Native\nStaking SSV\nStrategy" as nativeStrat <<Origin>>
 participant "Fee\nAccumulator" as feeAccum <<Origin>>
 participant "SSV Network" as ssvNet <<SSV>>
@@ -173,7 +175,7 @@ end group
 
 group Registrator deposits more SSV to SSV cluster
 
-treasury -> ssv : transfer(\nto\namount)
+strategist -> ssv : transfer(\nto\namount)
 activate ssv
 note right : transfer SSV tokens\nfrom Treasury\nto Native Staking Strategy
 return
@@ -195,7 +197,7 @@ cluster data:
 end note
 end group
 
-reg -> nativeStrat : depositSSV(\noperatorIds,\namount,\ncluster)
+strategist -> nativeStrat : depositSSV(\noperatorIds,\namount,\ncluster)
 activate nativeStrat
 nativeStrat -> ssvNet : deposit(\nclusterOwner,\noperatorIds,\namount,\ncluster)
 activate ssvNet
@@ -263,6 +265,18 @@ note over nativeStrat : Native Staking Strategy's\nWETH balance does not change
 
 end group
 
+group Execution Rewards
+
+mev -> feeAccum : ETH
+note right : MEV rewards
+
+sender -> nativeStrat : ETH
+note right : tx priority fees
+
+note over nativeStrat : Native Staking Strategy's WETH balance\ndoes not change from either
+
+end group
+
 group Registrator does accounting of consensus rewards and validator withdrawals
 
 reg -> nativeStrat : doAccounting()
@@ -292,18 +306,6 @@ return accounting valid flag
 
 end group
 
-group Execution Rewards
-
-mev -> feeAccum : ETH
-note right : MEV rewards
-
-sender -> nativeStrat : ETH
-note right : tx priority fees
-
-note over nativeStrat : Native Staking Strategy's WETH balance\ndoes not change from either
-
-end group
-
 group Harvester collects ETH rewards
 
 sender -> harv : harvestAndSwap(\nstrtaegy)
@@ -336,6 +338,25 @@ return
 
 end group
 
+group Collect and rebase
+
+sender -> drip : collectAndRebase()
+activate drip
+
+drip -> weth : transfer(\nvault,\nstreamed ETH)
+note left : Stream ETH from last collect to now
+activate weth
+note over drip : Recalculate 7 day drip rate\nbased on WETH balance
+return
+
+drip -> vault : rebase()
+activate vault
+return
+
+return
+
+end group
+
 group Strategist pauses Native Staking Strategy
 
 strategist -> nativeStrat : pause()