/
deposits.go
402 lines (353 loc) · 13.7 KB
/
deposits.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
package util
import (
"context"
"sync"
"testing"
"github.com/pkg/errors"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/core/signing"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/core/transition"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/state"
"github.com/prysmaticlabs/prysm/v4/config/params"
"github.com/prysmaticlabs/prysm/v4/container/trie"
"github.com/prysmaticlabs/prysm/v4/crypto/bls"
"github.com/prysmaticlabs/prysm/v4/crypto/hash"
"github.com/prysmaticlabs/prysm/v4/encoding/bytesutil"
ethpb "github.com/prysmaticlabs/prysm/v4/proto/prysm/v1alpha1"
"github.com/prysmaticlabs/prysm/v4/runtime/interop"
)
var lock sync.Mutex
// Caches
var cachedDeposits []*ethpb.Deposit
var privKeys []bls.SecretKey
var t *trie.SparseMerkleTrie
// DeterministicDepositsAndKeys returns the entered amount of deposits and secret keys.
// The deposits are configured such that for deposit n the validator
// account is key n and the withdrawal account is key n+1. As such,
// if all secret keys for n validators are required then numDeposits
// should be n+1.
func DeterministicDepositsAndKeys(numDeposits uint64) ([]*ethpb.Deposit, []bls.SecretKey, error) {
resetCache()
lock.Lock()
defer lock.Unlock()
var err error
// Populate trie cache, if not initialized yet.
if t == nil {
t, err = trie.NewTrie(params.BeaconConfig().DepositContractTreeDepth)
if err != nil {
return nil, nil, errors.Wrap(err, "failed to create new trie")
}
}
// If more deposits requested than cached, generate more.
if numDeposits > uint64(len(cachedDeposits)) {
numExisting := uint64(len(cachedDeposits))
numRequired := numDeposits - uint64(len(cachedDeposits))
// Fetch the required number of keys.
secretKeys, publicKeys, err := interop.DeterministicallyGenerateKeys(numExisting, numRequired+1)
if err != nil {
return nil, nil, errors.Wrap(err, "could not create deterministic keys: ")
}
privKeys = append(privKeys, secretKeys[:len(secretKeys)-1]...)
// Create the new deposits and add them to the trie.
for i := uint64(0); i < numRequired; i++ {
balance := params.BeaconConfig().MaxEffectiveBalance
deposit, err := signedDeposit(secretKeys[i], publicKeys[i].Marshal(), publicKeys[i+1].Marshal(), balance)
if err != nil {
return nil, nil, errors.Wrap(err, "could not create signed deposit")
}
cachedDeposits = append(cachedDeposits, deposit)
hashedDeposit, err := deposit.Data.HashTreeRoot()
if err != nil {
return nil, nil, errors.Wrap(err, "could not tree hash deposit data")
}
if err = t.Insert(hashedDeposit[:], int(numExisting+i)); err != nil {
return nil, nil, err
}
}
}
depositTrie, _, err := DeterministicDepositTrie(int(numDeposits)) // lint:ignore uintcast
if err != nil {
return nil, nil, errors.Wrap(err, "failed to create deposit trie")
}
requestedDeposits := cachedDeposits[:numDeposits]
for i := range requestedDeposits {
proof, err := depositTrie.MerkleProof(i)
if err != nil {
return nil, nil, errors.Wrap(err, "could not create merkle proof")
}
requestedDeposits[i].Proof = proof
}
return requestedDeposits, privKeys[0:numDeposits], nil
}
// DepositsWithBalance generates N amount of deposits with the balances taken from the passed in balances array.
// If an empty array is passed,
func DepositsWithBalance(balances []uint64) ([]*ethpb.Deposit, *trie.SparseMerkleTrie, error) {
var err error
sparseTrie, err := trie.NewTrie(params.BeaconConfig().DepositContractTreeDepth)
if err != nil {
return nil, nil, errors.Wrap(err, "failed to create new trie")
}
numDeposits := uint64(len(balances))
numExisting := uint64(len(cachedDeposits))
numRequired := numDeposits - uint64(len(cachedDeposits))
var secretKeys []bls.SecretKey
var publicKeys []bls.PublicKey
if numExisting >= numDeposits+1 {
secretKeys = append(secretKeys, privKeys[:numDeposits+1]...)
publicKeys = publicKeysFromSecrets(secretKeys)
} else {
secretKeys = append(secretKeys, privKeys[:numExisting]...)
publicKeys = publicKeysFromSecrets(secretKeys)
// Fetch enough keys for all deposits, since this function is uncached.
newSecretKeys, newPublicKeys, err := interop.DeterministicallyGenerateKeys(numExisting, numRequired+1)
if err != nil {
return nil, nil, errors.Wrap(err, "could not create deterministic keys: ")
}
secretKeys = append(secretKeys, newSecretKeys...)
publicKeys = append(publicKeys, newPublicKeys...)
}
deposits := make([]*ethpb.Deposit, numDeposits)
// Create the new deposits and add them to the trie.
for i := uint64(0); i < numDeposits; i++ {
balance := params.BeaconConfig().MaxEffectiveBalance
// lint:ignore uintcast -- test code
if len(balances) == int(numDeposits) {
balance = balances[i]
}
deposit, err := signedDeposit(secretKeys[i], publicKeys[i].Marshal(), publicKeys[i+1].Marshal(), balance)
if err != nil {
return nil, nil, errors.Wrap(err, "could not create signed deposit")
}
deposits[i] = deposit
hashedDeposit, err := deposit.Data.HashTreeRoot()
if err != nil {
return nil, nil, errors.Wrap(err, "could not tree hash deposit data")
}
// lint:ignore uintcast -- test code
if err = sparseTrie.Insert(hashedDeposit[:], int(i)); err != nil {
return nil, nil, err
}
}
depositTrie, _, err := DepositTrieSubset(sparseTrie, int(numDeposits)) // lint:ignore uintcast -- test code
if err != nil {
return nil, nil, errors.Wrap(err, "failed to create deposit trie")
}
for i := range deposits {
proof, err := depositTrie.MerkleProof(i)
if err != nil {
return nil, nil, errors.Wrap(err, "could not create merkle proof")
}
deposits[i].Proof = proof
}
return deposits, sparseTrie, nil
}
func signedDeposit(
secretKey bls.SecretKey,
publicKey,
withdrawalKey []byte,
balance uint64,
) (*ethpb.Deposit, error) {
withdrawalCreds := hash.Hash(withdrawalKey)
withdrawalCreds[0] = params.BeaconConfig().BLSWithdrawalPrefixByte
depositMessage := ðpb.DepositMessage{
PublicKey: publicKey,
Amount: balance,
WithdrawalCredentials: withdrawalCreds[:],
}
domain, err := signing.ComputeDomain(params.BeaconConfig().DomainDeposit, nil, nil)
if err != nil {
return nil, errors.Wrap(err, "could not compute domain")
}
root, err := depositMessage.HashTreeRoot()
if err != nil {
return nil, errors.Wrap(err, "could not get signing root of deposit data")
}
sigRoot, err := (ðpb.SigningData{ObjectRoot: root[:], Domain: domain}).HashTreeRoot()
if err != nil {
return nil, err
}
depositData := ðpb.Deposit_Data{
PublicKey: publicKey,
Amount: balance,
WithdrawalCredentials: withdrawalCreds[:],
Signature: secretKey.Sign(sigRoot[:]).Marshal(),
}
deposit := ðpb.Deposit{
Data: depositData,
}
return deposit, nil
}
// DeterministicDepositTrie returns a merkle trie of the requested size from the
// deterministic deposits.
func DeterministicDepositTrie(size int) (*trie.SparseMerkleTrie, [][32]byte, error) {
if t == nil {
return nil, [][32]byte{}, errors.New("trie cache is empty, generate deposits at an earlier point")
}
return DepositTrieSubset(t, size)
}
// DepositTrieSubset takes in a full tree and the desired size and returns a subset of the deposit trie.
func DepositTrieSubset(sparseTrie *trie.SparseMerkleTrie, size int) (*trie.SparseMerkleTrie, [][32]byte, error) {
if sparseTrie == nil {
return nil, [][32]byte{}, errors.New("trie is empty")
}
items := sparseTrie.Items()
if size > len(items) {
return nil, [][32]byte{}, errors.New("requested a larger tree than amount of deposits")
}
items = items[:size]
depositTrie, err := trie.GenerateTrieFromItems(items, params.BeaconConfig().DepositContractTreeDepth)
if err != nil {
return nil, [][32]byte{}, errors.Wrapf(err, "could not generate trie of %d length", size)
}
roots := make([][32]byte, len(items))
for i, dep := range items {
roots[i] = bytesutil.ToBytes32(dep)
}
return depositTrie, roots, nil
}
// DeterministicEth1Data takes an array of deposits and returns the eth1Data made from the deposit trie.
func DeterministicEth1Data(size int) (*ethpb.Eth1Data, error) {
depositTrie, _, err := DeterministicDepositTrie(size)
if err != nil {
return nil, errors.Wrap(err, "failed to create trie")
}
root, err := depositTrie.HashTreeRoot()
if err != nil {
return nil, errors.Wrap(err, "failed to compute deposit trie root")
}
eth1Data := ðpb.Eth1Data{
BlockHash: root[:],
DepositRoot: root[:],
DepositCount: uint64(size),
}
return eth1Data, nil
}
// DeterministicGenesisState returns a genesis state made using the deterministic deposits.
func DeterministicGenesisState(t testing.TB, numValidators uint64) (state.BeaconState, []bls.SecretKey) {
deposits, privKeys, err := DeterministicDepositsAndKeys(numValidators)
if err != nil {
t.Fatal(errors.Wrapf(err, "failed to get %d deposits", numValidators))
}
eth1Data, err := DeterministicEth1Data(len(deposits))
if err != nil {
t.Fatal(errors.Wrapf(err, "failed to get eth1data for %d deposits", numValidators))
}
beaconState, err := transition.GenesisBeaconState(context.Background(), deposits, uint64(0), eth1Data)
if err != nil {
t.Fatal(errors.Wrapf(err, "failed to get genesis beacon state of %d validators", numValidators))
}
return beaconState, privKeys
}
// DepositTrieFromDeposits takes an array of deposits and returns the deposit trie.
func DepositTrieFromDeposits(deposits []*ethpb.Deposit) (*trie.SparseMerkleTrie, [][32]byte, error) {
encodedDeposits := make([][]byte, len(deposits))
roots := make([][32]byte, len(deposits))
for i := 0; i < len(encodedDeposits); i++ {
hashedDeposit, err := deposits[i].Data.HashTreeRoot()
if err != nil {
return nil, [][32]byte{}, errors.Wrap(err, "could not tree hash deposit data")
}
encodedDeposits[i] = hashedDeposit[:]
roots[i] = hashedDeposit
}
depositTrie, err := trie.GenerateTrieFromItems(encodedDeposits, params.BeaconConfig().DepositContractTreeDepth)
if err != nil {
return nil, [][32]byte{}, errors.Wrap(err, "Could not generate deposit trie")
}
return depositTrie, roots, nil
}
// resetCache clears out the old trie, private keys and deposits.
func resetCache() {
lock.Lock()
defer lock.Unlock()
t = nil
privKeys = []bls.SecretKey{}
cachedDeposits = []*ethpb.Deposit{}
}
// DeterministicDepositsAndKeysSameValidator returns the entered amount of deposits and secret keys
// of the same validator. This is for negative test cases such as same deposits from same validators in a block don't
// result in duplicated validator indices.
func DeterministicDepositsAndKeysSameValidator(numDeposits uint64) ([]*ethpb.Deposit, []bls.SecretKey, error) {
resetCache()
lock.Lock()
defer lock.Unlock()
var err error
// Populate trie cache, if not initialized yet.
if t == nil {
t, err = trie.NewTrie(params.BeaconConfig().DepositContractTreeDepth)
if err != nil {
return nil, nil, errors.Wrap(err, "failed to create new trie")
}
}
// If more deposits requested than cached, generate more.
if numDeposits > uint64(len(cachedDeposits)) {
numExisting := uint64(len(cachedDeposits))
numRequired := numDeposits - uint64(len(cachedDeposits))
// Fetch the required number of keys.
secretKeys, publicKeys, err := interop.DeterministicallyGenerateKeys(numExisting, numRequired+1)
if err != nil {
return nil, nil, errors.Wrap(err, "could not create deterministic keys: ")
}
privKeys = append(privKeys, secretKeys[:len(secretKeys)-1]...)
// Create the new deposits and add them to the trie. Always use the first validator to create deposit
for i := uint64(0); i < numRequired; i++ {
withdrawalCreds := hash.Hash(publicKeys[1].Marshal())
withdrawalCreds[0] = params.BeaconConfig().BLSWithdrawalPrefixByte
depositMessage := ðpb.DepositMessage{
PublicKey: publicKeys[1].Marshal(),
Amount: params.BeaconConfig().MaxEffectiveBalance,
WithdrawalCredentials: withdrawalCreds[:],
}
domain, err := signing.ComputeDomain(params.BeaconConfig().DomainDeposit, nil, nil)
if err != nil {
return nil, nil, errors.Wrap(err, "could not compute domain")
}
root, err := depositMessage.HashTreeRoot()
if err != nil {
return nil, nil, errors.Wrap(err, "could not get signing root of deposit data")
}
sigRoot, err := (ðpb.SigningData{ObjectRoot: root[:], Domain: domain}).HashTreeRoot()
if err != nil {
return nil, nil, errors.Wrap(err, "could not get signing root of deposit data and domain")
}
// Always use the same validator to sign
depositData := ðpb.Deposit_Data{
PublicKey: depositMessage.PublicKey,
Amount: depositMessage.Amount,
WithdrawalCredentials: depositMessage.WithdrawalCredentials,
Signature: secretKeys[1].Sign(sigRoot[:]).Marshal(),
}
deposit := ðpb.Deposit{
Data: depositData,
}
cachedDeposits = append(cachedDeposits, deposit)
hashedDeposit, err := deposit.Data.HashTreeRoot()
if err != nil {
return nil, nil, errors.Wrap(err, "could not tree hash deposit data")
}
if err = t.Insert(hashedDeposit[:], int(numExisting+i)); err != nil {
return nil, nil, err
}
}
}
// lint:ignore uintcast -- test code
depositTrie, _, err := DeterministicDepositTrie(int(numDeposits))
if err != nil {
return nil, nil, errors.Wrap(err, "failed to create deposit trie")
}
requestedDeposits := cachedDeposits[:numDeposits]
for i := range requestedDeposits {
proof, err := depositTrie.MerkleProof(i)
if err != nil {
return nil, nil, errors.Wrap(err, "could not create merkle proof")
}
requestedDeposits[i].Proof = proof
}
return requestedDeposits, privKeys[0:numDeposits], nil
}
func publicKeysFromSecrets(secretKeys []bls.SecretKey) []bls.PublicKey {
publicKeys := make([]bls.PublicKey, len(secretKeys))
for i, secretKey := range secretKeys {
publicKeys[i] = secretKey.PublicKey()
}
return publicKeys
}