common

Documentation

Index

• func GetNamespaceFromSubName(subName string) string
• func HandleReceipt(ctx context.Context, plugin core.Named, reply *BlockchainReceiptNotification, ...) error
• type BatchPinParams
• type BlockchainCallbacks
  • func NewBlockchainCallbacks() BlockchainCallbacks
• type BlockchainReceiptHeaders
• type BlockchainReceiptNotification
• type FireflySubscriptions
  • func NewFireflySubscriptions() FireflySubscriptions
• type SubscriptionInfo

Functions

func GetNamespaceFromSubName

func GetNamespaceFromSubName(subName string) string

func HandleReceipt

func HandleReceipt(ctx context.Context, plugin core.Named, reply *BlockchainReceiptNotification, callbacks BlockchainCallbacks) error

Common function for handling receipts from blockchain connectors.

Types

type BatchPinParams

type BatchPinParams struct {
	UUIDs      string
	BatchHash  string
	Contexts   []string
	PayloadRef string
	NsOrAction string
}

type BlockchainCallbacks

type BlockchainCallbacks interface {
	SetHandler(namespace string, handler blockchain.Callbacks)
	SetOperationalHandler(namespace string, handler core.OperationCallbacks)

	OperationUpdate(ctx context.Context, plugin core.Named, nsOpID string, status core.OpStatus, blockchainTXID, errorMessage string, opOutput fftypes.JSONObject)
	BatchPinOrNetworkAction(ctx context.Context, subInfo *SubscriptionInfo, location *fftypes.JSONAny, event *blockchain.Event, signingKey *core.VerifierRef, params *BatchPinParams) error
	BlockchainEvent(ctx context.Context, namespace string, event *blockchain.EventWithSubscription) error
}

func NewBlockchainCallbacks

func NewBlockchainCallbacks() BlockchainCallbacks

type BlockchainReceiptHeaders

type BlockchainReceiptHeaders struct {
	ReceiptID string `json:"requestId,omitempty"`
	ReplyType string `json:"type,omitempty"`
}

type BlockchainReceiptNotification

type BlockchainReceiptNotification struct {
	Headers          BlockchainReceiptHeaders `json:"headers,omitempty"`
	TxHash           string                   `json:"transactionHash,omitempty"`
	Message          string                   `json:"errorMessage,omitempty"`
	ProtocolID       string                   `json:"protocolId,omitempty"`
	ContractLocation *fftypes.JSONAny         `json:"contractLocation,omitempty"`
}

type FireflySubscriptions

type FireflySubscriptions interface {
	AddSubscription(ctx context.Context, namespace *core.Namespace, version int, subID string, extra interface{})
	RemoveSubscription(ctx context.Context, subID string)
	GetSubscription(subID string) *SubscriptionInfo
}

func NewFireflySubscriptions

func NewFireflySubscriptions() FireflySubscriptions

type SubscriptionInfo

type SubscriptionInfo struct {
	Version     int
	V1Namespace map[string][]string
	V2Namespace string
	Extra       interface{}
}

A single subscription on network version 1 may receive events from many remote namespaces, which in turn map to one or more local namespaces. A subscription on network version 2 is always specific to a single local namespace.