-
Notifications
You must be signed in to change notification settings - Fork 105
/
rewards.go
395 lines (346 loc) · 11.6 KB
/
rewards.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
package node
import (
"fmt"
"math"
"math/big"
"time"
"github.com/ethereum/go-ethereum/common"
"github.com/rocket-pool/rocketpool-go/dao/trustednode"
"github.com/rocket-pool/rocketpool-go/minipool"
"github.com/rocket-pool/rocketpool-go/node"
"github.com/rocket-pool/rocketpool-go/rewards"
"github.com/rocket-pool/rocketpool-go/tokens"
"github.com/rocket-pool/rocketpool-go/utils/eth"
rpstate "github.com/rocket-pool/rocketpool-go/utils/state"
"github.com/urfave/cli"
"golang.org/x/sync/errgroup"
"github.com/rocket-pool/smartnode/shared/services"
"github.com/rocket-pool/smartnode/shared/services/beacon"
rprewards "github.com/rocket-pool/smartnode/shared/services/rewards"
"github.com/rocket-pool/smartnode/shared/types/api"
"github.com/rocket-pool/smartnode/shared/utils/eth2"
)
func getRewards(c *cli.Context) (*api.NodeRewardsResponse, error) {
// Get services
if err := services.RequireNodeWallet(c); err != nil {
return nil, err
}
if err := services.RequireRocketStorage(c); err != nil {
return nil, err
}
if err := services.RequireEthClientSynced(c); err != nil {
return nil, err
}
w, err := services.GetWallet(c)
if err != nil {
return nil, err
}
rp, err := services.GetRocketPool(c)
if err != nil {
return nil, err
}
bc, err := services.GetBeaconClient(c)
if err != nil {
return nil, err
}
cfg, err := services.GetConfig(c)
if err != nil {
return nil, err
}
// Response
response := api.NodeRewardsResponse{}
// Get node account
nodeAccount, err := w.GetNodeAccount()
if err != nil {
return nil, err
}
// Get the event log interval
/*eventLogInterval, err := cfg.GetEventLogInterval()
if err != nil {
return nil, err
}*/
// Legacy contract addresses
//legacyRocketRewardsAddress := cfg.Smartnode.GetLegacyRewardsPoolAddress()
//legacyClaimNodeAddress := cfg.Smartnode.GetLegacyClaimNodeAddress()
//legacyClaimTrustedNodeAddress := cfg.Smartnode.GetLegacyClaimTrustedNodeAddress()
var totalEffectiveStake *big.Int
var totalRplSupply *big.Int
var inflationInterval *big.Int
var odaoSize uint64
var nodeOperatorRewardsPercent float64
var trustedNodeOperatorRewardsPercent float64
var totalDepositBalance float64
var totalNodeShare float64
var addresses []common.Address
var beaconHead beacon.BeaconHead
// Sync
var wg errgroup.Group
// Check if the node is registered or not
wg.Go(func() error {
exists, err := node.GetNodeExists(rp, nodeAccount.Address, nil)
if err == nil {
response.Registered = exists
}
return err
})
// Get the node registration time
wg.Go(func() error {
var time time.Time
var err error
time, err = node.GetNodeRegistrationTime(rp, nodeAccount.Address, nil)
if err == nil {
response.NodeRegistrationTime = time
}
return err
})
// Get node trusted status
wg.Go(func() error {
trusted, err := trustednode.GetMemberExists(rp, nodeAccount.Address, nil)
if err == nil {
response.Trusted = trusted
}
return err
})
// Get claimed and pending rewards
wg.Go(func() error {
// Legacy rewards
unclaimedRplRewardsWei := big.NewInt(0)
rplRewards := big.NewInt(0)
// TEMP removal of the legacy rewards crawler for now, TODO performance improvements here
/*
rplRewards, err := legacyrewards.CalculateLifetimeNodeRewards(rp, nodeAccount.Address, big.NewInt(int64(eventLogInterval)), nil, &legacyRocketRewardsAddress, &legacyClaimNodeAddress)*/
unclaimedEthRewardsWei := big.NewInt(0)
ethRewards := big.NewInt(0)
// Get the claimed and unclaimed intervals
unclaimed, claimed, err := rprewards.GetClaimStatus(rp, nodeAccount.Address)
if err != nil {
return err
}
// Get the info for each claimed interval
for _, claimedInterval := range claimed {
intervalInfo, err := rprewards.GetIntervalInfo(rp, cfg, nodeAccount.Address, claimedInterval, nil)
if err != nil {
return err
}
if !intervalInfo.TreeFileExists {
return fmt.Errorf("Error calculating lifetime node rewards: rewards file %s doesn't exist but interval %d was claimed", intervalInfo.TreeFilePath, claimedInterval)
}
rplRewards.Add(rplRewards, &intervalInfo.CollateralRplAmount.Int)
ethRewards.Add(ethRewards, &intervalInfo.SmoothingPoolEthAmount.Int)
}
// Get the unclaimed rewards
for _, unclaimedInterval := range unclaimed {
intervalInfo, err := rprewards.GetIntervalInfo(rp, cfg, nodeAccount.Address, unclaimedInterval, nil)
if err != nil {
return err
}
if !intervalInfo.TreeFileExists {
return fmt.Errorf("Error calculating lifetime node rewards: rewards file %s doesn't exist and interval %d is unclaimed", intervalInfo.TreeFilePath, unclaimedInterval)
}
if intervalInfo.NodeExists {
unclaimedRplRewardsWei.Add(unclaimedRplRewardsWei, &intervalInfo.CollateralRplAmount.Int)
unclaimedEthRewardsWei.Add(unclaimedEthRewardsWei, &intervalInfo.SmoothingPoolEthAmount.Int)
}
}
if err == nil {
response.CumulativeRplRewards = eth.WeiToEth(rplRewards)
response.UnclaimedRplRewards = eth.WeiToEth(unclaimedRplRewardsWei)
response.CumulativeEthRewards = eth.WeiToEth(ethRewards)
response.UnclaimedEthRewards = eth.WeiToEth(unclaimedEthRewardsWei)
}
return err
})
// Get the start of the rewards checkpoint
wg.Go(func() error {
lastCheckpoint, err := rewards.GetClaimIntervalTimeStart(rp, nil)
if err == nil {
response.LastCheckpoint = lastCheckpoint
}
return err
})
// Get the rewards checkpoint interval
wg.Go(func() error {
rewardsInterval, err := rewards.GetClaimIntervalTime(rp, nil)
if err == nil {
response.RewardsInterval = rewardsInterval
}
return err
})
// Get the node's effective stake
wg.Go(func() error {
effectiveStake, err := node.GetNodeEffectiveRPLStake(rp, nodeAccount.Address, nil)
if err == nil {
response.EffectiveRplStake = eth.WeiToEth(effectiveStake)
}
return err
})
// Get the node's total stake
wg.Go(func() error {
stake, err := node.GetNodeRPLStake(rp, nodeAccount.Address, nil)
if err == nil {
response.TotalRplStake = eth.WeiToEth(stake)
}
return err
})
// Get the total network effective stake
wg.Go(func() error {
multicallerAddress := common.HexToAddress(cfg.Smartnode.GetMulticallAddress())
balanceBatcherAddress := common.HexToAddress(cfg.Smartnode.GetBalanceBatcherAddress())
contracts, err := rpstate.NewNetworkContracts(rp, multicallerAddress, balanceBatcherAddress, false, nil)
if err != nil {
return fmt.Errorf("error creating network contract binding: %w", err)
}
totalEffectiveStake, err = rpstate.GetTotalEffectiveRplStake(rp, contracts)
if err != nil {
return fmt.Errorf("error getting total effective RPL stake: %w", err)
}
return nil
})
// Get the total RPL supply
wg.Go(func() error {
var err error
totalRplSupply, err = tokens.GetRPLTotalSupply(rp, nil)
if err != nil {
return err
}
return nil
})
// Get the RPL inflation interval
wg.Go(func() error {
var err error
inflationInterval, err = tokens.GetRPLInflationIntervalRate(rp, nil)
if err != nil {
return err
}
return nil
})
// Get the node operator rewards percent
wg.Go(func() error {
nodeOperatorRewardsPercentRaw, err := rewards.GetNodeOperatorRewardsPercent(rp, nil)
nodeOperatorRewardsPercent = eth.WeiToEth(nodeOperatorRewardsPercentRaw)
if err != nil {
return err
}
return nil
})
// Get the list of minipool addresses for this node
wg.Go(func() error {
_addresses, err := minipool.GetNodeMinipoolAddresses(rp, nodeAccount.Address, nil)
if err != nil {
return fmt.Errorf("Error getting node minipool addresses: %w", err)
}
addresses = _addresses
return nil
})
// Get the beacon head
wg.Go(func() error {
_beaconHead, err := bc.GetBeaconHead()
if err != nil {
return fmt.Errorf("Error getting beacon chain head: %w", err)
}
beaconHead = _beaconHead
return nil
})
// Wait for data
if err := wg.Wait(); err != nil {
return nil, err
}
// Calculate the total deposits and corresponding beacon chain balance share
minipoolDetails, err := eth2.GetBeaconBalances(rp, bc, addresses, beaconHead, nil)
if err != nil {
return nil, err
}
for _, minipool := range minipoolDetails {
totalDepositBalance += eth.WeiToEth(minipool.NodeDeposit)
totalNodeShare += eth.WeiToEth(minipool.NodeBalance)
}
response.BeaconRewards = totalNodeShare - totalDepositBalance
// Calculate the estimated rewards
rewardsIntervalDays := response.RewardsInterval.Seconds() / (60 * 60 * 24)
inflationPerDay := eth.WeiToEth(inflationInterval)
totalRplAtNextCheckpoint := (math.Pow(inflationPerDay, float64(rewardsIntervalDays)) - 1) * eth.WeiToEth(totalRplSupply)
if totalRplAtNextCheckpoint < 0 {
totalRplAtNextCheckpoint = 0
}
if totalEffectiveStake.Cmp(big.NewInt(0)) == 1 {
response.EstimatedRewards = response.EffectiveRplStake / eth.WeiToEth(totalEffectiveStake) * totalRplAtNextCheckpoint * nodeOperatorRewardsPercent
}
if response.Trusted {
var wg2 errgroup.Group
// Get cumulative ODAO rewards
wg2.Go(func() error {
// Legacy rewards
unclaimedRplRewardsWei := big.NewInt(0)
rplRewards := big.NewInt(0)
// TODO: PERFORMANCE IMPROVEMENTS
//rplRewards, err := legacyrewards.CalculateLifetimeTrustedNodeRewards(rp, nodeAccount.Address, big.NewInt(int64(eventLogInterval)), nil, &legacyRocketRewardsAddress, &legacyClaimTrustedNodeAddress)
// Get the claimed and unclaimed intervals
unclaimed, claimed, err := rprewards.GetClaimStatus(rp, nodeAccount.Address)
if err != nil {
return err
}
// Get the info for each claimed interval
for _, claimedInterval := range claimed {
intervalInfo, err := rprewards.GetIntervalInfo(rp, cfg, nodeAccount.Address, claimedInterval, nil)
if err != nil {
return err
}
if !intervalInfo.TreeFileExists {
return fmt.Errorf("Error calculating lifetime node rewards: rewards file %s doesn't exist but interval %d was claimed", intervalInfo.TreeFilePath, claimedInterval)
}
rplRewards.Add(rplRewards, &intervalInfo.ODaoRplAmount.Int)
}
// Get the unclaimed rewards
for _, unclaimedInterval := range unclaimed {
intervalInfo, err := rprewards.GetIntervalInfo(rp, cfg, nodeAccount.Address, unclaimedInterval, nil)
if err != nil {
return err
}
if !intervalInfo.TreeFileExists {
return fmt.Errorf("Error calculating lifetime node rewards: rewards file %s doesn't exist and interval %d is unclaimed", intervalInfo.TreeFilePath, unclaimedInterval)
}
if intervalInfo.NodeExists {
unclaimedRplRewardsWei.Add(unclaimedRplRewardsWei, &intervalInfo.ODaoRplAmount.Int)
}
}
if err == nil {
response.CumulativeTrustedRplRewards = eth.WeiToEth(rplRewards)
response.UnclaimedTrustedRplRewards = eth.WeiToEth(unclaimedRplRewardsWei)
}
return err
})
// Get the ODAO member count
wg2.Go(func() error {
var err error
odaoSize, err = trustednode.GetMemberCount(rp, nil)
if err != nil {
return err
}
return nil
})
// Get the trusted node operator rewards percent
wg2.Go(func() error {
trustedNodeOperatorRewardsPercentRaw, err := rewards.GetTrustedNodeOperatorRewardsPercent(rp, nil)
trustedNodeOperatorRewardsPercent = eth.WeiToEth(trustedNodeOperatorRewardsPercentRaw)
if err != nil {
return err
}
return nil
})
// Get the node's oDAO RPL stake
wg2.Go(func() error {
bond, err := trustednode.GetMemberRPLBondAmount(rp, nodeAccount.Address, nil)
if err == nil {
response.TrustedRplBond = eth.WeiToEth(bond)
}
return err
})
// Wait for data
if err := wg2.Wait(); err != nil {
return nil, err
}
response.EstimatedTrustedRplRewards = totalRplAtNextCheckpoint * trustedNodeOperatorRewardsPercent / float64(odaoSize)
}
// Return response
return &response, nil
}