-
Notifications
You must be signed in to change notification settings - Fork 12
/
blockissuer.go
406 lines (315 loc) · 14.6 KB
/
blockissuer.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
package mock
import (
"context"
"fmt"
"sync"
"testing"
"time"
"github.com/stretchr/testify/require"
"golang.org/x/crypto/blake2b"
hiveEd25519 "github.com/iotaledger/hive.go/crypto/ed25519"
"github.com/iotaledger/hive.go/ierrors"
"github.com/iotaledger/hive.go/lo"
"github.com/iotaledger/hive.go/runtime/options"
"github.com/iotaledger/hive.go/runtime/syncutils"
"github.com/iotaledger/hive.go/serializer/v2/serix"
"github.com/iotaledger/iota-core/pkg/model"
"github.com/iotaledger/iota-core/pkg/protocol/engine/blocks"
iotago "github.com/iotaledger/iota.go/v4"
"github.com/iotaledger/iota.go/v4/api"
"github.com/iotaledger/iota.go/v4/builder"
"github.com/iotaledger/iota.go/v4/wallet"
)
var (
ErrBlockAttacherInvalidBlock = ierrors.New("invalid block")
ErrBlockAttacherAttachingNotPossible = ierrors.New("attaching not possible")
ErrBlockAttacherIncompleteBlockNotAllowed = ierrors.New("incomplete block is not allowed on this node")
ErrBlockTooRecent = ierrors.New("block is too recent compared to latest commitment")
)
// TODO: make sure an honest validator does not issue blocks within the same slot ratification period in two conflicting chains.
// - this can be achieved by remembering the last issued block together with the engine name/chain.
// - if the engine name/chain is the same we can always issue a block.
// - if the engine name/chain is different we need to make sure to wait "slot ratification" slots.
// BlockIssuer contains logic to create and issue blocks signed by the given account.
type BlockIssuer struct {
Testing *testing.T
Name string
Validator bool
keyManager *wallet.KeyManager
Client Client
mutex syncutils.RWMutex
AccountData *AccountData
}
func NewBlockIssuer(t *testing.T, name string, keyManager *wallet.KeyManager, client Client, accountData *AccountData, validator bool, opts ...options.Option[BlockIssuer]) *BlockIssuer {
t.Helper()
_, pub := keyManager.KeyPair(accountData.AddressIndex)
if accountData.ID == iotago.EmptyAccountID {
accountData.ID = blake2b.Sum256(pub)
}
accountData.ID.RegisterAlias(name)
return options.Apply(&BlockIssuer{
Testing: t,
Name: name,
Validator: validator,
keyManager: keyManager,
Client: client,
AccountData: accountData,
}, opts)
}
func (i *BlockIssuer) BlockIssuerKey() iotago.BlockIssuerKey {
_, pub := i.keyManager.KeyPair(i.AccountData.AddressIndex)
return iotago.Ed25519PublicKeyHashBlockIssuerKeyFromPublicKey(hiveEd25519.PublicKey(pub))
}
func (i *BlockIssuer) BlockIssuerKeys() iotago.BlockIssuerKeys {
return iotago.NewBlockIssuerKeys(i.BlockIssuerKey())
}
func (i *BlockIssuer) Address() iotago.Address {
_, pub := i.keyManager.KeyPair(i.AccountData.AddressIndex)
return iotago.Ed25519AddressFromPubKey(pub)
}
// CreateValidationBlock creates a new validation block with the options provided. If a node is specified, it will try to
// revive the chain if the block is too far behind the latest commitment.
func (i *BlockIssuer) CreateValidationBlock(ctx context.Context, alias string, node *Node, opts ...options.Option[ValidationBlockParams]) (*blocks.Block, error) {
blockParams := options.Apply(NewValidationBlockParams(), opts)
blockIssuanceInfo, err := i.Client.BlockIssuance(ctx)
require.NoError(i.Testing, err)
if blockParams.BlockHeader.IssuingTime == nil {
issuingTime := time.Now().UTC()
if issuingTime.Before(blockIssuanceInfo.LatestParentBlockIssuingTime) {
issuingTime = blockIssuanceInfo.LatestParentBlockIssuingTime.Add(time.Nanosecond)
}
blockParams.BlockHeader.IssuingTime = &issuingTime
}
apiForBlock := i.retrieveAPI(blockParams.BlockHeader)
protoParams := apiForBlock.ProtocolParameters()
if blockParams.BlockHeader.SlotCommitment == nil {
commitment := blockIssuanceInfo.LatestCommitment
blockSlot := apiForBlock.TimeProvider().SlotFromTime(*blockParams.BlockHeader.IssuingTime)
if blockSlot > commitment.Slot+protoParams.MaxCommittableAge() && node != nil {
var parentID iotago.BlockID
var err error
commitment, parentID, err = i.reviveChain(*blockParams.BlockHeader.IssuingTime, node)
if err != nil {
return nil, ierrors.Wrap(err, "failed to revive chain")
}
blockParams.BlockHeader.SlotCommitment = commitment
blockParams.BlockHeader.References = make(model.ParentReferences)
blockParams.BlockHeader.References[iotago.StrongParentType] = []iotago.BlockID{parentID}
}
if blockSlot < commitment.Slot+protoParams.MinCommittableAge() &&
blockSlot > protoParams.MinCommittableAge() &&
commitment.Slot > protoParams.MinCommittableAge() {
commitmentSlot := commitment.Slot - protoParams.MinCommittableAge()
var err error
commitment, err = i.Client.CommitmentBySlot(ctx, commitmentSlot)
if err != nil {
return nil, ierrors.Errorf("can't issue block: failed to get commitment at slot %d", commitmentSlot)
}
}
blockParams.BlockHeader.SlotCommitment = commitment
}
if blockParams.BlockHeader.References == nil {
blockParams.BlockHeader.References = referencesFromBlockIssuanceResponse(blockIssuanceInfo)
}
err = i.setDefaultBlockParams(ctx, blockParams.BlockHeader)
require.NoError(i.Testing, err)
if blockParams.HighestSupportedVersion == nil {
// We use the latest supported version and not the current one.
version := i.Client.LatestAPI().Version()
blockParams.HighestSupportedVersion = &version
}
if blockParams.ProtocolParametersHash == nil {
protocolParametersHash, err := apiForBlock.ProtocolParameters().Hash()
require.NoError(i.Testing, err)
blockParams.ProtocolParametersHash = &protocolParametersHash
}
blockBuilder := builder.NewValidationBlockBuilder(apiForBlock)
blockBuilder.SlotCommitmentID(blockParams.BlockHeader.SlotCommitment.MustID())
blockBuilder.LatestFinalizedSlot(*blockParams.BlockHeader.LatestFinalizedSlot)
blockBuilder.IssuingTime(*blockParams.BlockHeader.IssuingTime)
strongParents, exists := blockParams.BlockHeader.References[iotago.StrongParentType]
require.True(i.Testing, exists && len(strongParents) > 0, "block should have strong parents (exists: %t, parents: %s)", exists, strongParents)
blockBuilder.StrongParents(strongParents)
if weakParents, exists := blockParams.BlockHeader.References[iotago.WeakParentType]; exists {
blockBuilder.WeakParents(weakParents)
}
if shallowLikeParents, exists := blockParams.BlockHeader.References[iotago.ShallowLikeParentType]; exists {
blockBuilder.ShallowLikeParents(shallowLikeParents)
}
blockBuilder.HighestSupportedVersion(*blockParams.HighestSupportedVersion)
blockBuilder.ProtocolParametersHash(*blockParams.ProtocolParametersHash)
priv, _ := i.keyManager.KeyPair(i.AccountData.AddressIndex)
blockBuilder.Sign(i.AccountData.ID, priv)
block, err := blockBuilder.Build()
require.NoError(i.Testing, err)
// Make sure we only create syntactically valid blocks.
modelBlock, err := model.BlockFromBlock(block, serix.WithValidation())
require.NoError(i.Testing, err)
modelBlock.ID().RegisterAlias(alias)
return blocks.NewBlock(modelBlock), nil
}
func referencesFromBlockIssuanceResponse(response *api.IssuanceBlockHeaderResponse) model.ParentReferences {
references := make(model.ParentReferences)
references[iotago.StrongParentType] = response.StrongParents
references[iotago.WeakParentType] = response.WeakParents
references[iotago.ShallowLikeParentType] = response.ShallowLikeParents
return references
}
func (i *BlockIssuer) CreateAndSubmitValidationBlock(ctx context.Context, alias string, node *Node, opts ...options.Option[ValidationBlockParams]) (*blocks.Block, error) {
block, err := i.CreateValidationBlock(ctx, alias, node, opts...)
require.NoError(i.Testing, err)
err = i.SubmitBlock(ctx, block.ModelBlock())
return block, err
}
// CreateBlock creates a new block with the options.
func (i *BlockIssuer) CreateBasicBlock(ctx context.Context, alias string, opts ...options.Option[BasicBlockParams]) (*blocks.Block, error) {
blockParams := options.Apply(&BasicBlockParams{BlockHeader: &BlockHeaderParams{}}, opts)
blockIssuanceInfo, err := i.Client.BlockIssuance(ctx)
require.NoError(i.Testing, err)
if blockParams.BlockHeader.References == nil {
blockParams.BlockHeader.References = referencesFromBlockIssuanceResponse(blockIssuanceInfo)
}
err = i.setDefaultBlockParams(ctx, blockParams.BlockHeader)
require.NoError(i.Testing, err)
api := i.Client.APIForTime(*blockParams.BlockHeader.IssuingTime)
blockBuilder := builder.NewBasicBlockBuilder(api)
blockBuilder.SlotCommitmentID(blockParams.BlockHeader.SlotCommitment.MustID())
blockBuilder.LatestFinalizedSlot(*blockParams.BlockHeader.LatestFinalizedSlot)
strongParents, exists := blockParams.BlockHeader.References[iotago.StrongParentType]
require.True(i.Testing, exists && len(strongParents) > 0, "block should have strong parents (exists: %t, parents: %s)", exists, strongParents)
blockBuilder.StrongParents(strongParents)
if weakParents, exists := blockParams.BlockHeader.References[iotago.WeakParentType]; exists {
blockBuilder.WeakParents(weakParents)
}
if shallowLikeParents, exists := blockParams.BlockHeader.References[iotago.ShallowLikeParentType]; exists {
blockBuilder.ShallowLikeParents(shallowLikeParents)
}
blockBuilder.Payload(blockParams.Payload)
// use the rmc corresponding to the commitment used in the block
blockBuilder.CalculateAndSetMaxBurnedMana(blockIssuanceInfo.LatestCommitment.ReferenceManaCost)
// set the issuing time last to ensure the timestamp is greater than that of the parents selected.
if blockParams.BlockHeader.IssuingTime == nil {
issuingTime := time.Now().UTC()
if issuingTime.Before(blockIssuanceInfo.LatestParentBlockIssuingTime) {
issuingTime = blockIssuanceInfo.LatestParentBlockIssuingTime.Add(time.Nanosecond)
}
blockParams.BlockHeader.IssuingTime = &issuingTime
}
blockBuilder.IssuingTime(*blockParams.BlockHeader.IssuingTime)
priv, _ := i.keyManager.KeyPair(i.AccountData.AddressIndex)
blockBuilder.Sign(i.AccountData.ID, priv)
block, err := blockBuilder.Build()
require.NoError(i.Testing, err)
// Make sure we only create syntactically valid blocks.
modelBlock, err := model.BlockFromBlock(block, serix.WithValidation())
require.NoError(i.Testing, err)
modelBlock.ID().RegisterAlias(alias)
return blocks.NewBlock(modelBlock), err
}
func (i *BlockIssuer) CreateAndSubmitBasicBlock(ctx context.Context, alias string, opts ...options.Option[BasicBlockParams]) (*blocks.Block, error) {
block, err := i.CreateBasicBlock(ctx, alias, opts...)
if err != nil {
return nil, err
}
err = i.SubmitBlock(ctx, block.ModelBlock())
return block, err
}
func (i *BlockIssuer) IssueActivity(ctx context.Context, wg *sync.WaitGroup, startSlot iotago.SlotIndex, node *Node) {
issuingTime := node.Protocol.APIForSlot(startSlot).TimeProvider().SlotStartTime(startSlot)
start := time.Now()
wg.Add(1)
go func() {
defer wg.Done()
fmt.Println(i.Name, "> Starting activity")
var counter int
for {
if ctx.Err() != nil {
fmt.Println(i.Name, "> Stopped activity due to canceled context:", ctx.Err())
return
}
blockAlias := fmt.Sprintf("%s-activity.%d", i.Name, counter)
timeOffset := time.Since(start)
lo.PanicOnErr(i.CreateAndSubmitValidationBlock(ctx, blockAlias, node,
WithValidationBlockHeaderOptions(
WithIssuingTime(issuingTime.Add(timeOffset)),
),
))
counter++
time.Sleep(1 * time.Second)
}
}()
}
func (i *BlockIssuer) setDefaultBlockParams(ctx context.Context, blockParams *BlockHeaderParams) error {
if blockParams.IssuingTime == nil {
issuingTime := time.Now().UTC()
blockParams.IssuingTime = &issuingTime
}
issuanceInfo, err := i.Client.BlockIssuance(ctx)
require.NoError(i.Testing, err)
if blockParams.SlotCommitment == nil {
blockParams.SlotCommitment = issuanceInfo.LatestCommitment
}
if blockParams.LatestFinalizedSlot == nil {
blockParams.LatestFinalizedSlot = &issuanceInfo.LatestFinalizedSlot
}
if blockParams.Issuer == nil {
priv, _ := i.keyManager.KeyPair(i.AccountData.AddressIndex)
blockParams.Issuer = wallet.NewEd25519Account(i.AccountData.ID, priv)
} else if blockParams.Issuer.ID() != i.AccountData.ID {
return ierrors.Errorf("provided issuer account %s, but issuer provided in the block params is different %s", i.AccountData.ID, blockParams.Issuer.ID())
}
if blockParams.ReferenceValidation {
if err := i.validateReferences(ctx, *blockParams.IssuingTime, blockParams.SlotCommitment.Slot, blockParams.References); err != nil {
return ierrors.Wrap(err, "block references invalid")
}
}
return nil
}
func (i *BlockIssuer) validateReferences(ctx context.Context, issuingTime time.Time, slotCommitmentIndex iotago.SlotIndex, references model.ParentReferences) error {
for _, parent := range lo.Flatten(lo.Map(lo.Values(references), func(ds iotago.BlockIDs) []iotago.BlockID { return ds })) {
b, err := i.Client.BlockByBlockID(ctx, parent)
if err != nil {
return ierrors.Wrapf(err, "cannot issue block if parent %s does not exist", parent)
}
if b.Header.IssuingTime.After(issuingTime) {
return ierrors.Errorf("cannot issue block if the parents issuingTime is ahead block's issuingTime: %s vs %s", b.Header.IssuingTime, issuingTime.UTC())
}
if b.Header.SlotCommitmentID.Slot() > slotCommitmentIndex {
return ierrors.Errorf("cannot issue block if the commitment is ahead of its parents' commitment: %s vs %s", b.Header.SlotCommitmentID.Slot(), slotCommitmentIndex)
}
}
return nil
}
func (i *BlockIssuer) SubmitBlock(ctx context.Context, block *model.Block) error {
i.mutex.Lock()
defer i.mutex.Unlock()
return lo.Return2(i.Client.SubmitBlock(ctx, block.ProtocolBlock()))
}
func (i *BlockIssuer) SubmitBlockWithoutAwaitingBooking(block *model.Block, node *Node) error {
if err := node.RequestHandler.SubmitBlockWithoutAwaitingBooking(block); err != nil {
return err
}
if _, isValidationBlock := block.ValidationBlock(); isValidationBlock {
_ = node.Protocol.Engines.Main.Get().Storage.Settings().SetLatestIssuedValidationBlock(block)
}
return nil
}
func (i *BlockIssuer) CopyIdentityFromBlockIssuer(otherBlockIssuer *BlockIssuer) {
i.keyManager = otherBlockIssuer.keyManager
i.AccountData = otherBlockIssuer.AccountData
i.Validator = otherBlockIssuer.Validator
}
func (i *BlockIssuer) retrieveAPI(blockParams *BlockHeaderParams) iotago.API {
if blockParams.ProtocolVersion != nil {
api, err := i.Client.APIForVersion(*blockParams.ProtocolVersion)
require.NoError(i.Testing, err)
return api
}
// It is crucial to get the API from the issuing time/slot as that defines the version with which the block should be issued.
return i.Client.APIForTime(*blockParams.IssuingTime)
}
func (i *BlockIssuer) GetNewBlockIssuanceResponse() *api.IssuanceBlockHeaderResponse {
resp, err := i.Client.BlockIssuance(context.Background())
require.NoError(i.Testing, err)
return resp
}