forked from decred/dcrd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rpcserver.go
6030 lines (5324 loc) · 187 KB
/
rpcserver.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) 2013-2016 The btcsuite developers
// Copyright (c) 2015-2024 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.
package rpcserver
import (
"bytes"
"context"
"crypto/hmac"
"crypto/rand"
"crypto/sha256"
"crypto/subtle"
"encoding/base64"
"encoding/binary"
"encoding/hex"
"encoding/json"
"errors"
"fmt"
"hash"
"io"
stdlog "log"
"math"
"math/big"
"net"
"net/http"
"net/url"
"runtime"
"sort"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
"unicode/utf8"
"github.com/gorilla/websocket"
"github.com/jrick/bitset"
"github.com/decred/dcrd/blockchain/stake/v5"
"github.com/decred/dcrd/blockchain/standalone/v2"
"github.com/decred/dcrd/chaincfg/chainhash"
"github.com/decred/dcrd/chaincfg/v3"
"github.com/decred/dcrd/crypto/blake256"
"github.com/decred/dcrd/database/v3"
"github.com/decred/dcrd/dcrec/secp256k1/v4/ecdsa"
"github.com/decred/dcrd/dcrjson/v4"
"github.com/decred/dcrd/dcrutil/v4"
"github.com/decred/dcrd/internal/blockchain"
"github.com/decred/dcrd/internal/mempool"
"github.com/decred/dcrd/internal/mining"
"github.com/decred/dcrd/internal/version"
"github.com/decred/dcrd/rpc/jsonrpc/types/v4"
"github.com/decred/dcrd/txscript/v4"
"github.com/decred/dcrd/txscript/v4/stdaddr"
"github.com/decred/dcrd/txscript/v4/stdscript"
"github.com/decred/dcrd/wire"
)
// API version constants
const (
jsonrpcSemverMajor = 8
jsonrpcSemverMinor = 1
jsonrpcSemverPatch = 0
)
const (
// rpcAuthTimeoutSeconds is the number of seconds a connection to the
// RPC server is allowed to stay open without authenticating before it
// is closed.
rpcAuthTimeoutSeconds = 10
// rpcReadLimitAuthenticated is the maximum number of bytes allowed for a
// JSON-RPC message read from a client.
rpcReadLimitAuthenticated = 1 << 23 // 8 MiB
// uint256Size is the number of bytes needed to represent an unsigned
// 256-bit integer.
uint256Size = 32
// getworkDataLenBlake256 is the length of the data field of the getwork
// RPC when providing work for blake256. It consists of the serialized
// block header plus the internal blake256 padding. The internal blake256
// padding consists of a single 1 bit followed by zeros and a final 1 bit in
// order to pad the message out to 56 bytes followed by length of the
// message in bits encoded as a big-endian uint64 (8 bytes). Thus, the
// resulting length is a multiple of the blake256 block size (64 bytes).
// Given the padding requires at least a 1 bit and 64 bits for the padding,
// the following converts the block header length and hash block size to
// bits in order to ensure the correct number of hash blocks are calculated
// and then multiplies the result by the block hash block size in bytes.
getworkDataLenBlake256 = (1 + ((wire.MaxBlockHeaderPayload*8 + 65) /
(blake256.BlockSize * 8))) * blake256.BlockSize
// blake3BlkSize is the internal block size of the blake3 hashing algorithm.
blake3BlkSize = 64
// getworkDataLenBlake3 is the length of the data field of the getwork RPC
// when providing work for blake3. It consists of the serialized block
// header plus the internal blake3 padding. The internal blake3 padding
// consists of enough zeros to pad the message out to a multiple of the
// blake3 block size (64 bytes).
getworkDataLenBlake3 = ((wire.MaxBlockHeaderPayload + (blake3BlkSize - 1)) /
blake3BlkSize) * blake3BlkSize
// getworkExpirationDiff is the number of blocks below the current
// best block in height to begin pruning out old block work from
// the template pool.
getworkExpirationDiff = 3
// sstxCommitmentString is the string to insert when a verbose
// transaction output's pkscript type is a ticket commitment.
sstxCommitmentString = "sstxcommitment"
// merkleRootPairSize is the size in bytes of the merkle root + stake root
// of a block.
merkleRootPairSize = 64
// syncWait is the maximum time in seconds to wait for an index
// to sync with the main chain.
syncWait = time.Second * 3
)
var (
// jsonrpcSemverString is the RPC server's semantic API version formatted as
// a string.
jsonrpcSemverString = fmt.Sprintf("%d.%d.%d", jsonrpcSemverMajor,
jsonrpcSemverMinor, jsonrpcSemverPatch)
// blake256Pad is the extra blake256 internal padding needed for the
// data of the getwork RPC. It is set in the init routine since it is
// based on the size of the block header and requires a bit of
// calculation.
blake256Pad []byte
// blake3Pad is the extra blake3 internal padding needed for the data of the
// getwork RPC. It consists of all zeros.
blake3Pad = make([]byte, getworkDataLenBlake3-wire.MaxBlockHeaderPayload)
// JSON 2.0 batched request prefix
batchedRequestPrefix = []byte("[")
// zeroHash is the zero value for a chainhash.Hash and is defined as
// a package level variable to avoid the need to create a new instance
// every time a check is needed.
zeroHash chainhash.Hash
)
// Errors
var (
// ErrRPCUnimplemented is an error returned to RPC clients when the
// provided command is recognized, but not implemented.
ErrRPCUnimplemented = &dcrjson.RPCError{
Code: dcrjson.ErrRPCUnimplemented,
Message: "Command unimplemented",
}
// ErrRPCNoWallet is an error returned to RPC clients when the provided
// command is recognized as a wallet command.
ErrRPCNoWallet = &dcrjson.RPCError{
Code: dcrjson.ErrRPCNoWallet,
Message: "This implementation does not implement wallet commands",
}
)
type commandHandler func(context.Context, *Server, interface{}) (interface{}, error)
// rpcHandlers maps RPC command strings to appropriate handler functions.
// This is set by init because help references rpcHandlers and thus causes
// a dependency loop.
var rpcHandlers map[types.Method]commandHandler
var rpcHandlersBeforeInit = map[types.Method]commandHandler{
"addnode": handleAddNode,
"createrawsstx": handleCreateRawSStx,
"createrawssrtx": handleCreateRawSSRtx,
"createrawtransaction": handleCreateRawTransaction,
"debuglevel": handleDebugLevel,
"decoderawtransaction": handleDecodeRawTransaction,
"decodescript": handleDecodeScript,
"estimatefee": handleEstimateFee,
"estimatesmartfee": handleEstimateSmartFee,
"estimatestakediff": handleEstimateStakeDiff,
"existsaddress": handleExistsAddress,
"existsaddresses": handleExistsAddresses,
"existsliveticket": handleExistsLiveTicket,
"existslivetickets": handleExistsLiveTickets,
"existsmempooltxs": handleExistsMempoolTxs,
"generate": handleGenerate,
"getaddednodeinfo": handleGetAddedNodeInfo,
"getbestblock": handleGetBestBlock,
"getbestblockhash": handleGetBestBlockHash,
"getblock": handleGetBlock,
"getblockchaininfo": handleGetBlockchainInfo,
"getblockcount": handleGetBlockCount,
"getblockhash": handleGetBlockHash,
"getblockheader": handleGetBlockHeader,
"getblocksubsidy": handleGetBlockSubsidy,
"getcfilterv2": handleGetCFilterV2,
"getchaintips": handleGetChainTips,
"getcoinsupply": handleGetCoinSupply,
"getconnectioncount": handleGetConnectionCount,
"getcurrentnet": handleGetCurrentNet,
"getdifficulty": handleGetDifficulty,
"getgenerate": handleGetGenerate,
"gethashespersec": handleGetHashesPerSec,
"getheaders": handleGetHeaders,
"getinfo": handleGetInfo,
"getmempoolinfo": handleGetMempoolInfo,
"getmininginfo": handleGetMiningInfo,
"getnettotals": handleGetNetTotals,
"getnetworkhashps": handleGetNetworkHashPS,
"getnetworkinfo": handleGetNetworkInfo,
"getpeerinfo": handleGetPeerInfo,
"getrawmempool": handleGetRawMempool,
"getrawtransaction": handleGetRawTransaction,
"getstakedifficulty": handleGetStakeDifficulty,
"getstakeversioninfo": handleGetStakeVersionInfo,
"getstakeversions": handleGetStakeVersions,
"getticketpoolvalue": handleGetTicketPoolValue,
"gettreasurybalance": handleGetTreasuryBalance,
"gettreasuryspendvotes": handleGetTreasurySpendVotes,
"getvoteinfo": handleGetVoteInfo,
"gettxout": handleGetTxOut,
"gettxoutsetinfo": handleGetTxOutSetInfo,
"getwork": handleGetWork,
"help": handleHelp,
"invalidateblock": handleInvalidateBlock,
"livetickets": handleLiveTickets,
"node": handleNode,
"ping": handlePing,
"reconsiderblock": handleReconsiderBlock,
"regentemplate": handleRegenTemplate,
"sendrawtransaction": handleSendRawTransaction,
"setgenerate": handleSetGenerate,
"stop": handleStop,
"submitblock": handleSubmitBlock,
"ticketfeeinfo": handleTicketFeeInfo,
"ticketsforaddress": handleTicketsForAddress,
"ticketvwap": handleTicketVWAP,
"txfeeinfo": handleTxFeeInfo,
"validateaddress": handleValidateAddress,
"verifychain": handleVerifyChain,
"verifymessage": handleVerifyMessage,
"version": handleVersion,
}
// list of commands that we recognize, but for which dcrd has no support because
// it lacks support for wallet functionality. For these commands the user
// should ask a connected instance of dcrwallet.
var rpcAskWallet = map[string]struct{}{
"abandontransaction": {},
"accountaddressindex": {},
"accountsyncaddressindex": {},
"addmultisigaddress": {},
"addtransaction": {},
"addticket": {},
"auditreuse": {},
"consolidate": {},
"createmultisig": {},
"createnewaccount": {},
"createsignature": {},
"createvotingaccount": {},
"discoverusage": {},
"dumpprivkey": {},
"fundrawtransaction": {},
"generatevote": {},
"getaccount": {},
"getaccountaddress": {},
"getaddressesbyaccount": {},
"getbalance": {},
"getcoinjoinsbyacct": {},
"getmasterpubkey": {},
"getmultisigoutinfo": {},
"getnewaddress": {},
"getrawchangeaddress": {},
"getreceivedbyaccount": {},
"getreceivedbyaddress": {},
"getstakeinfo": {},
"gettickets": {},
"gettransaction": {},
"getunconfirmedbalance": {},
"getvotechoices": {},
"getwalletfee": {},
"importcfiltersv2": {},
"importprivkey": {},
"importscript": {},
"importxpub": {},
"listaccounts": {},
"listaddresstransactions": {},
"listalltransactions": {},
"listlockunspent": {},
"listreceivedbyaccount": {},
"listreceivedbyaddress": {},
"listsinceblock": {},
"listtransactions": {},
"listunspent": {},
"lockunspent": {},
"mixoutput": {},
"purchaseticket": {},
"redeemmultisigout": {},
"redeemmultisigouts": {},
"renameaccount": {},
"rescanwallet": {},
"revoketickets": {},
"sendfrom": {},
"sendfromtreasury": {},
"sendmany": {},
"sendtoaddress": {},
"sendtomultisig": {},
"sendtotreasury": {},
"setticketfee": {},
"settxfee": {},
"setvotechoice": {},
"signmessage": {},
"signrawtransaction": {},
"signrawtransactions": {},
"stakepooluserinfo": {},
"sweepaccount": {},
"ticketinfo": {},
"ticketsforaddress": {},
"validatepredcp0005cf": {},
"verifymessage": {},
"walletinfo": {},
"walletislocked": {},
"walletlock": {},
"walletpassphrase": {},
"walletpassphrasechange": {},
"walletpubpassphrasechange": {},
}
// Commands that are currently unimplemented, but should ultimately be.
var rpcUnimplemented = map[string]struct{}{
"estimatepriority": {},
}
// Commands that are available to a limited user
var rpcLimited = map[string]struct{}{
// Websockets commands
"notifyblocks": {},
"notifynewtransactions": {},
"rescan": {},
"session": {},
"rebroadcastwinners": {},
// Websockets AND HTTP/S commands
"help": {},
// HTTP/S-only commands
"createrawsstx": {},
"createrawssrtx": {},
"createrawtransaction": {},
"decoderawtransaction": {},
"decodescript": {},
"estimatefee": {},
"estimatesmartfee": {},
"estimatestakediff": {},
"existsaddress": {},
"existsaddresses": {},
"existsliveticket": {},
"existslivetickets": {},
"existsmempooltxs": {},
"getbestblock": {},
"getbestblockhash": {},
"getblock": {},
"getblockchaininfo": {},
"getblockcount": {},
"getblockhash": {},
"getblockheader": {},
"getblocksubsidy": {},
"getcfilterv2": {},
"getchaintips": {},
"getcoinsupply": {},
"getcurrentnet": {},
"getdifficulty": {},
"getheaders": {},
"getinfo": {},
"getnettotals": {},
"getnetworkhashps": {},
"getnetworkinfo": {},
"getrawmempool": {},
"getstakedifficulty": {},
"getstakeversioninfo": {},
"getstakeversions": {},
"getrawtransaction": {},
"gettreasurybalance": {},
"gettxout": {},
"getvoteinfo": {},
"livetickets": {},
"regentemplate": {},
"sendrawtransaction": {},
"submitblock": {},
"ticketfeeinfo": {},
"ticketsforaddress": {},
"ticketvwap": {},
"txfeeinfo": {},
"validateaddress": {},
"verifymessage": {},
"version": {},
}
// rpcInternalErr is a convenience function to convert an internal error to an
// RPC error with the appropriate code set. It also logs the error to the RPC
// server subsystem since internal errors really should not occur. The context
// parameter is only used in the log message and may be empty if it's not
// needed.
func rpcInternalErr(err error, context string) *dcrjson.RPCError {
errStr := err.Error()
logStr := errStr
if context != "" {
logStr = context + ": " + errStr
}
log.Error(logStr)
return dcrjson.NewRPCError(dcrjson.ErrRPCInternal.Code, errStr)
}
// rpcInvalidError is a convenience function to convert an invalid parameter
// error to an RPC error with the appropriate code set.
func rpcInvalidError(fmtStr string, args ...interface{}) *dcrjson.RPCError {
return dcrjson.NewRPCError(dcrjson.ErrRPCInvalidParameter,
fmt.Sprintf(fmtStr, args...))
}
// rpcDeserializetionError is a convenience function to convert a
// deserialization error to an RPC error with the appropriate code set.
func rpcDeserializationError(fmtStr string, args ...interface{}) *dcrjson.RPCError {
return dcrjson.NewRPCError(dcrjson.ErrRPCDeserialization,
fmt.Sprintf(fmtStr, args...))
}
// rpcRuleError is a convenience function to convert a
// rule error to an RPC error with the appropriate code set.
func rpcRuleError(fmtStr string, args ...interface{}) *dcrjson.RPCError {
return dcrjson.NewRPCError(dcrjson.ErrRPCMisc,
fmt.Sprintf(fmtStr, args...))
}
// rpcDuplicateTxError is a convenience function to convert a
// rejected duplicate tx error to an RPC error with the appropriate code set.
func rpcDuplicateTxError(fmtStr string, args ...interface{}) *dcrjson.RPCError {
return dcrjson.NewRPCError(dcrjson.ErrRPCDuplicateTx,
fmt.Sprintf(fmtStr, args...))
}
// rpcAddressKeyError is a convenience function to convert an address/key error to
// an RPC error with the appropriate code set. It also logs the error to the
// RPC server subsystem since internal errors really should not occur. The
// context parameter is only used in the log message and may be empty if it's
// not needed.
func rpcAddressKeyError(fmtStr string, args ...interface{}) *dcrjson.RPCError {
return dcrjson.NewRPCError(dcrjson.ErrRPCInvalidAddressOrKey,
fmt.Sprintf(fmtStr, args...))
}
// rpcDecodeHexError is a convenience function for returning a nicely formatted
// RPC error which indicates the provided hex string failed to decode.
func rpcDecodeHexError(gotHex string) *dcrjson.RPCError {
return dcrjson.NewRPCError(dcrjson.ErrRPCDecodeHexString,
fmt.Sprintf("Argument must be hexadecimal string (not %q)",
gotHex))
}
// rpcNoTxInfoError is a convenience function for returning a nicely formatted
// RPC error which indicates there is no information available for the provided
// transaction hash.
func rpcNoTxInfoError(txHash *chainhash.Hash) *dcrjson.RPCError {
return dcrjson.NewRPCError(dcrjson.ErrRPCNoTxInfo,
fmt.Sprintf("No information available about transaction %v",
txHash))
}
// rpcBlockNotFoundError is a convenience function for returning a nicely
// formatted RPC error which indicates that the provided block was not found in
// the blockchain.
func rpcBlockNotFoundError(blockHash chainhash.Hash) *dcrjson.RPCError {
return dcrjson.NewRPCError(dcrjson.ErrRPCBlockNotFound,
fmt.Sprintf("No information available about block %v",
blockHash))
}
// rpcConnectionClosedError is a convenience function for returning an RPC error
// which indicates the associated connection has been closed, most likely due to
// context cancellation such as when the server is being shutdown.
func rpcConnectionClosedError() *dcrjson.RPCError {
return dcrjson.NewRPCError(dcrjson.ErrRPCMisc, "Connection closed")
}
// rpcMiscError is a convenience function for returning a nicely formatted RPC
// error which indicates there is an unquantifiable error. Use this sparingly;
// misc return codes are a cop out.
func rpcMiscError(message string) *dcrjson.RPCError {
return dcrjson.NewRPCError(dcrjson.ErrRPCMisc, message)
}
// directionString is a helper function that returns a string that represents
// the direction of a connection (inbound or outbound).
func directionString(inbound bool) string {
if inbound {
return "inbound"
}
return "outbound"
}
// normalizeAddress returns addr with the passed default port appended if
// there is not already a port specified.
//
// If the host portion of the address is an interface name, the first IP address
// associated with the interface is used. Otherwise, the name is interpreted as
// a hostname.
func normalizeAddress(addr, defaultPort string) string {
port := defaultPort
if a, p, err := net.SplitHostPort(addr); err == nil {
addr = a
port = p
}
iface, _ := net.InterfaceByName(addr)
if iface == nil {
return net.JoinHostPort(addr, port)
}
ifaceAddrs, err := iface.Addrs()
if err != nil {
return net.JoinHostPort(addr, port)
}
for _, a := range ifaceAddrs {
switch a := a.(type) {
case *net.IPNet:
dialAddr := a.IP.String()
if a.IP.To4() == nil { // IPv6
zoned := a.IP.IsLinkLocalUnicast() ||
a.IP.IsLinkLocalMulticast()
if zoned {
dialAddr += "%" + addr
}
}
return net.JoinHostPort(dialAddr, port)
}
}
return net.JoinHostPort(addr, port)
}
// workState houses state that is used in between multiple RPC invocations to
// getwork.
type workState struct {
// workSem is a semaphore used to limit multiple RPC invocations for work
// requests and submission. This approach is used over a mutex to support
// early cancellation.
workSem semaphore
// These fields are all protected by the embedded mutex.
//
// prevBestHash houses the previous best known chain tip.
//
// waitForUpdatedTemplate determines whether or not a getwork invocation
// should block until a new template is received from the background
// template generator.
//
// templatePool houses unique block templates that have been returned to
// clients so the full block can be reconstructed from it upon successful
// submission of solved work. The templates are pruned when the get old
// enough.
sync.Mutex
prevBestHash *chainhash.Hash
waitForUpdatedTemplate bool
templatePool map[[merkleRootPairSize]byte]*wire.MsgBlock
}
// newWorkState returns a new instance of a workState with all internal fields
// initialized and ready to use.
func newWorkState() *workState {
return &workState{
workSem: makeSemaphore(1),
templatePool: make(map[[merkleRootPairSize]byte]*wire.MsgBlock),
}
}
// handleAddNode handles addnode commands.
func handleAddNode(_ context.Context, s *Server, cmd interface{}) (interface{}, error) {
c := cmd.(*types.AddNodeCmd)
addr := normalizeAddress(c.Addr, s.cfg.ChainParams.DefaultPort)
connMgr := s.cfg.ConnMgr
var err error
switch c.SubCmd {
case "add":
err = connMgr.Connect(addr, true)
case "remove":
err = connMgr.RemoveByAddr(addr)
case "onetry":
err = connMgr.Connect(addr, false)
default:
return nil, rpcInvalidError("Invalid subcommand for addnode")
}
if err != nil {
return nil, rpcInvalidError("%v: %v", c.SubCmd, err)
}
// no data returned unless an error.
return nil, nil
}
// handleNode handles node commands.
func handleNode(_ context.Context, s *Server, cmd interface{}) (interface{}, error) {
c := cmd.(*types.NodeCmd)
connMgr := s.cfg.ConnMgr
var addr string
var nodeID uint64
var errN, err error
params := s.cfg.ChainParams
switch c.SubCmd {
case "disconnect":
// If we have a valid uint disconnect by node id. Otherwise,
// attempt to disconnect by address, returning an error if a
// valid IP address is not supplied.
if nodeID, errN = strconv.ParseUint(c.Target, 10, 32); errN == nil {
err = connMgr.DisconnectByID(int32(nodeID))
} else {
if _, _, errP := net.SplitHostPort(c.Target); errP == nil ||
net.ParseIP(c.Target) != nil {
addr = normalizeAddress(c.Target, params.DefaultPort)
err = connMgr.DisconnectByAddr(addr)
} else {
return nil, rpcInvalidError("%v: Invalid "+
"address or node ID", c.SubCmd)
}
}
if err != nil && peerExists(connMgr, addr, int32(nodeID)) {
return nil, rpcMiscError("can't disconnect a permanent peer, " +
"use remove")
}
case "remove":
// If we have a valid uint disconnect by node id. Otherwise,
// attempt to disconnect by address, returning an error if a
// valid IP address is not supplied.
if nodeID, errN = strconv.ParseUint(c.Target, 10, 32); errN == nil {
err = connMgr.RemoveByID(int32(nodeID))
} else {
if _, _, errP := net.SplitHostPort(c.Target); errP == nil ||
net.ParseIP(c.Target) != nil {
addr = normalizeAddress(c.Target, params.DefaultPort)
err = connMgr.RemoveByAddr(addr)
} else {
return nil, rpcInvalidError("%v: invalid "+
"address or node ID", c.SubCmd)
}
}
if err != nil && peerExists(connMgr, addr, int32(nodeID)) {
return nil, rpcMiscError("can't remove a temporary peer, " +
"use disconnect")
}
case "connect":
addr = normalizeAddress(c.Target, params.DefaultPort)
// Default to temporary connections.
subCmd := "temp"
if c.ConnectSubCmd != nil {
subCmd = *c.ConnectSubCmd
}
switch subCmd {
case "perm", "temp":
err = connMgr.Connect(addr, subCmd == "perm")
default:
return nil, rpcInvalidError("%v: invalid subcommand "+
"for node connect", subCmd)
}
default:
return nil, rpcInvalidError("%v: invalid subcommand for node", c.SubCmd)
}
if err != nil {
return nil, rpcInvalidError("%v: %v", c.SubCmd, err)
}
// no data returned unless an error.
return nil, nil
}
// peerExists determines if a certain peer is currently connected given
// information about all currently connected peers. Peer existence is
// determined using either a target address or node id.
func peerExists(connMgr ConnManager, addr string, nodeID int32) bool {
for _, p := range connMgr.ConnectedPeers() {
if p.ID() == nodeID || p.Addr() == addr {
return true
}
}
return false
}
// messageToHex serializes a message to the wire protocol encoding using the
// latest protocol version and returns a hex-encoded string of the result.
func (s *Server) messageToHex(msg wire.Message) (string, error) {
var buf bytes.Buffer
if err := msg.BtcEncode(&buf, s.cfg.MaxProtocolVersion); err != nil {
context := fmt.Sprintf("Failed to encode msg of type %T", msg)
return "", rpcInternalErr(err, context)
}
return hex.EncodeToString(buf.Bytes()), nil
}
// newTxOut returns a new transaction output with the given parameters.
func newTxOut(amount int64, pkScriptVer uint16, pkScript []byte) *wire.TxOut {
return &wire.TxOut{
Value: amount,
Version: pkScriptVer,
PkScript: pkScript,
}
}
// handleCreateRawTransaction handles createrawtransaction commands.
func handleCreateRawTransaction(_ context.Context, s *Server, cmd interface{}) (interface{}, error) {
c := cmd.(*types.CreateRawTransactionCmd)
// Validate expiry, if given.
if c.Expiry != nil && *c.Expiry < 0 {
return nil, rpcInvalidError("Expiry out of range")
}
// Validate the locktime, if given.
if c.LockTime != nil &&
(*c.LockTime < 0 ||
*c.LockTime > int64(wire.MaxTxInSequenceNum)) {
return nil, rpcInvalidError("Locktime out of range")
}
// Add all transaction inputs to a new transaction after performing
// some validity checks.
mtx := wire.NewMsgTx()
for _, input := range c.Inputs {
txHash, err := chainhash.NewHashFromStr(input.Txid)
if err != nil {
return nil, rpcDecodeHexError(input.Txid)
}
if !(input.Tree == wire.TxTreeRegular ||
input.Tree == wire.TxTreeStake) {
return nil, rpcInvalidError("Tx tree must be regular " +
"or stake")
}
prevOutV := wire.NullValueIn
if input.Amount > 0 {
amt, err := dcrutil.NewAmount(input.Amount)
if err != nil {
return nil, rpcInvalidError(err.Error())
}
prevOutV = int64(amt)
}
prevOut := wire.NewOutPoint(txHash, input.Vout, input.Tree)
txIn := wire.NewTxIn(prevOut, prevOutV, []byte{})
if c.LockTime != nil && *c.LockTime != 0 {
txIn.Sequence = wire.MaxTxInSequenceNum - 1
}
mtx.AddTxIn(txIn)
}
// Add all transaction outputs to the transaction after performing
// some validity checks.
for encodedAddr, amount := range c.Amounts {
atoms, err := dcrutil.NewAmount(amount)
if err != nil {
return nil, rpcInternalErr(err, "New amount")
}
// Ensure amount is in the valid range for monetary amounts.
if atoms <= 0 || atoms > dcrutil.MaxAmount {
return nil, rpcInvalidError("Invalid amount: 0 >= %v "+
"> %v", amount, dcrutil.MaxAmount)
}
// Decode the provided address. This also ensures the network encoded
// with the address matches the network the server is currently on.
addr, err := stdaddr.DecodeAddress(encodedAddr, s.cfg.ChainParams)
if err != nil {
return nil, rpcAddressKeyError("Could not decode address: %v", err)
}
// Ensure the address is one of the supported types.
if _, ok := addr.(stdaddr.StakeAddress); !ok {
return nil, rpcAddressKeyError("Invalid type: %T", addr)
}
// Create a new script which pays to the provided address.
pkScriptVer, pkScript := addr.PaymentScript()
mtx.AddTxOut(newTxOut(int64(atoms), pkScriptVer, pkScript))
}
// Set the Locktime, if given.
if c.LockTime != nil {
mtx.LockTime = uint32(*c.LockTime)
}
// Set the Expiry, if given.
if c.Expiry != nil {
mtx.Expiry = uint32(*c.Expiry)
}
// Return the serialized and hex-encoded transaction. Note that this
// is intentionally not directly returning because the first return
// value is a string and it would result in returning an empty string to
// the client instead of nothing (nil) in the case of an error.
mtxHex, err := s.messageToHex(mtx)
if err != nil {
return nil, err
}
return mtxHex, nil
}
// handleCreateRawSStx handles createrawsstx commands.
func handleCreateRawSStx(_ context.Context, s *Server, cmd interface{}) (interface{}, error) {
c := cmd.(*types.CreateRawSStxCmd)
// Basic sanity checks for the information coming from the cmd.
if len(c.Inputs) != len(c.COuts) {
return nil, rpcInvalidError("Number of inputs should be equal "+
"to the number of future commitment/change outs for "+
"any sstx; %v inputs given, but %v COuts",
len(c.Inputs), len(c.COuts))
}
if len(c.Amount) != 1 {
return nil, rpcInvalidError("Only one SSGen tagged output is "+
"allowed per sstx; len ssgenout %v", len(c.Amount))
}
// Add all transaction inputs to a new transaction after performing
// some validity checks.
mtx := wire.NewMsgTx()
for _, input := range c.Inputs {
txHash, err := chainhash.NewHashFromStr(input.Txid)
if err != nil {
return nil, rpcDecodeHexError(input.Txid)
}
if !(input.Tree == wire.TxTreeRegular ||
input.Tree == wire.TxTreeStake) {
return nil, rpcInvalidError("Tx tree must be regular or stake")
}
prevOut := wire.NewOutPoint(txHash, input.Vout, input.Tree)
txIn := wire.NewTxIn(prevOut, input.Amt, nil)
mtx.AddTxIn(txIn)
}
// Add all transaction outputs to the transaction after performing
// some validity checks.
amtTicket := int64(0)
for encodedAddr, amount := range c.Amount {
// Ensure amount is in the valid range for monetary amounts.
if amount <= 0 || amount > dcrutil.MaxAmount {
return nil, rpcInvalidError("Invalid SSTx commitment "+
"amount: 0 >= %v > %v", amount,
dcrutil.MaxAmount)
}
// Decode the provided address. This also ensures the network encoded
// with the address matches the network the server is currently on.
addr, err := stdaddr.DecodeAddress(encodedAddr, s.cfg.ChainParams)
if err != nil {
return nil, rpcAddressKeyError("Could not decode address: %v", err)
}
// Ensure the address is one of the supported types.
stakeAddr, ok := addr.(stdaddr.StakeAddress)
if !ok {
return nil, rpcAddressKeyError("Invalid address type: %T", addr)
}
// Create the necessary voting rights script.
pkScriptVer, pkScript := stakeAddr.VotingRightsScript()
mtx.AddTxOut(newTxOut(amount, pkScriptVer, pkScript))
amtTicket += amount
}
// Calculated the commitment amounts, then create the
// addresses and payout proportions as null data
// outputs.
inputAmts := make([]int64, len(c.Inputs))
for i, input := range c.Inputs {
inputAmts[i] = input.Amt
}
changeAmts := make([]int64, len(c.COuts))
for i, cout := range c.COuts {
changeAmts[i] = cout.ChangeAmt
}
// Check and make sure none of the change overflows
// the input amounts.
for i, amt := range inputAmts {
if changeAmts[i] >= amt {
return nil, rpcInvalidError("input %v >= amount %v",
changeAmts[i], amt)
}
}
// Obtain the commitment amounts.
_, amountsCommitted, err := stake.SStxNullOutputAmounts(inputAmts,
changeAmts, amtTicket)
if err != nil {
return nil, rpcInternalErr(err, "Invalid SSTx output amounts")
}
for i, cout := range c.COuts {
// Append future commitment output. This also ensures the network
// encoded with the address matches the network the server is currently
// on.
addr, err := stdaddr.DecodeAddress(cout.Addr, s.cfg.ChainParams)
if err != nil {
return nil, rpcAddressKeyError("Could not decode address: %v", err)
}
// Ensure the address is one of the supported types.
stakeAddr, ok := addr.(stdaddr.StakeAddress)
if !ok {
return nil, rpcAddressKeyError("Invalid type: %T", addr)
}
// Create the reward commitment script.
//
// TODO: Allow fee limits to be specified with an argument.
const voteFeeLimit = 0
const revokeFeeLimit = 0
cmtScriptVer, cmtScript := stakeAddr.RewardCommitmentScript(
amountsCommitted[i], voteFeeLimit, revokeFeeLimit)
mtx.AddTxOut(newTxOut(0, cmtScriptVer, cmtScript))
// 2. Append change output.
// Ensure amount is in the valid range for monetary amounts.
if cout.ChangeAmt < 0 || cout.ChangeAmt > dcrutil.MaxAmount {
return nil, rpcInvalidError("Invalid change amount: 0 "+
"> %v > %v", cout.ChangeAmt, dcrutil.MaxAmount)
}
// Decode the provided address. This also ensures the network encoded
// with the address matches the network the server is currently on.
addr, err = stdaddr.DecodeAddress(cout.ChangeAddr, s.cfg.ChainParams)
if err != nil {
return nil, rpcAddressKeyError("Wrong network: %v",
addr)
}
// Ensure the address is one of the supported types.
stakeAddr, ok = addr.(stdaddr.StakeAddress)
if !ok {
return nil, rpcAddressKeyError("Invalid type: %T", addr)
}
// Create a new script which pays change to the provided address.
changeScriptVer, changeScript := stakeAddr.StakeChangeScript()
mtx.AddTxOut(newTxOut(cout.ChangeAmt, changeScriptVer, changeScript))
}
// Make sure we generated a valid SStx.
if err := stake.CheckSStx(mtx); err != nil {
return nil, rpcInternalErr(err, "Invalid SStx")
}
// Return the serialized and hex-encoded transaction.
mtxHex, err := s.messageToHex(mtx)
if err != nil {
return nil, err
}
return mtxHex, nil
}
// handleCreateRawSSRtx handles createrawssrtx commands.
func handleCreateRawSSRtx(_ context.Context, s *Server, cmd interface{}) (interface{}, error) {
c := cmd.(*types.CreateRawSSRtxCmd)
// Only a single SStx should be given
if len(c.Inputs) != 1 {
return nil, rpcInvalidError("SSRtx invalid number of inputs")
}
// The input must be in the stake tree.
input := c.Inputs[0]
if input.Tree != wire.TxTreeStake {
return nil, rpcInvalidError("Input tree is not TxTreeStake type")
}
// The input must be a ticket submission output.
const ticketSubmissionOutput = 0
if input.Vout != ticketSubmissionOutput {
return nil, rpcInvalidError("Input is not a ticket submission output " +
"(output index 0)")
}
// 1. Fetch the SStx, then calculate all the values we'll need later
// for the generation of the SSRtx tx outputs.
//