aries_cloudagent.protocols.present_proof.v2_0.models package

Package-wide data and code.

Submodules

aries_cloudagent.protocols.present_proof.v2_0.models.pres_exchange module

Presentation exchange record.

class aries_cloudagent.protocols.present_proof.v2_0.models.pres_exchange.V20PresExRecord(*, pres_ex_id: str = None, connection_id: str = None, thread_id: str = None, initiator: str = None, role: str = None, state: str = None, pres_proposal: Union[aries_cloudagent.protocols.present_proof.v2_0.messages.pres_proposal.V20PresProposal, Mapping] = None, pres_request: Union[aries_cloudagent.protocols.present_proof.v2_0.messages.pres_request.V20PresRequest, Mapping] = None, pres: Union[aries_cloudagent.protocols.present_proof.v2_0.messages.pres.V20Pres, Mapping] = None, verified: str = None, verified_msgs: list = None, auto_present: bool = False, auto_verify: bool = False, error_msg: str = None, trace: bool = False, by_format: Mapping = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base_record.BaseExchangeRecord

Represents a v2.0 presentation exchange.

INITIATOR_EXTERNAL = 'external'
INITIATOR_SELF = 'self'
class Meta[source]

Bases: object

V20PresExRecord metadata.

schema_class = 'V20PresExRecordSchema'
RECORD_ID_NAME = 'pres_ex_id'
RECORD_TOPIC = 'present_proof_v2_0'
RECORD_TYPE = 'pres_ex_v20'
ROLE_PROVER = 'prover'
ROLE_VERIFIER = 'verifier'
STATE_ABANDONED = 'abandoned'
STATE_DONE = 'done'
STATE_PRESENTATION_RECEIVED = 'presentation-received'
STATE_PRESENTATION_SENT = 'presentation-sent'
STATE_PROPOSAL_RECEIVED = 'proposal-received'
STATE_PROPOSAL_SENT = 'proposal-sent'
STATE_REQUEST_RECEIVED = 'request-received'
STATE_REQUEST_SENT = 'request-sent'
TAG_NAMES = {'thread_id'}
by_format

Record proposal, request, and presentation attachments by format.

emit_event(session: aries_cloudagent.core.profile.ProfileSession, payload: Any = None)[source]

Emit an event.

Parameters:
  • session – The profile session to use
  • payload – The event payload
pres

Accessor; get deserialized view.

pres_ex_id

Accessor for the ID associated with this exchange record.

pres_proposal

Accessor; get deserialized view.

pres_request

Accessor; get deserialized view.

record_value

Accessor for the JSON record value generated for this credential exchange.

save_error_state(session: aries_cloudagent.core.profile.ProfileSession, *, state: str = None, reason: str = None, log_params: Mapping[str, Any] = None, log_override: bool = False)[source]

Save record error state if need be; log and swallow any storage error.

Parameters:
  • session – The profile session to use
  • reason – A reason to add to the log
  • log_params – Additional parameters to log
  • override – Override configured logging regimen, print to stderr instead
class aries_cloudagent.protocols.present_proof.v2_0.models.pres_exchange.V20PresExRecordSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base_record.BaseExchangeSchema

Schema for de/serialization of v2.0 presentation exchange records.

class Meta[source]

Bases: object

V20PresExRecordSchema metadata.

model_class

alias of V20PresExRecord

auto_present

Used by autodoc_mock_imports.

auto_verify

Used by autodoc_mock_imports.

by_format

Used by autodoc_mock_imports.

connection_id

Used by autodoc_mock_imports.

error_msg

Used by autodoc_mock_imports.

initiator

Used by autodoc_mock_imports.

pres

Used by autodoc_mock_imports.

pres_ex_id

Used by autodoc_mock_imports.

pres_proposal

Used by autodoc_mock_imports.

pres_request

Used by autodoc_mock_imports.

role

Used by autodoc_mock_imports.

state

Used by autodoc_mock_imports.

thread_id

Used by autodoc_mock_imports.

verified

Used by autodoc_mock_imports.

verified_msgs

Used by autodoc_mock_imports.