-
Notifications
You must be signed in to change notification settings - Fork 10
/
server.go
583 lines (481 loc) · 17.2 KB
/
server.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
package metamorph
import (
"context"
"encoding/hex"
"fmt"
"log/slog"
"net"
"net/url"
"os"
"strings"
"sync"
"time"
"github.com/opentracing/opentracing-go"
"github.com/ordishs/go-bitcoin"
"github.com/ordishs/gocore"
"github.com/pkg/errors"
"github.com/spf13/viper"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/reflection"
"google.golang.org/protobuf/types/known/emptypb"
"google.golang.org/protobuf/types/known/timestamppb"
"github.com/bitcoin-sv/arc/blocktx"
"github.com/bitcoin-sv/arc/blocktx/blocktx_api"
"github.com/bitcoin-sv/arc/metamorph/metamorph_api"
"github.com/bitcoin-sv/arc/metamorph/processor_response"
"github.com/bitcoin-sv/arc/metamorph/store"
"github.com/bitcoin-sv/arc/tracing"
grpc_prometheus "github.com/grpc-ecosystem/go-grpc-prometheus"
"github.com/libsv/go-bt/v2"
"github.com/libsv/go-p2p/chaincfg/chainhash"
)
func init() {
gocore.NewStat("PutTransaction", true)
}
const (
responseTimeout = 5 * time.Second
)
type BitcoinNode interface {
GetTxOut(txHex string, vout int, includeMempool bool) (res *bitcoin.TXOut, err error)
}
// Server type carries the zmqLogger within it
type Server struct {
metamorph_api.UnimplementedMetaMorphAPIServer
logger *slog.Logger
processor ProcessorI
store store.MetamorphStore
timeout time.Duration
grpcServer *grpc.Server
btc blocktx.ClientI
source string
bitcoinNode BitcoinNode
forceCheckUtxos bool
}
func WithLogger(logger *slog.Logger) func(*Server) {
return func(p *Server) {
p.logger = logger.With(slog.String("service", "mtm"))
}
}
func WithForceCheckUtxos(bitcoinNode BitcoinNode) func(*Server) {
return func(p *Server) {
p.bitcoinNode = bitcoinNode
p.forceCheckUtxos = true
}
}
type ServerOption func(f *Server)
// NewServer will return a server instance with the zmqLogger stored within it
func NewServer(s store.MetamorphStore, p ProcessorI, btc blocktx.ClientI, source string, opts ...ServerOption) *Server {
server := &Server{
logger: slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{Level: logLevelDefault})).With(slog.String("service", "mtm")),
processor: p,
store: s,
timeout: responseTimeout,
btc: btc,
source: source,
forceCheckUtxos: false,
}
for _, opt := range opts {
opt(server)
}
return server
}
func (s *Server) SetTimeout(timeout time.Duration) {
s.timeout = timeout
}
// StartGRPCServer function
func (s *Server) StartGRPCServer(address string, grpcMessageSize int) error {
// LEVEL 0 - no security / no encryption
var opts []grpc.ServerOption
prometheusEndpoint := viper.GetString("prometheusEndpoint")
if prometheusEndpoint != "" {
opts = append(opts,
grpc.ChainStreamInterceptor(grpc_prometheus.StreamServerInterceptor),
grpc.ChainUnaryInterceptor(grpc_prometheus.UnaryServerInterceptor),
grpc.MaxRecvMsgSize(grpcMessageSize),
)
}
s.grpcServer = grpc.NewServer(tracing.AddGRPCServerOptions(opts)...)
gocore.SetAddress(address)
lis, err := net.Listen("tcp", address)
if err != nil {
return fmt.Errorf("GRPC server failed to listen [%w]", err)
}
metamorph_api.RegisterMetaMorphAPIServer(s.grpcServer, s)
// Register reflection service on gRPC server.
reflection.Register(s.grpcServer)
s.logger.Info("GRPC server listening on", slog.String("address", address))
if err = s.grpcServer.Serve(lis); err != nil {
return fmt.Errorf("metamorph GRPC server failed [%w]", err)
}
return nil
}
func (s *Server) Shutdown() {
s.logger.Info("Shutting down")
s.grpcServer.Stop()
s.processor.Shutdown()
}
func (s *Server) Health(_ context.Context, _ *emptypb.Empty) (*metamorph_api.HealthResponse, error) {
stats := s.processor.GetStats(false)
peersConnected, peersDisconnected := s.processor.GetPeers()
details := fmt.Sprintf(`Peer stats (started: %s)`, stats.StartTime.UTC().Format(time.RFC3339))
return &metamorph_api.HealthResponse{
Ok: true,
Details: details,
Timestamp: timestamppb.New(time.Now()),
Uptime: float32(time.Since(stats.StartTime).Milliseconds()) / 1000.0,
Queued: stats.QueuedCount,
Processed: stats.SentToNetwork.GetCount(),
Waiting: stats.QueueLength,
Average: float32(stats.SentToNetwork.GetAverageDuration().Milliseconds()),
MapSize: stats.ChannelMapSize,
PeersConnected: strings.Join(peersConnected, ","),
PeersDisconnected: strings.Join(peersDisconnected, ","),
}, nil
}
func validateCallbackURL(callbackURL string) error {
if callbackURL == "" {
return nil
}
_, err := url.ParseRequestURI(callbackURL)
if err != nil {
return fmt.Errorf("invalid URL [%w]", err)
}
return nil
}
func (s *Server) PutTransaction(ctx context.Context, req *metamorph_api.TransactionRequest) (*metamorph_api.TransactionStatus, error) {
span, ctx := opentracing.StartSpanFromContext(ctx, "Server:PutTransaction")
defer span.Finish()
start := gocore.CurrentNanos()
defer func() {
gocore.NewStat("PutTransaction").AddTime(start)
}()
err := validateCallbackURL(req.CallbackUrl)
if err != nil {
return nil, err
}
next, status, hash, transactionStatus, err := s.putTransactionInit(ctx, req, start)
if err != nil {
// if we have an error, we will return immediately
return nil, err
}
if transactionStatus != nil {
// if we have a transactionStatus, no need to process it
return transactionStatus, nil
}
// Convert gRPC req to store.StoreData struct...
sReq := &store.StoreData{
Hash: hash,
Status: status,
CallbackUrl: req.CallbackUrl,
CallbackToken: req.CallbackToken,
MerkleProof: req.MerkleProof,
RawTx: req.RawTx,
}
next = gocore.NewStat("PutTransaction").NewStat("2: ProcessTransaction").AddTime(next)
span2, _ := opentracing.StartSpanFromContext(ctx, "Server:PutTransaction:Wait")
defer span2.Finish()
defer func() {
gocore.NewStat("PutTransaction").NewStat("3: Wait for status").AddTime(next)
}()
return s.processTransaction(ctx, req.WaitForStatus, sReq, hash.String(), metamorph_api.Status_RECEIVED), nil
}
func (s *Server) PutTransactions(ctx context.Context, req *metamorph_api.TransactionRequests) (*metamorph_api.TransactionStatuses, error) {
span, ctx := opentracing.StartSpanFromContext(ctx, "Server:PutTransactions")
defer span.Finish()
start := gocore.CurrentNanos()
defer gocore.NewStat("PutTransactions").AddTime(start)
// for each transaction if we have status in the db already set that status in the response
// if not we store the transaction data and set the transaction status in response array to - STORED
type processTxInput struct {
data *store.StoreData
waitForStatus metamorph_api.Status
responseIndex int
}
// prepare response object before filling with tx statuses
resp := &metamorph_api.TransactionStatuses{}
resp.Statuses = make([]*metamorph_api.TransactionStatus, len(req.Transactions))
processTxsInputMap := make(map[chainhash.Hash]processTxInput)
for ind, txReq := range req.Transactions {
err := validateCallbackURL(txReq.CallbackUrl)
if err != nil {
return nil, err
}
_, status, hash, transactionStatus, err := s.putTransactionInit(ctx, txReq, start)
if err != nil {
// if we have an error, we will return immediately
return nil, err
}
if transactionStatus != nil {
// if we have a transactionStatus, no need to process it another time
resp.Statuses[ind] = transactionStatus
continue
}
// Convert gRPC req to store.StoreData struct...
sReq := &store.StoreData{
Hash: hash,
Status: status,
CallbackUrl: txReq.CallbackUrl,
CallbackToken: txReq.CallbackToken,
MerkleProof: txReq.MerkleProof,
RawTx: txReq.RawTx,
}
if err = s.processor.Set(NewProcessorRequest(ctx, sReq, nil)); err != nil {
return nil, err
}
processTxsInputMap[*hash] = processTxInput{
data: sReq,
waitForStatus: txReq.WaitForStatus,
responseIndex: ind,
}
}
// Concurrently process each transaction and wait for the transaction status to return
wg := &sync.WaitGroup{}
for hash, input := range processTxsInputMap {
wg.Add(1)
// TODO check the context when API call ends
go func(ctx context.Context, processTxInput processTxInput, txID string, wg *sync.WaitGroup, resp *metamorph_api.TransactionStatuses) {
defer wg.Done()
statusNew := s.processTransaction(ctx, processTxInput.waitForStatus, processTxInput.data, txID, metamorph_api.Status_STORED)
resp.Statuses[processTxInput.responseIndex] = statusNew
}(ctx, input, hash.String(), wg, resp)
}
wg.Wait()
return resp, nil
}
func (s *Server) processTransaction(ctx context.Context, waitForStatus metamorph_api.Status, data *store.StoreData, TxID string, latestStatus metamorph_api.Status) *metamorph_api.TransactionStatus {
responseChannel := make(chan processor_response.StatusAndError, 1)
defer func() {
close(responseChannel)
}()
// TODO check the context when API call ends
s.processor.ProcessTransaction(NewProcessorRequest(ctx, data, responseChannel))
if waitForStatus < metamorph_api.Status_RECEIVED || waitForStatus > metamorph_api.Status_SEEN_ON_NETWORK {
// wait for seen by default, this is the safest option
waitForStatus = metamorph_api.Status_SEEN_ON_NETWORK
}
// normally a node would respond very quickly, unless it's under heavy load
timeout := time.NewTimer(s.timeout)
for {
select {
case <-timeout.C:
return &metamorph_api.TransactionStatus{
TimedOut: true,
Status: latestStatus,
Txid: TxID,
}
case res := <-responseChannel:
latestStatus = res.Status
if res.Status < latestStatus {
continue
}
if resErr := res.Err; resErr != nil {
return &metamorph_api.TransactionStatus{
Status: latestStatus,
Txid: TxID,
RejectReason: resErr.Error(),
}
}
if latestStatus >= waitForStatus {
return &metamorph_api.TransactionStatus{
Status: latestStatus,
Txid: TxID,
}
}
}
}
}
func (s *Server) putTransactionInit(ctx context.Context, req *metamorph_api.TransactionRequest, start int64) (int64, metamorph_api.Status, *chainhash.Hash, *metamorph_api.TransactionStatus, error) {
initSpan, initCtx := opentracing.StartSpanFromContext(ctx, "Server:PutTransaction:init")
defer initSpan.Finish()
// init next variable to allow conditional functions to run, all accepting next as an argument
next := start
status := metamorph_api.Status_UNKNOWN
hash := chainhash.DoubleHashH(req.RawTx)
initSpan.SetTag("txid", hash.String())
// Register the transaction in blocktx store
rtr, err := s.btc.RegisterTransaction(initCtx, &blocktx_api.TransactionAndSource{
Hash: hash[:],
Source: s.source,
})
if err != nil {
return 0, 0, nil, nil, err
}
if rtr.Source != s.source {
if isForwarded(ctx) {
// This is a forwarded request, so we should not forward it again
s.logger.Warn("Endless forwarding loop detected for", slog.String("hash", hash.String()), slog.String("address", s.source), slog.String("source", rtr.Source))
return 0, 0, nil, nil, fmt.Errorf("endless forwarding loop detected")
}
// This transaction was already registered by another metamorph, and we
// should forward the request to that metamorph
var ownerConn *grpc.ClientConn
if ownerConn, err = dialMetamorph(initCtx, rtr.Source); err != nil {
return 0, 0, nil, nil, err
}
defer ownerConn.Close()
ownerMM := metamorph_api.NewMetaMorphAPIClient(ownerConn)
var transactionStatus *metamorph_api.TransactionStatus
if transactionStatus, err = ownerMM.PutTransaction(createForwardedContext(initCtx), req); err != nil {
return 0, 0, nil, nil, err
}
transactionStatus.MerklePath = rtr.MerklePath
return 0, 0, nil, transactionStatus, nil
}
if rtr.BlockHash != nil {
// If the transaction was mined, we should mark it as such
status = metamorph_api.Status_MINED
blockHash, _ := chainhash.NewHash(rtr.BlockHash)
if err = s.store.UpdateMined(initCtx, &hash, blockHash, rtr.BlockHeight); err != nil {
return 0, 0, nil, nil, err
}
}
// Check if the transaction is already in the store
var transactionStatus *metamorph_api.TransactionStatus
next, transactionStatus = s.checkStore(initCtx, &hash, next)
if transactionStatus != nil {
// just return the status if we found it in the store
transactionStatus.MerklePath = rtr.MerklePath
return 0, 0, nil, transactionStatus, nil
}
if s.forceCheckUtxos {
next, err = s.checkUtxos(initCtx, next, req.RawTx)
s.logger.Error("Error checking utxos", slog.String("err", err.Error()))
if err != nil {
return 0, 0, nil, &metamorph_api.TransactionStatus{
Status: metamorph_api.Status_REJECTED,
Txid: hash.String(),
MerklePath: rtr.MerklePath,
RejectReason: err.Error(),
}, nil
}
}
return next, status, &hash, nil, nil
}
func (s *Server) checkStore(ctx context.Context, hash *chainhash.Hash, next int64) (int64, *metamorph_api.TransactionStatus) {
storeData, err := s.store.Get(ctx, hash[:])
if err != nil && !errors.Is(err, store.ErrNotFound) {
s.logger.Error("Error getting transaction from store", slog.String("err", err.Error()))
}
if storeData != nil {
// we found the transaction in the store, so we can just return it
return 0, &metamorph_api.TransactionStatus{
TimedOut: false,
StoredAt: timestamppb.New(storeData.StoredAt),
AnnouncedAt: timestamppb.New(storeData.AnnouncedAt),
MinedAt: timestamppb.New(storeData.MinedAt),
Txid: fmt.Sprintf("%v", storeData.Hash),
Status: storeData.Status,
RejectReason: storeData.RejectReason,
BlockHeight: storeData.BlockHeight,
BlockHash: fmt.Sprintf("%v", storeData.BlockHash),
}
}
return gocore.NewStat("PutTransaction").NewStat("1: Check store").AddTime(next), nil
}
func (s *Server) checkUtxos(ctx context.Context, next int64, rawTx []byte) (int64, error) {
span, _ := opentracing.StartSpanFromContext(ctx, "Server:PutTransaction:UtxoCheck")
defer span.Finish()
var tx *bt.Tx
tx, err := bt.NewTxFromBytes(rawTx)
if err != nil {
return 0, fmt.Errorf("failed to create bitcoin tx: %v", err)
}
for _, input := range tx.Inputs {
var utxos *bitcoin.TXOut
utxos, err = s.bitcoinNode.GetTxOut(input.PreviousTxIDStr(), int(input.PreviousTxOutIndex), true)
if err != nil {
return 0, fmt.Errorf("failed to get utxo: %v", err)
}
if utxos == nil {
return 0, fmt.Errorf("utxo %s:%d not found", input.PreviousTxIDStr(), input.PreviousTxOutIndex)
}
}
return gocore.NewStat("PutTransaction").NewStat("0: Check utxos").AddTime(next), nil
}
func (s *Server) GetTransaction(ctx context.Context, req *metamorph_api.TransactionStatusRequest) (*metamorph_api.Transaction, error) {
data, announcedAt, minedAt, storedAt, err := s.getTransactionData(ctx, req)
if err != nil {
return nil, err
}
return &metamorph_api.Transaction{
Txid: data.Hash.String(),
AnnouncedAt: announcedAt,
StoredAt: storedAt,
MinedAt: minedAt,
Status: data.Status,
BlockHeight: data.BlockHeight,
BlockHash: data.BlockHash.String(),
RejectReason: data.RejectReason,
RawTx: data.RawTx,
}, nil
}
func (s *Server) GetTransactionStatus(ctx context.Context, req *metamorph_api.TransactionStatusRequest) (*metamorph_api.TransactionStatus, error) {
data, announcedAt, minedAt, storedAt, err := s.getTransactionData(ctx, req)
if err != nil {
return nil, err
}
var blockHash string
if data.BlockHash != nil {
blockHash = data.BlockHash.String()
}
return &metamorph_api.TransactionStatus{
Txid: data.Hash.String(),
AnnouncedAt: announcedAt,
StoredAt: storedAt,
MinedAt: minedAt,
Status: data.Status,
BlockHeight: data.BlockHeight,
BlockHash: blockHash,
RejectReason: data.RejectReason,
}, nil
}
func (s *Server) getTransactionData(ctx context.Context, req *metamorph_api.TransactionStatusRequest) (*store.StoreData, *timestamppb.Timestamp, *timestamppb.Timestamp, *timestamppb.Timestamp, error) {
txBytes, err := hex.DecodeString(req.Txid)
if err != nil {
return nil, nil, nil, nil, err
}
hash := bt.ReverseBytes(txBytes)
var data *store.StoreData
data, err = s.store.Get(ctx, hash)
if err != nil {
return nil, nil, nil, nil, err
}
var announcedAt *timestamppb.Timestamp
if !data.AnnouncedAt.IsZero() {
announcedAt = timestamppb.New(data.AnnouncedAt)
}
var minedAt *timestamppb.Timestamp
if !data.MinedAt.IsZero() {
minedAt = timestamppb.New(data.MinedAt)
}
var storedAt *timestamppb.Timestamp
if !data.StoredAt.IsZero() {
storedAt = timestamppb.New(data.StoredAt)
}
return data, announcedAt, minedAt, storedAt, nil
}
func dialMetamorph(ctx context.Context, address string) (*grpc.ClientConn, error) {
opts := []grpc.DialOption{
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithChainUnaryInterceptor(grpc_prometheus.UnaryClientInterceptor),
grpc.WithChainStreamInterceptor(grpc_prometheus.StreamClientInterceptor),
}
return grpc.DialContext(ctx, address, tracing.AddGRPCDialOptions(opts)...)
}
func createForwardedContext(ctx context.Context) context.Context {
return metadata.NewOutgoingContext(
ctx,
metadata.Pairs("forwarded", "true"),
)
}
func isForwarded(ctx context.Context) bool {
if md, ok := metadata.FromIncomingContext(ctx); ok {
f := md.Get("forwarded")
if len(f) > 0 && f[0] == "true" {
return true
}
}
return false
}