presentproof

type Action struct {
	// Protocol instance ID
	PIID     string
	Msg      service.DIDCommMsgMap
	MyDID    string
	TheirDID string
}

type Format struct {
	AttachID string `json:"attach_id,omitempty"`
	Format   string `json:"format,omitempty"`
}

type Handler interface {
	Handle(metadata Metadata) error
}

type HandlerFunc func(metadata Metadata) error

type Metadata interface {
	// Message contains the original inbound/outbound message
	Message() service.DIDCommMsg
	// Presentation is pointer to the message provided by the user through the Continue function.
	Presentation() *PresentationV2
	// ProposePresentation is pointer to the message provided by the user through the Continue function.
	ProposePresentation() *ProposePresentationV2
	// RequestPresentation is pointer to the message provided by the user through the Continue function.
	RequestPresentation() *RequestPresentationV2
	// PresentationV3 is pointer to the message provided by the user through the Continue function.
	PresentationV3() *PresentationV3
	// ProposePresentationV3 is pointer to the message provided by the user through the Continue function.
	ProposePresentationV3() *ProposePresentationV3
	// RequestPresentationV3 is pointer to the message provided by the user through the Continue function.
	RequestPresentationV3() *RequestPresentationV3
	// PresentationNames is a slice which contains presentation names provided by the user through the Continue function.
	PresentationNames() []string
	// StateName provides the state name
	StateName() string
	// Properties provides the possibility to set properties
	Properties() map[string]interface{}
	// GetAddProofFn provides function to sign the Presentation.
	GetAddProofFn() func(presentation *verifiable.Presentation) error
}

type Middleware func(next Handler) Handler

type Opt func(md *metaData)

type PresentationParams struct {
	// Comment is a field that provides some human readable information about the provided presentation.
	// TODO: Should follow DIDComm conventions for l10n. [Issue #1300].
	Comment string
	// Formats contains an entry for each presentations~attach array entry, providing the the value of the attachment
	// @id and the verifiable presentation format and version of the attachment.
	Formats []Format
	// Attachments is an array of attachments containing verifiable presentations.
	Attachments []decorator.GenericAttachment
	// GoalCode is an optional goal code to indicate the intended use of the provided presentation(s).
	GoalCode string
}

type PresentationV2 struct {
	ID   string `json:"@id,omitempty"`
	Type string `json:"@type,omitempty"`
	// Comment is a field that provides some human readable information about the proposed presentation.
	// TODO: Should follow DIDComm conventions for l10n. [Issue #1300].
	Comment string `json:"comment,omitempty"`
	// Formats contains an entry for each presentations~attach array entry, providing the the value of the attachment
	// @id and the verifiable presentation format and version of the attachment.
	Formats []Format `json:"formats,omitempty"`
	// PresentationsAttach an array of attachments containing the presentation in the requested format(s).
	PresentationsAttach []decorator.Attachment `json:"presentations~attach,omitempty"`
}

type PresentationV3 struct {
	Type string             `json:"type,omitempty"`
	Body PresentationV3Body `json:"body,omitempty"`
	// Attachments is an array of attachments that further define the presentation request being proposed.
	// This might be used to clarify which formats or format versions are wanted.
	Attachments []decorator.AttachmentV2 `json:"attachments,omitempty"`
}

type PresentationV3Body struct {
	GoalCode string `json:"goal_code,omitempty"`
	// Comment is a field that provides some human readable information about the proposed presentation.
	// TODO: Should follow DIDComm conventions for l10n. [Issue #1300]
	Comment string `json:"comment,omitempty"`
}

type ProposePresentationParams struct {
	// Comment is a field that provides some human readable information about the proposed presentation.
	// TODO: Should follow DIDComm conventions for l10n. [Issue #1300]
	Comment string
	// Formats contains an entry for each proposal~attach array entry, including an optional value of the
	// attachment @id (if attachments are present) and the verifiable presentation format and version of the attachment.
	Formats  []Format
	GoalCode string
	// Attachments is an array of attachments that further define the presentation request being proposed.
	// This might be used to clarify which formats or format versions are wanted.
	Attachments []decorator.GenericAttachment
}

