fabric

Documentation

Index

• type Channel
• type Event
• type Factory
  • func NewFactory(config *environment.Config) (Factory, error)
• type Ledger
• type MSP
• type ResourceManagement
• type SDK

Types

type Channel

type Channel interface {
	Execute(request channel.Request, options ...channel.RequestOption) (channel.Response, error)
	InvokeHandler(handler invoke.Handler, request channel.Request, options ...channel.RequestOption) (channel.Response, error)
	Query(request channel.Request, options ...channel.RequestOption) (channel.Response, error)
	RegisterChaincodeEvent(chainCodeID string, eventFilter string) (fab.Registration, <-chan *fab.CCEvent, error)
	UnregisterChaincodeEvent(registration fab.Registration)
}

Channel defines the methods implemented by SDK channel client

type Event

type Event interface {
	RegisterBlockEvent(filter ...fab.BlockFilter) (fab.Registration, <-chan *fab.BlockEvent, error)
	RegisterChaincodeEvent(ccID, eventFilter string) (fab.Registration, <-chan *fab.CCEvent, error)
	RegisterFilteredBlockEvent() (fab.Registration, <-chan *fab.FilteredBlockEvent, error)
	RegisterTxStatusEvent(txID string) (fab.Registration, <-chan *fab.TxStatusEvent, error)
	Unregister(reg fab.Registration)
}

Event defines the methods implemented by SDK event client

type Factory

type Factory interface {
	SDK() (SDK, error)
	Channel() (Channel, error)
	Event() (Event, error)
	Ledger() (Ledger, error)
	ResourceManagement() (ResourceManagement, error)
	MSP() (MSP, error)
}

Factory provides abstractions for the various SDK clients

func NewFactory

func NewFactory(config *environment.Config) (Factory, error)

NewFactory creates a factory for the given profile/context

type Ledger

type Ledger interface {
	QueryBlock(blockNumber uint64, options ...ledger.RequestOption) (*common.Block, error)
	QueryBlockByHash(blockHash []byte, options ...ledger.RequestOption) (*common.Block, error)
	QueryBlockByTxID(txID fab.TransactionID, options ...ledger.RequestOption) (*common.Block, error)
	QueryConfig(options ...ledger.RequestOption) (fab.ChannelCfg, error)
	QueryInfo(options ...ledger.RequestOption) (*fab.BlockchainInfoResponse, error)
	QueryTransaction(transactionID fab.TransactionID, options ...ledger.RequestOption) (*pb.ProcessedTransaction, error)
}

Ledger defines the methods implemented by SDK ledger client

type MSP

type MSP interface {
	AddAffiliation(request *msp.AffiliationRequest) (*msp.AffiliationResponse, error)
	CreateIdentity(request *msp.IdentityRequest) (*msp.IdentityResponse, error)
	CreateSigningIdentity(opts ...mspctx.SigningIdentityOption) (mspctx.SigningIdentity, error)
	Enroll(enrollmentID string, opts ...msp.EnrollmentOption) error
	GetAffiliation(affiliation string, options ...msp.RequestOption) (*msp.AffiliationResponse, error)
	GetAllAffiliations(options ...msp.RequestOption) (*msp.AffiliationResponse, error)
	GetAllIdentities(options ...msp.RequestOption) ([]*msp.IdentityResponse, error)
	GetCAInfo() (*msp.GetCAInfoResponse, error)
	GetIdentity(ID string, options ...msp.RequestOption) (*msp.IdentityResponse, error)
	GetSigningIdentity(id string) (mspctx.SigningIdentity, error)
	ModifyAffiliation(request *msp.ModifyAffiliationRequest) (*msp.AffiliationResponse, error)
	ModifyIdentity(request *msp.IdentityRequest) (*msp.IdentityResponse, error)
	Reenroll(enrollmentID string, opts ...msp.EnrollmentOption) error
	Register(request *msp.RegistrationRequest) (string, error)
	RemoveAffiliation(request *msp.AffiliationRequest) (*msp.AffiliationResponse, error)
	RemoveIdentity(request *msp.RemoveIdentityRequest) (*msp.IdentityResponse, error)
	Revoke(request *msp.RevocationRequest) (*msp.RevocationResponse, error)
}

