StateTransferCodecInterface

Serializes {@see StateSnapshot} and {@see InteractionRequest} to and from wire strings the client round-trips (e.g. embedded in a `<milpa-state>` element in the SSR'd page, then echoed back verbatim on the next interaction). Because the client is untrusted, {@see \Milpa\Live\Http\LiveEndpoint} relies on a signed decorator of this interface (pairing an inner codec with a {@see \Milpa\Live\Contracts\Security\StateSignerInterface}) so a decoded snapshot is provably the one the server last issued — plain encode/decode here carries no authenticity guarantee by itself.

abstract public function encodeState(Milpa\Live\ValueObjects\StateSnapshot $snapshot): string

Serializes a state snapshot to a wire string.

Parameters

abstract public function decodeState(string $encoded): Milpa\Live\ValueObjects\StateSnapshot

Parses a wire string back into a {@see StateSnapshot}.

Parameters

Throws

\RuntimeException If `$encoded` is not well-formed, or (for signed implementations) fails signature verification.

abstract public function encodeInteraction(Milpa\Live\ValueObjects\InteractionRequest $request): string

Serializes an interaction request to a wire string.

Parameters

abstract public function decodeInteraction(string $encoded): Milpa\Live\ValueObjects\InteractionRequest

Parses a wire string back into an {@see InteractionRequest}.

Parameters

Throws

\RuntimeException If `$encoded` is not well-formed, or (for signed implementations) fails signature verification.