aries

Documentation

Overview

Package aries is implementation package for didcomm messages. See related package mesg which is for our legacy messages. Both aries and mesg messages share same interfaces defined in the didcomm package. didcomm defines a message factor interfaces as well. With the help of the factoring system, the actual messages can be constructed from the incoming messages with the correct type. We use statically typed JSON messages i.e. they are always mapped to corresponding Go struct.

Index

• Variables
• func ProtocolForType(typeStr string) string
• func ProtocolMsgForType(typeStr string) string
• type Factor
  • func (f *Factor) Add(t string, factor didcomm.Factor)
• type Msg
  • func (m *Msg) SetEndpoint(ae service.Addr)
  • func (m *Msg) SetRcvrEndp(ae service.Addr)
• type MsgFactor
  • func (f MsgFactor) Create(d didcomm.MsgInit) didcomm.MessageHdr
  • func (f MsgFactor) NewMessage(data []byte) didcomm.MessageHdr
  • func (f MsgFactor) NewMsg(init didcomm.MsgInit) didcomm.MessageHdr
• type PayloadFactor
  • func (f PayloadFactor) New(pi didcomm.PayloadInit) didcomm.Payload
  • func (f PayloadFactor) NewFromData(data []byte) didcomm.Payload
  • func (f PayloadFactor) NewMsg(id, t string, m didcomm.MessageHdr) didcomm.Payload
• type PayloadImpl
  • func (pl *PayloadImpl) Creator() didcomm.PayloadFactor
  • func (pl *PayloadImpl) Data() []byte
  • func (pl *PayloadImpl) FieldObj() interface{}
  • func (pl *PayloadImpl) ID() string
  • func (pl *PayloadImpl) Message() didcomm.Msg
  • func (pl *PayloadImpl) MsgCreator() didcomm.MsgFactor
  • func (pl *PayloadImpl) MsgHdr() didcomm.MessageHdr
  • func (pl *PayloadImpl) Namespace() string
  • func (pl *PayloadImpl) Protocol() string
  • func (pl *PayloadImpl) ProtocolMsg() string
  • func (pl *PayloadImpl) SetThread(t *decorator.Thread)
  • func (pl *PayloadImpl) ThreadID() string
  • func (pl *PayloadImpl) Type() string

Variables

var Creator = &Factor{factors: make(map[string]didcomm.Factor)}

var MsgCreator = MsgFactor{}

var PayloadCreator = PayloadFactor{}

Functions

func ProtocolForType

func ProtocolForType(typeStr string) string

func ProtocolMsgForType

func ProtocolMsgForType(typeStr string) string

Types

type Factor

type Factor struct {
	// contains filtered or unexported fields
}

func (*Factor) Add

func (f *Factor) Add(t string, factor didcomm.Factor)

type Msg

type Msg struct {
	Type string `json:"@type,omitempty"`
	AID  string `json:"@id,omitempty"`

	Thread *decorator.Thread `json:"~thread,omitempty"`

	Error      string                 `json:"error,omitempty"`        // If error happens includes error msg
	Did        string                 `json:"did,omitempty"`          // Usually senders DID and corresponding VerKey
	VerKey     string                 `json:"verkey,omitempty"`       // Senders Verkey for DID
	RcvrEndp   string                 `json:"rcvr_endp,omitempty"`    // Receivers own endpoint, usually the public URL
	RcvrKey    string                 `json:"rcvr_key,omitempty"`     // Receiver endpoint ver key
	Endpoint   string                 `json:"endpoint,omitempty"`     // Multipurpose field which still is under design
	EndpVerKey string                 `json:"endp_ver_key,omitempty"` // VerKey associated to endpoint i.e. payload verkey
	Name       string                 `json:"name,omitempty"`         // Multipurpose field which still is under design
	Info       string                 `json:"info,omitempty"`         // Used for transferring additional info like the Msg in IM-cases, and Pairwise name
	ID         string                 `json:"id,omitempty"`           // Used for transferring additional ID like the Cred Def ID
	Ready      bool                   `json:"ready,omitempty"`        // In queries tells if something is ready when true
	Msg        map[string]interface{} `json:"msg,omitempty"`          // Forwarded message
}

func (*Msg) SetEndpoint

func (m *Msg) SetEndpoint(ae service.Addr)

func (*Msg) SetRcvrEndp

func (m *Msg) SetRcvrEndp(ae service.Addr)

type MsgFactor

type MsgFactor struct{}

func (MsgFactor) Create

func (f MsgFactor) Create(d didcomm.MsgInit) didcomm.MessageHdr

func (MsgFactor) NewMessage

func (f MsgFactor) NewMessage(data []byte) didcomm.MessageHdr

func (MsgFactor) NewMsg

func (f MsgFactor) NewMsg(init didcomm.MsgInit) didcomm.MessageHdr

type PayloadFactor

type PayloadFactor struct{}

func (PayloadFactor) New

func (f PayloadFactor) New(pi didcomm.PayloadInit) didcomm.Payload

New creates a new Aries PL with PayloadInit struct. The type of the Msg is generic.

func (PayloadFactor) NewFromData

func (f PayloadFactor) NewFromData(data []byte) didcomm.Payload

NewFromData creates a new Aries PL in correct Go struct type. If @Type is associated to Go struct type which is registered to this Factor, it's used. If not a generic type is used.

func (PayloadFactor) NewMsg

func (f PayloadFactor) NewMsg(id, t string, m didcomm.MessageHdr) didcomm.Payload

NewMsg creates a new PL by ID, Type and already created internal Msg.

type PayloadImpl

type PayloadImpl struct {
	didcomm.MessageHdr
}

func (*PayloadImpl) Creator

func (pl *PayloadImpl) Creator() didcomm.PayloadFactor

func (*PayloadImpl) Data

func (pl *PayloadImpl) Data() []byte

func (*PayloadImpl) FieldObj

func (pl *PayloadImpl) FieldObj() interface{}

func (*PayloadImpl) ID

func (pl *PayloadImpl) ID() string

func (*PayloadImpl) Message

func (pl *PayloadImpl) Message() didcomm.Msg

func (*PayloadImpl) MsgCreator

func (pl *PayloadImpl) MsgCreator() didcomm.MsgFactor

func (*PayloadImpl) MsgHdr

func (pl *PayloadImpl) MsgHdr() didcomm.MessageHdr

func (*PayloadImpl) Namespace

func (pl *PayloadImpl) Namespace() string

func (*PayloadImpl) Protocol

func (pl *PayloadImpl) Protocol() string

func (*PayloadImpl) ProtocolMsg

func (pl *PayloadImpl) ProtocolMsg() string

func (*PayloadImpl) SetThread

func (pl *PayloadImpl) SetThread(t *decorator.Thread)

func (*PayloadImpl) ThreadID

func (pl *PayloadImpl) ThreadID() string

func (*PayloadImpl) Type

func (pl *PayloadImpl) Type() string