From 664d922b25dc98aee24a4762e9403bb6f76179ca Mon Sep 17 00:00:00 2001 From: wildmolasses Date: Wed, 21 Feb 2024 15:01:02 -0500 Subject: [PATCH] mermaid fixes --- README.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f1d4452..bd829a7 100644 --- a/README.md +++ b/README.md @@ -46,16 +46,16 @@ flowchart TD style E fill:transparent,stroke:transparent,stroke-width:4px classDef new stroke:#F7F,padding:10px,stroke-width:3px,line-height:3.5,font-weight:bold B --> F[(Pool N)] - B ..-> |
Collect fees on fee-enabled pools via
V3FactoryOwner.claimFees
|A1 - A1 ..-> |
Rewards immediately deposited into UniStaker|GG[UniStaker]:::new - G((UNI holders)) --> | -
Delegate and stake UNI to + B ..-> |"
Collect fees on fee-enabled pools via
V3FactoryOwner.claimFees
"|A1 + A1 ..-> |"
Rewards immediately deposited into UniStaker"|GG[UniStaker]:::new + G((UNI holders)) --> |" +
Delegate and stake UNI to earn rewards from fee-enabled pools
- |GG + "|GG G ---> |Vote on governance proposals|A - M((MEV searcher)) <..-> |
Collect fees by sending WETH - to be used as rewards|A1 + M((MEV searcher)) <..-> |"
Collect fees by sending WETH + to be used as rewards"|A1 ``` ### `V3FactoryOwner` @@ -72,18 +72,20 @@ The mechanics of the [`UniStaker`](src/UniStaker.sol) contract are heavily inspi ```mermaid flowchart LR - A[UniStaker] --> |Hold deposit tokens and - delegate on behalf of depositor|SurrogateFork - SurrogateFork --> |Yes|Surrogate[Surrogate contract for delegate - (Holds stake deposits, delegates to delegate address)] - SurrogateFork --> |No, deploy new surrogate|Surrogate - A1((UNI holder)) --> |Stake UNI - Withdraw UNI|A - A .-> |Earns rewards|B((Beneficiary + + A[UniStaker] --> |"Hold deposit tokens and + delegate on behalf of depositor"|SurrogateFork + SurrogateFork --> |Yes|Surrogate["Surrogate contract for delegate + (Holds stake deposits, delegates + to delegate address)"] + SurrogateFork --> |"No, deploy new surrogate"|Surrogate + A1((UNI holder)) --> |"Stake UNI + Withdraw UNI"|A + A .-> |Earns rewards|B(("Beneficiary (original holder or - other address))) - SurrogateFork{{Was a surrogate contract previously - deployed for this delegate?}} + other address)")) + SurrogateFork{{"Was a surrogate contract previously + deployed for this delegate?"}} ``` The UniStaker contract diverges from `StakingRewards.sol` in several ways: