-
Notifications
You must be signed in to change notification settings - Fork 666
/
spend.go
578 lines (513 loc) · 16.1 KB
/
spend.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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
// Copyright (C) 2019-2021, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package platformvm
import (
"errors"
"fmt"
"github.com/ava-labs/avalanchego/ids"
"github.com/ava-labs/avalanchego/utils/crypto"
"github.com/ava-labs/avalanchego/utils/hashing"
"github.com/ava-labs/avalanchego/utils/math"
"github.com/ava-labs/avalanchego/vms/components/avax"
"github.com/ava-labs/avalanchego/vms/components/verify"
"github.com/ava-labs/avalanchego/vms/platformvm/fx"
"github.com/ava-labs/avalanchego/vms/platformvm/stakeable"
"github.com/ava-labs/avalanchego/vms/secp256k1fx"
)
var (
errLockedFundsNotMarkedAsLocked = errors.New("locked funds not marked as locked")
errWrongLocktime = errors.New("wrong locktime reported")
errUnknownOwners = errors.New("unknown owners")
errCantSign = errors.New("can't sign")
)
// stake the provided amount while deducting the provided fee.
// Arguments:
// - [keys] are the owners of the funds
// - [amount] is the amount of funds that are trying to be staked
// - [fee] is the amount of AVAX that should be burned
// - [changeAddr] is the address that change, if there is any, is sent to
// Returns:
// - [inputs] the inputs that should be consumed to fund the outputs
// - [returnedOutputs] the outputs that should be immediately returned to the
// UTXO set
// - [stakedOutputs] the outputs that should be locked for the duration of the
// staking period
// - [signers] the proof of ownership of the funds being moved
func (vm *VM) stake(
keys []*crypto.PrivateKeySECP256K1R,
amount uint64,
fee uint64,
changeAddr ids.ShortID,
) (
[]*avax.TransferableInput, // inputs
[]*avax.TransferableOutput, // returnedOutputs
[]*avax.TransferableOutput, // stakedOutputs
[][]*crypto.PrivateKeySECP256K1R, // signers
error,
) {
addrs := ids.NewShortSet(len(keys)) // The addresses controlled by [keys]
for _, key := range keys {
addrs.Add(key.PublicKey().Address())
}
utxos, err := avax.GetAllUTXOs(vm.internalState, addrs) // The UTXOs controlled by [keys]
if err != nil {
return nil, nil, nil, nil, fmt.Errorf("couldn't get UTXOs: %w", err)
}
kc := secp256k1fx.NewKeychain(keys...) // Keychain consumes UTXOs and creates new ones
// Minimum time this transaction will be issued at
now := uint64(vm.clock.Time().Unix())
ins := []*avax.TransferableInput{}
returnedOuts := []*avax.TransferableOutput{}
stakedOuts := []*avax.TransferableOutput{}
signers := [][]*crypto.PrivateKeySECP256K1R{}
// Amount of AVAX that has been staked
amountStaked := uint64(0)
// Consume locked UTXOs
for _, utxo := range utxos {
// If we have consumed more AVAX than we are trying to stake, then we
// have no need to consume more locked AVAX
if amountStaked >= amount {
break
}
if assetID := utxo.AssetID(); assetID != vm.ctx.AVAXAssetID {
continue // We only care about staking AVAX, so ignore other assets
}
out, ok := utxo.Out.(*stakeable.LockOut)
if !ok {
// This output isn't locked, so it will be handled during the next
// iteration of the UTXO set
continue
}
if out.Locktime <= now {
// This output is no longer locked, so it will be handled during the
// next iteration of the UTXO set
continue
}
inner, ok := out.TransferableOut.(*secp256k1fx.TransferOutput)
if !ok {
// We only know how to clone secp256k1 outputs for now
continue
}
inIntf, inSigners, err := kc.Spend(out.TransferableOut, now)
if err != nil {
// We couldn't spend the output, so move on to the next one
continue
}
in, ok := inIntf.(avax.TransferableIn)
if !ok { // should never happen
vm.ctx.Log.Warn("expected input to be avax.TransferableIn but is %T", inIntf)
continue
}
// The remaining value is initially the full value of the input
remainingValue := in.Amount()
// Stake any value that should be staked
amountToStake := math.Min64(
amount-amountStaked, // Amount we still need to stake
remainingValue, // Amount available to stake
)
amountStaked += amountToStake
remainingValue -= amountToStake
// Add the input to the consumed inputs
ins = append(ins, &avax.TransferableInput{
UTXOID: utxo.UTXOID,
Asset: avax.Asset{ID: vm.ctx.AVAXAssetID},
In: &stakeable.LockIn{
Locktime: out.Locktime,
TransferableIn: in,
},
})
// Add the output to the staked outputs
stakedOuts = append(stakedOuts, &avax.TransferableOutput{
Asset: avax.Asset{ID: vm.ctx.AVAXAssetID},
Out: &stakeable.LockOut{
Locktime: out.Locktime,
TransferableOut: &secp256k1fx.TransferOutput{
Amt: amountToStake,
OutputOwners: inner.OutputOwners,
},
},
})
if remainingValue > 0 {
// This input provided more value than was needed to be locked.
// Some of it must be returned
returnedOuts = append(returnedOuts, &avax.TransferableOutput{
Asset: avax.Asset{ID: vm.ctx.AVAXAssetID},
Out: &stakeable.LockOut{
Locktime: out.Locktime,
TransferableOut: &secp256k1fx.TransferOutput{
Amt: remainingValue,
OutputOwners: inner.OutputOwners,
},
},
})
}
// Add the signers needed for this input to the set of signers
signers = append(signers, inSigners)
}
// Amount of AVAX that has been burned
amountBurned := uint64(0)
for _, utxo := range utxos {
// If we have consumed more AVAX than we are trying to stake, and we
// have burned more AVAX then we need to, then we have no need to
// consume more AVAX
if amountBurned >= fee && amountStaked >= amount {
break
}
if assetID := utxo.AssetID(); assetID != vm.ctx.AVAXAssetID {
continue // We only care about burning AVAX, so ignore other assets
}
out := utxo.Out
inner, ok := out.(*stakeable.LockOut)
if ok {
if inner.Locktime > now {
// This output is currently locked, so this output can't be
// burned. Additionally, it may have already been consumed
// above. Regardless, we skip to the next UTXO
continue
}
out = inner.TransferableOut
}
inIntf, inSigners, err := kc.Spend(out, now)
if err != nil {
// We couldn't spend this UTXO, so we skip to the next one
continue
}
in, ok := inIntf.(avax.TransferableIn)
if !ok {
// Because we only use the secp Fx right now, this should never
// happen
continue
}
// The remaining value is initially the full value of the input
remainingValue := in.Amount()
// Burn any value that should be burned
amountToBurn := math.Min64(
fee-amountBurned, // Amount we still need to burn
remainingValue, // Amount available to burn
)
amountBurned += amountToBurn
remainingValue -= amountToBurn
// Stake any value that should be staked
amountToStake := math.Min64(
amount-amountStaked, // Amount we still need to stake
remainingValue, // Amount available to stake
)
amountStaked += amountToStake
remainingValue -= amountToStake
// Add the input to the consumed inputs
ins = append(ins, &avax.TransferableInput{
UTXOID: utxo.UTXOID,
Asset: avax.Asset{ID: vm.ctx.AVAXAssetID},
In: in,
})
if amountToStake > 0 {
// Some of this input was put for staking
stakedOuts = append(stakedOuts, &avax.TransferableOutput{
Asset: avax.Asset{ID: vm.ctx.AVAXAssetID},
Out: &secp256k1fx.TransferOutput{
Amt: amountToStake,
OutputOwners: secp256k1fx.OutputOwners{
Locktime: 0,
Threshold: 1,
Addrs: []ids.ShortID{changeAddr},
},
},
})
}
if remainingValue > 0 {
// This input had extra value, so some of it must be returned
returnedOuts = append(returnedOuts, &avax.TransferableOutput{
Asset: avax.Asset{ID: vm.ctx.AVAXAssetID},
Out: &secp256k1fx.TransferOutput{
Amt: remainingValue,
OutputOwners: secp256k1fx.OutputOwners{
Locktime: 0,
Threshold: 1,
Addrs: []ids.ShortID{changeAddr},
},
},
})
}
// Add the signers needed for this input to the set of signers
signers = append(signers, inSigners)
}
if amountBurned < fee || amountStaked < amount {
return nil, nil, nil, nil, fmt.Errorf(
"provided keys have balance (unlocked, locked) (%d, %d) but need (%d, %d)",
amountBurned, amountStaked, fee, amount)
}
avax.SortTransferableInputsWithSigners(ins, signers) // sort inputs and keys
avax.SortTransferableOutputs(returnedOuts, Codec) // sort outputs
avax.SortTransferableOutputs(stakedOuts, Codec) // sort outputs
return ins, returnedOuts, stakedOuts, signers, nil
}
// authorize an operation on behalf of the named subnet with the provided keys.
func (vm *VM) authorize(
vs MutableState,
subnetID ids.ID,
keys []*crypto.PrivateKeySECP256K1R,
) (
verify.Verifiable, // Input that names owners
[]*crypto.PrivateKeySECP256K1R, // Keys that prove ownership
error,
) {
subnetTx, _, err := vs.GetTx(subnetID)
if err != nil {
return nil, nil, fmt.Errorf(
"failed to fetch subnet %s: %w",
subnetID,
err,
)
}
subnet, ok := subnetTx.UnsignedTx.(*UnsignedCreateSubnetTx)
if !ok {
return nil, nil, errWrongTxType
}
// Make sure the owners of the subnet match the provided keys
owner, ok := subnet.Owner.(*secp256k1fx.OutputOwners)
if !ok {
return nil, nil, errUnknownOwners
}
// Add the keys to a keychain
kc := secp256k1fx.NewKeychain(keys...)
// Make sure that the operation is valid after a minimum time
now := uint64(vm.clock.Time().Unix())
// Attempt to prove ownership of the subnet
indices, signers, matches := kc.Match(owner, now)
if !matches {
return nil, nil, errCantSign
}
return &secp256k1fx.Input{SigIndices: indices}, signers, nil
}
// Verify that [tx] is semantically valid.
// [db] should not be committed if an error is returned
// [ins] and [outs] are the inputs and outputs of [tx].
// [creds] are the credentials of [tx], which allow [ins] to be spent.
// Precondition: [tx] has already been syntactically verified
func (vm *VM) semanticVerifySpend(
utxoDB UTXOGetter,
tx UnsignedTx,
ins []*avax.TransferableInput,
outs []*avax.TransferableOutput,
creds []verify.Verifiable,
feeAmount uint64,
feeAssetID ids.ID,
) error {
utxos := make([]*avax.UTXO, len(ins))
for index, input := range ins {
utxo, err := utxoDB.GetUTXO(input.InputID())
if err != nil {
return fmt.Errorf(
"failed to read consumed UTXO %s due to: %w",
&input.UTXOID,
err,
)
}
utxos[index] = utxo
}
return vm.semanticVerifySpendUTXOs(tx, utxos, ins, outs, creds, feeAmount, feeAssetID)
}
// Verify that [tx] is semantically valid.
// [db] should not be committed if an error is returned
// [ins] and [outs] are the inputs and outputs of [tx].
// [creds] are the credentials of [tx], which allow [ins] to be spent.
// [utxos[i]] is the UTXO being consumed by [ins[i]]
// Precondition: [tx] has already been syntactically verified
func (vm *VM) semanticVerifySpendUTXOs(
tx UnsignedTx,
utxos []*avax.UTXO,
ins []*avax.TransferableInput,
outs []*avax.TransferableOutput,
creds []verify.Verifiable,
feeAmount uint64,
feeAssetID ids.ID,
) error {
if len(ins) != len(creds) {
return fmt.Errorf(
"there are %d inputs but %d credentials. Should be same number",
len(ins),
len(creds),
)
}
if len(ins) != len(utxos) {
return fmt.Errorf(
"there are %d inputs but %d utxos. Should be same number",
len(ins),
len(utxos),
)
}
for _, cred := range creds { // Verify credentials are well-formed.
if err := cred.Verify(); err != nil {
return err
}
}
// Time this transaction is being verified
now := uint64(vm.clock.Time().Unix())
// Track the amount of unlocked transfers
unlockedProduced := feeAmount
unlockedConsumed := uint64(0)
// Track the amount of locked transfers and their owners
// locktime -> ownerID -> amount
lockedProduced := make(map[uint64]map[ids.ID]uint64)
lockedConsumed := make(map[uint64]map[ids.ID]uint64)
for index, input := range ins {
utxo := utxos[index] // The UTXO consumed by [input]
if assetID := utxo.AssetID(); assetID != feeAssetID {
return errAssetIDMismatch
}
if assetID := input.AssetID(); assetID != feeAssetID {
return errAssetIDMismatch
}
out := utxo.Out
locktime := uint64(0)
// Set [locktime] to this UTXO's locktime, if applicable
if inner, ok := out.(*stakeable.LockOut); ok {
out = inner.TransferableOut
locktime = inner.Locktime
}
in := input.In
// The UTXO says it's locked until [locktime], but this input, which
// consumes it, is not locked even though [locktime] hasn't passed. This
// is invalid.
if inner, ok := in.(*stakeable.LockIn); now < locktime && !ok {
return errLockedFundsNotMarkedAsLocked
} else if ok {
if inner.Locktime != locktime {
// This input is locked, but its locktime is wrong
return errWrongLocktime
}
in = inner.TransferableIn
}
// Verify that this tx's credentials allow [in] to be spent
if err := vm.fx.VerifyTransfer(tx, in, creds[index], out); err != nil {
return fmt.Errorf("failed to verify transfer: %w", err)
}
amount := in.Amount()
if now >= locktime {
newUnlockedConsumed, err := math.Add64(unlockedConsumed, amount)
if err != nil {
return err
}
unlockedConsumed = newUnlockedConsumed
continue
}
owned, ok := out.(fx.Owned)
if !ok {
return errUnknownOwners
}
owner := owned.Owners()
ownerBytes, err := Codec.Marshal(CodecVersion, owner)
if err != nil {
return fmt.Errorf("couldn't marshal owner: %w", err)
}
ownerID := hashing.ComputeHash256Array(ownerBytes)
owners, ok := lockedConsumed[locktime]
if !ok {
owners = make(map[ids.ID]uint64)
lockedConsumed[locktime] = owners
}
newAmount, err := math.Add64(owners[ownerID], amount)
if err != nil {
return err
}
owners[ownerID] = newAmount
}
for _, out := range outs {
if assetID := out.AssetID(); assetID != feeAssetID {
return errAssetIDMismatch
}
output := out.Output()
locktime := uint64(0)
// Set [locktime] to this output's locktime, if applicable
if inner, ok := output.(*stakeable.LockOut); ok {
output = inner.TransferableOut
locktime = inner.Locktime
}
amount := output.Amount()
if locktime == 0 {
newUnlockedProduced, err := math.Add64(unlockedProduced, amount)
if err != nil {
return err
}
unlockedProduced = newUnlockedProduced
continue
}
owned, ok := output.(fx.Owned)
if !ok {
return errUnknownOwners
}
owner := owned.Owners()
ownerBytes, err := Codec.Marshal(CodecVersion, owner)
if err != nil {
return fmt.Errorf("couldn't marshal owner: %w", err)
}
ownerID := hashing.ComputeHash256Array(ownerBytes)
owners, ok := lockedProduced[locktime]
if !ok {
owners = make(map[ids.ID]uint64)
lockedProduced[locktime] = owners
}
newAmount, err := math.Add64(owners[ownerID], amount)
if err != nil {
return err
}
owners[ownerID] = newAmount
}
// Make sure that for each locktime, tokens produced <= tokens consumed
for locktime, producedAmounts := range lockedProduced {
consumedAmounts := lockedConsumed[locktime]
for ownerID, producedAmount := range producedAmounts {
consumedAmount := consumedAmounts[ownerID]
if producedAmount > consumedAmount {
increase := producedAmount - consumedAmount
if increase > unlockedConsumed {
return fmt.Errorf(
"address %s produces %d unlocked and consumes %d unlocked for locktime %d",
ownerID,
increase,
unlockedConsumed,
locktime,
)
}
unlockedConsumed -= increase
}
}
}
// More unlocked tokens produced than consumed. Invalid.
if unlockedProduced > unlockedConsumed {
return fmt.Errorf(
"tx produces more unlocked (%d) than it consumes (%d)",
unlockedProduced,
unlockedConsumed,
)
}
return nil
}
// Removes the UTXOs consumed by [ins] from the UTXO set
func consumeInputs(
utxoDB UTXODeleter,
ins []*avax.TransferableInput,
) {
for _, input := range ins {
utxoDB.DeleteUTXO(input.InputID())
}
}
// Adds the UTXOs created by [outs] to the UTXO set.
// [txID] is the ID of the tx that created [outs].
func produceOutputs(
utxoDB UTXOAdder,
txID ids.ID,
assetID ids.ID,
outs []*avax.TransferableOutput,
) {
for index, out := range outs {
utxoDB.AddUTXO(&avax.UTXO{
UTXOID: avax.UTXOID{
TxID: txID,
OutputIndex: uint32(index),
},
Asset: avax.Asset{ID: assetID},
Out: out.Output(),
})
}
}