forked from hyperledger/fabric-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
resmgmt.go
1376 lines (1124 loc) · 44.7 KB
/
resmgmt.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 SecureKey Technologies Inc. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
// Package resmgmt enables creation and update of resources on a Fabric network.
// It allows administrators to create and/or update channnels, and for peers to join channels.
// Administrators can also perform chaincode related operations on a peer, such as
// installing, instantiating, and upgrading chaincode.
//
// Basic Flow:
// 1) Prepare client context
// 2) Create resource managememt client
// 3) Create new channel
// 4) Peer(s) join channel
// 5) Install chaincode onto peer(s) filesystem
// 6) Instantiate chaincode on channel
// 7) Query peer for channels, installed/instantiated chaincodes etc.
package resmgmt
import (
reqContext "context"
"io"
"io/ioutil"
"math/rand"
"os"
"time"
"github.com/golang/protobuf/proto"
"github.com/hyperledger/fabric-protos-go/common"
pb "github.com/hyperledger/fabric-protos-go/peer"
"github.com/pkg/errors"
"github.com/x-chain/fabric-sdk-go/internal/github.com/hyperledger/fabric/sdkinternal/configtxlator/update"
"github.com/x-chain/fabric-sdk-go/pkg/client/common/verifier"
"github.com/x-chain/fabric-sdk-go/pkg/common/errors/multi"
"github.com/x-chain/fabric-sdk-go/pkg/common/errors/retry"
"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/context"
"github.com/x-chain/fabric-sdk-go/pkg/common/providers/fab"
"github.com/x-chain/fabric-sdk-go/pkg/common/providers/msp"
contextImpl "github.com/x-chain/fabric-sdk-go/pkg/context"
"github.com/x-chain/fabric-sdk-go/pkg/fab/channel"
"github.com/x-chain/fabric-sdk-go/pkg/fab/chconfig"
"github.com/x-chain/fabric-sdk-go/pkg/fab/peer"
"github.com/x-chain/fabric-sdk-go/pkg/fab/resource"
"github.com/x-chain/fabric-sdk-go/pkg/fab/txn"
)
const bufferSize = 1024
// InstallCCRequest contains install chaincode request parameters
type InstallCCRequest struct {
Name string
Path string
Version string
Package *resource.CCPackage
}
// InstallCCResponse contains install chaincode response status
type InstallCCResponse struct {
Target string
Status int32
Info string
}
// InstantiateCCRequest contains instantiate chaincode request parameters
type InstantiateCCRequest struct {
Name string
Path string
Version string
Lang pb.ChaincodeSpec_Type
Args [][]byte
Policy *common.SignaturePolicyEnvelope
CollConfig []*pb.CollectionConfig
}
// InstantiateCCResponse contains response parameters for instantiate chaincode
type InstantiateCCResponse struct {
TransactionID fab.TransactionID
}
// UpgradeCCRequest contains upgrade chaincode request parameters
type UpgradeCCRequest struct {
Name string
Path string
Version string
Lang pb.ChaincodeSpec_Type
Args [][]byte
Policy *common.SignaturePolicyEnvelope
CollConfig []*pb.CollectionConfig
}
// UpgradeCCResponse contains response parameters for upgrade chaincode
type UpgradeCCResponse struct {
TransactionID fab.TransactionID
}
//requestOptions contains options for operations performed by ResourceMgmtClient
type requestOptions struct {
Targets []fab.Peer // target peers
TargetFilter fab.TargetFilter // target filter
Orderer fab.Orderer // use specific orderer
Timeouts map[fab.TimeoutType]time.Duration //timeout options for resmgmt operations
ParentContext reqContext.Context //parent grpc context for resmgmt operations
Retry retry.Opts
// signatures for channel configurations, if set, this option will take precedence over signatures of SaveChannelRequest.SigningIdentities
Signatures []*common.ConfigSignature
}
//SaveChannelRequest holds parameters for save channel request
type SaveChannelRequest struct {
ChannelID string
ChannelConfig io.Reader // ChannelConfig data source
ChannelConfigPath string // Convenience option to use the named file as ChannelConfig reader
// Users that sign channel configuration
// deprecated - one entity shouldn't have access to another entities' keys to sign on their behalf
SigningIdentities []msp.SigningIdentity
}
// SaveChannelResponse contains response parameters for save channel
type SaveChannelResponse struct {
TransactionID fab.TransactionID
}
//RequestOption func for each Opts argument
type RequestOption func(ctx context.Client, opts *requestOptions) error
var logger = logging.NewLogger("fabsdk/client")
// Client enables managing resources in Fabric network.
type Client struct {
ctx context.Client
filter fab.TargetFilter
localCtxProvider context.LocalProvider
lifecycleProcessor *lifecycleProcessor
}
// mspFilter filters peers by MSP ID
type mspFilter struct {
mspID string
}
// Accept returns true if this peer is to be included in the target list
func (f *mspFilter) Accept(peer fab.Peer) bool {
return peer.MSPID() == f.mspID
}
// ClientOption describes a functional parameter for the New constructor
type ClientOption func(*Client) error
// WithDefaultTargetFilter option to configure default target filter per client
func WithDefaultTargetFilter(filter fab.TargetFilter) ClientOption {
return func(rmc *Client) error {
rmc.filter = filter
return nil
}
}
// New returns a resource management client instance.
func New(ctxProvider context.ClientProvider, opts ...ClientOption) (*Client, error) {
ctx, err := ctxProvider()
if err != nil {
return nil, errors.WithMessage(err, "failed to create resmgmt client due to context error")
}
if ctx.Identifier().MSPID == "" {
return nil, errors.New("mspID not available in user context")
}
resourceClient := &Client{
ctx: ctx,
}
for _, opt := range opts {
err1 := opt(resourceClient)
if err1 != nil {
return nil, err1
}
}
if resourceClient.localCtxProvider == nil {
resourceClient.localCtxProvider = func() (context.Local, error) {
return contextImpl.NewLocal(
func() (context.Client, error) {
return resourceClient.ctx, nil
},
)
}
}
resourceClient.lifecycleProcessor = newLifecycleProcessor(ctx, resourceClient.getCCProposalTargets, resourceClient.verifyTPSignature, resourceClient.sendTransactionAndCheckEvent)
return resourceClient, nil
}
// JoinChannel allows for peers to join existing channel with optional custom options (specific peers, filtered peers). If peer(s) are not specified in options it will default to all peers that belong to client's MSP.
// Parameters:
// channel is manadatory channel name
// options holds optional request options
//
// Returns:
// an error if join fails
func (rc *Client) JoinChannel(channelID string, options ...RequestOption) error {
if channelID == "" {
return errors.New("must provide channel ID")
}
opts, err := rc.prepareRequestOpts(options...)
if err != nil {
return errors.WithMessage(err, "failed to get opts for JoinChannel")
}
//resolve timeouts
rc.resolveTimeouts(&opts)
//set parent request context for overall timeout
parentReqCtx, parentReqCancel := contextImpl.NewRequest(rc.ctx, contextImpl.WithTimeout(opts.Timeouts[fab.ResMgmt]), contextImpl.WithParent(opts.ParentContext))
parentReqCtx = reqContext.WithValue(parentReqCtx, contextImpl.ReqContextTimeoutOverrides, opts.Timeouts)
defer parentReqCancel()
targets, err := rc.calculateTargets(opts.Targets, opts.TargetFilter)
if err != nil {
return errors.WithMessage(err, "failed to determine target peers for JoinChannel")
}
if len(targets) == 0 {
return errors.WithStack(status.New(status.ClientStatus, status.NoPeersFound.ToInt32(), "no targets available", nil))
}
orderer, err := rc.requestOrderer(&opts, channelID)
if err != nil {
return errors.WithMessage(err, "failed to find orderer for request")
}
ordrReqCtx, ordrReqCtxCancel := contextImpl.NewRequest(rc.ctx, contextImpl.WithTimeoutType(fab.OrdererResponse), contextImpl.WithParent(parentReqCtx))
defer ordrReqCtxCancel()
genesisBlock, err := resource.GenesisBlockFromOrderer(ordrReqCtx, channelID, orderer, resource.WithRetry(opts.Retry))
if err != nil {
return errors.WithMessage(err, "genesis block retrieval failed")
}
joinChannelRequest := resource.JoinChannelRequest{
GenesisBlock: genesisBlock,
}
peerReqCtx, peerReqCtxCancel := contextImpl.NewRequest(rc.ctx, contextImpl.WithTimeoutType(fab.ResMgmt), contextImpl.WithParent(parentReqCtx))
defer peerReqCtxCancel()
err = resource.JoinChannel(peerReqCtx, joinChannelRequest, peersToTxnProcessors(targets), resource.WithRetry(opts.Retry))
if err != nil {
return errors.WithMessage(err, "join channel failed")
}
return nil
}
// filterTargets is helper method to filter peers
func filterTargets(peers []fab.Peer, filter fab.TargetFilter) []fab.Peer {
if filter == nil {
return peers
}
filteredPeers := []fab.Peer{}
for _, peer := range peers {
if filter.Accept(peer) {
filteredPeers = append(filteredPeers, peer)
}
}
return filteredPeers
}
func (rc *Client) resolveDefaultTargets(opts *requestOptions) ([]fab.Peer, error) {
if len(opts.Targets) != 0 {
return opts.Targets, nil
}
localCtx, err := rc.localCtxProvider()
if err != nil {
return nil, errors.WithMessage(err, "failed to create local context")
}
targets, err := rc.getDefaultTargets(localCtx.LocalDiscoveryService())
if err != nil {
return nil, err
}
if len(targets) == 0 {
return nil, errors.WithMessage(err, "no local targets for InstallCC")
}
return targets, nil
}
// helper method for calculating default targets
func (rc *Client) getDefaultTargets(discovery fab.DiscoveryService) ([]fab.Peer, error) {
// Default targets are discovery peers
peers, err := discovery.GetPeers()
if err != nil {
return nil, errors.WithMessage(err, "failed to discover peers")
}
// Apply default filter to discovery peers
targets := filterTargets(peers, rc.filter)
return targets, nil
}
// calculateTargets calculates targets based on targets and filter
func (rc *Client) calculateTargets(targets []fab.Peer, filter fab.TargetFilter) ([]fab.Peer, error) {
targetFilter := filter
if len(targets) == 0 {
// Retrieve targets from discovery
localCtx, err := rc.localCtxProvider()
if err != nil {
return nil, errors.WithMessage(err, "failed to create local context")
}
targets, err = localCtx.LocalDiscoveryService().GetPeers()
if err != nil {
return nil, err
}
if filter == nil {
targetFilter = rc.filter
}
}
if targetFilter != nil {
targets = filterTargets(targets, targetFilter)
}
return targets, nil
}
// isChaincodeInstalled verify if chaincode is installed on peer
func (rc *Client) isChaincodeInstalled(reqCtx reqContext.Context, req InstallCCRequest, peer fab.ProposalProcessor, retryOpts retry.Opts) (bool, error) {
chaincodeQueryResponse, err := resource.QueryInstalledChaincodes(reqCtx, peer, resource.WithRetry(retryOpts))
if err != nil {
return false, err
}
logger.Debugf("isChaincodeInstalled: %+v", chaincodeQueryResponse)
for _, chaincode := range chaincodeQueryResponse.Chaincodes {
if chaincode.Name == req.Name && chaincode.Version == req.Version && chaincode.Path == req.Path {
return true, nil
}
}
return false, nil
}
// InstallCC allows administrators to install chaincode onto the filesystem of a peer.
// If peer(s) are not specified in options it will default to all peers that belong to admin's MSP.
// Parameters:
// req holds info about mandatory chaincode name, path, version and policy
// options holds optional request options
//
// Returns:
// install chaincode proposal responses from peer(s)
func (rc *Client) InstallCC(req InstallCCRequest, options ...RequestOption) ([]InstallCCResponse, error) {
// For each peer query if chaincode installed. If cc is installed treat as success with message 'already installed'.
// If cc is not installed try to install, and if that fails add to the list with error and peer name.
err := checkRequiredInstallCCParams(req)
if err != nil {
return nil, err
}
opts, err := rc.prepareRequestOpts(options...)
if err != nil {
return nil, errors.WithMessage(err, "failed to get opts for InstallCC")
}
//resolve timeouts
rc.resolveTimeouts(&opts)
//set parent request context for overall timeout
parentReqCtx, parentReqCancel := contextImpl.NewRequest(rc.ctx, contextImpl.WithTimeout(opts.Timeouts[fab.ResMgmt]), contextImpl.WithParent(opts.ParentContext))
parentReqCtx = reqContext.WithValue(parentReqCtx, contextImpl.ReqContextTimeoutOverrides, opts.Timeouts)
defer parentReqCancel()
//Default targets when targets are not provided in options
defaultTargets, err := rc.resolveDefaultTargets(&opts)
if err != nil {
return nil, errors.WithMessage(err, "failed to get default targets for InstallCC")
}
targets, err := rc.calculateTargets(defaultTargets, opts.TargetFilter)
if err != nil {
return nil, errors.WithMessage(err, "failed to determine target peers for install cc")
}
if len(targets) == 0 {
return nil, errors.WithStack(status.New(status.ClientStatus, status.NoPeersFound.ToInt32(), "no targets available", nil))
}
responses, newTargets, errs := rc.adjustTargets(targets, req, opts.Retry, parentReqCtx)
if len(newTargets) == 0 {
// CC is already installed on all targets and/or
// we are unable to verify if cc is installed on target(s)
return responses, errs.ToError()
}
reqCtx, cancel := contextImpl.NewRequest(rc.ctx, contextImpl.WithTimeoutType(fab.ResMgmt), contextImpl.WithParent(parentReqCtx))
defer cancel()
responses, err = rc.sendInstallCCRequest(req, reqCtx, newTargets, responses)
if err != nil {
installErrs, ok := err.(multi.Errors)
if ok {
errs = append(errs, installErrs)
} else {
errs = append(errs, err)
}
}
return responses, errs.ToError()
}
func (rc *Client) sendInstallCCRequest(req InstallCCRequest, reqCtx reqContext.Context, newTargets []fab.Peer, responses []InstallCCResponse) ([]InstallCCResponse, error) {
icr := resource.InstallChaincodeRequest{Name: req.Name, Path: req.Path, Version: req.Version, Package: req.Package}
transactionProposalResponse, _, err := resource.InstallChaincode(reqCtx, icr, peer.PeersToTxnProcessors(newTargets))
if err != nil {
return nil, errors.WithMessage(err, "installing chaincode failed")
}
for _, v := range transactionProposalResponse {
logger.Debugf("Install chaincode '%s' endorser '%s' returned ProposalResponse status:%v", req.Name, v.Endorser, v.Status)
response := InstallCCResponse{Target: v.Endorser, Status: v.Status}
responses = append(responses, response)
}
return responses, nil
}
func (rc *Client) adjustTargets(targets []fab.Peer, req InstallCCRequest, retry retry.Opts, parentReqCtx reqContext.Context) ([]InstallCCResponse, []fab.Peer, multi.Errors) {
errs := multi.Errors{}
responses := make([]InstallCCResponse, 0)
// Targets will be adjusted if cc has already been installed
newTargets := make([]fab.Peer, 0)
for _, target := range targets {
reqCtx, cancel := contextImpl.NewRequest(rc.ctx, contextImpl.WithTimeoutType(fab.PeerResponse), contextImpl.WithParent(parentReqCtx))
defer cancel()
installed, err1 := rc.isChaincodeInstalled(reqCtx, req, target, retry)
if err1 != nil {
// Add to errors with unable to verify error message
errs = append(errs, errors.Errorf("unable to verify if cc is installed on %s. Got error: %s", target.URL(), err1))
continue
}
if installed {
// Nothing to do - add info message to response
response := InstallCCResponse{Target: target.URL(), Info: "already installed"}
responses = append(responses, response)
} else {
// Not installed - add for processing
newTargets = append(newTargets, target)
}
}
return responses, newTargets, errs
}
func checkRequiredInstallCCParams(req InstallCCRequest) error {
if req.Name == "" || req.Version == "" || req.Path == "" || req.Package == nil {
return errors.New("Chaincode name, version, path and chaincode package are required")
}
return nil
}
// InstantiateCC instantiates chaincode with optional custom options (specific peers, filtered peers, timeout). If peer(s) are not specified
// in options it will default to all channel peers.
// Parameters:
// channel is manadatory channel name
// req holds info about mandatory chaincode name, path, version and policy
// options holds optional request options
//
// Returns:
// instantiate chaincode response with transaction ID
func (rc *Client) InstantiateCC(channelID string, req InstantiateCCRequest, options ...RequestOption) (InstantiateCCResponse, error) {
opts, err := rc.prepareRequestOpts(options...)
if err != nil {
return InstantiateCCResponse{}, errors.WithMessage(err, "failed to get opts for InstantiateCC")
}
reqCtx, cancel := rc.createRequestContext(opts, fab.ResMgmt)
defer cancel()
txID, err := rc.sendCCProposal(reqCtx, InstantiateChaincode, channelID, req, opts)
return InstantiateCCResponse{TransactionID: txID}, err
}
// UpgradeCC upgrades chaincode with optional custom options (specific peers, filtered peers, timeout). If peer(s) are not specified in options
// it will default to all channel peers.
// Parameters:
// channel is manadatory channel name
// req holds info about mandatory chaincode name, path, version and policy
// options holds optional request options
//
// Returns:
// upgrade chaincode response with transaction ID
func (rc *Client) UpgradeCC(channelID string, req UpgradeCCRequest, options ...RequestOption) (UpgradeCCResponse, error) {
opts, err := rc.prepareRequestOpts(options...)
if err != nil {
return UpgradeCCResponse{}, errors.WithMessage(err, "failed to get opts for UpgradeCC")
}
reqCtx, cancel := rc.createRequestContext(opts, fab.ResMgmt)
defer cancel()
txID, err := rc.sendCCProposal(reqCtx, UpgradeChaincode, channelID, InstantiateCCRequest(req), opts)
return UpgradeCCResponse{TransactionID: txID}, err
}
// QueryInstalledChaincodes queries the installed chaincodes on a peer.
// Parameters:
// options hold optional request options
// Note: One target(peer) has to be specified using either WithTargetURLs or WithTargets request option
//
// Returns:
// list of installed chaincodes on specified peer
func (rc *Client) QueryInstalledChaincodes(options ...RequestOption) (*pb.ChaincodeQueryResponse, error) {
opts, err := rc.prepareRequestOpts(options...)
if err != nil {
return nil, err
}
if len(opts.Targets) != 1 {
return nil, errors.New("only one target is supported")
}
reqCtx, cancel := rc.createRequestContext(opts, fab.PeerResponse)
defer cancel()
return resource.QueryInstalledChaincodes(reqCtx, opts.Targets[0], resource.WithRetry(opts.Retry))
}
// QueryInstantiatedChaincodes queries the instantiated chaincodes on a peer for specific channel. If peer is not specified in options it will query random peer on this channel.
// Parameters:
// channel is manadatory channel name
// options hold optional request options
//
// Returns:
// list of instantiated chaincodes
func (rc *Client) QueryInstantiatedChaincodes(channelID string, options ...RequestOption) (*pb.ChaincodeQueryResponse, error) {
opts, err := rc.prepareRequestOpts(options...)
if err != nil {
return nil, err
}
chCtx, err := contextImpl.NewChannel(
func() (context.Client, error) {
return rc.ctx, nil
},
channelID,
)
if err != nil {
return nil, errors.WithMessage(err, "failed to create channel context")
}
var target fab.ProposalProcessor
if len(opts.Targets) >= 1 {
target = opts.Targets[0]
} else {
// select random channel peer
var srcpErr error
target, srcpErr = rc.selectRandomChannelPeer(chCtx)
if srcpErr != nil {
return nil, srcpErr
}
}
l, err := channel.NewLedger(channelID)
if err != nil {
return nil, err
}
reqCtx, cancel := rc.createRequestContext(opts, fab.PeerResponse)
defer cancel()
// Channel service membership is required to verify signature
channelService := chCtx.ChannelService()
membership, err := channelService.Membership()
if err != nil {
return nil, errors.WithMessage(err, "membership creation failed")
}
responses, err := l.QueryInstantiatedChaincodes(reqCtx, []fab.ProposalProcessor{target}, &verifier.Signature{Membership: membership})
if err != nil {
return nil, err
}
return responses[0], nil
}
// QueryCollectionsConfig queries the collections config on a peer for specific channel. If peer is not specified in options it will query random peer on this channel.
// Parameters:
// channel is mandatory channel name
// chaincode is mandatory chaincode name
// options hold optional request options
//
// Returns:
// list of collections config
func (rc *Client) QueryCollectionsConfig(channelID string, chaincodeName string, options ...RequestOption) (*pb.CollectionConfigPackage, error) {
opts, err := rc.prepareRequestOpts(options...)
if err != nil {
return nil, err
}
chCtx, err := contextImpl.NewChannel(
func() (context.Client, error) {
return rc.ctx, nil
},
channelID,
)
if err != nil {
return nil, errors.WithMessage(err, "failed to create channel context")
}
var target fab.ProposalProcessor
if len(opts.Targets) >= 1 {
target = opts.Targets[0]
} else {
// select random channel peer
var srcpErr error
target, srcpErr = rc.selectRandomChannelPeer(chCtx)
if srcpErr != nil {
return nil, srcpErr
}
}
l, err := channel.NewLedger(channelID)
if err != nil {
return nil, err
}
reqCtx, cancel := rc.createRequestContext(opts, fab.PeerResponse)
defer cancel()
// Channel service membership is required to verify signature
channelService := chCtx.ChannelService()
membership, err := channelService.Membership()
if err != nil {
return nil, errors.WithMessage(err, "membership creation failed")
}
responses, err := l.QueryCollectionsConfig(reqCtx, chaincodeName, []fab.ProposalProcessor{target}, &verifier.Signature{Membership: membership})
if err != nil {
return nil, err
}
return responses[0], nil
}
func (rc *Client) selectRandomChannelPeer(ctx context.Channel) (fab.ProposalProcessor, error) {
// discover peers on this channel
discovery, err := ctx.ChannelService().Discovery()
if err != nil {
return nil, errors.WithMessage(err, "failed to get discovery service")
}
// default filter will be applied (if any)
targets, err2 := rc.getDefaultTargets(discovery)
if err2 != nil {
return nil, errors.WithMessage(err2, "failed to get default target for query instantiated chaincodes")
}
// Filter by MSP since the LSCC only allows local calls
targets = filterTargets(targets, &mspFilter{mspID: ctx.Identifier().MSPID})
if len(targets) == 0 {
return nil, errors.Errorf("no targets in MSP [%s]", ctx.Identifier().MSPID)
}
// select random channel peer
randomNumber := rand.Intn(len(targets))
return targets[randomNumber], nil
}
// QueryChannels queries the names of all the channels that a peer has joined.
// Parameters:
// options hold optional request options
// Note: One target(peer) has to be specified using either WithTargetURLs or WithTargets request option
//
// Returns:
// all channels that peer has joined
func (rc *Client) QueryChannels(options ...RequestOption) (*pb.ChannelQueryResponse, error) {
opts, err := rc.prepareRequestOpts(options...)
if err != nil {
return nil, err
}
if len(opts.Targets) != 1 {
return nil, errors.New("only one target is supported")
}
reqCtx, cancel := rc.createRequestContext(opts, fab.PeerResponse)
defer cancel()
return resource.QueryChannels(reqCtx, opts.Targets[0], resource.WithRetry(opts.Retry))
}
// validateSendCCProposal
func (rc *Client) getCCProposalTargets(channelID string, opts requestOptions) ([]fab.Peer, error) {
chCtx, err := contextImpl.NewChannel(
func() (context.Client, error) {
return rc.ctx, nil
},
channelID,
)
if err != nil {
return nil, errors.WithMessage(err, "failed to create channel context")
}
// per channel discovery service
discovery, err := chCtx.ChannelService().Discovery()
if err != nil {
return nil, errors.WithMessage(err, "failed to get discovery service")
}
//Default targets when targets are not provided in options
if len(opts.Targets) == 0 {
opts.Targets, err = rc.getDefaultTargets(discovery)
if err != nil {
return nil, errors.WithMessage(err, "failed to get default targets for cc proposal")
}
}
targets, err := rc.calculateTargets(opts.Targets, opts.TargetFilter)
if err != nil {
return nil, errors.WithMessage(err, "failed to determine target peers for cc proposal")
}
if len(targets) == 0 {
return nil, errors.WithStack(status.New(status.ClientStatus, status.NoPeersFound.ToInt32(), "no targets available", nil))
}
return targets, nil
}
// createTP
func (rc *Client) createTP(req InstantiateCCRequest, channelID string, ccProposalType chaincodeProposalType) (*fab.TransactionProposal, fab.TransactionID, error) {
deployProposal := chaincodeDeployRequest(req)
txID, err := txn.NewHeader(rc.ctx, channelID)
if err != nil {
return nil, fab.EmptyTransactionID, errors.WithMessage(err, "create transaction ID failed")
}
tp, err := createChaincodeDeployProposal(txID, ccProposalType, channelID, deployProposal)
if err != nil {
return nil, txID.TransactionID(), errors.WithMessage(err, "creating chaincode deploy transaction proposal failed")
}
return tp, txID.TransactionID(), nil
}
func (rc *Client) verifyTPSignature(channelService fab.ChannelService, txProposalResponse []*fab.TransactionProposalResponse) error {
// Membership is required to verify signature
membership, err := channelService.Membership()
if err != nil {
return errors.WithMessage(err, "membership creation failed")
}
sv := &verifier.Signature{Membership: membership}
for _, r := range txProposalResponse {
if err := sv.Verify(r); err != nil {
return errors.WithMessage(err, "Failed to verify signature")
}
}
return nil
}
// sendCCProposal sends proposal for type Instantiate, Upgrade
func (rc *Client) sendCCProposal(reqCtx reqContext.Context, ccProposalType chaincodeProposalType, channelID string, req InstantiateCCRequest, opts requestOptions) (fab.TransactionID, error) {
if err := checkRequiredCCProposalParams(channelID, &req); err != nil {
return fab.EmptyTransactionID, err
}
targets, err := rc.getCCProposalTargets(channelID, opts)
if err != nil {
return fab.EmptyTransactionID, err
}
// Get transactor on the channel to create and send the deploy proposal
channelService, err := rc.ctx.ChannelProvider().ChannelService(rc.ctx, channelID)
if err != nil {
return fab.EmptyTransactionID, errors.WithMessage(err, "Unable to get channel service")
}
transactor, err := channelService.Transactor(reqCtx)
if err != nil {
return fab.EmptyTransactionID, errors.WithMessage(err, "get channel transactor failed")
}
// create a transaction proposal for chaincode deployment
tp, txnID, err := rc.createTP(req, channelID, ccProposalType)
if err != nil {
return txnID, err
}
// Process and send transaction proposal
txProposalResponse, err := transactor.SendTransactionProposal(tp, peersToTxnProcessors(targets))
if err != nil {
return tp.TxnID, errors.WithMessage(err, "sending deploy transaction proposal failed")
}
// Verify signature(s)
err = rc.verifyTPSignature(channelService, txProposalResponse)
if err != nil {
return tp.TxnID, errors.WithMessage(err, "sending deploy transaction proposal failed to verify signature")
}
eventService, err := channelService.EventService()
if err != nil {
return tp.TxnID, errors.WithMessage(err, "unable to get event service")
}
// send transaction and check event
return rc.sendTransactionAndCheckEvent(eventService, tp, txProposalResponse, transactor, reqCtx)
}
func (rc *Client) sendTransactionAndCheckEvent(eventService fab.EventService, tp *fab.TransactionProposal, txProposalResponse []*fab.TransactionProposalResponse,
transac fab.Transactor, reqCtx reqContext.Context) (fab.TransactionID, error) {
// Register for commit event
reg, statusNotifier, err := eventService.RegisterTxStatusEvent(string(tp.TxnID))
if err != nil {
return tp.TxnID, errors.WithMessage(err, "error registering for TxStatus event")
}
defer eventService.Unregister(reg)
transactionRequest := fab.TransactionRequest{
Proposal: tp,
ProposalResponses: txProposalResponse,
}
if _, err := createAndSendTransaction(transac, transactionRequest); err != nil {
return tp.TxnID, errors.WithMessage(err, "CreateAndSendTransaction failed")
}
select {
case txStatus := <-statusNotifier:
if txStatus.TxValidationCode == pb.TxValidationCode_VALID {
return fab.TransactionID(txStatus.TxID), nil
}
return fab.TransactionID(txStatus.TxID), status.New(status.EventServerStatus, int32(txStatus.TxValidationCode), "instantiateOrUpgradeCC failed", nil)
case <-reqCtx.Done():
return tp.TxnID, errors.New("instantiateOrUpgradeCC timed out or cancelled")
}
}
func checkRequiredCCProposalParams(channelID string, req *InstantiateCCRequest) error {
if channelID == "" {
return errors.New("must provide channel ID")
}
if req.Name == "" || req.Version == "" || req.Path == "" || req.Policy == nil {
return errors.New("Chaincode name, version, path and policy are required")
}
// Forward compatibility, set Lang to golang by default
if req.Lang == 0 || pb.ChaincodeSpec_Type_name[int32(req.Lang)] == "" {
req.Lang = pb.ChaincodeSpec_GOLANG
}
return nil
}
func createAndSendTransaction(sender fab.Sender, request fab.TransactionRequest) (*fab.TransactionResponse, error) {
tx, err := sender.CreateTransaction(request)
if err != nil {
return nil, errors.WithMessage(err, "CreateTransaction failed")
}
transactionResponse, err := sender.SendTransaction(tx)
if err != nil {
return nil, errors.WithMessage(err, "SendTransaction failed")
}
return transactionResponse, nil
}
// peersToTxnProcessors converts a slice of Peers to a slice of ProposalProcessors
func peersToTxnProcessors(peers []fab.Peer) []fab.ProposalProcessor {
tpp := make([]fab.ProposalProcessor, len(peers))
for i := range peers {
tpp[i] = peers[i]
}
return tpp
}
// SaveChannel creates or updates channel.
// Parameters:
// req holds info about mandatory channel name and configuration
// options holds optional request options
// if options have signatures (WithConfigSignatures() or 1 or more WithConfigSignature() calls), then SaveChannel will
// use these signatures instead of creating ones for the SigningIdentities found in req.
// Make sure that req.ChannelConfigPath/req.ChannelConfig have the channel config matching these signatures.
//
// Returns:
// save channel response with transaction ID
func (rc *Client) SaveChannel(req SaveChannelRequest, options ...RequestOption) (SaveChannelResponse, error) {
opts, err := rc.prepareRequestOpts(options...)
if err != nil {
return SaveChannelResponse{}, err
}
if req.ChannelConfigPath != "" {
configReader, err1 := os.Open(req.ChannelConfigPath)
defer loggedClose(configReader)
if err1 != nil {
return SaveChannelResponse{}, errors.Wrapf(err1, "opening channel config file failed")
}
req.ChannelConfig = configReader
}
err = rc.validateSaveChannelRequest(req)
if err != nil {
return SaveChannelResponse{}, err
}
logger.Debugf("saving channel: %s", req.ChannelID)
chConfig, err := extractChConfigTx(req.ChannelConfig)
if err != nil {
return SaveChannelResponse{}, errors.WithMessage(err, "extracting channel config from ConfigTx failed")
}
orderer, err := rc.requestOrderer(&opts, req.ChannelID)
if err != nil {
return SaveChannelResponse{}, errors.WithMessage(err, "failed to find orderer for request")
}
txID, err := rc.signAndSubmitChannelConfigTx(
req.ChannelID,
req.SigningIdentities,
opts,
chConfig,
orderer,
)
if err != nil {
return SaveChannelResponse{}, errors.WithMessage(err, "create channel failed")
}
return SaveChannelResponse{TransactionID: txID}, nil
}
func (rc *Client) signAndSubmitChannelConfigTx(channelID string, signingIdentities []msp.SigningIdentity, opts requestOptions, chConfigTx []byte, orderer fab.Orderer) (fab.TransactionID, error) {
var configSignatures []*common.ConfigSignature
var err error
if opts.Signatures != nil {
configSignatures = opts.Signatures
} else {
configSignatures, err = rc.getConfigSignatures(signingIdentities, chConfigTx)
if err != nil {
return "", err
}
}
request := resource.CreateChannelRequest{
Name: channelID,
Orderer: orderer,
Config: chConfigTx,
Signatures: configSignatures,
}
reqCtx, cancel := rc.createRequestContext(opts, fab.OrdererResponse)
defer cancel()
txID, err := resource.CreateChannel(reqCtx, request, resource.WithRetry(opts.Retry))
if err != nil {
return "", errors.WithMessage(err, "create channel failed")
}
return txID, nil
}