MSP defines the methods implemented by SDK msp client

type ResourceManagement

type ResourceManagement interface {
	CreateConfigSignature(signer mspctx.SigningIdentity, channelConfigPath string) (*common.ConfigSignature, error)
	CreateConfigSignatureData(signer mspctx.SigningIdentity, channelConfigPath string) (signatureHeaderData resource.ConfigSignatureData, e error)
	InstallCC(req resmgmt.InstallCCRequest, options ...resmgmt.RequestOption) ([]resmgmt.InstallCCResponse, error)
	InstantiateCC(channelID string, req resmgmt.InstantiateCCRequest, options ...resmgmt.RequestOption) (resmgmt.InstantiateCCResponse, error)
	JoinChannel(channelID string, options ...resmgmt.RequestOption) error
	QueryChannels(options ...resmgmt.RequestOption) (*pb.ChannelQueryResponse, error)
	QueryCollectionsConfig(channelID string, chaincodeName string, options ...resmgmt.RequestOption) (*pb.CollectionConfigPackage, error)
	QueryConfigFromOrderer(channelID string, options ...resmgmt.RequestOption) (fab.ChannelCfg, error)
	QueryInstalledChaincodes(options ...resmgmt.RequestOption) (*pb.ChaincodeQueryResponse, error)
	QueryInstantiatedChaincodes(channelID string, options ...resmgmt.RequestOption) (*pb.ChaincodeQueryResponse, error)
	SaveChannel(req resmgmt.SaveChannelRequest, options ...resmgmt.RequestOption) (resmgmt.SaveChannelResponse, error)
	UpgradeCC(channelID string, req resmgmt.UpgradeCCRequest, options ...resmgmt.RequestOption) (resmgmt.UpgradeCCResponse, error)
	LifecycleInstallCC(req resmgmt.LifecycleInstallCCRequest, options ...resmgmt.RequestOption) ([]resmgmt.LifecycleInstallCCResponse, error)
	LifecycleApproveCC(channelID string, req resmgmt.LifecycleApproveCCRequest, options ...resmgmt.RequestOption) (fab.TransactionID, error)
	LifecycleCommitCC(channelID string, req resmgmt.LifecycleCommitCCRequest, options ...resmgmt.RequestOption) (fab.TransactionID, error)
	LifecycleQueryInstalledCC(options ...resmgmt.RequestOption) ([]resmgmt.LifecycleInstalledCC, error)
	LifecycleGetInstalledCCPackage(packageID string, options ...resmgmt.RequestOption) ([]byte, error)
	LifecycleQueryApprovedCC(channelID string, req resmgmt.LifecycleQueryApprovedCCRequest,
		options ...resmgmt.RequestOption) (resmgmt.LifecycleApprovedChaincodeDefinition, error)
	LifecycleCheckCCCommitReadiness(channelID string, req resmgmt.LifecycleCheckCCCommitReadinessRequest,
		options ...resmgmt.RequestOption) (resmgmt.LifecycleCheckCCCommitReadinessResponse, error)
	LifecycleQueryCommittedCC(channelID string, req resmgmt.LifecycleQueryCommittedCCRequest,
		options ...resmgmt.RequestOption) ([]resmgmt.LifecycleChaincodeDefinition, error)
}

ResourceManagement defines the methods implemented by SDK resmgmt client

type SDK

type SDK interface {
	ChannelContext(channelID string, options ...fabsdk.ContextOption) context.ChannelProvider
	Context(options ...fabsdk.ContextOption) context.ClientProvider
	Config() (core.ConfigBackend, error)
	CloseContext(ctxt fab.ClientContext)
	Close()
}

SDK defines the context methods for the various SDK clients