forked from hyperledger/fabric-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
orderer.go
450 lines (374 loc) · 12.5 KB
/
orderer.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
/*
Copyright SecureKey Technologies Inc. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package orderer
import (
reqContext "context"
"crypto/x509"
"io"
"time"
"github.com/x-chain/fabric-sdk-go/pkg/common/errors/multi"
"github.com/pkg/errors"
"github.com/spf13/cast"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/keepalive"
grpcstatus "google.golang.org/grpc/status"
"github.com/hyperledger/fabric-protos-go/common"
ab "github.com/hyperledger/fabric-protos-go/orderer"
"github.com/x-chain/fabric-sdk-go/pkg/client/common/verifier"
"github.com/x-chain/fabric-sdk-go/pkg/common/errors/status"
"github.com/x-chain/fabric-sdk-go/pkg/common/logging"
"github.com/x-chain/fabric-sdk-go/pkg/common/providers/fab"
"github.com/x-chain/fabric-sdk-go/pkg/context"
"github.com/x-chain/fabric-sdk-go/pkg/core/config/comm"
"github.com/x-chain/fabric-sdk-go/pkg/core/config/endpoint"
)
var logger = logging.NewLogger("fabsdk/fab")
const (
// GRPC max message size (same as Fabric)
maxCallRecvMsgSize = 100 * 1024 * 1024
maxCallSendMsgSize = 100 * 1024 * 1024
)
// Orderer allows a client to broadcast a transaction.
type Orderer struct {
config fab.EndpointConfig
url string
serverName string
tlsCACert *x509.Certificate
grpcDialOption []grpc.DialOption
kap keepalive.ClientParameters
dialTimeout time.Duration
failFast bool
allowInsecure bool
commManager fab.CommManager
}
// Option describes a functional parameter for the New constructor
type Option func(*Orderer) error
// New Returns a Orderer instance
func New(config fab.EndpointConfig, opts ...Option) (*Orderer, error) {
orderer := &Orderer{
config: config,
commManager: &defCommManager{},
}
for _, opt := range opts {
err := opt(orderer)
if err != nil {
return nil, err
}
}
var grpcOpts []grpc.DialOption
if orderer.kap.Time > 0 {
grpcOpts = append(grpcOpts, grpc.WithKeepaliveParams(orderer.kap))
}
grpcOpts = append(grpcOpts, grpc.WithDefaultCallOptions(grpc.WaitForReady(!orderer.failFast)))
if endpoint.AttemptSecured(orderer.url, orderer.allowInsecure) {
//tls config
tlsConfig, err := comm.TLSConfig(orderer.tlsCACert, orderer.serverName, config)
if err != nil {
return nil, err
}
tlsConfig.VerifyPeerCertificate = func(rawCerts [][]byte, verifiedChains [][]*x509.Certificate) error {
return verifier.VerifyPeerCertificate(rawCerts, verifiedChains)
}
grpcOpts = append(grpcOpts, grpc.WithTransportCredentials(credentials.NewTLS(tlsConfig)))
} else {
grpcOpts = append(grpcOpts, grpc.WithInsecure())
}
grpcOpts = append(grpcOpts, grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(maxCallRecvMsgSize),
grpc.MaxCallSendMsgSize(maxCallSendMsgSize)))
orderer.dialTimeout = config.Timeout(fab.OrdererConnection)
orderer.url = endpoint.ToAddress(orderer.url)
orderer.grpcDialOption = grpcOpts
return orderer, nil
}
// WithURL is a functional option for the orderer.New constructor that configures the orderer's URL.
func WithURL(url string) Option {
return func(o *Orderer) error {
o.url = url
return nil
}
}
// WithTLSCert is a functional option for the orderer.New constructor that configures the orderer's TLS certificate
func WithTLSCert(tlsCACert *x509.Certificate) Option {
return func(o *Orderer) error {
o.tlsCACert = tlsCACert
return nil
}
}
// WithServerName is a functional option for the orderer.New constructor that configures the orderer's server name
func WithServerName(serverName string) Option {
return func(o *Orderer) error {
o.serverName = serverName
return nil
}
}
// WithInsecure is a functional option for the orderer.New constructor that configures the orderer's grpc insecure option
func WithInsecure() Option {
return func(o *Orderer) error {
o.allowInsecure = true
return nil
}
}
// FromOrdererConfig is a functional option for the orderer.New constructor that configures a new orderer
// from a apiconfig.OrdererConfig struct
func FromOrdererConfig(ordererCfg *fab.OrdererConfig) Option {
return func(o *Orderer) error {
o.url = ordererCfg.URL
o.tlsCACert = ordererCfg.TLSCACert
if ordererCfg.GRPCOptions["allow-insecure"] == false {
//verify if certificate was expired or not yet valid
err := verifier.ValidateCertificateDates(o.tlsCACert)
if err != nil {
//log this error
logger.Warn(err)
}
}
o.serverName = getServerNameOverride(ordererCfg)
o.kap = getKeepAliveOptions(ordererCfg)
o.failFast = getFailFast(ordererCfg)
o.allowInsecure = isInsecureConnectionAllowed(ordererCfg)
return nil
}
}
// FromOrdererName is a functional option for the orderer.New constructor that obtains an apiconfig.OrdererConfig
// by name from the apiconfig.Config supplied to the constructor, and then constructs a new orderer from it
func FromOrdererName(name string) Option {
return func(o *Orderer) error {
ordererCfg, found, ignoreOrderer := o.config.OrdererConfig(name)
if ignoreOrderer {
return errors.Errorf("orderer config is ignoring orderer : %s by EntityMatchers", name)
}
if !found {
return errors.Errorf("orderer config not found for orderer : %s", name)
}
return FromOrdererConfig(ordererCfg)(o)
}
}
func getServerNameOverride(ordererCfg *fab.OrdererConfig) string {
serverNameOverride := ""
if str, ok := ordererCfg.GRPCOptions["ssl-target-name-override"].(string); ok {
serverNameOverride = str
}
return serverNameOverride
}
func getFailFast(ordererCfg *fab.OrdererConfig) bool {
var failFast = true
if ff, ok := ordererCfg.GRPCOptions["fail-fast"].(bool); ok {
failFast = cast.ToBool(ff)
}
return failFast
}
func getKeepAliveOptions(ordererCfg *fab.OrdererConfig) keepalive.ClientParameters {
var kap keepalive.ClientParameters
if kaTime, ok := ordererCfg.GRPCOptions["keep-alive-time"].(time.Duration); ok {
kap.Time = cast.ToDuration(kaTime)
}
if kaTimeout, ok := ordererCfg.GRPCOptions["keep-alive-timeout"].(time.Duration); ok {
kap.Timeout = cast.ToDuration(kaTimeout)
}
if kaPermit, ok := ordererCfg.GRPCOptions["keep-alive-permit"].(time.Duration); ok {
kap.PermitWithoutStream = cast.ToBool(kaPermit)
}
return kap
}
func isInsecureConnectionAllowed(ordererCfg *fab.OrdererConfig) bool {
allowInsecure, ok := ordererCfg.GRPCOptions["allow-insecure"].(bool)
if ok {
return allowInsecure
}
return false
}
func (o *Orderer) conn(ctx reqContext.Context) (*grpc.ClientConn, error) {
// Establish connection to Ordering Service
ctx, cancel := reqContext.WithTimeout(ctx, o.dialTimeout)
defer cancel()
commManager, ok := context.RequestCommManager(ctx)
if !ok {
commManager = o.commManager
}
return commManager.DialContext(ctx, o.url, o.grpcDialOption...)
}
func (o *Orderer) releaseConn(ctx reqContext.Context, conn *grpc.ClientConn) {
commManager, ok := context.RequestCommManager(ctx)
if !ok {
commManager = o.commManager
}
commManager.ReleaseConn(conn)
}
// URL Get the Orderer url. Required property for the instance objects.
// Returns the address of the Orderer.
func (o *Orderer) URL() string {
return o.url
}
// SendBroadcast Send the created transaction to Orderer.
func (o *Orderer) SendBroadcast(ctx reqContext.Context, envelope *fab.SignedEnvelope) (*common.Status, error) {
conn, err := o.conn(ctx)
if err != nil {
rpcStatus, ok := grpcstatus.FromError(err)
if ok {
return nil, errors.WithMessage(status.NewFromGRPCStatus(rpcStatus), "connection failed")
}
return nil, status.New(status.OrdererClientStatus, status.ConnectionFailed.ToInt32(), err.Error(), nil)
}
defer o.releaseConn(ctx, conn)
broadcastClient, err := ab.NewAtomicBroadcastClient(conn).Broadcast(ctx)
if err != nil {
rpcStatus, ok := grpcstatus.FromError(err)
if ok {
err = status.NewFromGRPCStatus(rpcStatus)
}
return nil, errors.Wrap(err, "NewAtomicBroadcastClient failed")
}
responses := make(chan common.Status)
errs := make(chan error, 1)
go broadcastStream(broadcastClient, responses, errs)
err = broadcastClient.Send(&common.Envelope{
Payload: envelope.Payload,
Signature: envelope.Signature,
})
if err != nil {
return nil, errors.Wrap(err, "failed to send envelope to orderer")
}
if err = broadcastClient.CloseSend(); err != nil {
logger.Debugf("unable to close broadcast client [%s]", err)
}
return wrapStreamStatusRPC(responses, errs)
}
// wrapStreamStatusRPC returns the last response and err and blocks until the chan is closed.
func wrapStreamStatusRPC(responses chan common.Status, errs chan error) (*common.Status, error) {
var status common.Status
var err multi.Errors
read:
for {
select {
case s, ok := <-responses:
if !ok {
break read
}
status = s
case e := <-errs:
err = append(err, e)
}
}
// drain remaining errors.
for i := 0; i < len(errs); i++ {
e := <-errs
err = append(err, e)
}
return &status, err.ToError()
}
func broadcastStream(broadcastClient ab.AtomicBroadcast_BroadcastClient, responses chan common.Status, errs chan error) {
for {
broadcastResponse, err := broadcastClient.Recv()
if err == io.EOF {
// done
close(responses)
return
}
if err != nil {
rpcStatus, ok := grpcstatus.FromError(err)
if ok {
err = status.NewFromGRPCStatus(rpcStatus)
}
errs <- errors.Wrap(err, "broadcast recv failed")
close(responses)
return
}
if broadcastResponse.Status == common.Status_SUCCESS {
responses <- broadcastResponse.Status
} else {
errs <- status.New(status.OrdererServerStatus, int32(broadcastResponse.Status), broadcastResponse.Info, nil)
}
}
}
// SendDeliver sends a deliver request to the ordering service and returns the
// blocks requested
// envelope: contains the seek request for blocks
func (o *Orderer) SendDeliver(ctx reqContext.Context, envelope *fab.SignedEnvelope) (chan *common.Block, chan error) {
responses := make(chan *common.Block)
errs := make(chan error, 1)
conn, err := o.conn(ctx)
if err != nil {
rpcStatus, ok := grpcstatus.FromError(err)
if ok {
errs <- errors.WithMessage(status.NewFromGRPCStatus(rpcStatus), "connection failed")
} else {
errs <- status.New(status.OrdererClientStatus, status.ConnectionFailed.ToInt32(), err.Error(), nil)
}
close(responses)
return responses, errs
}
// Create atomic broadcast client
broadcastClient, err := ab.NewAtomicBroadcastClient(conn).Deliver(ctx)
if err != nil {
logger.Errorf("deliver failed [%s]", err)
o.releaseConn(ctx, conn)
errs <- errors.Wrap(err, "deliver failed")
close(responses)
return responses, errs
}
// Receive blocks from the GRPC stream and put them on the channel
go func() {
blockStream(broadcastClient, responses, errs)
o.releaseConn(ctx, conn)
}()
// Send block request envelope
logger.Debug("Requesting blocks from ordering service")
err = broadcastClient.Send(&common.Envelope{
Payload: envelope.Payload,
Signature: envelope.Signature,
})
if err != nil {
logger.Warnf("failed to send block request to orderer [%s]", err)
}
if err = broadcastClient.CloseSend(); err != nil {
logger.Debugf("unable to close deliver client [%s]", err)
}
return responses, errs
}
func blockStream(deliverClient ab.AtomicBroadcast_DeliverClient, responses chan *common.Block, errs chan error) {
for {
response, err := deliverClient.Recv()
if err == io.EOF {
// done
close(responses)
return
}
if err != nil {
errs <- errors.Wrap(err, "recv from ordering service failed")
close(responses)
return
}
// Assert response type
switch t := response.Type.(type) {
// Seek operation success, no more responses
case *ab.DeliverResponse_Status:
logger.Debugf("Received deliver response status from ordering service: %s", t.Status)
if t.Status != common.Status_SUCCESS {
errs <- status.New(status.OrdererServerStatus, int32(t.Status), "error status from ordering service", []interface{}{})
}
// Response is a requested block
case *ab.DeliverResponse_Block:
logger.Debug("Received block from ordering service")
responses <- response.GetBlock()
// Unknown response
default:
// ignore unknown types.
logger.Infof("unknown response type from ordering service %T", t)
}
}
}
type defCommManager struct{}
func (*defCommManager) DialContext(ctx reqContext.Context, target string, opts ...grpc.DialOption) (conn *grpc.ClientConn, err error) {
logger.Debugf("DialContext [%s]", target)
opts = append(opts, grpc.WithBlock())
return grpc.DialContext(ctx, target, opts...)
}
func (*defCommManager) ReleaseConn(conn *grpc.ClientConn) {
logger.Debugf("ReleaseConn [%p]", conn)
if err := conn.Close(); err != nil {
logger.Debugf("unable to close connection [%s]", err)
}
}