spi

Documentation

Index

• Constants
• type Event
  • func NewEvent(uuid string, source string, eventType EventType) *Event
  • func NewEventWithPayload(uuid string, source string, eventType EventType, payload Payload) *Event
  • func (m *Event) Copy() *Event
• type EventType
• type Payload

Constants

const (
	// VerifierEventTopic verifier topic name.
	VerifierEventTopic = "vcs-verifier"
	// IssuerEventTopic issuer topic name.
	IssuerEventTopic = "vcs-issuer"
	// CredentialStatusEventTopic credential status topic name.
	CredentialStatusEventTopic = "vcs-credentialstatus"
)

Types

type Event

type Event struct {
	// SpecVersion is spec version(required).
	SpecVersion string `json:"specversion"`

	// ID identifies the event(required).
	ID string `json:"id"`

	// Source is URI for producer(required).
	Source string `json:"source"`

	// Type defines event type(required).
	Type EventType `json:"type"`

	// Time defines time of occurrence(required).
	Time *utiltime.TimeWrapper `json:"time"`

	// DataContentType is data content type(optional).
	DataContentType string `json:"datacontenttype,omitempty"`

	// Data defines message(optional).
	Data interface{} `json:"data,omitempty"`

	// TransactionID defines transaction ID(optional).
	TransactionID string `json:"txnid,omitempty"`

	// Subject defines subject(optional).
	Subject string `json:"subject,omitempty"`

	// Tracing defines tracing information(optional).
	Tracing string `json:"tracing,omitempty"`

	// RoutingKey is an optional key that is used by the event bus to determining how/where to route the event.
	RoutingKey string `json:"-"`
}

Event defines event.

func NewEvent

func NewEvent(uuid string, source string, eventType EventType) *Event

NewEvent creates a new Event and sets all required fields.

func NewEventWithPayload

func NewEventWithPayload(uuid string, source string, eventType EventType, payload Payload) *Event

NewEventWithPayload creates a new Event with payload.

func (*Event) Copy

func (m *Event) Copy() *Event

Copy an event.

type EventType

type EventType string

EventType event type.

const (
	// VerifierOIDCInteractionInitiated verifier oidc event.
	VerifierOIDCInteractionInitiated EventType = "verifier.oidc-interaction-initiated.v1"
	// VerifierOIDCInteractionQRScanned verifier oidc event.
	VerifierOIDCInteractionQRScanned EventType = "verifier.oidc-interaction-qr-scanned.v1"
	// VerifierOIDCInteractionSucceeded verifier oidc event.
	VerifierOIDCInteractionSucceeded EventType = "verifier.oidc-interaction-succeeded.v1"
	// VerifierOIDCInteractionFailed verifier oidc event.
	VerifierOIDCInteractionFailed          EventType = "verifier.oidc-interaction-failed.v1"
	VerifierOIDCInteractionClaimsRetrieved EventType = "verifier.oidc-interaction-claims-retrieved.v1"

	VerifierOIDCInteractionNoConsent    EventType = "verifier.oidc-interaction-no-consent.v1"
	VerifierOIDCInteractionNoMatchFound EventType = "verifier.oidc-interaction-no-match-found.v1"
	VerifierOIDCInteractionExpired      EventType = "verifier.oidc-interaction-expired.v1"

	// IssuerOIDCInteractionInitiated Issuer oidc event.
	IssuerOIDCInteractionInitiated EventType = "issuer.oidc-interaction-initiated.v1"
	// IssuerOIDCInteractionQRScanned Issuer oidc event.
	IssuerOIDCInteractionQRScanned EventType = "issuer.oidc-interaction-qr-scanned.v1"
	// IssuerOIDCInteractionSucceeded Issuer oidc event.
	IssuerOIDCInteractionSucceeded                    EventType = "issuer.oidc-interaction-succeeded.v1"
	IssuerOIDCInteractionAuthorizationRequestPrepared EventType = "issuer.oidc-interaction-authorization-request-prepared.v1" //nolint
	IssuerOIDCInteractionAuthorizationCodeStored      EventType = "issuer.oidc-interaction-authorization-code-stored.v1"      //nolint
	IssuerOIDCInteractionAuthorizationCodeExchanged   EventType = "issuer.oidc-interaction-authorization-code-exchanged.v1"   //nolint
	IssuerOIDCInteractionFailed                       EventType = "issuer.oidc-interaction-failed.v1"
	IssuerOIDCInteractionAckSucceeded                 EventType = "issuer.oidc-interaction-ack-succeeded.v1"
	IssuerOIDCInteractionAckFailed                    EventType = "issuer.oidc-interaction-ack-failed.v1"
	IssuerOIDCInteractionAckRejected                  EventType = "issuer.oidc-interaction-ack-rejected.v1"
	IssuerOIDCInteractionAckExpired                   EventType = "issuer.oidc-interaction-ack-expired.v1"

	CredentialStatusStatusUpdated EventType = "issuer.credential-status-updated.v1" //nolint:gosec

	CredentialRefreshInitiated  EventType = "issuer.credential-refresh-initiated.v1"  //nolint
	CredentialRefreshSuccessful EventType = "issuer.credential-refresh-successful.v1" //nolint
	CredentialRefreshFailed     EventType = "issuer.credential-refresh-failed.v1"     //nolint
)

type Payload

type Payload json.RawMessage

Payload defines payload.