/
sim.go
358 lines (303 loc) · 10.1 KB
/
sim.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
package agent
import (
"context"
"fmt"
"math/rand"
"strings"
"testing"
"github.com/chenjianmei111/go-address"
"github.com/chenjianmei111/go-state-types/abi"
"github.com/chenjianmei111/go-state-types/big"
"github.com/chenjianmei111/go-state-types/cbor"
"github.com/chenjianmei111/go-state-types/exitcode"
ipldcbor "github.com/ipfs/go-ipld-cbor"
"github.com/pkg/errors"
"github.com/chenjianmei111/specs-actors/v3/actors/builtin"
"github.com/chenjianmei111/specs-actors/v3/actors/builtin/market"
"github.com/chenjianmei111/specs-actors/v3/actors/builtin/power"
"github.com/chenjianmei111/specs-actors/v3/actors/builtin/reward"
"github.com/chenjianmei111/specs-actors/v3/actors/util/adt"
"github.com/chenjianmei111/specs-actors/v3/support/ipld"
vm "github.com/chenjianmei111/specs-actors/v3/support/vm"
)
// Sim is a simulation framework to exercise actor code in a network-like environment.
// It's goal is to simulate realistic call sequences and interactions to perform invariant analysis
// and test performance assumptions prior to shipping actor code out to implementations.
// The model is that the simulation will "Tick" once per epoch. Within this tick:
// * It will first compute winning tickets from previous state for miners to simulate block mining.
// * It will create any agents it is configured to create and generate messages to create their associated actors.
// * It will call tick on all it agents. This call will return messages that will get added to the simulated "tipset".
// * Messages will be shuffled to simulate network entropy.
// * Messages will be applied and an new VM will be created from the resulting state tree for the next tick.
type Sim struct {
Config SimConfig
Agents []Agent
DealProviders []DealProvider
WinCount uint64
MessageCount uint64
v *vm.VM
rnd *rand.Rand
statsByMethod map[vm.MethodKey]*vm.CallStats
blkStore ipldcbor.IpldBlockstore
blkStoreFactory func() ipldcbor.IpldBlockstore
ctx context.Context
t testing.TB
}
func NewSim(ctx context.Context, t testing.TB, blockstoreFactory func() ipldcbor.IpldBlockstore, config SimConfig) *Sim {
blkStore := blockstoreFactory()
metrics := ipld.NewMetricsBlockStore(blkStore)
v := vm.NewVMWithSingletons(ctx, t, metrics)
v.SetStatsSource(metrics)
return &Sim{
Config: config,
Agents: []Agent{},
DealProviders: []DealProvider{},
v: v,
rnd: rand.New(rand.NewSource(config.Seed)),
blkStore: blkStore,
blkStoreFactory: blockstoreFactory,
ctx: ctx,
t: t,
}
}
//////////////////////////////////////////
//
// Sim execution
//
//////////////////////////////////////////
func (s *Sim) Tick() error {
var err error
var blockMessages []message
// compute power table before state transition to create block rewards at the end
powerTable, err := computePowerTable(s.v, s.Agents)
if err != nil {
return err
}
if err := computeCircSupply(s.v); err != nil {
return err
}
// add all agent messages
for _, agent := range s.Agents {
msgs, err := agent.Tick(s)
if err != nil {
return err
}
blockMessages = append(blockMessages, msgs...)
}
// shuffle messages
s.rnd.Shuffle(len(blockMessages), func(i, j int) {
blockMessages[i], blockMessages[j] = blockMessages[j], blockMessages[i]
})
// run messages
for _, msg := range blockMessages {
ret, code := s.v.ApplyMessage(msg.From, msg.To, msg.Value, msg.Method, msg.Params)
// for now, assume everything should work
if code != exitcode.Ok {
return errors.Errorf("exitcode %d: message failed: %v\n%s\n", code, msg, strings.Join(s.v.GetLogs(), "\n"))
}
if msg.ReturnHandler != nil {
if err := msg.ReturnHandler(s, msg, ret); err != nil {
return err
}
}
}
s.MessageCount += uint64(len(blockMessages))
// Apply block rewards
// Note that this differs from the specification in that it applies all reward messages at the end, whereas
// a real implementation would apply a reward messages at the end of each block in the tipset (thereby
// interleaving them with the rest of the messages).
for _, miner := range powerTable.minerPower {
if powerTable.totalQAPower.GreaterThan(big.Zero()) {
wins := WinCount(miner.qaPower, powerTable.totalQAPower, s.rnd.Float64())
s.WinCount += wins
err := s.rewardMiner(miner.addr, wins)
if err != nil {
return err
}
}
}
// run cron
_, code := s.v.ApplyMessage(builtin.SystemActorAddr, builtin.CronActorAddr, big.Zero(), builtin.MethodsCron.EpochTick, nil)
if code != exitcode.Ok {
return errors.Errorf("exitcode %d: cron message failed:\n%s\n", code, strings.Join(s.v.GetLogs(), "\n"))
}
// store last stats
s.statsByMethod = s.v.GetCallStats()
// dump logs if we have them
if len(s.v.GetLogs()) > 0 {
fmt.Printf("%s\n", strings.Join(s.v.GetLogs(), "\n"))
}
// create next vm
nextEpoch := s.v.GetEpoch() + 1
if s.Config.CheckpointEpochs > 0 && uint64(nextEpoch)%s.Config.CheckpointEpochs == 0 {
nextStore := s.blkStoreFactory()
blks, size, err := BlockstoreCopy(s.blkStore, nextStore, s.v.StateRoot())
if err != nil {
return err
}
fmt.Printf("CHECKPOINT: state blocks: %d, state data size %d\n", blks, size)
s.blkStore = nextStore
metrics := ipld.NewMetricsBlockStore(nextStore)
s.v, err = vm.NewVMAtEpoch(s.ctx, s.v.ActorImpls, adt.WrapBlockStore(s.ctx, metrics), s.v.StateRoot(), nextEpoch)
if err != nil {
return err
}
s.v.SetStatsSource(metrics)
} else {
s.v, err = s.v.WithEpoch(nextEpoch)
}
return err
}
//////////////////////////////////////////////////
//
// SimState Methods and other accessors
//
//////////////////////////////////////////////////
func (s *Sim) GetEpoch() abi.ChainEpoch {
return s.v.GetEpoch()
}
func (s *Sim) GetState(addr address.Address, out cbor.Unmarshaler) error {
return s.v.GetState(addr, out)
}
func (s *Sim) Store() adt.Store {
return s.v.Store()
}
func (s *Sim) AddAgent(a Agent) {
s.Agents = append(s.Agents, a)
}
func (s *Sim) AddDealProvider(d DealProvider) {
s.DealProviders = append(s.DealProviders, d)
}
func (s *Sim) GetVM() *vm.VM {
return s.v
}
func (s *Sim) GetCallStats() map[vm.MethodKey]*vm.CallStats {
return s.statsByMethod
}
func (s *Sim) ChooseDealProvider() DealProvider {
if len(s.DealProviders) == 0 {
return nil
}
return s.DealProviders[s.rnd.Int63n(int64(len(s.DealProviders)))]
}
func (s *Sim) NetworkCirculatingSupply() abi.TokenAmount {
return s.v.GetCirculatingSupply()
}
//////////////////////////////////////////////////
//
// Misc Methods
//
//////////////////////////////////////////////////
func (s *Sim) rewardMiner(addr address.Address, wins uint64) error {
if wins < 1 {
return nil
}
rewardParams := reward.AwardBlockRewardParams{
Miner: addr,
Penalty: big.Zero(),
GasReward: big.Zero(),
WinCount: int64(wins),
}
_, code := s.v.ApplyMessage(builtin.SystemActorAddr, builtin.RewardActorAddr, big.Zero(), builtin.MethodsReward.AwardBlockReward, &rewardParams)
if code != exitcode.Ok {
return errors.Errorf("exitcode %d: reward message failed:\n%s\n", code, strings.Join(s.v.GetLogs(), "\n"))
}
return nil
}
func computePowerTable(v *vm.VM, agents []Agent) (powerTable, error) {
pt := powerTable{}
var rwst reward.State
if err := v.GetState(builtin.RewardActorAddr, &rwst); err != nil {
return powerTable{}, err
}
pt.blockReward = rwst.ThisEpochReward
var st power.State
if err := v.GetState(builtin.StoragePowerActorAddr, &st); err != nil {
return powerTable{}, err
}
pt.totalQAPower = st.TotalQualityAdjPower
for _, agent := range agents {
if miner, ok := agent.(*MinerAgent); ok {
if claim, found, err := st.GetClaim(v.Store(), miner.IDAddress); err != nil {
return pt, err
} else if found {
if sufficient, err := st.MinerNominalPowerMeetsConsensusMinimum(v.Store(), miner.IDAddress); err != nil {
return pt, err
} else if sufficient {
pt.minerPower = append(pt.minerPower, minerPowerTable{miner.IDAddress, claim.QualityAdjPower})
}
}
}
}
return pt, nil
}
func computeCircSupply(v *vm.VM) error {
// disbursed + reward.State.TotalStoragePowerReward - burnt.Balance - power.State.TotalPledgeCollateral
var rewardSt reward.State
if err := v.GetState(builtin.RewardActorAddr, &rewardSt); err != nil {
return err
}
var powerSt power.State
if err := v.GetState(builtin.StoragePowerActorAddr, &powerSt); err != nil {
return err
}
burnt, found, err := v.GetActor(builtin.BurntFundsActorAddr)
if err != nil {
return err
} else if !found {
return errors.Errorf("burnt actor not found at %v", builtin.BurntFundsActorAddr)
}
v.SetCirculatingSupply(big.Sum(DisbursedAmount, rewardSt.TotalStoragePowerReward,
powerSt.TotalPledgeCollateral.Neg(), burnt.Balance.Neg()))
return nil
}
//////////////////////////////////////////////
//
// Internal Types
//
//////////////////////////////////////////////
type SimState interface {
GetEpoch() abi.ChainEpoch
GetState(addr address.Address, out cbor.Unmarshaler) error
Store() adt.Store
AddAgent(a Agent)
AddDealProvider(d DealProvider)
NetworkCirculatingSupply() abi.TokenAmount
// randomly select an agent capable of making deals.
// Returns nil if no providers exist.
ChooseDealProvider() DealProvider
}
type Agent interface {
Tick(v SimState) ([]message, error)
}
type DealProvider interface {
Address() address.Address
DealRange(currentEpoch abi.ChainEpoch) (start abi.ChainEpoch, end abi.ChainEpoch)
CreateDeal(proposal market.ClientDealProposal)
AvailableCollateral() abi.TokenAmount
}
type SimConfig struct {
AccountCount int
AccountInitialBalance abi.TokenAmount
Seed int64
CreateMinerProbability float32
CheckpointEpochs uint64
}
type returnHandler func(v SimState, msg message, ret cbor.Marshaler) error
type message struct {
From address.Address
To address.Address
Value abi.TokenAmount
Method abi.MethodNum
Params interface{}
ReturnHandler returnHandler
}
type minerPowerTable struct {
addr address.Address
qaPower abi.StoragePower
}
type powerTable struct {
blockReward abi.TokenAmount
totalQAPower abi.StoragePower
minerPower []minerPowerTable
}