specs/messaging/shared/v0_1/messaging
library
Classes
-
Account
-
The mediator's view of one served account.
-
AccountStats
-
What an account has sent and received over its lifetime, as the mediator counted
it. Every member is optional: a mediator reports what it keeps, and a counter
absent from a response was not kept rather than zero. Counters survive restarts and
are not reset by reading them; removing an account discards them.
-
AdminAccount
-
A privileged account at the mediator (an
admin or rootAdmin).
-
AuditEntry
-
One record in the mediator's privileged-change audit log: one change, by one actor,
at one time.
-
MediatorAcl
-
The mediator's per-account access-control capability set, expressed as named
booleans (the transport-agnostic form of the mediator's internal capability flags).
On a set request, members omitted are left unchanged; a get/response carries the
full realized set.
-
ProtocolCounts
-
Message counts split by wire protocol. An absent member is a protocol the mediator
counted nothing for. The member names match the WireProtocol values the traffic
monitor reports.
-
QueueLimits
-
Per-account queued-message limits. A value of -1 means unlimited; a member omitted
on a change request leaves that limit unchanged.
Extension Types
-
AccountType
-
The account's role at the mediator.
standard is an ordinary served account;
admin/rootAdmin may administer other accounts; mediator is the mediator's own
account. Only a rootAdmin may assign or modify the rootAdmin role.
-
AuditAction
-
The kind of privileged change recorded in the audit log.
-
MediatorAclAccessListMode
-
How the account's access list is interpreted.
explicitAllow = an allowlist (empty
denies everyone); explicitDeny = a denylist (empty allows everyone).
Typedefs
-
Vid
= String
-
A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the
account's controlling DID, carried verbatim and compared by exact string equality.
For privacy — and because some mediators key accounts by a one-way hash and never
hold the full DID — a stable hash of the DID (e.g. its SHA-256 digest) is an
equally valid value here: producer and consumer simply agree on the same opaque
identifier and compare by exact string equality. The field carries whichever form
the issuing mediator uses.