identity

Documentation

Index

• type Callbacks
• type Capabilities
• type Plugin

Types

type Callbacks

type Callbacks interface {
}

Callbacks is the interface provided to the identity plugin, to allow it to request information from firefly, or pass events.

type Capabilities

type Capabilities struct {
}

Capabilities the supported featureset of the identity interface implemented by the plugin, with the specified config

type Plugin

type Plugin interface {
	fftypes.Named

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

	// Init initializes the plugin, with configuration
	// Returns the supported featureset of the interface
	Init(ctx context.Context, prefix config.Prefix, callbacks Callbacks) error

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

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

	// Resolve maps an identity identifier passed in a message to a full identity that includes the signing identity
	Resolve(ctx context.Context, identifier string) (identity *fftypes.Identity, err error)
}

Plugin is the interface implemented by each identity plugin