[FAB-5137] Split txn APIs into their own pkg

Change-Id: I418ccb1fc00931c8e25fcd60bc53db596bb2f6a3
Signed-off-by: Troy Ronda <troy@troyronda.com>

Author: troyronda

Makefile

@@ -47,7 +47,7 @@ integration-tests: integration-test
 mock-gen:
 	go get -u github.com/golang/mock/gomock
 	go get -u github.com/golang/mock/mockgen
-	mockgen -build_flags '$(LDFLAGS)' github.com/hyperledger/fabric-sdk-go/api/txnapi TxnProposalProcessor | sed "s/github.com\/hyperledger\/fabric-sdk-go\/vendor\///g"  > api/txnapi/mocks/mocktxnapi.gen.go
+	mockgen -build_flags '$(LDFLAGS)' github.com/hyperledger/fabric-sdk-go/api/apitxn ProposalProcessor | sed "s/github.com\/hyperledger\/fabric-sdk-go\/vendor\///g"  > api/apitxn/mocks/mockapitxn.gen.go
 	mockgen -build_flags '$(LDFLAGS)' github.com/hyperledger/fabric-sdk-go/api Config | sed "s/github.com\/hyperledger\/fabric-sdk-go\/vendor\///g"  > api/mocks/mockconfig.gen.go
 
 clean:

api/apitxn/mocks/mockapitxn.gen.go

@@ -4,15 +4,15 @@ Copyright SecureKey Technologies Inc. All Rights Reserved.
 SPDX-License-Identifier: Apache-2.0
 */
 
-// Package txnapi allows SDK users to plugin their own implementations of transaction processing.
-package txnapi
+// Package apitxn allows SDK users to plugin their own implementations of transaction processing.
+package apitxn
 
 import (
 	pb "github.com/hyperledger/fabric/protos/peer"
 )
 
