/
builder.go
438 lines (378 loc) · 11.5 KB
/
builder.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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package builder
import (
"context"
"errors"
"fmt"
"sync"
"time"
"go.uber.org/zap"
"github.com/ava-labs/avalanchego/ids"
"github.com/ava-labs/avalanchego/snow"
"github.com/ava-labs/avalanchego/snow/consensus/snowman"
"github.com/ava-labs/avalanchego/utils/set"
"github.com/ava-labs/avalanchego/utils/timer/mockable"
"github.com/ava-labs/avalanchego/utils/units"
"github.com/ava-labs/avalanchego/vms/platformvm/block"
"github.com/ava-labs/avalanchego/vms/platformvm/state"
"github.com/ava-labs/avalanchego/vms/platformvm/status"
"github.com/ava-labs/avalanchego/vms/platformvm/txs"
"github.com/ava-labs/avalanchego/vms/platformvm/txs/mempool"
blockexecutor "github.com/ava-labs/avalanchego/vms/platformvm/block/executor"
txexecutor "github.com/ava-labs/avalanchego/vms/platformvm/txs/executor"
)
// targetBlockSize is maximum number of transaction bytes to place into a
// StandardBlock
const targetBlockSize = 128 * units.KiB
var (
_ Builder = (*builder)(nil)
ErrEndOfTime = errors.New("program time is suspiciously far in the future")
ErrNoPendingBlocks = errors.New("no pending blocks")
errMissingPreferredState = errors.New("missing preferred block state")
errCalculatingNextStakerTime = errors.New("failed calculating next staker time")
)
type Builder interface {
mempool.Mempool
// StartBlockTimer starts to issue block creation requests to advance the
// chain timestamp.
StartBlockTimer()
// ResetBlockTimer forces the block timer to recalculate when it should
// advance the chain timestamp.
ResetBlockTimer()
// ShutdownBlockTimer stops block creation requests to advance the chain
// timestamp.
//
// Invariant: Assumes the context lock is held when calling.
ShutdownBlockTimer()
// BuildBlock can be called to attempt to create a new block
BuildBlock(context.Context) (snowman.Block, error)
// PackBlockTxs returns an array of txs that can fit into a valid block of
// size [targetBlockSize]. The returned txs are all verified against the
// preferred state.
//
// Note: This function does not call the consensus engine.
PackBlockTxs(targetBlockSize int) ([]*txs.Tx, error)
}
// builder implements a simple builder to convert txs into valid blocks
type builder struct {
mempool.Mempool
txExecutorBackend *txexecutor.Backend
blkManager blockexecutor.Manager
// resetTimer is used to signal that the block builder timer should update
// when it will trigger building of a block.
resetTimer chan struct{}
closed chan struct{}
closeOnce sync.Once
}
func New(
mempool mempool.Mempool,
txExecutorBackend *txexecutor.Backend,
blkManager blockexecutor.Manager,
) Builder {
return &builder{
Mempool: mempool,
txExecutorBackend: txExecutorBackend,
blkManager: blkManager,
resetTimer: make(chan struct{}, 1),
closed: make(chan struct{}),
}
}
func (b *builder) StartBlockTimer() {
go func() {
timer := time.NewTimer(0)
defer timer.Stop()
for {
// Invariant: The [timer] is not stopped.
select {
case <-timer.C:
case <-b.resetTimer:
if !timer.Stop() {
<-timer.C
}
case <-b.closed:
return
}
// Note: Because the context lock is not held here, it is possible
// that [ShutdownBlockTimer] is called concurrently with this
// execution.
for {
duration, err := b.durationToSleep()
if err != nil {
b.txExecutorBackend.Ctx.Log.Error("block builder encountered a fatal error",
zap.Error(err),
)
return
}
if duration > 0 {
timer.Reset(duration)
break
}
// Block needs to be issued to advance time.
b.Mempool.RequestBuildBlock(true /*=emptyBlockPermitted*/)
// Invariant: ResetBlockTimer is guaranteed to be called after
// [durationToSleep] returns a value <= 0. This is because we
// are guaranteed to attempt to build block. After building a
// valid block, the chain will have its preference updated which
// may change the duration to sleep and trigger a timer reset.
select {
case <-b.resetTimer:
case <-b.closed:
return
}
}
}
}()
}
func (b *builder) durationToSleep() (time.Duration, error) {
// Grabbing the lock here enforces that this function is not called mid-way
// through modifying of the state.
b.txExecutorBackend.Ctx.Lock.Lock()
defer b.txExecutorBackend.Ctx.Lock.Unlock()
// If [ShutdownBlockTimer] was called, we want to exit the block timer
// goroutine. We check this with the context lock held because
// [ShutdownBlockTimer] is expected to only be called with the context lock
// held.
select {
case <-b.closed:
return 0, nil
default:
}
preferredID := b.blkManager.Preferred()
preferredState, ok := b.blkManager.GetState(preferredID)
if !ok {
return 0, fmt.Errorf("%w: %s", errMissingPreferredState, preferredID)
}
nextStakerChangeTime, err := txexecutor.GetNextStakerChangeTime(preferredState)
if err != nil {
return 0, fmt.Errorf("%w of %s: %w", errCalculatingNextStakerTime, preferredID, err)
}
now := b.txExecutorBackend.Clk.Time()
return nextStakerChangeTime.Sub(now), nil
}
func (b *builder) ResetBlockTimer() {
// Ensure that the timer will be reset at least once.
select {
case b.resetTimer <- struct{}{}:
default:
}
}
func (b *builder) ShutdownBlockTimer() {
b.closeOnce.Do(func() {
close(b.closed)
})
}
// BuildBlock builds a block to be added to consensus.
// This method removes the transactions from the returned
// blocks from the mempool.
func (b *builder) BuildBlock(context.Context) (snowman.Block, error) {
// If there are still transactions in the mempool, then we need to
// re-trigger block building.
defer b.Mempool.RequestBuildBlock(false /*=emptyBlockPermitted*/)
b.txExecutorBackend.Ctx.Log.Debug("starting to attempt to build a block")
// Get the block to build on top of and retrieve the new block's context.
preferredID := b.blkManager.Preferred()
preferred, err := b.blkManager.GetBlock(preferredID)
if err != nil {
return nil, err
}
nextHeight := preferred.Height() + 1
preferredState, ok := b.blkManager.GetState(preferredID)
if !ok {
return nil, fmt.Errorf("%w: %s", state.ErrMissingParentState, preferredID)
}
timestamp, timeWasCapped, err := txexecutor.NextBlockTime(preferredState, b.txExecutorBackend.Clk)
if err != nil {
return nil, fmt.Errorf("could not calculate next staker change time: %w", err)
}
statelessBlk, err := buildBlock(
b,
preferredID,
nextHeight,
timestamp,
timeWasCapped,
preferredState,
)
if err != nil {
return nil, err
}
return b.blkManager.NewBlock(statelessBlk), nil
}
func (b *builder) PackBlockTxs(targetBlockSize int) ([]*txs.Tx, error) {
preferredID := b.blkManager.Preferred()
preferredState, ok := b.blkManager.GetState(preferredID)
if !ok {
return nil, fmt.Errorf("%w: %s", errMissingPreferredState, preferredID)
}
return packBlockTxs(
preferredID,
preferredState,
b.Mempool,
b.txExecutorBackend,
b.blkManager,
b.txExecutorBackend.Clk.Time(),
targetBlockSize,
)
}
// [timestamp] is min(max(now, parent timestamp), next staker change time)
func buildBlock(
builder *builder,
parentID ids.ID,
height uint64,
timestamp time.Time,
forceAdvanceTime bool,
parentState state.Chain,
) (block.Block, error) {
blockTxs, err := packBlockTxs(
parentID,
parentState,
builder.Mempool,
builder.txExecutorBackend,
builder.blkManager,
timestamp,
targetBlockSize,
)
if err != nil {
return nil, fmt.Errorf("failed to pack block txs: %w", err)
}
// Try rewarding stakers whose staking period ends at the new chain time.
// This is done first to prioritize advancing the timestamp as quickly as
// possible.
stakerTxID, shouldReward, err := getNextStakerToReward(timestamp, parentState)
if err != nil {
return nil, fmt.Errorf("could not find next staker to reward: %w", err)
}
if shouldReward {
rewardValidatorTx, err := NewRewardValidatorTx(builder.txExecutorBackend.Ctx, stakerTxID)
if err != nil {
return nil, fmt.Errorf("could not build tx to reward staker: %w", err)
}
return block.NewBanffProposalBlock(
timestamp,
parentID,
height,
rewardValidatorTx,
blockTxs,
)
}
// If there is no reason to build a block, don't.
if len(blockTxs) == 0 && !forceAdvanceTime {
builder.txExecutorBackend.Ctx.Log.Debug("no pending txs to issue into a block")
return nil, ErrNoPendingBlocks
}
// Issue a block with as many transactions as possible.
return block.NewBanffStandardBlock(
timestamp,
parentID,
height,
blockTxs,
)
}
func packBlockTxs(
parentID ids.ID,
parentState state.Chain,
mempool mempool.Mempool,
backend *txexecutor.Backend,
manager blockexecutor.Manager,
timestamp time.Time,
remainingSize int,
) ([]*txs.Tx, error) {
stateDiff, err := state.NewDiffOn(parentState)
if err != nil {
return nil, err
}
if _, err := txexecutor.AdvanceTimeTo(backend, stateDiff, timestamp); err != nil {
return nil, err
}
var (
blockTxs []*txs.Tx
inputs set.Set[ids.ID]
)
for {
tx, exists := mempool.Peek()
if !exists {
break
}
txSize := len(tx.Bytes())
if txSize > remainingSize {
break
}
mempool.Remove(tx)
// Invariant: [tx] has already been syntactically verified.
txDiff, err := state.NewDiffOn(stateDiff)
if err != nil {
return nil, err
}
executor := &txexecutor.StandardTxExecutor{
Backend: backend,
State: txDiff,
Tx: tx,
}
err = tx.Unsigned.Visit(executor)
if err != nil {
txID := tx.ID()
mempool.MarkDropped(txID, err)
continue
}
if inputs.Overlaps(executor.Inputs) {
txID := tx.ID()
mempool.MarkDropped(txID, blockexecutor.ErrConflictingBlockTxs)
continue
}
err = manager.VerifyUniqueInputs(parentID, executor.Inputs)
if err != nil {
txID := tx.ID()
mempool.MarkDropped(txID, err)
continue
}
inputs.Union(executor.Inputs)
txDiff.AddTx(tx, status.Committed)
err = txDiff.Apply(stateDiff)
if err != nil {
return nil, err
}
remainingSize -= txSize
blockTxs = append(blockTxs, tx)
}
return blockTxs, nil
}
// getNextStakerToReward returns the next staker txID to remove from the staking
// set with a RewardValidatorTx rather than an AdvanceTimeTx. [chainTimestamp]
// is the timestamp of the chain at the time this validator would be getting
// removed and is used to calculate [shouldReward].
// Returns:
// - [txID] of the next staker to reward
// - [shouldReward] if the txID exists and is ready to be rewarded
// - [err] if something bad happened
func getNextStakerToReward(
chainTimestamp time.Time,
preferredState state.Chain,
) (ids.ID, bool, error) {
if !chainTimestamp.Before(mockable.MaxTime) {
return ids.Empty, false, ErrEndOfTime
}
currentStakerIterator, err := preferredState.GetCurrentStakerIterator()
if err != nil {
return ids.Empty, false, err
}
defer currentStakerIterator.Release()
for currentStakerIterator.Next() {
currentStaker := currentStakerIterator.Value()
priority := currentStaker.Priority
// If the staker is a permissionless staker (not a permissioned subnet
// validator), it's the next staker we will want to remove with a
// RewardValidatorTx rather than an AdvanceTimeTx.
if priority != txs.SubnetPermissionedValidatorCurrentPriority {
return currentStaker.TxID, chainTimestamp.Equal(currentStaker.EndTime), nil
}
}
return ids.Empty, false, nil
}
func NewRewardValidatorTx(ctx *snow.Context, txID ids.ID) (*txs.Tx, error) {
utx := &txs.RewardValidatorTx{TxID: txID}
tx, err := txs.NewSigned(utx, txs.Codec, nil)
if err != nil {
return nil, err
}
return tx, tx.SyntacticVerify(ctx)
}