forked from decred/dcrwallet
-
Notifications
You must be signed in to change notification settings - Fork 0
/
stake.go
1196 lines (1021 loc) · 36.4 KB
/
stake.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
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2015-2017 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.
package udb
import (
"bytes"
"encoding/binary"
"fmt"
"sync"
"time"
"github.com/decred/dcrd/blockchain"
"github.com/decred/dcrd/blockchain/stake"
"github.com/decred/dcrd/chaincfg"
"github.com/decred/dcrd/chaincfg/chainec"
"github.com/decred/dcrd/chaincfg/chainhash"
"github.com/decred/dcrd/txscript"
"github.com/decred/dcrd/wire"
"github.com/decred/dcrutil"
"github.com/decred/dcrwallet/apperrors"
walletchain "github.com/decred/dcrwallet/chain"
"github.com/decred/dcrwallet/wallet/txrules"
"github.com/decred/dcrwallet/walletdb"
)
func stakeStoreError(code apperrors.Code, str string, err error) error {
return apperrors.E{ErrorCode: code, Description: str, Err: err}
}
// sstxRecord is the structure for a stored SStx.
type sstxRecord struct {
tx *dcrutil.Tx
ts time.Time
voteBitsSet bool // Removed in version 3
voteBits uint16 // Removed in version 3
voteBitsExt []byte // Removed in version 3
}
// ssgenRecord is the structure for a stored SSGen tx. There's no
// real reason to store the actual transaction I don't think,
// the inputs and outputs are all predetermined from the block
// height and the original SStx it references.
//
// TODO Store the extended votebits, too.
type ssgenRecord struct {
blockHash chainhash.Hash
blockHeight uint32
txHash chainhash.Hash
voteBits uint16
ts time.Time
}
// ssrtxRecord is the structure for a stored SSRtx. While the
// ssrtx itself does not include the block hash or block height,
// we still preserve that so that we know the block ntfn that
// informed us that the sstx was missed.
type ssrtxRecord struct {
blockHash chainhash.Hash
blockHeight uint32
txHash chainhash.Hash
ts time.Time
}
// TicketStatus is the current status of a stake pool ticket.
type TicketStatus uint8
const (
// TSImmatureOrLive indicates that the ticket is either
// live or immature.
TSImmatureOrLive = iota
// TSVoted indicates that the ticket was spent as a vote.
TSVoted
// TSMissed indicates that the ticket was spent as a
// revocation.
TSMissed
)
// PoolTicket is a 73-byte struct that is used to preserve user's
// ticket information when they have an account at the stake pool.
type PoolTicket struct {
Ticket chainhash.Hash
HeightTicket uint32
Status TicketStatus
HeightSpent uint32
SpentBy chainhash.Hash
}
// StakePoolUser is a list of tickets for a given user (P2SH
// address) in the stake pool.
type StakePoolUser struct {
Tickets []*PoolTicket
InvalidTickets []*chainhash.Hash
}
// StakeStore represents a safely accessible database of
// stake transactions.
type StakeStore struct {
Params *chaincfg.Params
Manager *Manager
chainSvr *walletchain.RPCClient
ownedSStxs map[chainhash.Hash]struct{}
mtx sync.RWMutex // only protects ownedSStxs
}
// StakeNotification is the data structure that contains information
// about an SStx (ticket), SSGen (vote), or SSRtx (revocation)
// produced by wallet.
type StakeNotification struct {
TxType int8 // These are the same as in staketx.go of stake, but int8
TxHash chainhash.Hash
BlockHash chainhash.Hash // SSGen only
Height int32 // SSGen only
Amount int64 // SStx only
SStxIn chainhash.Hash // SSGen and SSRtx
VoteBits uint16 // SSGen only
}
// checkHashInStore checks if a hash exists in ownedSStxs.
func (s *StakeStore) checkHashInStore(hash *chainhash.Hash) bool {
_, exists := s.ownedSStxs[*hash]
return exists
}
// CheckHashInStore is the exported version of CheckHashInStore that is
// safe for concurrent access.
func (s *StakeStore) CheckHashInStore(hash *chainhash.Hash) bool {
s.mtx.RLock()
exists := s.checkHashInStore(hash)
s.mtx.RUnlock()
return exists
}
// addHashToStore adds a hash into ownedSStxs.
func (s *StakeStore) addHashToStore(hash *chainhash.Hash) {
s.ownedSStxs[*hash] = struct{}{}
}
// insertSStx inserts an SStx into the store.
func (s *StakeStore) insertSStx(ns walletdb.ReadWriteBucket, sstx *dcrutil.Tx) error {
// If we already have the SStx, no need to
// try to include twice.
exists := s.checkHashInStore(sstx.Hash())
if exists {
log.Tracef("Attempted to insert SStx %v into the stake store, "+
"but the SStx already exists.", sstx.Hash())
return nil
}
record := &sstxRecord{
tx: sstx,
ts: time.Now(),
}
// Add the SStx to the database.
err := putSStxRecord(ns, record, DBVersion)
if err != nil {
return err
}
// Add the SStx's hash to the internal list in the store.
s.addHashToStore(sstx.Hash())
return nil
}
// InsertSStx is the exported version of insertSStx that is safe for concurrent
// access.
func (s *StakeStore) InsertSStx(ns walletdb.ReadWriteBucket, sstx *dcrutil.Tx) error {
s.mtx.Lock()
err := s.insertSStx(ns, sstx)
s.mtx.Unlock()
return err
}
// dumpSStxHashes dumps the hashes of all owned SStxs. Note
// that this doesn't use the DB.
func (s *StakeStore) dumpSStxHashes() []chainhash.Hash {
// Copy the hash list of sstxs. You could pass the pointer
// directly but you risk that the size of the internal
// ownedSStxs is later modified while the end user is
// working with the returned list.
ownedSStxs := make([]chainhash.Hash, len(s.ownedSStxs))
itr := 0
for hash := range s.ownedSStxs {
ownedSStxs[itr] = hash
itr++
}
return ownedSStxs
}
// DumpSStxHashes returns the hashes of all wallet ticket purchase transactions.
func (s *StakeStore) DumpSStxHashes() ([]chainhash.Hash, error) {
defer s.mtx.RUnlock()
s.mtx.RLock()
return s.dumpSStxHashes(), nil
}
// dumpSStxHashes dumps the hashes of all owned SStxs for some address.
func (s *StakeStore) dumpSStxHashesForAddress(ns walletdb.ReadBucket, addr dcrutil.Address) ([]chainhash.Hash, error) {
// Extract the HASH160 script hash; if it's not 20 bytes
// long, return an error.
hash160 := addr.ScriptAddress()
if len(hash160) != 20 {
str := "stake store is closed"
return nil, stakeStoreError(apperrors.ErrInput, str, nil)
}
_, addrIsP2SH := addr.(*dcrutil.AddressScriptHash)
allTickets := s.dumpSStxHashes()
var ticketsForAddr []chainhash.Hash
// Access the database and store the result locally.
for _, h := range allTickets {
thisHash160, p2sh, err := fetchSStxRecordSStxTicketHash160(ns, &h, DBVersion)
if err != nil {
str := "failure getting ticket 0th out script hashes from db"
return nil, stakeStoreError(apperrors.ErrDatabase, str, err)
}
if addrIsP2SH != p2sh {
continue
}
if bytes.Equal(hash160, thisHash160) {
ticketsForAddr = append(ticketsForAddr, h)
}
}
return ticketsForAddr, nil
}
// DumpSStxHashesForAddress returns the hashes of all wallet ticket purchase
// transactions for an address.
func (s *StakeStore) DumpSStxHashesForAddress(ns walletdb.ReadBucket, addr dcrutil.Address) ([]chainhash.Hash, error) {
defer s.mtx.RUnlock()
s.mtx.RLock()
return s.dumpSStxHashesForAddress(ns, addr)
}
// sstxAddress returns the address for a given ticket.
func (s *StakeStore) sstxAddress(ns walletdb.ReadBucket, hash *chainhash.Hash) (dcrutil.Address, error) {
// Access the database and store the result locally.
thisHash160, p2sh, err := fetchSStxRecordSStxTicketHash160(ns, hash, DBVersion)
if err != nil {
str := "failure getting ticket 0th out script hashes from db"
return nil, stakeStoreError(apperrors.ErrDatabase, str, err)
}
var addr dcrutil.Address
if p2sh {
addr, err = dcrutil.NewAddressScriptHashFromHash(thisHash160, s.Params)
} else {
addr, err = dcrutil.NewAddressPubKeyHash(thisHash160, s.Params, chainec.ECTypeSecp256k1)
}
if err != nil {
str := "failure getting ticket 0th out script hashes from db"
return nil, stakeStoreError(apperrors.ErrDatabase, str, err)
}
return addr, nil
}
// SStxAddress is the exported, concurrency safe version of sstxAddress.
func (s *StakeStore) SStxAddress(ns walletdb.ReadBucket, hash *chainhash.Hash) (dcrutil.Address, error) {
return s.sstxAddress(ns, hash)
}
// dumpSSGenHashes fetches and returns the entire list of votes generated by
// this wallet, including votes that were produced but were never included in
// the blockchain.
func (s *StakeStore) dumpSSGenHashes(ns walletdb.ReadBucket) ([]chainhash.Hash, error) {
var voteList []chainhash.Hash
// Open the vite records database.
bucket := ns.NestedReadBucket(ssgenRecordsBucketName)
// Store each hash sequentially.
err := bucket.ForEach(func(k []byte, v []byte) error {
recs, errDeser := deserializeSSGenRecords(v)
if errDeser != nil {
return errDeser
}
for _, rec := range recs {
voteList = append(voteList, rec.txHash)
}
return nil
})
return voteList, err
}
// DumpSSGenHashes is the exported version of dumpSSGenHashes that is safe
// for concurrent access.
func (s *StakeStore) DumpSSGenHashes(ns walletdb.ReadBucket) ([]chainhash.Hash, error) {
return s.dumpSSGenHashes(ns)
}
// dumpSSRtxTickets fetches the entire list of tickets spent as revocations
// byt this wallet.
func (s *StakeStore) dumpSSRtxTickets(ns walletdb.ReadBucket) ([]chainhash.Hash, error) {
var ticketList []chainhash.Hash
// Open the revocation records database.
bucket := ns.NestedReadBucket(ssrtxRecordsBucketName)
// Store each hash sequentially.
err := bucket.ForEach(func(k []byte, v []byte) error {
ticket, errDeser := chainhash.NewHash(k)
if errDeser != nil {
return errDeser
}
ticketList = append(ticketList, *ticket)
return nil
})
return ticketList, err
}
// DumpSSRtxTickets is the exported version of dumpSSRtxTickets that is safe
// for concurrent access.
func (s *StakeStore) DumpSSRtxTickets(ns walletdb.ReadBucket) ([]chainhash.Hash, error) {
return s.dumpSSRtxTickets(ns)
}
// insertSSGen inserts an SSGen record into the DB (keyed to the SStx it
// spends.
func insertSSGen(ns walletdb.ReadWriteBucket, blockHash *chainhash.Hash, blockHeight int64,
ssgenHash *chainhash.Hash, voteBits uint16, sstxHash *chainhash.Hash) error {
if blockHeight <= 0 {
return fmt.Errorf("invalid SSGen block height")
}
record := &ssgenRecord{
*blockHash,
uint32(blockHeight),
*ssgenHash,
voteBits,
time.Now(),
}
// Add the SSGen to the database.
return putSSGenRecord(ns, sstxHash, record)
}
// InsertSSGen is the exported version of insertSSGen that is safe for
// concurrent access.
func (s *StakeStore) InsertSSGen(ns walletdb.ReadWriteBucket, blockHash *chainhash.Hash, blockHeight int64, ssgenHash *chainhash.Hash, voteBits uint16, sstxHash *chainhash.Hash) error {
return insertSSGen(ns, blockHash, blockHeight, ssgenHash, voteBits, sstxHash)
}
// signVRTransaction signs a vote (SSGen) or revocation (SSRtx)
// transaction. isSSGen indicates if it is an SSGen; if it's not,
// it's an SSRtx.
func signVRTransaction(m *Manager, ns walletdb.ReadBucket, msgTx *wire.MsgTx, sstx *dcrutil.Tx, isSSGen bool) error {
txInNumToSign := 0
hashType := txscript.SigHashAll
if isSSGen {
// For an SSGen tx, skip the first input as it is a stake base
// and doesn't need to be signed.
msgTx.TxIn[0].SignatureScript = m.chainParams.StakeBaseSigScript
txInNumToSign = 1
}
// Get the script for the OP_SSTX tagged output that we need
// to sign.
sstxOutScript := sstx.MsgTx().TxOut[0].PkScript
// Create a slice of functions to run after the retreived secrets are no
// longer needed.
doneFuncs := make([]func(), 0, len(msgTx.TxIn))
defer func() {
for _, done := range doneFuncs {
done()
}
}()
// Set up our callbacks that we pass to dcrscript so it can
// look up the appropriate keys and scripts by address.
var getKey txscript.KeyClosure = func(addr dcrutil.Address) (chainec.PrivateKey, bool, error) {
address, err := m.Address(ns, addr)
if err != nil {
return nil, false, err
}
pka, ok := address.(ManagedPubKeyAddress)
if !ok {
return nil, false, fmt.Errorf("address is not " +
"a pubkey address")
}
key, done, err := m.PrivateKey(ns, addr)
if err != nil {
return nil, false, err
}
doneFuncs = append(doneFuncs, done)
return key, pka.Compressed(), nil
}
var getScript txscript.ScriptClosure = func(addr dcrutil.Address) ([]byte, error) {
script, done, err := m.RedeemScript(ns, addr)
if err != nil {
return nil, err
}
doneFuncs = append(doneFuncs, done)
return script, nil
}
// Attempt to generate the signed txin.
signedScript, err := txscript.SignTxOutput(
m.chainParams,
msgTx,
txInNumToSign,
sstxOutScript,
hashType,
getKey,
getScript,
msgTx.TxIn[txInNumToSign].SignatureScript,
chainec.ECTypeSecp256k1,
)
if err != nil {
return fmt.Errorf("failed to sign ssgen or "+
"ssrtx, error: %v", err.Error())
}
msgTx.TxIn[txInNumToSign].SignatureScript = signedScript
// Either it was already signed or we just signed it.
// Find out if it is completely satisfied or still needs more.
// Decred: Needed??
flags := txscript.ScriptBip16
engine, err := txscript.NewEngine(sstxOutScript,
msgTx,
txInNumToSign,
flags,
txscript.DefaultScriptVersion,
nil)
if err != nil {
return fmt.Errorf("failed to generate signature script engine for "+
"ssgen or ssrtx, error: %v", err.Error())
}
err = engine.Execute()
if err != nil {
return fmt.Errorf("failed to generate correct signature script for "+
"ssgen or ssrtx: %v", err.Error())
}
return nil
}
var subsidyCache *blockchain.SubsidyCache
var initSudsidyCacheOnce sync.Once
// generateVoteScript generates a voting script from the passed VoteBits, for
// use in a vote.
func generateVoteScript(voteBits stake.VoteBits) ([]byte, error) {
toPush := make([]byte, 2+len(voteBits.ExtendedBits))
binary.LittleEndian.PutUint16(toPush[0:2], voteBits.Bits)
copy(toPush[2:], voteBits.ExtendedBits[:])
blockVBScript, err := txscript.GenerateProvablyPruneableOut(toPush)
if err != nil {
return nil, err
}
return blockVBScript, nil
}
// generateVoteNtfn creates a new SSGen given a header hash, height, sstx
// tx hash, and votebits and returns a notification.
func (s *StakeStore) generateVoteNtfn(ns walletdb.ReadWriteBucket, waddrmgrNs walletdb.ReadBucket, blockHash *chainhash.Hash, height int64, sstxHash *chainhash.Hash, defaultVoteBits stake.VoteBits, stakePoolEnabled, allowHighFees bool) (*StakeNotification, error) {
// 1. Fetch the SStx, then calculate all the values we'll need later for
// the generation of the SSGen tx outputs.
sstxRecord, err := fetchSStxRecord(ns, sstxHash, DBVersion)
if err != nil {
return nil, err
}
sstx := sstxRecord.tx
sstxMsgTx := sstx.MsgTx()
// The legacy wallet didn't store anything about the voteBits to use.
// In the case we're loading a legacy wallet and the voteBits are
// unset, just use the default voteBits as set by the user.
voteBits := defaultVoteBits
if stakePoolEnabled && sstxRecord.voteBitsSet {
voteBits.Bits = sstxRecord.voteBits
// This is not correct and therefore commented out. For now, this will set
// extended voteBits to whatever the default is to the wallet.
// voteBits.ExtendedBits = sstxRecord.voteBitsExt
}
// Store the sstx pubkeyhashes and amounts as found in the transaction
// outputs.
// TODO Get information on the allowable fee range for the vote
// and check to make sure we don't overflow that.
ssgenPayTypes, ssgenPkhs, sstxAmts, _, _, _ :=
stake.TxSStxStakeOutputInfo(sstxMsgTx)
// Get the current reward.
initSudsidyCacheOnce.Do(func() {
subsidyCache = blockchain.NewSubsidyCache(height, s.Params)
})
stakeVoteSubsidy := blockchain.CalcStakeVoteSubsidy(subsidyCache,
height, s.Params)
// Calculate the output values from this data.
ssgenCalcAmts := stake.CalculateRewards(sstxAmts,
sstxMsgTx.TxOut[0].Value,
stakeVoteSubsidy)
subsidyCache = blockchain.NewSubsidyCache(height, s.Params)
// 2. Add all transaction inputs to a new transaction after performing
// some validity checks. First, add the stake base, then the OP_SSTX
// tagged output.
msgTx := wire.NewMsgTx()
// Stakebase.
stakeBaseOutPoint := wire.NewOutPoint(&chainhash.Hash{},
uint32(0xFFFFFFFF),
wire.TxTreeRegular)
txInStakeBase := wire.NewTxIn(stakeBaseOutPoint, []byte{})
msgTx.AddTxIn(txInStakeBase)
// Add the subsidy amount into the input.
msgTx.TxIn[0].ValueIn = stakeVoteSubsidy
// SStx tagged output as an OutPoint.
prevOut := wire.NewOutPoint(sstxHash,
0, // Index 0
1) // Tree stake
txIn := wire.NewTxIn(prevOut, []byte{})
msgTx.AddTxIn(txIn)
// 3. Add the OP_RETURN null data pushes of the block header hash,
// the block height, and votebits, then add all the OP_SSGEN tagged
// outputs.
//
// Block reference output.
blockRefScript, err := txscript.GenerateSSGenBlockRef(*blockHash,
uint32(height))
if err != nil {
return nil, err
}
blockRefOut := wire.NewTxOut(0, blockRefScript)
msgTx.AddTxOut(blockRefOut)
// Votebits output.
blockVBScript, err := generateVoteScript(voteBits)
if err != nil {
return nil, err
}
blockVBOut := wire.NewTxOut(0, blockVBScript)
msgTx.AddTxOut(blockVBOut)
// Add all the SSGen-tagged transaction outputs to the transaction after
// performing some validity checks.
for i, ssgenPkh := range ssgenPkhs {
// Create a new script which pays to the provided address specified in
// the original ticket tx.
var ssgenOutScript []byte
switch ssgenPayTypes[i] {
case false: // P2PKH
ssgenOutScript, err = txscript.PayToSSGenPKHDirect(ssgenPkh)
if err != nil {
return nil, err
}
case true: // P2SH
ssgenOutScript, err = txscript.PayToSSGenSHDirect(ssgenPkh)
if err != nil {
return nil, err
}
}
// Add the txout to our SSGen tx.
txOut := wire.NewTxOut(ssgenCalcAmts[i], ssgenOutScript)
msgTx.AddTxOut(txOut)
}
// Check to make sure our SSGen was created correctly.
_, err = stake.IsSSGen(msgTx)
if err != nil {
return nil, err
}
// Sign the transaction.
err = signVRTransaction(s.Manager, waddrmgrNs, msgTx, sstx, true)
if err != nil {
return nil, err
}
// Store the information about the SSGen.
hash := msgTx.TxHash()
err = insertSSGen(ns,
blockHash,
height,
&hash,
voteBits.Bits,
sstx.Hash())
if err != nil {
return nil, err
}
// Send the transaction.
ssgenSha, err := s.chainSvr.SendRawTransaction(msgTx, allowHighFees)
if err != nil {
return nil, err
}
log.Debugf("Generated SSGen %v, voting on block %v at height %v. "+
"The ticket used to generate the SSGen was %v.",
ssgenSha, blockHash, height, sstxHash)
// Generate a notification to return.
ntfn := &StakeNotification{
TxType: int8(stake.TxTypeSSGen),
TxHash: *ssgenSha,
BlockHash: *blockHash,
Height: int32(height),
Amount: 0,
SStxIn: *sstx.Hash(),
VoteBits: voteBits.Bits,
}
return ntfn, nil
}
func (s *StakeStore) generateVoteTx(ns walletdb.ReadBucket, waddrmgrNs walletdb.ReadBucket, blockHash *chainhash.Hash, height int64, sstxHash *chainhash.Hash, voteBits stake.VoteBits) (*wire.MsgTx, error) {
// 1. Fetch the SStx, then calculate all the values we'll need later for
// the generation of the SSGen tx outputs.
sstxRecord, err := fetchSStxRecord(ns, sstxHash, DBVersion)
if err != nil {
return nil, err
}
sstx := sstxRecord.tx
sstxMsgTx := sstx.MsgTx()
// Store the sstx pubkeyhashes and amounts as found in the transaction
// outputs.
// TODO Get information on the allowable fee range for the vote
// and check to make sure we don't overflow that.
ssgenPayTypes, ssgenPkhs, sstxAmts, _, _, _ :=
stake.TxSStxStakeOutputInfo(sstxMsgTx)
// Get the current reward.
initSudsidyCacheOnce.Do(func() {
subsidyCache = blockchain.NewSubsidyCache(height, s.Params)
})
stakeVoteSubsidy := blockchain.CalcStakeVoteSubsidy(subsidyCache,
height, s.Params)
// Calculate the output values from this data.
ssgenCalcAmts := stake.CalculateRewards(sstxAmts,
sstxMsgTx.TxOut[0].Value,
stakeVoteSubsidy)
subsidyCache = blockchain.NewSubsidyCache(height, s.Params)
// 2. Add all transaction inputs to a new transaction after performing
// some validity checks. First, add the stake base, then the OP_SSTX
// tagged output.
msgTx := wire.NewMsgTx()
// Stakebase.
stakeBaseOutPoint := wire.NewOutPoint(&chainhash.Hash{},
uint32(0xFFFFFFFF),
wire.TxTreeRegular)
txInStakeBase := wire.NewTxIn(stakeBaseOutPoint, []byte{})
msgTx.AddTxIn(txInStakeBase)
// Add the subsidy amount into the input.
msgTx.TxIn[0].ValueIn = stakeVoteSubsidy
// SStx tagged output as an OutPoint.
prevOut := wire.NewOutPoint(sstxHash,
0, // Index 0
1) // Tree stake
txIn := wire.NewTxIn(prevOut, []byte{})
msgTx.AddTxIn(txIn)
// 3. Add the OP_RETURN null data pushes of the block header hash,
// the block height, and votebits, then add all the OP_SSGEN tagged
// outputs.
//
// Block reference output.
blockRefScript, err := txscript.GenerateSSGenBlockRef(*blockHash,
uint32(height))
if err != nil {
return nil, err
}
blockRefOut := wire.NewTxOut(0, blockRefScript)
msgTx.AddTxOut(blockRefOut)
// Votebits output.
blockVBScript, err := generateVoteScript(voteBits)
if err != nil {
return nil, err
}
blockVBOut := wire.NewTxOut(0, blockVBScript)
msgTx.AddTxOut(blockVBOut)
// Add all the SSGen-tagged transaction outputs to the transaction after
// performing some validity checks.
for i, ssgenPkh := range ssgenPkhs {
// Create a new script which pays to the provided address specified in
// the original ticket tx.
var ssgenOutScript []byte
switch ssgenPayTypes[i] {
case false: // P2PKH
ssgenOutScript, err = txscript.PayToSSGenPKHDirect(ssgenPkh)
if err != nil {
return nil, err
}
case true: // P2SH
ssgenOutScript, err = txscript.PayToSSGenSHDirect(ssgenPkh)
if err != nil {
return nil, err
}
}
// Add the txout to our SSGen tx.
txOut := wire.NewTxOut(ssgenCalcAmts[i], ssgenOutScript)
msgTx.AddTxOut(txOut)
}
// Check to make sure our SSGen was created correctly.
_, err = stake.IsSSGen(msgTx)
if err != nil {
return nil, err
}
// Sign the transaction.
err = signVRTransaction(s.Manager, waddrmgrNs, msgTx, sstx, true)
return msgTx, err
}
// GenerateVoteTx creates a new vote transaction given a header hash, height,
// sstx tx hash, and votebits. The vote is not stored in the database.
func (s *StakeStore) GenerateVoteTx(ns walletdb.ReadBucket, waddrmgrNs walletdb.ReadBucket, blockHash *chainhash.Hash, height int64, sstxHash *chainhash.Hash, voteBits stake.VoteBits) (*wire.MsgTx, error) {
return s.generateVoteTx(ns, waddrmgrNs, blockHash, height, sstxHash, voteBits)
}
// insertSSRtx inserts an SSRtx record into the DB (keyed to the SStx it
// spends.
func (s *StakeStore) insertSSRtx(ns walletdb.ReadWriteBucket, blockHash *chainhash.Hash, blockHeight int64, ssrtxHash *chainhash.Hash, sstxHash *chainhash.Hash) error {
if blockHeight <= 0 {
return fmt.Errorf("invalid SSRtx block height")
}
record := &ssrtxRecord{
*blockHash,
uint32(blockHeight),
*ssrtxHash,
time.Now(),
}
// Add the SSRtx to the database.
return putSSRtxRecord(ns, sstxHash, record)
}
// InsertSSRtx is the exported version of insertSSRtx that is safe for
// concurrent access.
func (s *StakeStore) InsertSSRtx(ns walletdb.ReadWriteBucket, blockHash *chainhash.Hash, blockHeight int64, ssrtxHash *chainhash.Hash, sstxHash *chainhash.Hash) error {
return s.insertSSRtx(ns, blockHash, blockHeight, ssrtxHash, sstxHash)
}
// GetSSRtxs gets a list of SSRtxs that have been generated for some stake
// ticket.
func (s *StakeStore) getSSRtxs(ns walletdb.ReadBucket, sstxHash *chainhash.Hash) ([]*ssrtxRecord, error) {
return fetchSSRtxRecords(ns, sstxHash)
}
// GenerateRevocation generates a revocation (SSRtx), signs it, and
// submits it by SendRawTransaction. It also stores a record of it
// in the local database.
func (s *StakeStore) generateRevocation(ns walletdb.ReadWriteBucket, waddrmgrNs walletdb.ReadBucket,
blockHash *chainhash.Hash, height int64, sstxHash *chainhash.Hash, feePerKb dcrutil.Amount,
allowHighFees bool) (*StakeNotification, error) {
// 1. Fetch the SStx, then calculate all the values we'll need later for
// the generation of the SSRtx tx outputs.
sstxRecord, err := fetchSStxRecord(ns, sstxHash, DBVersion)
if err != nil {
return nil, err
}
sstx := sstxRecord.tx
// Store the sstx pubkeyhashes and amounts as found in the transaction
// outputs.
// TODO Get information on the allowable fee range for the revocation
// and check to make sure we don't overflow that.
sstxPayTypes, sstxPkhs, sstxAmts, _, _, _ :=
stake.TxSStxStakeOutputInfo(sstx.MsgTx())
ssrtxCalcAmts := stake.CalculateRewards(sstxAmts, sstx.MsgTx().TxOut[0].Value,
int64(0))
// Calculate the fee to use for this revocation based on the fee
// per KB that is standard for mainnet.
revocationSizeEst := estimateSSRtxTxSize(1, len(sstxPkhs))
revocationFee := txrules.FeeForSerializeSize(feePerKb,
revocationSizeEst)
// 2. Add the only input.
msgTx := wire.NewMsgTx()
// SStx tagged output as an OutPoint; reference this as
// the only input.
prevOut := wire.NewOutPoint(sstxHash,
0, // Index 0
1) // Tree stake
txIn := wire.NewTxIn(prevOut, []byte{})
msgTx.AddTxIn(txIn)
// 3. Add all the OP_SSRTX tagged outputs.
// Add all the SSRtx-tagged transaction outputs to the transaction after
// performing some validity checks.
feeAdded := false
for i, sstxPkh := range sstxPkhs {
// Create a new script which pays to the provided address specified in
// the original ticket tx.
var ssrtxOutScript []byte
switch sstxPayTypes[i] {
case false: // P2PKH
ssrtxOutScript, err = txscript.PayToSSRtxPKHDirect(sstxPkh)
if err != nil {
return nil, err
}
case true: // P2SH
ssrtxOutScript, err = txscript.PayToSSRtxSHDirect(sstxPkh)
if err != nil {
return nil, err
}
}
// Add a fee from an output that has enough.
amt := ssrtxCalcAmts[i]
if !feeAdded && ssrtxCalcAmts[i] >= int64(revocationFee) {
amt -= int64(revocationFee)
feeAdded = true
}
// Add the txout to our SSRtx tx.
txOut := wire.NewTxOut(amt, ssrtxOutScript)
msgTx.AddTxOut(txOut)
}
// Check to make sure our SSRtx was created correctly.
_, err = stake.IsSSRtx(msgTx)
if err != nil {
return nil, err
}
// Sign the transaction.
err = signVRTransaction(s.Manager, waddrmgrNs, msgTx, sstx, false)
if err != nil {
return nil, err
}
// Store the information about the SSRtx.
hash := msgTx.TxHash()
err = s.insertSSRtx(ns,
blockHash,
height,
&hash,
sstx.Hash())
if err != nil {
return nil, err
}
// Send the transaction.
ssrtxHash, err := s.chainSvr.SendRawTransaction(msgTx, allowHighFees)
if err != nil {
return nil, err
}
log.Debugf("Generated SSRtx %v. The ticket used to "+
"generate the SSRtx was %v.", ssrtxHash, sstx.Hash())
// Generate a notification to return.
ntfn := &StakeNotification{
TxType: int8(stake.TxTypeSSRtx),
TxHash: *ssrtxHash,
BlockHash: chainhash.Hash{},
Height: 0,
Amount: 0,
SStxIn: *sstx.Hash(),
VoteBits: 0,
}
return ntfn, nil
}
// HandleWinningTicketsNtfn scans the list of eligible tickets and, if any
// of these tickets in the sstx store match these tickets, spends them as
// votes.
func (s *StakeStore) HandleWinningTicketsNtfn(ns walletdb.ReadWriteBucket, waddrmgrNs walletdb.ReadBucket, blockHash *chainhash.Hash, blockHeight int64, tickets []*chainhash.Hash, defaultVoteBits stake.VoteBits, stakePoolEnabled, allowHighFees bool) ([]*StakeNotification, error) {
// Go through the list of tickets and see any of the
// ones we own match those eligible.
var ticketsToPull []*chainhash.Hash
s.mtx.RLock()
for _, ticket := range tickets {
if s.checkHashInStore(ticket) {
ticketsToPull = append(ticketsToPull, ticket)
}
}
defer s.mtx.RUnlock()
// No matching tickets (boo!), return.
if len(ticketsToPull) == 0 {
return nil, nil
}
ntfns := make([]*StakeNotification, len(ticketsToPull))
voteErrors := make([]error, len(ticketsToPull))
// Matching tickets (yay!), generate some SSGen.
for i, ticket := range ticketsToPull {
ntfns[i], voteErrors[i] = s.generateVoteNtfn(ns, waddrmgrNs, blockHash,
blockHeight, ticket, defaultVoteBits, stakePoolEnabled, allowHighFees)
}
errStr := ""
for i, err := range voteErrors {
if err != nil {
errStr += fmt.Sprintf("Error encountered attempting to create "+
"vote using ticket %v: ", ticketsToPull[i])
errStr += err.Error()
errStr += "\n"
}
}
if errStr != "" {
return nil, fmt.Errorf("%v", errStr)
}
return ntfns, nil
}
// HandleMissedTicketsNtfn scans the list of missed tickets and, if any
// of these tickets in the sstx store match these tickets, spends them as
// SSRtx.
func (s *StakeStore) HandleMissedTicketsNtfn(ns walletdb.ReadWriteBucket, waddrmgrNs walletdb.ReadBucket, blockHash *chainhash.Hash,
blockHeight int64, tickets []*chainhash.Hash, feePerKb dcrutil.Amount, allowHighFees bool) ([]*StakeNotification, error) {
// Go through the list of tickets and see any of the
// ones we own match those eligible.
var ticketsToPull []*chainhash.Hash
s.mtx.RLock()
for _, ticket := range tickets {
if s.checkHashInStore(ticket) {
ticketsToPull = append(ticketsToPull, ticket)
}
}
s.mtx.RUnlock()
// No matching tickets, return.
if len(ticketsToPull) == 0 {
return nil, nil
}
ntfns := make([]*StakeNotification, len(ticketsToPull))
revocationErrors := make([]error, len(ticketsToPull))
// Matching tickets, generate some SSRtx.
for i, ticket := range ticketsToPull {
ntfns[i], revocationErrors[i] = s.generateRevocation(ns, waddrmgrNs,
blockHash, blockHeight, ticket, feePerKb, allowHighFees)
}
errStr := ""
for i, err := range revocationErrors {
if err != nil {
errStr += fmt.Sprintf("Error encountered attempting to create "+
"revocation using ticket %v: ", ticketsToPull[i])
errStr += err.Error()
errStr += "\n"
}
}
if errStr != "" {
return nil, fmt.Errorf("%v", errStr)
}
return ntfns, nil
}
// updateStakePoolUserTickets updates a stake pool ticket for a given user.
// If the ticket does not currently exist in the database, it adds it. If it
// does exist (the ticket hash exists), it replaces the old record.
func (s *StakeStore) updateStakePoolUserTickets(ns walletdb.ReadWriteBucket, waddrmgrNs walletdb.ReadBucket, user dcrutil.Address, ticket *PoolTicket) error {