From 6ce7a1ee7dc11690cbd8309cb2e58106eb354b8f Mon Sep 17 00:00:00 2001 From: oldchili <130549691+oldchili@users.noreply.github.com> Date: Tue, 10 Sep 2024 20:51:51 +0300 Subject: [PATCH] Readme clarification about distribution rate (#4) --------- Co-authored-by: telome <130504305+telome@users.noreply.github.com> --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index ee2dd58..09e6d10 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,12 @@ This repository implements a mechanism to distribute rewards vested in a [DssVes Note that `L1FarmProxy.rewardThreshold` should be sufficiently large to reduce the frequency of cross-chain transfers (thereby saving keepers gas). `L2FarmProxy.rewardThreshold` must also be sufficiently large to limit the reduction of the farm's rate of rewards distribution. Consider also choosing `L2FarmProxy.rewardThreshold <= L1FarmProxy.rewardThreshold` so that the bridged rewards can be promptly distributed to the farm. In the initialization library, these two variables are assigned the same value. +Note that the L2 Farm's reward rate might not be perfectly constant, even if the `L1FarmProxy` and `L2FarmProxy` reward thresholds are set to the same value. With the cross-chain setup there are several ways that can lead to non-constant reward rates. Therefore the following should be taken into consideration: +* The system configuration (durations and thresholds) should be chosen carefully to align the vesting rate with the farm's reward rate. +* Keepers should monitor and call `VestedRewardsDistribution.distribute` on L1 and `L2FarmProxy.forwardReward` whenever their reward thresholds are reached. +* L2 sequencer downtimes or other bridging delays can lead to delayed L2 distribution. +* Failed reward token bridging transactions should be monitored and retried. + ## Deployment ### Declare env variables