Struct Character

Source

pub struct Character {
    pub nickname: String,
    pub emoji: String,
    pub palette: Palette,
}

Expand description

A character for an identity: human-readable nickname, emoji, and palette.

Constructed deterministically from a seed (typically the DID). The same seed always produces the same Character — operators can rely on “🦊 foxtrot-meadow” persisting across daemon restarts, machine migration, and process boundaries.

Fields§

§nickname: String

Adjective-noun pair, lowercase, hyphen-joined. e.g. "foxtrot-meadow".

§emoji: String

Single-codepoint (or VS-16-qualified) emoji glyph. e.g. "🦊".

§palette: Palette

Two-color palette for terminal/UI display.

Implementations§

Source §

impl Character

Source

pub fn from_did(did: &str) -> Self

Derive a Character from a wire DID (e.g. did:wire:paul-a1b2c3d4).

v0.11 ONE-NAME: derive the character from the DID’s pubkey fingerprint suffix only (the trailing 8-hex after the final -). This makes the character a deterministic function of the PUBLIC KEY, NOT of the handle-in-DID. Critical for the v0.11 invariant: wire init sets agent-card.handle = character, which rewrites the DID’s handle portion; if the character changed because of the rewrite, we’d be back to two-name confusion (operator-typed handle yields one character, character-as-handle yields another). Fingerprint-only seeding closes the loop — whatever handle ends up in the DID, the character is the same.

Back-compat: pre-v0.5.7 DIDs (no fingerprint suffix) and any malformed DID fall back to hashing the full string, so legacy peers still get a stable (if different) character.

Source

pub fn from_card(card: &Value) -> Self

Derive a Character from a pinned peer’s agent-card JSON object.

v0.7.0-alpha.6: when a peer has published their operator-chosen character (display.nickname / display.emoji on their signed agent-card), we honor it. Otherwise falls back to auto-derived from their DID — same as from_did.

v0.7.0-alpha.8 (review-fix #1): peer-published override fields are sanitized (control chars stripped, length-capped) before use so a malicious peer cannot inject ANSI/OSC escape sequences via their display.nickname / display.emoji and execute terminal control codes on every wire peers / wire whoami render. Override that fully sanitizes to empty falls back to auto-derived.

v0.7.0-alpha.8 (review-fix #8): missing or non-string did returns a distinctive “unknown peer” sentinel character rather than collapsing all such peers onto the empty-string-derived character. Surfaces partially-corrupt pinned cards to operators rather than masking them as one fake identity.

Backward compat: agent-cards without the display field land in the auto-derived path automatically.

Source

pub fn from_did_with_override( did: &str, nickname_override: Option<&str>, emoji_override: Option<&str>, ) -> Self

Derive a Character from a DID, optionally overriding the nickname and/or emoji with operator-chosen values.

v0.7.0-alpha.3: agents can name themselves. The palette stays deterministic (derived from DID hash) so the visual color identity remains stable even when the operator picks a custom name; only the textual + emoji fields override. Empty-string override is treated as “unset” (falls back to auto-derived).

Source

pub fn from_seed(seed: &[u8]) -> Self

Derive a Character from an arbitrary byte seed.

Exposed for testing and for callers that already have a high-entropy seed (e.g. an Ed25519 public key). Production code generally calls from_did instead.

Source

pub fn short(&self) -> String

"🦊 foxtrot-meadow" — plain, no ANSI escapes. Safe in any output.

Source

pub fn colored(&self) -> String

short() wrapped in ANSI 256-color foreground escapes for the primary color. Renders correctly in any terminal supporting 256 colors (the universal lower bound — every modern emulator). For terminals without color support, escapes will be visible-but-harmless.