-
Notifications
You must be signed in to change notification settings - Fork 107
/
generator.go
246 lines (218 loc) · 8.95 KB
/
generator.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
package rewards
import (
"fmt"
"math/big"
"time"
"github.com/ethereum/go-ethereum/core/types"
"github.com/rocket-pool/rocketpool-go/rocketpool"
"github.com/rocket-pool/smartnode/shared/services/beacon"
"github.com/rocket-pool/smartnode/shared/services/config"
"github.com/rocket-pool/smartnode/shared/services/state"
cfgtypes "github.com/rocket-pool/smartnode/shared/types/config"
"github.com/rocket-pool/smartnode/shared/utils/log"
)
// Settings
const (
SmoothingPoolDetailsBatchSize uint64 = 8
TestingInterval uint64 = 1000000000 // A large number that won't ever actually be hit
// Mainnet intervals
MainnetV2Interval uint64 = 4
MainnetV3Interval uint64 = 5
MainnetV4Interval uint64 = 6
MainnetV5Interval uint64 = 8
MainnetV6Interval uint64 = 12
MainnetV7Interval uint64 = 15
MainnetV8Interval uint64 = 18
// Devnet intervals
DevnetV2Interval uint64 = 0
DevnetV3Interval uint64 = 0
DevnetV4Interval uint64 = 0
DevnetV5Interval uint64 = 0
DevnetV6Interval uint64 = 0
DevnetV7Interval uint64 = 0
// Holesky intervals
HoleskyV2Interval uint64 = 0
HoleskyV3Interval uint64 = 0
HoleskyV4Interval uint64 = 0
HoleskyV5Interval uint64 = 0
HoleskyV6Interval uint64 = 0
HoleskyV7Interval uint64 = 0
HoleskyV8Interval uint64 = 93
)
type TreeGenerator struct {
rewardsIntervalInfos map[uint64]rewardsIntervalInfo
logger *log.ColorLogger
logPrefix string
rp *rocketpool.RocketPool
cfg *config.RocketPoolConfig
bc beacon.Client
index uint64
startTime time.Time
endTime time.Time
consensusBlock uint64
elSnapshotHeader *types.Header
intervalsPassed uint64
generatorImpl treeGeneratorImpl
approximatorImpl treeGeneratorImpl
}
type treeGeneratorImpl interface {
generateTree(rp *rocketpool.RocketPool, cfg *config.RocketPoolConfig, bc beacon.Client) (IRewardsFile, error)
approximateStakerShareOfSmoothingPool(rp *rocketpool.RocketPool, cfg *config.RocketPoolConfig, bc beacon.Client) (*big.Int, error)
getRulesetVersion() uint64
}
func NewTreeGenerator(logger *log.ColorLogger, logPrefix string, rp *rocketpool.RocketPool, cfg *config.RocketPoolConfig, bc beacon.Client, index uint64, startTime time.Time, endTime time.Time, consensusBlock uint64, elSnapshotHeader *types.Header, intervalsPassed uint64, state *state.NetworkState, rollingRecord *RollingRecord) (*TreeGenerator, error) {
t := &TreeGenerator{
logger: logger,
logPrefix: logPrefix,
rp: rp,
cfg: cfg,
bc: bc,
index: index,
startTime: startTime,
endTime: endTime,
consensusBlock: consensusBlock,
elSnapshotHeader: elSnapshotHeader,
intervalsPassed: intervalsPassed,
}
// v8
var v8_generator treeGeneratorImpl
if rollingRecord == nil {
v8_generator = newTreeGeneratorImpl_v8(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed, state)
} else {
v8_generator = newTreeGeneratorImpl_v8_rolling(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed, state, rollingRecord)
}
// v7
var v7_generator treeGeneratorImpl
if rollingRecord == nil {
v7_generator = newTreeGeneratorImpl_v7(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed, state)
} else {
v7_generator = newTreeGeneratorImpl_v7_rolling(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed, state, rollingRecord)
}
// v6
var v6_generator treeGeneratorImpl
if rollingRecord == nil {
v6_generator = newTreeGeneratorImpl_v6(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed, state)
} else {
v6_generator = newTreeGeneratorImpl_v6_rolling(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed, state, rollingRecord)
}
// Create the interval wrappers
rewardsIntervalInfos := []rewardsIntervalInfo{
{
rewardsRulesetVersion: 8,
mainnetStartInterval: MainnetV8Interval,
holeskyStartInterval: HoleskyV8Interval,
generator: v8_generator,
},
{
rewardsRulesetVersion: 7,
mainnetStartInterval: MainnetV7Interval,
devnetStartInterval: DevnetV7Interval,
holeskyStartInterval: HoleskyV7Interval,
generator: v7_generator,
}, {
rewardsRulesetVersion: 6,
mainnetStartInterval: MainnetV6Interval,
devnetStartInterval: DevnetV6Interval,
holeskyStartInterval: HoleskyV6Interval,
generator: v6_generator,
}, {
rewardsRulesetVersion: 5,
mainnetStartInterval: MainnetV5Interval,
devnetStartInterval: DevnetV5Interval,
holeskyStartInterval: HoleskyV5Interval,
generator: newTreeGeneratorImpl_v5(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed, state),
}, {
rewardsRulesetVersion: 4,
mainnetStartInterval: MainnetV4Interval,
devnetStartInterval: DevnetV4Interval,
holeskyStartInterval: HoleskyV4Interval,
generator: newTreeGeneratorImpl_v4(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed),
}, {
rewardsRulesetVersion: 3,
mainnetStartInterval: MainnetV3Interval,
devnetStartInterval: DevnetV3Interval,
holeskyStartInterval: HoleskyV3Interval,
generator: newTreeGeneratorImpl_v3(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed),
}, {
rewardsRulesetVersion: 2,
mainnetStartInterval: MainnetV2Interval,
devnetStartInterval: DevnetV2Interval,
holeskyStartInterval: HoleskyV2Interval,
generator: newTreeGeneratorImpl_v2(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed),
}, {
rewardsRulesetVersion: 1,
mainnetStartInterval: 0,
devnetStartInterval: 0,
holeskyStartInterval: 0,
generator: newTreeGeneratorImpl_v1(t.logger, t.logPrefix, t.index, t.startTime, t.endTime, t.consensusBlock, t.elSnapshotHeader, t.intervalsPassed),
},
}
// Create the map of versions to infos
t.rewardsIntervalInfos = map[uint64]rewardsIntervalInfo{}
for _, info := range rewardsIntervalInfos {
// Sanity check to make sure there aren't multiple infos with the same version
_, exists := t.rewardsIntervalInfos[info.rewardsRulesetVersion]
if exists {
return nil, fmt.Errorf("multiple ruleset interval infos with ruleset v%d", info.rewardsRulesetVersion)
}
t.rewardsIntervalInfos[info.rewardsRulesetVersion] = info
}
// Get the current network
network := t.cfg.Smartnode.Network.Value.(cfgtypes.Network)
// Determine which actual rulesets to use based on the current interval number, checking in descending order from the latest
// to interval 2 since interval 1 is the default
foundGenerator := false
foundApproximator := false
for i := uint64(len(t.rewardsIntervalInfos)); i > 1; i-- {
info := t.rewardsIntervalInfos[i]
startInterval, err := info.GetStartInterval(network)
if err != nil {
return nil, fmt.Errorf("error getting start interval for rewards period %d: %w", i, err)
}
if !foundGenerator && t.index >= startInterval {
t.generatorImpl = info.generator
foundGenerator = true
}
if !foundApproximator && t.index > startInterval {
t.approximatorImpl = info.generator
foundApproximator = true
}
if foundGenerator && foundApproximator {
break
}
}
// Default to interval 1 if nothing could be found
if !foundGenerator {
t.generatorImpl = t.rewardsIntervalInfos[1].generator
}
if !foundApproximator {
t.approximatorImpl = t.rewardsIntervalInfos[1].generator
}
return t, nil
}
func (t *TreeGenerator) GenerateTree() (IRewardsFile, error) {
return t.generatorImpl.generateTree(t.rp, t.cfg, t.bc)
}
func (t *TreeGenerator) ApproximateStakerShareOfSmoothingPool() (*big.Int, error) {
return t.approximatorImpl.approximateStakerShareOfSmoothingPool(t.rp, t.cfg, t.bc)
}
func (t *TreeGenerator) GetGeneratorRulesetVersion() uint64 {
return t.generatorImpl.getRulesetVersion()
}
func (t *TreeGenerator) GetApproximatorRulesetVersion() uint64 {
return t.approximatorImpl.getRulesetVersion()
}
func (t *TreeGenerator) GenerateTreeWithRuleset(ruleset uint64) (IRewardsFile, error) {
info, exists := t.rewardsIntervalInfos[ruleset]
if !exists {
return nil, fmt.Errorf("ruleset v%d does not exist", ruleset)
}
return info.generator.generateTree(t.rp, t.cfg, t.bc)
}
func (t *TreeGenerator) ApproximateStakerShareOfSmoothingPoolWithRuleset(ruleset uint64) (*big.Int, error) {
info, exists := t.rewardsIntervalInfos[ruleset]
if !exists {
return nil, fmt.Errorf("ruleset v%d does not exist", ruleset)
}
return info.generator.approximateStakerShareOfSmoothingPool(t.rp, t.cfg, t.bc)
}