definitions

Documentation

Index

• func NewDefinitionSender(ctx context.Context, ns *core.Namespace, multiparty bool, di database.Plugin, ...) (Sender, Handler, error)
• type DefinitionMessageAction
  • func (dma DefinitionMessageAction) String() string
• type Handler
• type HandlerResult
• type Sender

Functions

func NewDefinitionSender

func NewDefinitionSender(ctx context.Context, ns *core.Namespace, multiparty bool, di database.Plugin, bi blockchain.Plugin, dx dataexchange.Plugin, bm broadcast.Manager, im identity.Manager, dm data.Manager, am assets.Manager, cm contracts.Manager, tokenBroadcastNames map[string]string) (Sender, Handler, error)

Types

type DefinitionMessageAction

type DefinitionMessageAction int

DefinitionMessageAction is the action to be taken on an individual definition message

const (
	// ActionReject the message was successfully processed, but was malformed/invalid and should be marked as rejected
	ActionReject DefinitionMessageAction = iota

	// ActionConfirm the message was valid and should be confirmed
	ActionConfirm

	// ActionRetry a recoverable error was encountered - batch should be halted and then re-processed from the start
	ActionRetry

	// ActionWait the message is still awaiting further pieces for aggregation and should be held in pending state
	ActionWait
)

func (DefinitionMessageAction) String

func (dma DefinitionMessageAction) String() string

type Handler

type Handler interface {
	HandleDefinitionBroadcast(ctx context.Context, state *core.BatchState, msg *core.Message, data core.DataArray, tx *fftypes.UUID) (HandlerResult, error)
}

type HandlerResult

type HandlerResult struct {
	Action           DefinitionMessageAction
	CustomCorrelator *fftypes.UUID
}

type Sender

type Sender interface {
	core.Named

	ClaimIdentity(ctx context.Context, def *core.IdentityClaim, signingIdentity *core.SignerRef, parentSigner *core.SignerRef, waitConfirm bool) error
	UpdateIdentity(ctx context.Context, identity *core.Identity, def *core.IdentityUpdate, signingIdentity *core.SignerRef, waitConfirm bool) error
	DefineDatatype(ctx context.Context, datatype *core.Datatype, waitConfirm bool) error
	DefineTokenPool(ctx context.Context, pool *core.TokenPoolAnnouncement, waitConfirm bool) error
	DefineFFI(ctx context.Context, ffi *fftypes.FFI, waitConfirm bool) error
	DefineContractAPI(ctx context.Context, httpServerURL string, api *core.ContractAPI, waitConfirm bool) error
}