atproto_identity.did.resolvers.base_resolver¶

class atproto_identity.did.resolvers.base_resolver.AsyncBaseResolver(cache: AsyncDidBaseCache | None = None)¶

Bases: _BaseResolver, ABC

async ensure_resolve(did: str, force_refresh: bool = False) → DidDocument¶

Ensure DID is resolved.

Parameters:

did – DID.
force_refresh – Force refresh cache.

Returns:

DID document.

Return type:

DidDocument

Raises:

DidNotFoundError – DID not find.

async refresh_cache(did: str) → None¶

Refresh cached DID.

Parameters:: did – DID.

async resolve(did: str, force_refresh: bool = False) → DidDocument | None¶

Resolve DID.

Parameters:

did – DID.
force_refresh – Force refresh cache.

Returns:

DID document or None if not found.

Return type:

DidDocument

async resolve_atproto_data(did: str, force_refresh: bool = False) → AtprotoData¶

Resolve AT Protocol Data.

Parameters:

did – DID.
force_refresh – Force refresh cache.

Returns:

AT Protocol data.

Return type:

AtprotoData

Raises:

DidNotFoundError – DID not find.
AtprotoDataParseError – If the DID document is not an AT Protocol DID document.

async resolve_atproto_key(did: str, force_refresh: bool = False) → str¶

Resolve AT Protocol signing key.

Parameters:

did – DID.
force_refresh – Force refresh cache.

Returns:

AT Protocol signing key.

Return type:

str

Raises:

DidNotFoundError – DID not find.
AtprotoDataParseError – If the DID document does not have an AT Protocol signing key.

async resolve_no_cache(did: str) → DidDocument | None¶

Resolve DID without a cache.

Parameters:: did – DID.
Returns:: DID document or None if not found.
Return type:: DidDocument

abstract async resolve_without_validation(did: str) → Dict[str, Any] | None¶

class atproto_identity.did.resolvers.base_resolver.BaseResolver(cache: DidBaseCache | None = None)¶

Bases: _BaseResolver, ABC

ensure_resolve(did: str, force_refresh: bool = False) → DidDocument¶

Ensure DID is resolved.

Parameters:

did – DID.
force_refresh – Force refresh cache.

Returns:

DID document.

Return type:

DidDocument

Raises:

DidNotFoundError – DID not find.

refresh_cache(did: str) → None¶

Refresh cached DID.

Parameters:: did – DID.

resolve(did: str, force_refresh: bool = False) → DidDocument | None¶

Resolve DID.

Parameters:

did – DID.
force_refresh – Force refresh cache.

Returns:

DID document or None if not found.

Return type:

DidDocument

resolve_atproto_data(did: str, force_refresh: bool = False) → AtprotoData¶

Resolve AT Protocol Data.

Parameters:

did – DID.
force_refresh – Force refresh cache.

Returns:

AT Protocol data.

Return type:

AtprotoData

Raises:

DidNotFoundError – DID not find.
AtprotoDataParseError – If the DID document is not an AT Protocol DID document.

resolve_atproto_key(did: str, force_refresh: bool = False) → str¶

Resolve AT Protocol signing key.

Parameters:

did – DID.
force_refresh – Force refresh cache.

Returns:

AT Protocol signing key.

Return type:

str

Raises:

DidNotFoundError – DID not find.
AtprotoDataParseError – If the DID document does not have an AT Protocol signing key.

resolve_no_cache(did: str) → DidDocument | None¶

Resolve DID without a cache.

Parameters:: did – DID.
Returns:: DID document or None if not found.
Return type:: DidDocument

abstract resolve_without_validation(did: str) → Dict[str, Any] | None¶