rfc0593

func GetCredentialSpec ¶

func GetCredentialSpec(p JSONLDDocumentLoaderProvider,
	formats []issuecredential.Format, attachments []decorator.Attachment) (*CredentialSpec, error)

GetCredentialSpec extracts the CredentialSpec from the formats and attachments.

func IssueCredential ¶

func IssueCredential(p Provider, msg service.DIDCommMsg) (interface{}, *CredentialSpecOptions, error)

IssueCredential attaches an LD proof to the template VC in the inbound request message and attaches the verifiable credential to an outbound issue-credential message.

Usage:

var p Provider = ...
client := issuecredential.Client = ...
var events chan service.DIDCommAction = ...
err := client.RegisterActionEvent(events)
if err != nil {
    panic(err)
}
for event := range events {
    if event.Message.Type() == issuecredential.RequestCredentialMsgType {
        arg, options, err := IssueCredential(p, event.Message)
        if errors.Is(err, ErrRFC0593NotApplicable) {
            // inspect and handle the event yourself
            arg, err = handleEvent(event)
        }

        if err != nil {
            event.Stop(err)
        }

        // inspect options

        event.Continue(arg)
    }
}

func ReplayOffer ¶

func ReplayOffer(p JSONLDDocumentLoaderProvider, msg service.DIDCommMsg) (interface{}, *CredentialSpecOptions, error)

ReplayOffer replays the inbound offered CredentialSpec as an outbound request that can be sent back to the original sender.

Usage:

var p JSONLDDocumentLoaderProvider = ...
client := issuecredential.Client = ...
var events chan service.DIDCommAction = ...
err := client.RegisterActionEvent(events)
if err != nil {
    panic(err)
}
for event := range events {
    if event.Message.Type() == issuecredential.OfferCredentialMsgType {
        arg, options, err := ReplayOffer(p, event.Message)
        if errors.Is(err, ErrRFC0593NotApplicable) {
            // inspect and handle the event yourself
            arg, err = handleEvent(event)
        }

        if err != nil {
            event.Stop(err)
        }

        // inspect options

        event.Continue(arg)
    }
}

func ReplayProposal ¶

func ReplayProposal(p JSONLDDocumentLoaderProvider,
	msg service.DIDCommMsg) (interface{}, *CredentialSpecOptions, error)

ReplayProposal replays the inbound proposed CredentialSpec as an outbound offer that can be sent back to the original sender.

Usage:

var p JSONLDDocumentLoaderProvider = ...
client := issuecredential.Client = ...
var events chan service.DIDCommAction = ...
err := client.RegisterActionEvent(events)
if err != nil {
    panic(err)
}
for event := range events {
    if event.Message.Type() == issuecredential.ProposeCredentialMsgType {
        arg, options, err := ReplayProposal(p, event.Message)
        if errors.Is(err, ErrRFC0593NotApplicable) {
            // inspect and handle the event yourself
            arg, err = handleEvent(event)
        }

        if err != nil {
            event.Stop(err)
        }

        // inspect options

        event.Continue(arg)
    }
}

func NewMiddleware ¶

func NewMiddleware(p TransientStorage) (Middleware, error)

NewMiddleware returns a new Middleware that can be used with the issuecredential protocol service in conjunction with AutoExecute when the protocol needs to be started with a request-credential message.

Usage:

framework, err := aries.New()
if err != nil {
    panic(err)
}
ctx, err := framework.Context()
if err != nil {
    panic(err)
}
mw, err := NewMiddleware(ctx)
if err != nil {
    panic(err)
}
err = RegisterMiddleware(mw, ctx)
if err != nil {
    panic(err)
}
client := issuecredential.Client = ...
events = make(chan service.DIDCommAction)
err := client.RegisterActionEvent(events)
if err != nil {
    panic(err)
}
next := make(chan service.DIDCommAction)
go AutoExecute(ctx, next)(events)
for event := range next {
    // handle events from issue-credential that do not conform to RFC0593
}

See also: AutoExecute.