acapy_agent.storage.vc_holder package

Submodules

acapy_agent.storage.vc_holder.askar module

acapy_agent.storage.vc_holder.base module

Abstract interfaces for VC holder implementations.

class acapy_agent.storage.vc_holder.base.IterVCRecordSearch(search: VCRecordSearch, page_size: int | None = None)

Bases: object

A generic record search async iterator.

class acapy_agent.storage.vc_holder.base.VCHolder

Bases: ABC

Abstract base class for a verifiable credential holder.

abstractmethod build_type_or_schema_query(uri_list: Sequence[str]) → dict

Build and return backend-specific type_or_schema_query.

Parameters:

uri_list – List of schema uri from input_descriptor

abstractmethod async delete_credential(cred: VCRecord)

Remove a previously-stored VC record.

Raises:

StorageNotFoundError – If the record is not found

abstractmethod async retrieve_credential_by_given_id(given_id: str) → VCRecord

Fetch a VC record by its given ID (‘id’ property).

Raises:

StorageNotFoundError – If the record is not found

abstractmethod async retrieve_credential_by_id(record_id: str) → VCRecord

Fetch a VC record by its record ID.

Raises:

StorageNotFoundError – If the record is not found

abstractmethod search_credentials(contexts: Sequence[str] = None, types: Sequence[str] = None, schema_ids: Sequence[str] = None, issuer_id: str | None = None, subject_ids: Sequence[str] = None, proof_types: Sequence[str] = None, given_id: str | None = None, tag_query: Mapping | None = None) → VCRecordSearch

Start a new VC record search.

Parameters:

• contexts – An inclusive list of JSON-LD contexts to match

• types – An inclusive list of JSON-LD types to match

• schema_ids – An inclusive list of credential schema identifiers

• issuer_id – The ID of the credential issuer

• subject_ids – The IDs of any credential subjects all of which to match

• proof_types – The signature suite types used for the proof objects.

• given_id – The given id of the credential

• tag_query – A tag filter clause

abstractmethod async store_credential(cred: VCRecord)

Add a new VC record to the store.

Parameters:

cred – The VCRecord instance to store

Raises:

StorageDuplicateError – If the record_id is not unique

class acapy_agent.storage.vc_holder.base.VCRecordSearch

Bases: ABC

A VC record search in progress.

async close()

Dispose of the search query.

abstractmethod async fetch(max_count: int | None = None) → Sequence[VCRecord]

Fetch the next list of VC records from the store.

Parameters:

max_count – Max number of records to return. If not provided, defaults to the backend’s preferred page size

Returns:

A list of VCRecord instances

acapy_agent.storage.vc_holder.kanon module

Kanon storage implementation of VC holder interface.

class acapy_agent.storage.vc_holder.kanon.KanonVCHolder(profile: Profile)

Bases: VCHolder

Kanon VC record storage class.

build_type_or_schema_query(uri_list: Sequence[str]) → dict

Build and return indy-specific type_or_schema_query.

async delete_credential(cred: VCRecord)

Remove a previously-stored VC record.

Raises:

StorageNotFoundError – If the record is not found

async retrieve_credential_by_given_id(given_id: str) → VCRecord

Fetch a VC record by its given ID (‘id’ property).

Raises:

StorageNotFoundError – If the record is not found

async retrieve_credential_by_id(record_id: str) → VCRecord

Fetch a VC record by its record ID.

Raises:

StorageNotFoundError – If the record is not found

search_credentials(contexts: Sequence[str] = None, types: Sequence[str] = None, schema_ids: Sequence[str] = None, issuer_id: str | None = None, subject_ids: str | None = None, proof_types: Sequence[str] = None, given_id: str | None = None, tag_query: Mapping | None = None, pd_uri_list: Sequence[str] = None) → VCRecordSearch

Start a new VC record search.

Parameters:

• contexts – An inclusive list of JSON-LD contexts to match

• types – An inclusive list of JSON-LD types to match

• schema_ids – An inclusive list of credential schema identifiers

• issuer_id – The ID of the credential issuer

• subject_ids – The IDs of credential subjects all of which to match

• proof_types – The signature suite types used for the proof objects.

• given_id – The given id of the credential

• tag_query – A tag filter clause

• pd_uri_list – A list of presentation definition URIs to match

async store_credential(cred: VCRecord)

Add a new VC record to the store.

Parameters:

cred – The VCRecord instance to store

Raises:

StorageDuplicateError – If the record_id is not unique

class acapy_agent.storage.vc_holder.kanon.KanonVCRecordSearch(search: KanonStorageSearchSession)

Bases: VCRecordSearch

Kanon storage search for VC records.

async close()

Dispose of the search query.

async fetch(max_count: int | None = None) → Sequence[VCRecord]

Fetch the next list of VC records from the store.

Parameters:

max_count – Max number of records to return. If not provided, defaults to the backend’s preferred page size

Returns:

A list of VCRecord instances

acapy_agent.storage.vc_holder.kanon.storage_to_vc_record(record: StorageRecord) → VCRecord

Convert an Kanon stored record into a VC record.

acapy_agent.storage.vc_holder.kanon.vc_to_storage_record(cred: VCRecord) → StorageRecord

Convert a VC record into an Kanon stored record.

acapy_agent.storage.vc_holder.vc_record module

Model for representing a stored verifiable credential.

class acapy_agent.storage.vc_holder.vc_record.VCRecord(*, contexts: Sequence[str], expanded_types: Sequence[str], issuer_id: str, subject_ids: Sequence[str], schema_ids: Sequence[str], proof_types: Sequence[str], cred_value: Mapping, given_id: str | None = None, cred_tags: Mapping | None = None, record_id: str | None = None)

Bases: BaseModel

Verifiable credential storage record class.

class Meta

Bases: object

VCRecord metadata.

schema_class = 'VCRecordSchema'

serialize(as_string=False) → dict

Create a JSON-compatible dict representation of the model instance.

Parameters:

as_string – Return a string of JSON instead of a dict

Returns:

A dict representation of this model, or a JSON string if as_string is True

class acapy_agent.storage.vc_holder.vc_record.VCRecordSchema(*args: Any, **kwargs: Any)

Bases: BaseModelSchema

Verifiable credential storage record schema class.

class Meta

Bases: object

Verifiable credential storage record schema metadata.

model_class

alias of VCRecord

acapy_agent.storage.vc_holder.xform module

Transformation between StorageRecord and VCRecord.

acapy_agent.storage.vc_holder.xform.storage_to_vc_record(record: StorageRecord) → VCRecord

Convert an Indy-SDK stored record into a VC record.

acapy_agent.storage.vc_holder.xform.vc_to_storage_record(cred: VCRecord) → StorageRecord

Convert a VC record into an in-memory stored record.