invitation

Documentation

Index

• Constants
• func Build(inv Invitation) (s string, err error)
• type AgentInfo
• type DIDExchangeVersion
• type Invitation
  • func Create(version DIDExchangeVersion, info AgentInfo) (inv Invitation, err error)
  • func CreateInvitationV0(info *AgentInfo) Invitation
  • func CreateInvitationV1(info *AgentInfo) Invitation
  • func Translate(s string) (i Invitation, err error)
• type ServiceEndpoint
  • func (s ServiceEndpoint) RecipientKeysAsB58() []string
  • func (s ServiceEndpoint) RoutingKeysAsB58() []string
• type V0
• type V1
• type V1Service

Constants

const DIDKeyPrefix = "did:key"

Functions

func Build

func Build(inv Invitation) (s string, err error)

Types

type AgentInfo

type AgentInfo struct {
	InvitationType string
	InvitationID   string
	EndpointURL    string
	RecipientKey   string
	AgentLabel     string
}

type DIDExchangeVersion

type DIDExchangeVersion int

const (
	DIDExchangeVersionV0 DIDExchangeVersion = 0
	DIDExchangeVersionV1 DIDExchangeVersion = 10
	DIDExchangeVersionV2 DIDExchangeVersion = 20
)

type Invitation

type Invitation interface {
	Build() (string, error)
	Version() DIDExchangeVersion
	Type() string
	ID() string
	Label() string
	Services() []ServiceEndpoint
	ImageURL() string
	Accept() []string
	HandshakeProtocols() []string
}

func Create

func Create(version DIDExchangeVersion, info AgentInfo) (inv Invitation, err error)

func CreateInvitationV0

func CreateInvitationV0(info *AgentInfo) Invitation

func CreateInvitationV1

func CreateInvitationV1(info *AgentInfo) Invitation

func Translate

func Translate(s string) (i Invitation, err error)

type ServiceEndpoint

type ServiceEndpoint struct {
	ID              string
	ServiceEndpoint string
	Type            string
	RecipientKeys   []string
	RoutingKeys     []string
}

func (ServiceEndpoint) RecipientKeysAsB58

func (s ServiceEndpoint) RecipientKeysAsB58() []string

func (ServiceEndpoint) RoutingKeysAsB58

func (s ServiceEndpoint) RoutingKeysAsB58() []string

type V0

type V0 struct {
	// the Image URL of the connection invitation
	ImageURL string `json:"imageUrl,omitempty"`

	// the Service endpoint of the connection invitation
	ServiceEndpoint string `json:"serviceEndpoint,omitempty"`

	// the RecipientKeys for the connection invitation
	RecipientKeys []string `json:"recipientKeys,omitempty"`

	// the ID of the connection invitation
	ID string `json:"@id,omitempty"`

	// the Label of the connection invitation
	Label string `json:"label,omitempty"`

	// the RoutingKeys of the connection invitation
	RoutingKeys []string `json:"routingKeys,omitempty"`

	// the Type of the connection invitation
	Type string `json:"@type,omitempty"`
}

type V1

type V1 struct {
	// the Type of the connection invitation
	Type string `json:"@type,omitempty"`

	// the ID of the connection invitation
	ID string `json:"@id,omitempty"`

	// the Label of the connection invitation
	Label string `json:"label,omitempty"`

	Accept []string `json:"accept,omitempty"`

	HandshakeProtocols []string `json:"handshake_protocols,omitempty"`

	Services []V1Service `json:"services,omitempty"`

	// the Image URL of the connection invitation
	ImageURL string `json:"imageUrl,omitempty"`
}

type V1Service

type V1Service struct {
	ID              string   `json:"id,omitempty"`
	ServiceEndpoint string   `json:"serviceEndpoint,omitempty"`
	Type            string   `json:"type,omitempty"`
	RecipientKeys   []string `json:"recipientKeys,omitempty"`
	RoutingKeys     []string `json:"routingKeys,omitempty"`
}