-// TxnProposalProcessor simulates transaction proposal, so that a client can submit the result for ordering.
-type TxnProposalProcessor interface {
+// ProposalProcessor simulates transaction proposal, so that a client can submit the result for ordering.
+type ProposalProcessor interface {
 	ProcessTransactionProposal(proposal TransactionProposal) (TransactionProposalResult, error)
 }
 

api/txnapi/txnproposer.go api/apitxn/proposer.goapi/txnapi/txnproposer.go renamed to api/apitxn/proposer.go

@@ -0,0 +1,36 @@
+/*
+Copyright SecureKey Technologies Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+// Package apitxn allows SDK users to plugin their own implementations of transaction processing.
+package apitxn
+
+import (
+	pb "github.com/hyperledger/fabric/protos/peer"
+)
+
+// Sender provides the ability for a transaction to be created and sent.
+type Sender interface {
+	CreateTransaction(resps []*TransactionProposalResponse) (*Transaction, error)
+	SendTransaction(tx *Transaction) ([]*TransactionResponse, error)
+}
+
+// ProposalSender provides the ability for a transaction proposal to be created and sent.
+type ProposalSender interface {
+	CreateTransactionProposal(chaincodeName string, channelID string, args []string, sign bool, transientData map[string][]byte) (*TransactionProposal, error)
+	SendTransactionProposal(proposal *TransactionProposal, retry int, targets []ProposalProcessor) ([]*TransactionProposalResponse, error)
+}
+
+// The Transaction object created from an endorsed proposal.
+type Transaction struct {
+	Proposal    *TransactionProposal
+	Transaction *pb.Transaction
+}
+
+// TransactionResponse contains information returned by the orderer.
+type TransactionResponse struct {
+	Orderer string
+	Err     error
+}

api/apitxn/sender.go

@@ -7,7 +7,7 @@ SPDX-License-Identifier: Apache-2.0
 package api
 
 import (
-	"github.com/hyperledger/fabric-sdk-go/api/txnapi"
+	txn "github.com/hyperledger/fabric-sdk-go/api/apitxn"
 	"github.com/hyperledger/fabric/msp"
 	"github.com/hyperledger/fabric/protos/common"
 	pb "github.com/hyperledger/fabric/protos/peer"
@@ -24,12 +24,22 @@ import (
  * primary orderer to retrieve the configuration settings for this channel.
  */
 type Channel interface {
+	txn.Sender
+	txn.ProposalSender
+
 	Name() string
 	Initialize(data []byte) error
 	IsInitialized() bool
 	IsSecurityEnabled() bool
+	QueryExtensionInterface() ChannelExtension
+	LoadConfigUpdateEnvelope(data []byte) error
+	SendInstantiateProposal(chaincodeName string, channelID string, args []string, chaincodePath string, chaincodeVersion string, targets []txn.ProposalProcessor) ([]*txn.TransactionProposalResponse, string, error)
+
+	// TCerts
 	TCertBatchSize() int
 	SetTCertBatchSize(batchSize int)
+
+	// Network
 	AddPeer(peer Peer) error
 	RemovePeer(peer Peer)
 	Peers() []Peer
@@ -41,37 +51,32 @@ type Channel interface {
 	Orderers() []Orderer
 	SetMSPManager(mspManager msp.MSPManager)
 	MSPManager() msp.MSPManager
+	OrganizationUnits() ([]string, error)
+
+	// Channel Info
 	GenesisBlock(request *GenesisBlockRequest) (*common.Block, error)
 	JoinChannel(request *JoinChannelRequest) error
 	UpdateChannel() bool
 	IsReadonly() bool
+
+	// Query
 	QueryInfo() (*common.BlockchainInfo, error)
 	QueryBlock(blockNumber int) (*common.Block, error)
 	QueryBlockByHash(blockHash []byte) (*common.Block, error)
 	QueryTransaction(transactionID string) (*pb.ProcessedTransaction, error)
 	QueryInstantiatedChaincodes() (*pb.ChaincodeQueryResponse, error)
-	QueryByChaincode(chaincodeName string, args []string, targets []Peer) ([][]byte, error)
-	SendInstantiateProposal(chaincodeName string, channelID string, args []string, chaincodePath string, chaincodeVersion string, targets []Peer) ([]*txnapi.TransactionProposalResponse, string, error)
-	OrganizationUnits() ([]string, error)
-	QueryExtensionInterface() ChannelExtension
-	LoadConfigUpdateEnvelope(data []byte) error
-
-	// Transaction Proposal
-	CreateTransactionProposal(chaincodeName string, channelID string, args []string, sign bool, transientData map[string][]byte) (*txnapi.TransactionProposal, error)
-	SendTransactionProposal(proposal *txnapi.TransactionProposal, retry int, targets []Peer) ([]*txnapi.TransactionProposalResponse, error)
-	CreateTransaction(resps []*txnapi.TransactionProposalResponse) (*Transaction, error)
-	SendTransaction(tx *Transaction) ([]*TransactionResponse, error)
+	QueryByChaincode(chaincodeName string, args []string, targets []txn.ProposalProcessor) ([][]byte, error)
 }
 
 // The ChannelExtension interface allows extensions of the SDK to add functionality to Channel overloads.
 type ChannelExtension interface {
 	ClientContext() FabricClient
 
 	SignPayload(payload []byte) (*SignedEnvelope, error)
-	BroadcastEnvelope(envelope *SignedEnvelope) ([]*TransactionResponse, error)
+	BroadcastEnvelope(envelope *SignedEnvelope) ([]*txn.TransactionResponse, error)
 
 	// TODO: This should go somewhere else - see TransactionProposal.GetBytes(). - deprecated
-	ProposalBytes(tp *txnapi.TransactionProposal) ([]byte, error)
+	ProposalBytes(tp *txn.TransactionProposal) ([]byte, error)
 }
 
 // OrgAnchorPeer contains information about an anchor peer on this channel
@@ -94,18 +99,3 @@ type JoinChannelRequest struct {
 	TxID         string
 	Nonce        []byte
 }
-
-// The Transaction object created from an endorsed proposal
-type Transaction struct {
-	Proposal    *txnapi.TransactionProposal
-	Transaction *pb.Transaction
-}
-
-// TransactionResponse ...
-/**
- * The TransactionProposalResponse result object returned from orderers.
- */
-type TransactionResponse struct {
-	Orderer string
-	Err     error
-}

api/channel.go

@@ -7,7 +7,7 @@ SPDX-License-Identifier: Apache-2.0
 package api
 
 import (
-	"github.com/hyperledger/fabric-sdk-go/api/txnapi"
+	txn "github.com/hyperledger/fabric-sdk-go/api/apitxn"
 	"github.com/hyperledger/fabric/bccsp"
 	"github.com/hyperledger/fabric/protos/common"
 	pb "github.com/hyperledger/fabric/protos/peer"
@@ -43,7 +43,7 @@ type FabricClient interface {
 	GetCryptoSuite() bccsp.BCCSP
 	SaveUserToStateStore(user User, skipPersistence bool) error
 	LoadUserFromStateStore(name string) (User, error)
-	InstallChaincode(chaincodeName string, chaincodePath string, chaincodeVersion string, chaincodePackage []byte, targets []Peer) ([]*txnapi.TransactionProposalResponse, string, error)
+	InstallChaincode(chaincodeName string, chaincodePath string, chaincodeVersion string, chaincodePackage []byte, targets []Peer) ([]*txn.TransactionProposalResponse, string, error)
 	QueryChannels(peer Peer) (*pb.ChannelQueryResponse, error)
 	QueryInstalledChaincodes(peer Peer) (*pb.ChaincodeQueryResponse, error)
 	GetIdentity() ([]byte, error)

api/fabricclient.go

@@ -9,7 +9,7 @@ package api
 import (
 	"encoding/pem"
 
-	"github.com/hyperledger/fabric-sdk-go/api/txnapi"
+	txn "github.com/hyperledger/fabric-sdk-go/api/apitxn"
 )
 
 // The Peer class represents a peer in the target blockchain network to which
@@ -26,7 +26,7 @@ import (
 // It should be noted that Peer event streams function at the Peer level and not at the
 // channel and chaincode levels.
 type Peer interface {
-	txnapi.TxnProposalProcessor
+	txn.ProposalProcessor
 
 	// Events (need verb)
 	ConnectEventSource()
@@ -45,3 +45,13 @@ type Peer interface {
 	SetRoles(roles []string)
 	URL() string
 }
+
+// PeersToTxnProcessors converts a slice of Peers to a slice of TxnProposalProcessors
+func PeersToTxnProcessors(peers []Peer) []txn.ProposalProcessor {
+	tpp := make([]txn.ProposalProcessor, len(peers))
+
+	for i := range peers {
+		tpp[i] = peers[i]
+	}
+	return tpp
+}

api/peer.go

@@ -18,8 +18,7 @@ import (
 	"strings"
 	"time"
 
-	api "github.com/hyperledger/fabric-sdk-go/api"
-
+	"github.com/hyperledger/fabric-sdk-go/api"
 	bccspFactory "github.com/hyperledger/fabric/bccsp/factory"
 	"github.com/op/go-logging"
 	"github.com/spf13/viper"

api/txnapi/mocks/mocktxnapi.gen.go

@@ -13,7 +13,7 @@ import (
 	"strings"
 	"testing"
 
-	api "github.com/hyperledger/fabric-sdk-go/api"
+	"github.com/hyperledger/fabric-sdk-go/api"
 	"github.com/spf13/viper"
 )