module arch.node.engines.wall_clock_messages;

import prelude open;

Wall Clock Messages¶

These are the messages that the Wall Clock engine can receive/respond to.

Message interface¶

type WallClockMsg :=
  | GetTime
  | GetTimeResult TimeResult;

Message sequence diagrams¶

Wall Clock request and response¶

sequenceDiagram
    participant WallClockClient
    participant WallClock

    WallClockClient ->> WallClock: WallClockGetTime
    WallClock ->> WallClockClient: WallClockGetTimeResult

Message types¶

syntax alias StorageKey := String;

syntax alias StorageValue := String;

syntax alias EpochTimestamp := Nat;

WallClockGetTime¶

A WallClockGetTime message tracks and manages time within the local computing environment. This message doesn't require any arguments.

TimeResult¶

Reply to a WallClockGetTime request.

type TimeResult :=
  mk@{
    epochTime : EpochTimestamp;
  };

WallClockMsg¶

type WallClockMsg :=
  | GetTime
  | GetTimeResult TimeResult;

Engine components¶

• Wall Clock Configuration
• Wall Clock Environment
• Wall Clock Behaviour