scala-did-docs/fmgp/fmgp.did/fmgp.did.method/fmgp.did.method.prism/PrismStateRead

PrismStateRead

fmgp.did.method.prism.PrismStateRead

Read-only interface for querying PRISM blockchain state.

This trait provides methods to query the state of PRISM DIDs (Decentralized Identifiers) and VDRs (Verifiable Data Registries) from an event-sourced storage backend. Events represent blockchain operations (create, update, deactivate) that form immutable chains tracked through hash references.

==Key Concepts==

'''SSI (Self-Sovereign Identity):''' A PRISM DID (e.g., did:prism:xxx) managed through fmgp.did.method.prism.proto.CreateDidOP, fmgp.did.method.prism.proto.UpdateDidOP, and fmgp.did.method.prism.proto.DeactivateDidOP events. SSIs represent identity with keys and services.

'''VDR (Verifiable Data Registry):''' Storage entries owned by a DID, managed through fmgp.did.method.prism.proto.CreateStorageEntryOP, fmgp.did.method.prism.proto.UpdateStorageEntryOP, and fmgp.did.method.prism.proto.DeactivateStorageEntryOP events. Used for storing arbitrary data on-chain.

'''Event Chains:''' Operations form chains via previousEventHash references. Create operations start chains; update/deactivate operations reference previous events. All events in a chain share the same root hash.

Attributes

Example

val state: PrismStateRead = ???
for {
 events <- state.getEventsForSSI(didSubject)
 ssi <- state.getSSI(didSubject)
 history <- state.getSSIHistory(didSubject)
} yield (events, ssi, history)

Graph

Supertypes

class Object

trait Matchable

class Any

Known subtypes

trait PrismState

class PrismStateInMemory

class PrismStateMongoDB

class PrismStateFS

class PrismStateHTTP

Members list

Value members

Abstract methods

Attributes

Returns: EventCursor of the latest Event

Gets a specific event by its EventHash.

Attributes

Returns event references for a specific SSI DID.

Attributes

Returns event references for a specific VDR.

Attributes

Returns mapping of all SSI DIDs to their event references.

Attributes

Note: TODO: make it a Stream of (DIDSubject, Seq[EventRef])

Returns mapping of all VDRs to their event references.

Attributes

Note: TODO: make it a Stream of (RefVDR, Seq[EventRef])

Concrete methods

Fetches all events in the chain for the given DID.

Attributes

Returns: ZIO effect that may fail with Throwable (RuntimeException if event hash missing or type validation fails) and succeeds with sequence of DID-related fmgp.did.method.prism.proto.MySignedPrismEvent

Fetches all events in the chain for the given VDR reference.

Value parameters

refVDR: The VDR reference to query

Attributes

Returns: ZIO effect that may fail with Throwable (RuntimeException if event hash missing or type validation fails) and succeeds with sequence of storage-related fmgp.did.method.prism.proto.MySignedPrismEvent

Gets the current SSI state.

Attributes

Gets the full SSIHistory for a SSI.

Attributes

Gets the VDR state with full ownership validation.

Attributes

Returns the last synced block timestamp.

Attributes

Returns: Tuple of (epoch seconds, nanoseconds)
Note: Current implementation returns current time (FIXME: should track actual sync state)

Returns count of SSI DIDs in the state.

Attributes

Note: TODO: improve in specific implementations for better performance

Returns count of VDRs in the state.

Attributes

Note: TODO: improve in specific implementations for better performance

In this article

Generated with