-
Notifications
You must be signed in to change notification settings - Fork 27
/
client.go
501 lines (417 loc) · 16.7 KB
/
client.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
package sdk
import (
"context"
"google.golang.org/grpc/codes"
"github.com/go-playground/validator/v10"
"go.uber.org/fx"
"go.uber.org/zap"
"golang.org/x/xerrors"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/proto"
"github.com/coinbase/chainstorage/internal/blockchain/parser"
"github.com/coinbase/chainstorage/internal/config"
"github.com/coinbase/chainstorage/internal/gateway"
"github.com/coinbase/chainstorage/internal/storage/blobstorage/downloader"
"github.com/coinbase/chainstorage/internal/utils/log"
"github.com/coinbase/chainstorage/internal/utils/retry"
"github.com/coinbase/chainstorage/internal/utils/syncgroup"
api "github.com/coinbase/chainstorage/protos/coinbase/chainstorage"
)
type (
Client interface {
// GetTag returns the current tag used by the client.
// It is zero by default and ChainStorage returns the latest and greatest version of the block.
GetTag() uint32
// SetTag sets the current tag which effectively pins the version to the specified tag.
SetTag(tag uint32)
// GetClientID returns the clientID which could be empty.
GetClientID() string
// SetClientID sets the clientID when initiate client.
SetClientID(clientID string)
// SetBlockValidation sets the blockValidation which by default is disabled.
SetBlockValidation(blockValidation bool)
// GetBlockValidation returns the blockValidation.
GetBlockValidation() bool
// GetLatestBlock returns the latest block height.
// Deprecated: use GetLatestBlockWithTag instead.
GetLatestBlock(ctx context.Context) (uint64, error)
// GetLatestBlockWithTag returns the latest block height, tag is optional.
// If tag is not provided, ChainStorage uses the stable tag to look up the latest height.
GetLatestBlockWithTag(ctx context.Context, tag uint32) (uint64, error)
// GetBlock returns the raw block. height is required and hash is optional.
// If hash is not provided, ChainStorage returns the block on the canonical chain.
// Deprecated: use GetBlockWithTag instead.
GetBlock(ctx context.Context, height uint64, hash string) (*api.Block, error)
// GetBlockWithTag returns the raw block. height is required, while tag and hash are optional.
// If tag is not provided, ChainStorage uses the stable tag to look up the block.
// If hash is not provided, ChainStorage returns the block on the canonical chain.
// Note that while processing a BlockchainEvent, tag/height/hash must be provided,
// because it is associated with a past event.
GetBlockWithTag(ctx context.Context, tag uint32, height uint64, hash string) (*api.Block, error)
// GetBlocksByRange returns the raw blocks between [startHeight, endHeight).
// endHeight is optional and defaults to startHeight + 1.
GetBlocksByRange(ctx context.Context, startHeight uint64, endHeight uint64) ([]*api.Block, error)
// GetBlocksByRangeWithTag returns the raw blocks between [startHeight, endHeight).
// endHeight is optional and defaults to startHeight + 1.
// tag is optional and defaults to stable tag.
// Note: GetBlocksByRangeWithTag is not equivalent to the batch version of GetBlockWithTag since there is no way to specify the block hash,
// and thus you may get back FailedPrecondition errors if it goes beyond current tip due to reorg, especially for streaming case.
GetBlocksByRangeWithTag(ctx context.Context, tag uint32, startHeight uint64, endHeight uint64) ([]*api.Block, error)
// GetBlockByTransaction returns the raw block(s) where the transaction resides,
// or an empty list if the transaction is not found.
// In most networks a transaction belongs to a single block, but there are exceptions.
// Note that this API is still experimental and may change at any time.
GetBlockByTransaction(ctx context.Context, tag uint32, transactionHash string) ([]*api.Block, error)
// StreamChainEvents streams raw blocks from ChainStorage.
// The caller is responsible for keeping track of the sequence or sequence_num in BlockchainEvent.
StreamChainEvents(ctx context.Context, cfg StreamingConfiguration) (<-chan *ChainEventResult, error)
// GetChainEvents returns at most req.MaxNumEvents available chain events.
// Returned size is not guaranteed. If no enough chain events, it will return as many as possible.
// Either req.StartEventId or req.InitialPositionInStream should be provided.
GetChainEvents(ctx context.Context, req *api.GetChainEventsRequest) ([]*api.BlockchainEvent, error)
// GetChainMetadata returns chain metadata, e.g. LatestEventTag.
GetChainMetadata(ctx context.Context, req *api.GetChainMetadataRequest) (*api.GetChainMetadataResponse, error)
// GetStaticChainMetadata returns the static chain metadata, getting from the Config, instead of querying the ChainStorage server.
// This is useful if the caller needs a consistent snapshot of chain metadata during its current lifecycle.
GetStaticChainMetadata(ctx context.Context, req *api.GetChainMetadataRequest) (*api.GetChainMetadataResponse, error)
}
ChainEventResult struct {
BlockchainEvent *api.BlockchainEvent
Block *api.Block
Error error
}
clientImpl struct {
logger *zap.Logger
config *config.Config
blockDownloader downloader.BlockDownloader
client gateway.Client
parser Parser
clientID string
tag uint32
blockValidation bool
retry retry.Retry
validate *validator.Validate
}
clientParams struct {
fx.In
Logger *zap.Logger
Config *config.Config
BlockDownloader downloader.BlockDownloader
Client gateway.Client
Parser parser.Parser
}
)
func newClient(params clientParams) (Client, error) {
logger := log.WithPackage(params.Logger)
var client Client = &clientImpl{
logger: logger,
config: params.Config,
blockDownloader: params.BlockDownloader,
client: params.Client,
parser: params.Parser,
tag: 0, // by default, let the server decide the tag.
retry: retry.New(),
validate: validator.New(),
}
client = WithTimeoutableClientInterceptor(client, logger)
return client, nil
}
func (c *clientImpl) GetTag() uint32 {
return c.tag
}
func (c *clientImpl) SetTag(tag uint32) {
c.tag = tag
}
func (c *clientImpl) GetClientID() string {
return c.clientID
}
func (c *clientImpl) SetClientID(clientID string) {
c.clientID = clientID
}
func (c *clientImpl) SetBlockValidation(blockValidation bool) {
c.blockValidation = blockValidation
}
func (c *clientImpl) GetBlockValidation() bool {
return c.blockValidation
}
func (c *clientImpl) GetLatestBlock(ctx context.Context) (uint64, error) {
return c.GetLatestBlockWithTag(ctx, c.tag)
}
func (c *clientImpl) GetLatestBlockWithTag(ctx context.Context, tag uint32) (uint64, error) {
resp, err := c.client.GetLatestBlock(ctx, &api.GetLatestBlockRequest{
Tag: tag,
})
if err != nil {
return 0, xerrors.Errorf("failed to get latest block height (tag=%v): %w", tag, err)
}
return resp.Height, nil
}
func (c *clientImpl) GetBlock(ctx context.Context, height uint64, hash string) (*api.Block, error) {
return c.GetBlockWithTag(ctx, c.tag, height, hash)
}
func (c *clientImpl) GetBlockWithTag(ctx context.Context, tag uint32, height uint64, hash string) (*api.Block, error) {
return c.downloadBlock(ctx, tag, height, hash)
}
func (c *clientImpl) GetBlocksByRangeWithTag(ctx context.Context, tag uint32, startHeight uint64, endHeight uint64) ([]*api.Block, error) {
if endHeight == 0 {
endHeight = startHeight + 1
}
resp, err := c.client.GetBlockFilesByRange(ctx, &api.GetBlockFilesByRangeRequest{
Tag: tag,
StartHeight: startHeight,
EndHeight: endHeight,
})
if err != nil {
return nil, xerrors.Errorf("failed to get block file metadata (tag=%d, startHeight=%d, endHeight=%d): %w", tag, startHeight, endHeight, err)
}
if len(resp.GetFiles()) == 0 {
return nil, xerrors.Errorf("no block file metadata found")
}
blockFiles := resp.GetFiles()
blocks := make([]*api.Block, endHeight-startHeight)
group, ctx := syncgroup.New(ctx, syncgroup.WithThrottling(int(c.config.SDK.NumWorkers)))
for i := range blockFiles {
i := i
group.Go(func() error {
blockFile := blockFiles[i]
c.logger.Debug(
"downloading block",
zap.Uint32("tag", blockFile.Tag),
zap.Uint64("height", blockFile.Height),
zap.String("hash", blockFile.Hash),
)
rawBlock, err := c.blockDownloader.Download(ctx, blockFile)
if err != nil {
return xerrors.Errorf("failed download blockFile from %s: %w", blockFile.GetFileUrl(), err)
}
if c.blockValidation {
err := c.validateBlock(ctx, rawBlock)
if err != nil {
return xerrors.Errorf("failed to validate block (blockHeight=%v, blockHash=%v): %w", blockFile.Height, blockFile.Hash, err)
}
}
blocks[i] = rawBlock
return nil
})
}
if err := group.Wait(); err != nil {
return nil, xerrors.Errorf("failed to download block files: %w", err)
}
return blocks, nil
}
func (c *clientImpl) GetBlocksByRange(ctx context.Context, startHeight uint64, endHeight uint64) ([]*api.Block, error) {
return c.GetBlocksByRangeWithTag(ctx, c.tag, startHeight, endHeight)
}
func (c *clientImpl) StreamChainEvents(ctx context.Context, cfg StreamingConfiguration) (<-chan *ChainEventResult, error) {
if err := c.validate.Struct(cfg); err != nil {
return nil, xerrors.Errorf("invalid config: %w", err)
}
// initiate streaming API call
stream, err := c.client.StreamChainEvents(ctx, cfg.ChainEventsRequest)
if err != nil {
return nil, xerrors.Errorf("failed to call StreamChainEvents (cfg={%+v}): %w", cfg, err)
}
// defaults to 1 if not set
if cfg.ChannelBufferCapacity == 0 {
cfg.ChannelBufferCapacity = 1
}
// initiate channel
ch := make(chan *ChainEventResult, cfg.ChannelBufferCapacity)
// start streaming
go c.streamBlocks(ctx, &cfg, stream, ch)
return ch, nil
}
func (c *clientImpl) streamBlocks(
ctx context.Context,
cfg *StreamingConfiguration,
stream api.ChainStorage_StreamChainEventsClient,
ch chan *ChainEventResult,
) {
defer close(ch)
request := proto.Clone(cfg.ChainEventsRequest).(*api.ChainEventsRequest)
for i := uint64(0); cfg.NumberOfEvents == 0 || i < cfg.NumberOfEvents; i++ {
var event *api.BlockchainEvent
if err := c.retry.Retry(ctx, func(ctx context.Context) error {
resp, err := stream.Recv()
if err != nil {
if request.Sequence == "" && request.InitialPositionInStream != "" {
// Fail fast if InitialPositionInStream is specified,
// because we do not know how to reconnect the stream in this case.
return err
}
if !c.isTransientStreamError(err) {
// Fail fast if the error is NOT transient.
return err
}
// In the event of a transient error,
// reconnect the stream using the previous sequence.
// Note that it is not safe to retry stream.Recv() without creating a new stream, because:
// 1. the connection may already be broken at this point;
// 2. stream.Recv() is not idempotent and retry may result in duplicate or missing events.
c.logger.Info(
"reconnecting stream",
zap.Error(err),
zap.Reflect("request", request),
)
newStream, newErr := c.client.StreamChainEvents(ctx, request)
if newErr != nil {
c.logger.Warn(
"failed to reconnect stream",
zap.Error(newErr),
zap.Reflect("request", request),
)
return err
}
stream = newStream
return retry.Retryable(err)
}
event = resp.GetEvent()
return nil
}); err != nil {
c.sendBlockResult(ctx, ch, &ChainEventResult{
Error: xerrors.Errorf("failed to receive from event stream (cfg={%+v}, request={%+v}): %w", cfg, request, err),
})
return
}
if event == nil {
c.sendBlockResult(ctx, ch, &ChainEventResult{
Error: xerrors.Errorf("received null event (cfg={%+v}, request={%+v})", cfg, request),
})
return
}
// block is omitted if EventOnly is specified.
var block *api.Block
if !cfg.EventOnly {
var err error
blockID := event.GetBlock()
block, err = c.downloadBlock(ctx, blockID.GetTag(), blockID.GetHeight(), blockID.GetHash())
if err != nil {
c.sendBlockResult(ctx, ch, &ChainEventResult{
Error: xerrors.Errorf("failed to download block (cfg={%+v}, request={%+v}, event={%+v}): %w", cfg, request, event, err),
})
return
}
}
if ok := c.sendBlockResult(ctx, ch, &ChainEventResult{
BlockchainEvent: event,
Block: block,
}); !ok {
return
}
request.Sequence = event.Sequence
request.SequenceNum = event.SequenceNum
}
}
func (c *clientImpl) sendBlockResult(
ctx context.Context,
ch chan *ChainEventResult,
result *ChainEventResult,
) bool {
select {
case <-ctx.Done():
// caller may have ended the context either deadline or cancel
c.logger.Debug("sendBlockResult context done")
return false
case ch <- result:
return true
}
}
func (c *clientImpl) downloadBlock(ctx context.Context, tag uint32, height uint64, hash string) (*api.Block, error) {
c.logger.Debug(
"downloading block",
zap.Uint32("tag", tag),
zap.Uint64("height", height),
zap.String("hash", hash),
)
blockFile, err := c.client.GetBlockFile(ctx, &api.GetBlockFileRequest{
Tag: tag,
Height: height,
Hash: hash,
})
if err != nil {
return nil, xerrors.Errorf("failed to query block file (tag=%v, height=%v, hash=%v): %w", tag, height, hash, err)
}
rawBlock, err := c.blockDownloader.Download(ctx, blockFile.File)
if err != nil {
return nil, xerrors.Errorf("failed download blockFile (blockFile={%+v}): %w", blockFile.File, err)
}
if c.blockValidation {
err = c.validateBlock(ctx, rawBlock)
if err != nil {
return nil, xerrors.Errorf("failed to validate block (blockHeight=%v, blockHash=%v): %w", height, hash, err)
}
}
return rawBlock, nil
}
func (c *clientImpl) isTransientStreamError(err error) bool {
s, ok := status.FromError(err)
if !ok {
return false
}
// Typical errors include:
// - "rpc error: code = Internal desc = unexpected EOF"
// This error occurs when ChainStorage is re-deployed.
// - "rpc error: code = Internal desc = stream terminated by RST_STREAM with error code: INTERNAL_ERROR"
// This error occurs periodically, yet no error is emitted by the handler of StreamChainEvents.
// It is likely caused by networking issues or gRPC internal errors.
// - "rpc error: code = Unavailable desc = closing transport due to: connection error: desc = \"error reading from server: EOF\", received prior goaway: code: NO_ERROR"
return gateway.IsRetryableCode(s.Code())
}
func (c *clientImpl) GetChainEvents(ctx context.Context, req *api.GetChainEventsRequest) ([]*api.BlockchainEvent, error) {
resp, err := c.client.GetChainEvents(ctx, req)
if err != nil {
return nil, xerrors.Errorf("failed to get chain events (req={%+v}): %w", req, err)
}
return resp.Events, nil
}
func (c *clientImpl) GetChainMetadata(ctx context.Context, req *api.GetChainMetadataRequest) (*api.GetChainMetadataResponse, error) {
resp, err := c.client.GetChainMetadata(ctx, req)
if err != nil {
return nil, xerrors.Errorf("failed to get chain metadata (req={%+v}): %w", req, err)
}
return resp, nil
}
func (c *clientImpl) GetStaticChainMetadata(ctx context.Context, req *api.GetChainMetadataRequest) (*api.GetChainMetadataResponse, error) {
return c.config.GetChainMetadataHelper(req)
}
func (c *clientImpl) GetBlockByTransaction(ctx context.Context, tag uint32, transactionHash string) ([]*api.Block, error) {
resp, err := c.client.GetBlockByTransaction(ctx, &api.GetBlockByTransactionRequest{
Tag: tag,
TransactionHash: transactionHash,
})
if err != nil {
var grpcErr gateway.GrpcError
if xerrors.As(err, &grpcErr) && grpcErr.GRPCStatus().Code() == codes.NotFound {
return []*api.Block{}, nil
}
return nil, xerrors.Errorf("failed to find blocks by transaction (%v): %w", transactionHash, err)
}
blockIds := resp.Blocks
if len(blockIds) == 0 {
return []*api.Block{}, nil
}
// Parallel download is unnecessary
// because a transaction belongs to a single block in most cases.
blocks := make([]*api.Block, len(blockIds))
for i, blockId := range blockIds {
block, err := c.downloadBlock(ctx, blockId.Tag, blockId.Height, blockId.Hash)
if err != nil {
return nil, xerrors.Errorf("failed to download block data: %w", err)
}
blocks[i] = block
}
return blocks, nil
}
func (c *clientImpl) validateBlock(ctx context.Context, rawBlock *api.Block) error {
hash := rawBlock.GetMetadata().GetHash()
height := rawBlock.GetMetadata().GetHeight()
nativeBlock, err := c.parser.ParseNativeBlock(ctx, rawBlock)
if err != nil {
return xerrors.Errorf("failed to parse native format for block (blockHeight=%v, blockHash=%v): %w", height, hash, err)
}
err = c.parser.ValidateBlock(ctx, nativeBlock)
if err != nil {
return xerrors.Errorf("failed to validate block (blockHeight=%v, blockHash=%v): %w", height, hash, err)
}
return nil
}