type ProposePresentationV2 struct {
	ID   string `json:"@id,omitempty"`
	Type string `json:"@type,omitempty"`
	// Comment is a field that provides some human readable information about the proposed presentation.
	// TODO: Should follow DIDComm conventions for l10n. [Issue #1300]
	Comment string `json:"comment,omitempty"`
	// Formats contains an entry for each proposal~attach array entry, including an optional value of the
	// attachment @id (if attachments are present) and the verifiable presentation format and version of the attachment.
	Formats []Format `json:"formats,omitempty"`
	// ProposalsAttach is an array of attachments that further define the presentation request being proposed.
	// This might be used to clarify which formats or format versions are wanted.
	ProposalsAttach []decorator.Attachment `json:"proposals~attach,omitempty"`
}

type ProposePresentationV3 struct {
	ID   string                    `json:"id,omitempty"`
	Type string                    `json:"type,omitempty"`
	Body ProposePresentationV3Body `json:"body,omitempty"`
	// Attachments is an array of attachments that further define the presentation request being proposed.
	// This might be used to clarify which formats or format versions are wanted.
	Attachments []decorator.AttachmentV2 `json:"attachments,omitempty"`
}

type ProposePresentationV3Body struct {
	GoalCode string `json:"goal_code,omitempty"`
	// Comment is a field that provides some human readable information about the proposed presentation.
	// TODO: Should follow DIDComm conventions for l10n. [Issue #1300]
	Comment string `json:"comment,omitempty"`
}

type Provider interface {
	Messenger() service.Messenger
	StorageProvider() storage.Provider
}

type RequestPresentationParams struct {
	// Comment is a field that provides some human readable information about the proposed presentation.
	// TODO: Should follow DIDComm conventions for l10n. [Issue #1300]
	Comment string
	// WillConfirm is a field that defaults to "false" to indicate that the verifier will or will not
	// send a post-presentation confirmation ack message.
	WillConfirm bool
	// Formats contains an entry for each request_presentations~attach array entry, providing the the value of the
	// attachment @id and the verifiable presentation request format and version of the attachment.
	Formats []Format
	// Attachments is an array of attachments containing the acceptable verifiable presentation requests.
	Attachments []decorator.GenericAttachment
	// GoalCode is an optional goal code to indicate the desired use of the requested presentation.
	GoalCode string
}

type RequestPresentationV2 struct {
	ID   string `json:"@id,omitempty"`
	Type string `json:"@type,omitempty"`
	// Comment is a field that provides some human readable information about the proposed presentation.
	// TODO: Should follow DIDComm conventions for l10n. [Issue #1300]
	Comment string `json:"comment,omitempty"`
	// WillConfirm is a field that defaults to "false" to indicate that the verifier will or will not
	// send a post-presentation confirmation ack message.
	WillConfirm bool `json:"will_confirm,omitempty"`
	// Formats contains an entry for each request_presentations~attach array entry, providing the the value of the
	// attachment @id and the verifiable presentation request format and version of the attachment.
	Formats []Format `json:"formats,omitempty"`
	// RequestPresentationsAttach is an array of attachments containing the acceptable verifiable presentation requests.
	RequestPresentationsAttach []decorator.Attachment `json:"request_presentations~attach,omitempty"`
}

type RequestPresentationV3 struct {
	ID   string                    `json:"id,omitempty"`
	Type string                    `json:"type,omitempty"`
	Body RequestPresentationV3Body `json:"body,omitempty"`
	// Attachments is an array of attachments containing the acceptable verifiable presentation requests.
	Attachments []decorator.AttachmentV2 `json:"attachments,omitempty"`
}

type RequestPresentationV3Body struct {
	GoalCode string `json:"goal_code,omitempty"`
	// Comment is a field that provides some human readable information about the proposed presentation.
	// TODO: Should follow DIDComm conventions for l10n. [Issue #1300]
	Comment string `json:"comment,omitempty"`
	// WillConfirm is a field that defaults to "false" to indicate that the verifier will or will not
	// send a post-presentation confirmation ack message.
	WillConfirm bool `json:"will_confirm,omitempty"`
}

type Service struct {
	service.Action
	service.Message
	// contains filtered or unexported fields
}