scala-did-docs
API
Generated with
scala-did-docs/fmgp/fmgp.did/fmgp.did.method/fmgp.did.method.prism/PrismState

PrismState

fmgp.did.method.prism.PrismState
See thePrismState companion object
trait PrismState extends PrismStateRead

Writable PRISM state interface extending PrismStateRead with event storage capabilities.

Adds methods to persist blockchain events to the state backend. Events are added without validation, allowing implementations to handle ordering and chain integrity according to their storage strategy.

Attributes

Example 
val state: PrismState = ???
val event: MySignedPrismEvent[CreateDidOP] = ???
for {
 _ <- state.addEvent(event)
 ssi <- state.getSSI(event.event.didPrism)
} yield ssi
Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
Self type

Members list

Value members

Abstract methods

def addEvent(event: MySignedPrismEvent[OP]): ZIO[Any, Exception, Unit]

Adds a signed PRISM event to the state.

Adds a signed PRISM event to the state.

Events are indexed without validation. Implementations may handle out-of-order events differently.

Attributes

Concrete methods

def addMaybeEvent(maybeEvent: MaybeEvent[OP]): ZIO[Any, Exception, Unit]

Adds an event after filtering out invalid ones.

Adds an event after filtering out invalid ones.

Only valid MySignedPrismEvent instances are added; invalid objects are silently ignored.

Attributes

Inherited methods

def getEventsForSSI(ssi: DIDSubject): ZIO[Any, Throwable, Seq[MySignedPrismEvent[CreateDidOP | UpdateDidOP | DeactivateDidOP]]]

Fetches all events in the chain for the given DID.

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 MySignedPrismEvent

Inherited from:
PrismStateRead
def getEventsForVDR(refVDR: RefVDR): ZIO[Any, Throwable, Seq[MySignedPrismEvent[CreateStorageEntryOP | UpdateStorageEntryOP | DeactivateStorageEntryOP]]]

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

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 MySignedPrismEvent

Inherited from:
PrismStateRead
def getSSI(ssi: DIDSubject): ZIO[Any, Throwable, SSI]

Gets the current SSI state.

Gets the current SSI state.

Attributes

Inherited from:
PrismStateRead
def getSSIHistory(ssi: DIDSubject): ZIO[Any, Throwable, SSIHistory]

Gets the full SSIHistory for a SSI.

Gets the full SSIHistory for a SSI.

Attributes

Inherited from:
PrismStateRead
def getVDR(ref: RefVDR): ZIO[Any, Throwable, VDR]

Gets the VDR state with full ownership validation.

Gets the VDR state with full ownership validation.

Attributes

Inherited from:
PrismStateRead
def lastSyncedBlockEpochSecondNano: (Long, Int)

Returns the last synced block timestamp.

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)

Inherited from:
PrismStateRead
def ssiCount: ZIO[Any, Nothing, Int]

Returns count of SSI DIDs in the state.

Returns count of SSI DIDs in the state.

Attributes

Note

TODO: improve in specific implementations for better performance

Inherited from:
PrismStateRead
def vdrCount: ZIO[Any, Nothing, Int]

Returns count of VDRs in the state.

Returns count of VDRs in the state.

Attributes

Note

TODO: improve in specific implementations for better performance

Inherited from:
PrismStateRead

Inherited and Abstract methods

def cursor: ZIO[Any, Nothing, EventCursor]

Attributes

Returns

EventCursor of the latest Event

Inherited from:
PrismStateRead
def getEventByHash(refHash: EventHash): ZIO[Any, Exception, Option[MySignedPrismEvent[OP]]]

Gets a specific event by its EventHash.

Gets a specific event by its EventHash.

Attributes

Inherited from:
PrismStateRead
def getEventsIdBySSI(ssi: DIDSubject): ZIO[Any, Nothing, Seq[EventRef]]

Returns event references for a specific SSI DID.

Returns event references for a specific SSI DID.

Attributes

Inherited from:
PrismStateRead
def getEventsIdByVDR(id: RefVDR): ZIO[Any, Nothing, Seq[EventRef]]

Returns event references for a specific VDR.

Returns event references for a specific VDR.

Attributes

Inherited from:
PrismStateRead
def ssi2eventsRef: ZIO[Any, Nothing, Map[DIDSubject, Seq[EventRef]]]

Returns mapping of all SSI DIDs to their event references.

Returns mapping of all SSI DIDs to their event references.

Attributes

Note

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

Inherited from:
PrismStateRead
def vdr2eventsRef: ZIO[Any, Nothing, Map[RefVDR, Seq[EventRef]]]

Returns mapping of all VDRs to their event references.

Returns mapping of all VDRs to their event references.

Attributes

Note

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

Inherited from:
PrismStateRead
Generated with