aries_cloudagent.protocols.issue_credential.v2_0.formats package

Subpackages

• aries_cloudagent.protocols.issue_credential.v2_0.formats.indy package
  • Submodules
  • aries_cloudagent.protocols.issue_credential.v2_0.formats.indy.handler module
• aries_cloudagent.protocols.issue_credential.v2_0.formats.ld_proof package
  • Subpackages
    • aries_cloudagent.protocols.issue_credential.v2_0.formats.ld_proof.models package
      • Submodules
      • aries_cloudagent.protocols.issue_credential.v2_0.formats.ld_proof.models.cred_detail module
      • aries_cloudagent.protocols.issue_credential.v2_0.formats.ld_proof.models.cred_detail_options module
  • Submodules
  • aries_cloudagent.protocols.issue_credential.v2_0.formats.ld_proof.handler module

Submodules

aries_cloudagent.protocols.issue_credential.v2_0.formats.handler module

V2.0 issue-credential base credential format handler.

exception aries_cloudagent.protocols.issue_credential.v2_0.formats.handler.V20CredFormatError(*args, error_code: Optional[str] = None, **kwargs)

Bases: aries_cloudagent.core.error.BaseError

Credential format error under issue-credential protocol v2.0.

class aries_cloudagent.protocols.issue_credential.v2_0.formats.handler.V20CredFormatHandler(profile: aries_cloudagent.core.profile.Profile)

Bases: abc.ABC

Base credential format handler.

abstract async create_offer(cred_proposal_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_proposal.V20CredProposal) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat, aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]

Create format specific credential offer attachment data.

abstract async create_proposal(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, proposal_data: Mapping) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat, aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]

Create format specific credential proposal attachment data.

abstract async create_request(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, request_data: Optional[Mapping] = None) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat, aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]

Create format specific credential request attachment data.

format: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat.Format = None

abstract get_format_data(message_type: str, data: dict) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat, aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]

Get credential format and attachment objects for use in cred ex messages.

abstract get_format_identifier(message_type: str) → str

Get attachment format identifier for format and message combination.

Parameters

message_type (str) – Message type for which to return the format identifier

Returns

Issue credential attachment format identifier

Return type

str

abstract async issue_credential(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, retries: int = 5) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat, aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]

Create format specific issue credential attachment data.

property profile: aries_cloudagent.core.profile.Profile

Accessor for the current profile instance.

Returns

The profile instance for this credential format

abstract async receive_credential(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_issue_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_issue.V20CredIssue) → None

Create format specific issue credential message.

abstract async receive_offer(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_offer_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_offer.V20CredOffer) → None

Receive foramt specific credential offer message.

abstract async receive_proposal(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_proposal_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_proposal.V20CredProposal) → None

Receive format specific credential proposal message.

abstract async receive_request(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_request_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_request.V20CredRequest) → None

Receive format specific credential request message.

abstract async store_credential(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_id: Optional[str] = None) → None

Store format specific credential from issue credential message.

abstract classmethod validate_fields(message_type: str, attachment_data: dict) → None

Validate attachment data for specific message type and format.