api

type BlockEvent struct {
	Block *cb.Block
}

type CCEvent struct {
	TxID        string
	ChaincodeID string
	EventName   string
}

type EventService interface {
	FilteredEventService

	// RegisterBlockEvent registers for block events. If the client is not authorized to receive
	// block events then an error is returned.
	RegisterBlockEvent() (Registration, <-chan *BlockEvent, error)
}

type FilteredBlockEvent struct {
	FilteredBlock *pb.FilteredBlock
}

type FilteredEventService interface {
	// RegisterFilteredBlockEvent registers for filtered block events. If the client is not authorized to receive
	// filtered block events then an error is returned.
	// - Returns the registration and a channel that is used to receive events
	RegisterFilteredBlockEvent() (Registration, <-chan *FilteredBlockEvent, error)

	// RegisterChaincodeEvent registers for chaincode events. If the client is not authorized to receive
	// chaincode events then an error is returned.
	// - ccID is the chaincode ID for which events are to be received
	// - eventFilter is the chaincode event filter (regular expression) for which events are to be received
	RegisterChaincodeEvent(ccID, eventFilter string) (Registration, <-chan *CCEvent, error)

	// RegisterTxStatusEvent registers for transaction status events. If the client is not authorized to receive
	// transaction status events then an error is returned.
	// - txID is the transaction ID for which events are to be received
	RegisterTxStatusEvent(txID string) (Registration, <-chan *TxStatusEvent, error)

	// Unregister unregisters the given registration.
	// - reg is the registration handle that was returned from one of the RegisterXXX functions
	Unregister(reg Registration)
}

type Registration interface{}

type RegistrationResponse struct {
	// Reg is a handle to the registration
	Reg Registration

	// Err contains the error if registration is unsuccessful
	Err error
}

type TxStatusEvent struct {
	TxID             string
	TxValidationCode pb.TxValidationCode
}