From 954c50a5611a9cf74afa78376bcdd24988b94ae4 Mon Sep 17 00:00:00 2001 From: Edgar Aroutiounian Date: Mon, 2 Dec 2019 07:08:45 -0800 Subject: [PATCH] [reward] Add reward Schedule table from spreadsheet (#1929) * [reward] Add reward Schedule table from spreadsheet * [reward][schedule] Make denom a function of time block rather than fixed 12.6 billion * [reward] Fix latent mistaken because of .UnixNano usage, header uses seconds --- consensus/reward/schedule.go | 147 +++++++++++++++++++++++++++++++++++ internal/chain/reward.go | 10 ++- 2 files changed, 153 insertions(+), 4 deletions(-) create mode 100644 consensus/reward/schedule.go diff --git a/consensus/reward/schedule.go b/consensus/reward/schedule.go new file mode 100644 index 000000000..3ef4d75df --- /dev/null +++ b/consensus/reward/schedule.go @@ -0,0 +1,147 @@ +package reward + +import ( + "sort" + "time" + + "github.com/harmony-one/harmony/internal/utils" + "github.com/harmony-one/harmony/numeric" +) + +type pair struct { + ts int64 + share numeric.Dec +} + +var ( + + // schedule is the Token Release Schedule of Harmony + releasePlan = map[int64]numeric.Dec{ + //2019 + mustParse("2019-May-31"): numeric.MustNewDecFromStr("0.2429"), + mustParse("2019-Jun-30"): numeric.MustNewDecFromStr("0.2488"), + mustParse("2019-Jul-31"): numeric.MustNewDecFromStr("0.2547"), + mustParse("2019-Aug-31"): numeric.MustNewDecFromStr("0.2607"), + mustParse("2019-Sep-30"): numeric.MustNewDecFromStr("0.2666"), + mustParse("2019-Oct-31"): numeric.MustNewDecFromStr("0.2726"), + mustParse("2019-Nov-30"): numeric.MustNewDecFromStr("0.3785"), + mustParse("2019-Dec-31"): numeric.MustNewDecFromStr("0.3844"), + // 2020 + mustParse("2020-Jan-31"): numeric.MustNewDecFromStr("0.3951"), + mustParse("2020-Feb-29"): numeric.MustNewDecFromStr("0.4047"), + mustParse("2020-Mar-31"): numeric.MustNewDecFromStr("0.4143"), + mustParse("2020-Apr-30"): numeric.MustNewDecFromStr("0.4239"), + mustParse("2020-May-31"): numeric.MustNewDecFromStr("0.5335"), + mustParse("2020-Jun-30"): numeric.MustNewDecFromStr("0.5431"), + mustParse("2020-Jul-31"): numeric.MustNewDecFromStr("0.5527"), + mustParse("2020-Aug-31"): numeric.MustNewDecFromStr("0.5623"), + mustParse("2020-Sep-30"): numeric.MustNewDecFromStr("0.5719"), + mustParse("2020-Oct-31"): numeric.MustNewDecFromStr("0.5815"), + mustParse("2020-Nov-30"): numeric.MustNewDecFromStr("0.6882"), + mustParse("2020-Dec-31"): numeric.MustNewDecFromStr("0.6948"), + // 2021 + mustParse("2021-Jan-31"): numeric.MustNewDecFromStr("0.7015"), + mustParse("2021-Feb-28"): numeric.MustNewDecFromStr("0.7082"), + mustParse("2021-Mar-31"): numeric.MustNewDecFromStr("0.7148"), + mustParse("2021-Apr-30"): numeric.MustNewDecFromStr("0.7215"), + mustParse("2021-May-31"): numeric.MustNewDecFromStr("0.7721"), + mustParse("2021-Jun-30"): numeric.MustNewDecFromStr("0.7788"), + mustParse("2021-Jul-31"): numeric.MustNewDecFromStr("0.7855"), + mustParse("2021-Aug-31"): numeric.MustNewDecFromStr("0.7922"), + mustParse("2021-Sep-30"): numeric.MustNewDecFromStr("0.7988"), + mustParse("2021-Oct-31"): numeric.MustNewDecFromStr("0.8055"), + mustParse("2021-Nov-30"): numeric.MustNewDecFromStr("0.8561"), + mustParse("2021-Dec-31"): numeric.MustNewDecFromStr("0.8628"), + // 2022 + mustParse("2022-Jan-31"): numeric.MustNewDecFromStr("0.8695"), + mustParse("2022-Feb-28"): numeric.MustNewDecFromStr("0.8761"), + mustParse("2022-Mar-31"): numeric.MustNewDecFromStr("0.8828"), + mustParse("2022-Apr-30"): numeric.MustNewDecFromStr("0.8895"), + mustParse("2022-May-31"): numeric.MustNewDecFromStr("0.8962"), + mustParse("2022-Jun-30"): numeric.MustNewDecFromStr("0.9028"), + mustParse("2022-Jul-31"): numeric.MustNewDecFromStr("0.9095"), + mustParse("2022-Aug-31"): numeric.MustNewDecFromStr("0.9162"), + mustParse("2022-Sep-30"): numeric.MustNewDecFromStr("0.9228"), + mustParse("2022-Oct-31"): numeric.MustNewDecFromStr("0.9295"), + mustParse("2022-Nov-30"): numeric.MustNewDecFromStr("0.9362"), + mustParse("2022-Dec-31"): numeric.MustNewDecFromStr("0.9429"), + // 2023 + mustParse("2023-Jan-31"): numeric.MustNewDecFromStr("0.9448"), + mustParse("2023-Feb-28"): numeric.MustNewDecFromStr("0.9468"), + mustParse("2023-Mar-31"): numeric.MustNewDecFromStr("0.9488"), + mustParse("2023-Apr-30"): numeric.MustNewDecFromStr("0.9507"), + mustParse("2023-May-31"): numeric.MustNewDecFromStr("0.9527"), + mustParse("2023-Jun-30"): numeric.MustNewDecFromStr("0.9547"), + mustParse("2023-Jul-31"): numeric.MustNewDecFromStr("0.9567"), + mustParse("2023-Aug-31"): numeric.MustNewDecFromStr("0.9586"), + mustParse("2023-Sep-30"): numeric.MustNewDecFromStr("0.9606"), + mustParse("2023-Oct-31"): numeric.MustNewDecFromStr("0.9626"), + mustParse("2023-Nov-30"): numeric.MustNewDecFromStr("0.9645"), + mustParse("2023-Dec-31"): numeric.MustNewDecFromStr("0.9665"), + // 2024 + mustParse("2024-Jan-31"): numeric.MustNewDecFromStr("0.9685"), + mustParse("2024-Feb-29"): numeric.MustNewDecFromStr("0.9704"), + mustParse("2024-Mar-31"): numeric.MustNewDecFromStr("0.9724"), + mustParse("2024-Apr-30"): numeric.MustNewDecFromStr("0.9744"), + mustParse("2024-May-31"): numeric.MustNewDecFromStr("0.9764"), + mustParse("2024-Jun-30"): numeric.MustNewDecFromStr("0.9783"), + mustParse("2024-Jul-31"): numeric.MustNewDecFromStr("0.9803"), + mustParse("2024-Aug-31"): numeric.MustNewDecFromStr("0.9823"), + mustParse("2024-Sep-30"): numeric.MustNewDecFromStr("0.9842"), + mustParse("2024-Oct-31"): numeric.MustNewDecFromStr("0.9862"), + mustParse("2024-Nov-30"): numeric.MustNewDecFromStr("0.9882"), + mustParse("2024-Dec-31"): numeric.MustNewDecFromStr("0.9901"), + // 2025 + mustParse("2025-Jan-31"): numeric.MustNewDecFromStr("0.9921"), + mustParse("2025-Feb-28"): numeric.MustNewDecFromStr("0.9941"), + mustParse("2025-Mar-31"): numeric.MustNewDecFromStr("0.9961"), + mustParse("2025-Apr-30"): numeric.MustNewDecFromStr("0.9980"), + mustParse("2025-May-30"): numeric.MustNewDecFromStr("1.0000"), + } + sorted = func() []pair { + s := []pair{} + for k, v := range releasePlan { + s = append(s, pair{k, v}) + } + sort.SliceStable( + s, + func(i, j int) bool { return s[i].ts < s[j].ts }, + ) + return s + }() +) + +func mustParse(ts string) int64 { + const shortForm = "2006-Jan-02" + t, err := time.Parse(shortForm, ts) + if err != nil { + panic("could not parse timestamp") + } + return t.Unix() +} + +// PercentageForTimeStamp .. +func PercentageForTimeStamp(ts int64) numeric.Dec { + bucket := pair{} + i, j := 0, 1 + + for range sorted { + if i == len(sorted) { + bucket = sorted[i-1] + break + } + if ts >= sorted[i].ts && ts < sorted[j].ts { + bucket = sorted[i] + break + } + i++ + j++ + } + + utils.Logger().Info(). + Str("percent of total-supply used", bucket.share.Mul(numeric.NewDec(100)).String()). + Str("for-time", time.Unix(ts, 0).String()). + Msg("Picked Percentage for timestamp") + + return bucket.share +} diff --git a/internal/chain/reward.go b/internal/chain/reward.go index 34b016f71..e6d10b45b 100644 --- a/internal/chain/reward.go +++ b/internal/chain/reward.go @@ -131,6 +131,7 @@ func ballotResultBeaconchain( func whatPercentStakedNow( beaconchain engine.ChainReader, + timestamp int64, ) (*numeric.Dec, error) { stakedNow := numeric.ZeroDec() // Only active validators' stake is counted in stake ratio because only their stake is under slashing risk @@ -154,8 +155,9 @@ func whatPercentStakedNow( numeric.NewDecFromBigInt(wrapper.TotalDelegation()), ) } - - percentage := stakedNow.Quo(totalTokens.Add( + percentage := stakedNow.Quo(totalTokens.Mul( + reward.PercentageForTimeStamp(timestamp), + ).Add( numeric.NewDecFromBigInt(soFarDoledOut)), ) return &percentage, nil @@ -169,8 +171,8 @@ func AccumulateRewards( rewarder reward.Distributor, slasher slash.Slasher, beaconChain engine.ChainReader, ) error { - blockNum := header.Number().Uint64() + if blockNum == 0 { // genesis block has no parent to reward. return nil @@ -188,7 +190,7 @@ func AccumulateRewards( defaultReward := BaseStakedReward // TODO Use cached result in off-chain db instead of full computation - percentageStaked, err := whatPercentStakedNow(beaconChain) + percentageStaked, err := whatPercentStakedNow(beaconChain, header.Time().Int64()) if err != nil { return err }