dataexchange

type Callbacks interface {
	// Event has sub-types as defined below, and can be processed and ack'd asynchronously
	DXEvent(plugin Plugin, event DXEvent) error
}

type Capabilities struct {
	// Manifest - whether TransferResult events contain the manifest generated by the receiving FireFly
	Manifest bool
}

type DXEvent interface {
	EventID() string
	Ack()
	AckWithManifest(manifest string)
	Type() DXEventType
	MessageReceived() *MessageReceived
	PrivateBlobReceived() *PrivateBlobReceived
}

type DXEventType int

type MessageReceived struct {
	PeerID    string
	Transport *core.TransportWrapper
}

type Plugin interface {
	core.Named

	// InitConfig initializes the set of configuration options that are valid, with defaults. Called on all plugins.
	InitConfig(config config.Section)

	// Init initializes the plugin, with configuration
	Init(ctx context.Context, cancelCtx context.CancelFunc, config config.Section) error

	// SetHandler registers a handler to receive callbacks
	// Plugin will attempt (but is not guaranteed) to deliver events only for the given namespace and node
	SetHandler(networkNamespace, nodeName string, handler Callbacks)

	// SetOperationHandler registers a handler to receive async operation status
	// If namespace is set, plugin will attempt to deliver only events for that namespace
	SetOperationHandler(namespace string, handler core.OperationCallbacks)

	// Data exchange interface must not deliver any events until start is called
	Start() error

	// Capabilities returns capabilities - not called until after Init
	Capabilities() *Capabilities

	// GetEndpointInfo returns the information about the local endpoint
	GetEndpointInfo(ctx context.Context, nodeName string) (peer fftypes.JSONObject, err error)

	// AddNode registers details on a node in the multiparty network
	// This may be information loaded from the database at init, or received in flight while running
	AddNode(ctx context.Context, networkNamespace, nodeName string, peer fftypes.JSONObject) (err error)

	// UploadBlob streams a blob to storage, and returns the hash to confirm the hash calculated in Core matches the hash calculated in the plugin
	UploadBlob(ctx context.Context, ns string, id fftypes.UUID, content io.Reader) (payloadRef string, hash *fftypes.Bytes32, size int64, err error)

	// DownloadBlob streams a received blob out of storage
	DownloadBlob(ctx context.Context, payloadRef string) (content io.ReadCloser, err error)

	// DeleteBlob streams a deletes a blob from the local DB and DX
	DeleteBlob(ctx context.Context, payloadRef string) (err error)

	// SendMessage sends an in-line package of data to another network node.
	// Should return as quickly as possible for parallelism, then report completion asynchronously via the operation ID
	SendMessage(ctx context.Context, nsOpID string, peer, sender fftypes.JSONObject, data []byte) (err error)

	// TransferBlob initiates a transfer of a previously stored blob to another node
	TransferBlob(ctx context.Context, nsOpID string, peer, sender fftypes.JSONObject, payloadRef string) (err error)

	// GetPeerID extracts the peer ID from the peer JSON
	GetPeerID(peer fftypes.JSONObject) string
}

type PrivateBlobReceived struct {
	Namespace  string
	PeerID     string
	Hash       fftypes.Bytes32
	Size       int64
	PayloadRef string
	DataID     string
}