messaging

README

Messaging

This library contains default golang message structures and types which are used by the micro services as data contract for communication.

Documentation

Index

• Constants
• type CreateKeyReply
• type CreateKeyRequest
• type CreateStatusListEntryReply
• type CreateStatusListEntryRequest
• type CreateTokenReply
• type CreateTokenRequest
• type GetIssuerMetadataReply
• type GetIssuerMetadataReq
• type HistoryRecord
• type IssuanceReply
• type IssuanceRequest
• type IssuerRegistration
• type RecordEventType
  • func RecordEventTypes() []RecordEventType
• type RetrievalAcceptanceNotification
• type RetrievalNotification
• type RetrievalOffering
• type StorageServiceStoreMessage
• type VerifyStatusListEntryReply
• type VerifyStatusListEntryRequest

Constants

const (
	EventTypeRetrievalExternal               = "retrieval.offering.external"
	EventTypeRetrievalAcceptanceNotification = "retrieval.offering.acceptance"
	EventTypeRetrievalReceivedNotification   = "retrieval.offering.received"
	TopicRetrevialSubscription               = "retrieval.offering.subscription"
	TopicRetrevialPublication                = "retrieval.offering.publication"
)

const (
	SignerServiceCreateKeyType string = "signer.createKey"
	SignerServiceSignTokenType string = "signer.signToken"
	SignerServiceErrorType     string = "signer.error"
)

const (
	EventTypeStatus       = "status.data"
	TopicStatusData       = "status.data.create"
	TopicStatusDataVerify = "status.data.verify"
)

const (
	StorePresentationType = "storage.service.presentation"
	StoreCredentialType   = "storage.service.credential"
	StorageTopic          = "storage.service.store"
)

const (
	TopicGetIssuerMetadata     = "wellknown.issuer.metadata"
	EventTypeGetIssuerMetadata = "wellknown.issuer.metadata"
)

const (
	TopicIssuerRegistration     = "wellknown.issuer.registration"
	EventTypeIssuerRegistration = "wellknown.issuer.registration"
)

const (
	EventTypeIssuance = "issuance.request"
)

const SourceWellKnownService = "wellknown"

Types

type CreateKeyReply

type CreateKeyReply struct {
	common.Reply
}

type CreateKeyRequest

type CreateKeyRequest struct {
	common.Request
	Namespace string `json:"namespace"`
	Group     string `json:"group"`
	Key       string `json:"key"`
	Type      string `json:"type"`
}

type CreateStatusListEntryReply

type CreateStatusListEntryReply struct {
	common.Reply
	Index     int    `json:"index"`
	StatusUrl string `json:"statusUrl"`
	Type      string `json:"type"`
	Purpose   string `json:"purpose"`
}

type CreateStatusListEntryRequest

type CreateStatusListEntryRequest struct {
	common.Request
	Origin string `json:"origin"`
}

type CreateTokenReply

type CreateTokenReply struct {
	common.Reply
	Token []byte `json:"token"`
}

type CreateTokenRequest

type CreateTokenRequest struct {
	common.Request
	Namespace string `json:"namespace"`
	Group     string `json:"group"`
	Key       string `json:"key"`
	Payload   []byte `json:"payload"`
	Header    []byte `json:"header"`
}

type GetIssuerMetadataReply

type GetIssuerMetadataReply struct {
	common.Reply
	Issuer *credential.IssuerMetadata
}

type GetIssuerMetadataReq

type GetIssuerMetadataReq struct {
	common.Request
	Format *string
}

type HistoryRecord

type HistoryRecord struct {
	common.Reply
	UserId  string `json:"user_id"`
	Message string `json:"message"`
}

type IssuanceReply

type IssuanceReply struct {
	common.Reply
	Offer credential.CredentialOffer `json:"offer"`
}

type IssuanceRequest

type IssuanceRequest struct {
	common.Request
	Identifier string                 `json:"identifier"`
	Payload    map[string]interface{} `json:"payload"`
}

type IssuerRegistration

type IssuerRegistration struct {
	common.Request
	Issuer credential.IssuerMetadata `json:"issuer"`
}

type RecordEventType

type RecordEventType string

const (
	Consent             RecordEventType = "consent"
	Pairing             RecordEventType = "pairing"
	Issued              RecordEventType = "issued"
	Presented           RecordEventType = "presented"
	Revoked             RecordEventType = "revoked"
	PresentationRequest RecordEventType = "presentationRequest"
	DeviceConnection    RecordEventType = "device.connection"
)

func RecordEventTypes

func RecordEventTypes() []RecordEventType

type RetrievalAcceptanceNotification

type RetrievalAcceptanceNotification struct {
	common.Request
	OfferingId      string `json:"offeringId"`
	Message         string `json:"message"`
	Result          bool   `json:"result"`
	HolderKey       string `json:"holderKey`
	HolderNamespace string `json:"holderNamespace`
	HolderGroup     string `json:"holderGroup`
	TxCode          string `json:"tx_code`
}

Notification when something was accepted --> EventTypeRetrievalAcceptanceNotification

type RetrievalNotification

type RetrievalNotification struct {
	common.Request
	Offer credential.CredentialOfferParameters `json:"offerParams"`
}

Notification when something was received --> EventTypeRetrievalReceivedNotification

type RetrievalOffering

type RetrievalOffering struct {
	common.Request
	Offer credential.CredentialOffer `json:"offer"`
}

Incoming Event for Offerings --> EventTypeRetrievalExternal

type StorageServiceStoreMessage

type StorageServiceStoreMessage struct {
	common.Request
	AccountId   string `json:"accountId"`
	Type        string `json:"type"`
	Payload     []byte `json:"payload"`
	ContentType string `json:"contentType"`
	Id          string `json:"id"`
}

type VerifyStatusListEntryReply

type VerifyStatusListEntryReply struct {
	common.Reply
	Revocated bool `json:"revocated"`
	Suspended bool `json:"suspended"`
}

type VerifyStatusListEntryRequest

type VerifyStatusListEntryRequest struct {
	common.Request
	Index     int    `json:"index"`
	StatusUrl string `json:"statusUrl"`
	Type      string `json:"type"`
	Purpose   string `json:"purpose"`
}