This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works
GET / PATCH /api/settings/instance (routes/settings.ts, admin, the pair GeneralPanel uses) gain supportCardEnabled: the shared type InstanceAdminSettings gains the field, rowToAdminSettings maps it, and the PATCH accepts a boolean and otherwise answers sendError(reply, 400, 'field_not_boolean', { field: 'supportCardEnabled' }), the existing code the route uses for its other boolean fields.
InstanceAdminSettings has a supportCardEnabled field
HoldsPR #378 · Oct 2
429 with the shared error body ({ error, code: 'rate_limited', statusCode: 429 }, see localization.md) plus retryAfter in whole seconds, and the plugin's own Retry-After header.
3 rules from this sentence
ErrorBody has error
Holds
ErrorBody has code
Holds
ErrorBody has statusCode
Holds
Space.directoryListed is carried on every space response and in the WebSocket ready payload.
Space has directoryListed
HoldsPR #378 · Oct 2
The target is named one of two ways (SendFriendRequest in packages/shared/src/types.ts):
SendFriendRequest is in packages/shared/src
Holds
instanceId (InstanceInfoResponse.instanceId, string) is this instance's persistent epoch — the incarnation UUID minted once by ensureDefaults and stable across restarts (see database.md → Instance Settings).
InstanceInfoResponse has instanceId
Holds
InstanceStreamingLimits.directoryEnabled is also carried on GET /settings/streaming, read-only there, so a non-admin's space settings can tell whether the instance allows listing.
InstanceStreamingLimits has directoryEnabled
Holds
TelemetryStatus is { enabled: boolean | null, id: string | null, lastDay: string | null, lastError: { day, status } | null, askDue: boolean }, where enabled: null means the instance was never asked and askDue says whether the admin should see the ask now (always while never answered, never after a yes, and after a no again from the next minor release on; telemetry.md §7).
5 rules from this sentence
TelemetryStatus has enabled
Holds
TelemetryStatus has id
Holds
TelemetryStatus has lastDay
Holds
TelemetryStatus has lastError
Holds
TelemetryStatus has askDue
Holds
FederationRelayRequest.sourceInstanceId stamps the sender's current epoch on every relay;
FederationRelayRequest has sourceInstanceId
HoldsPR #378 · Oct 2
needsAttentionReason ('auth_failures' | 'peer_reset_detected' | 'repeer_incomplete' | null) is now included on each GET /federation/peers peer object so the client can raise the persistent Reset-cleanup banner only for reset-detected peers and surface an "incomplete Re-peer" warning for repeer_incomplete.
FederationPeer has needsAttentionReason
HoldsPR #378 · Oct 2
State. A conversation is { key, copies: Map<origin, DmCopy>, pinnedOrigin }, a copy is { origin, channel, keySource }, at most one copy per key and origin.
3 rules from this sentence
DmConversation has key
Holds
DmConversation has copies
Holds
DmConversation has pinnedOrigin
Holds
RemoteLoginRequiredError is an HttpError carrying a registered code (federation_different_password, 409, or federated_registration_closed, 403, by reason), minted by the client rather than by a route, so describeError says it in the user's language anywhere it does surface as a message.
RemoteLoginRequiredError extends HttpError
Holds
The live ConnectedInstance.error field is a separate, unrendered string for the console and stays English.
ConnectedInstance has an error field
Holds
A settings section carries a count (SettingsSection.badgeCount) when the number matters, or a dot (SettingsSection.badgeDot) when only the existence does.
2 rules from this sentence
SettingsSection has badgeCount
Holds
SettingsSection has badgeDot
Holds
inRecoveryMode (private to the store, guards loadFile(recovery.html) re-entry / loop prevention) and updateConfirmed (local to main.ts:initAutoUpdater, controls whether updater errors get pushed to the renderer).
RecoveryStateStore has inRecoveryMode
Holds
keybinds: KeybindConfig[] — current bindings synced from renderer
KeybindManager has keybinds
Holds
pressedKeys: Set<number> — currently held keys (djb2 hashes)
KeybindManager has pressedKeys
Holds
activeActions: Set<string> — actions whose keybind is currently satisfied
KeybindManager has activeActions
Holds
window: BrowserWindow | null — target for IPC sends
KeybindManager has window
Holds
started: boolean — whether uIOhook is running
KeybindManager has started
Holds
Space carries directoryListed everywhere a space is serialised: the spaces routes, the explore routes, and the WebSocket ready payload.
Space has directoryListed
Holds
GET /api/settings/streaming (InstanceStreamingLimits, readable by any signed-in user) carries directoryEnabled too, so the space settings panel of a non-admin can tell whether the instance allows listing.
InstanceStreamingLimits has directoryEnabled
Holds
Each entry is { origin, instanceName, federatedRegistrationOpen, id, name, description, icon, banner, avatarColor, visibility, memberCount, createdAt }, the DirectoryEntry shape in packages/shared.
DirectoryEntry is in packages/shared
Holds
directoryBrowseEnabled lives on InstanceAdminSettings, behind GET /api/settings/instance, which is admin-only, and a member surface must not carry an admin-only read.
InstanceAdminSettings has directoryBrowseEnabled
Holds
Replies (message.replyTo, filled by dmReplyRefForRelay in queueDmRelay and in the sync endpoint) and reactions (reaction.messageId + reaction.messageHomeInstance, filled by the WS reaction handlers and in the sync endpoint) both use it.
Reaction has messageId
Holds
Naming a message across instances. Each instance holds its own copy of a federated message under its own local id, so a relay event that points at another message names it with FederationMessageRef { messageId, messageHomeInstance }: the message's id on the instance that created it, and that instance's origin.
2 rules from this sentence
FederationMessageRef has messageId
Holds
FederationMessageRef has messageHomeInstance
Holds
Every entry carries id, federatedId, ownerId, ownerHomeUserId, ownerHomeInstance, createdAt, name, icon, metadataUpdatedAt, members and lastMessage, with null (or 0 for metadataUpdatedAt) where the channel has no value.
11 rules from this sentence
DmChannel has id, federatedId, ownerId and 8 more
Holdsall 11
On the client every 429 throws RateLimitError, an HttpError with status 429, the body's own code when the route sends one and rate_limited otherwise, plus retryAfter, so describeError localizes it like any other server error and the auth pages keep their countdown.
All friend events use the friendship field of FederationRelayEvent:
FederationRelayEvent has a friendship field
Holds
Profile snapshots (FederationRelayProfileSnapshot) carry { username, displayName, avatar, avatarColor, banner, bio } for hydrating replicated user stubs on the receiving instance.
6 rules from this sentence
FederationRelayProfileSnapshot has username, displayName, avatar and 3 more
Holdsall 6
Field name, Type string, Required yes, Validation trimmed, 1-100 chars
CreateSpaceRequest has a name field
Holds
Field icon, Type string, Required no, Validation Upload filename
CreateSpaceRequest has an icon field
Holds
Field banner, Type string, Required no, Validation Upload filename
CreateSpaceRequest has a banner field
Holds
Field avatarColor, Type AvatarColor, Required no, Validation Must be in AVATAR_COLORS random if omitted
CreateSpaceRequest has an avatarColor field
Holds
Field visibility, Type SpaceVisibility, Required no, Validation 'public' / 'request' / 'private' defaults to 'private'
CreateSpaceRequest has a visibility field
Holds
Field description, Type string, Required no, Validation trimmed, max 200 chars
CreateSpaceRequest has a description field
Holds
AudioManager.releaseInputStream() closes that gap: it disconnects inputSource, detaches each capture track's onended handler and .stop()s it, nulls currentStream, resets currentInputDeviceId to 'default', and bumps streamGeneration so the next join re-acquires instead of short-circuiting.
AudioManager has a releaseInputStream method
Holds
Input device changes flow through AudioManager.setInputDevice(deviceId) (serialized chain).
AudioManager has a setInputDevice method
Holds
When inputDeviceId === 'default' and a stream is active, AudioInputSection shows a Currently using: <label> subline by reading AudioManager.getCurrentInputDeviceId() and looking up the label in inputLabels.
AudioManager has a getCurrentInputDeviceId method
Holds
Mic device changes therefore unpublish/republish via AudioManager.getFreshTrack().
AudioManager has a getFreshTrack method
Holds
voiceChannelElapsedSeconds is a whole-second duration computed from the in-memory VoiceRoom.startedAt;
VoiceRoom has startedAt
Holds
In a space channel every event above is emitted with connectionManager.sendToChannel, from the REST route and from the WebSocket handler alike, so both paths reach the same audience.
ConnectionManager has sendToChannel
Holds
(reaction_added and reaction_removed are reused on the DM path, where they go out with sendToDmMembers.) See permissions.md, "Broadcast audience".
ConnectionManager has sendToDmMembers
Holds
Voice-state assembly:voiceStates / voiceChannelElapsedSeconds / voiceUserStates / spaceVoiceStates for each of the user's spaces are produced by ConnectionManager.buildSpaceVoiceState(spaceId, userId) — the single source of truth shared with the mid-session join push (see below).
ConnectionManager has a buildSpaceVoiceState method
Holds
To close this, ConnectionManager.addUserSpace(userId, spaceId) — the single chokepoint every join path funnels through, and which is not used on reconnect (that path uses setUserSpaces) — builds the same per-space snapshot via buildSpaceVoiceState and pushes it to the joining user as a space_voice_state event.