nandi/frqpublic Fork 0
a008d3bb4cef6d5905699f39dd51f4665d8a2199
Commits
Clone
git clone https://git.rickub.com/nandi/frq.git
git clone ssh://git@rickub.com/nandi/frq.git

Host key fingerprint (ed25519): SHA256:iycHnxEyq0Q7uyVpB7JlznP0G7JrTPXLYRcAU5CSLhc — verify it before your first connect.

README.md · 205 lines · 10.4 KBmarkdown Blame HistoryRaw
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago1# frq
2
3A **[freeq](https://github.com/codegod100/freeq)** client written in
4**[jolt](https://github.com/jolt-lang/jolt)**, as
5[glimmer](https://github.com/jolt-lang/glimmer) components painted by
6**[Vidya](https://tangled.org/nandi.uk/vidya)**/egui.
7
8It is a proof of concept port of [sleek](../sleek), which is the same client in
9Rust against egui directly. The screens are sleek's — connect, chats, chat,
10discover, settings, under a tab bar — but each is hiccup over glimmer's widget
11tags rather than immediate-mode drawing code, and state lives in ratoms instead
12of an `AppState` struct.
13
14```
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 20d ago15src/frq/atproto.jolt handle → DID → PDS → session, and the SASL payloads
16src/frq/oauth.jolt the broker flow: login URL, loopback capture, /session
Remember an OAuth sign-in across restarts 4aa71e7 nandi 20d ago17src/frq/store.jolt the saved sign-in, mode 600 in the config directory
Show who is talking, with their Bluesky picture f5548bd nandi 20d ago18src/frq/avatars.jolt profile pictures, by DID or handle
Copy sleek's profiles b79ebc4 nandi 19d ago19src/frq/profile.jolt who someone is: the Bluesky profile behind a nick
Show the pictures people paste 56cdac3 nandi 20d ago20src/frq/media.jolt image links: spot them, fetch them once, cache on disk
Send a picture by pasting it 8a491ba nandi 19d ago21src/frq/upload.jolt a pasted picture to freeq's media endpoint, as multipart
Calls f31ad3d nandi 19d ago22src/frq/av.jolt calls: the signaling, and a handle on the media plane
Say when each thing was said dbf3b86 nandi 20d ago23src/frq/clock.jolt the reader's own zone, twelve-hour times, day headings
Pick any emoji, in colour 18c5ccd nandi 20d ago24src/frq/emoji.jolt the picker's catalog: every drawable emoji and its name
Sign in with a Bluesky identity 5192124 nandi 20d ago25src/frq/irc.jolt IRC over TLS or TCP: parser, reader thread, SASL, PRIVMSG
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago26src/frq/state.jolt the ratoms every screen reads, and `apply-msg!`
27src/frq/app.jolt the screens
28```
29
Stop mistaking a quiet connection for a closed one a225fb1 nandi 20d ago30## Tracing
31
32`FRQ_TRACE=1` prints every IRC line sent and received to stderr, which on
33Android is logcat.
34
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago35## Running
36
Take both native libraries from one place a66d1c1 nandi 19d ago37Both native libraries, then the app:
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago38
39```bash
40just lib
41just run
42```
43
Take every jolt-native half from the release, and only from there a008d3b nandi 18d ago44`just lib` fetches both shared objects this client loads —
45[jolt-native](https://gitlab.com/nandithebull/jolt-native)'s `libvidya`, the
46retained-tree ABI glimmer paints through, and `libjoltmoq`, the AV media plane
47— out of that project's release, by the digests in `scripts/*.dotslash`, and
48links them into `build/lib`. Nothing is compiled: no Rust toolchain, and no
49jolt-native checkout beside this one. It needs `patchelf`, and only to name
50libasound in `libjoltmoq.so`, which v0.1.3 does not — see the comment in
51`scripts/lib.bb`; that goes away with the release that links it. `just bump` moves every pin to the
52latest release at once, and `just bump v0.1.2` to a named one.
53
54`just run` is `jolt -M:frq` with `LD_LIBRARY_PATH` pointed at `build/lib`. It
55connects to `irc.freeq.at:6697` over TLS and joins `#test`. Untick TLS on the
56connect screen (or point it at `127.0.0.1`) for a local server's
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago57plain listener:
58
59```bash
60cargo run --release --bin freeq-server # in the freeq checkout
61```
62
Sign in with a Bluesky identity 5192124 nandi 20d ago63## Signing in
64
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 20d ago65Three modes on the connect screen.
Sign in with a Bluesky identity 5192124 nandi 20d ago66
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 20d ago67**Bluesky** (OAuth, the default way in) follows sleek's flow: frq binds a
68loopback port, puts it in `return_to`, and opens
69`auth.freeq.at/auth/login?handle=…`. The broker runs the OAuth dance with the
70PDS and redirects back to that port with the handoff in the URL *fragment*, so
71it never reaches a server as a query string. The page frq serves there has one
72job: POST the fragment back to itself. What comes back is a single-use SASL
73`web-token` and a durable `broker_token`; later connections mint a fresh token
74from the durable one at `/session` and skip the browser.
Sign in with a Bluesky identity 5192124 nandi 20d ago75
Remember an OAuth sign-in across restarts 4aa71e7 nandi 20d ago76The durable token is saved to `$XDG_CONFIG_HOME/frq/session.edn` (mode 600) so
Connect on launch when an account is remembered 9237cf4 nandi 20d ago77a restart resumes without one, along with the handle and nick it belongs to —
78and it connects on its own at launch when one is there.
Remember an OAuth sign-in across restarts 4aa71e7 nandi 20d ago79The web-token beside it is single-use and deliberately not saved. A token the
80broker no longer honours is dropped — from disk and memory — and the browser
81flow runs once more, rather than failing the same way on every Connect.
82
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 20d ago83**App password** signs in without a browser, straight to the user's own PDS:
84`resolveHandle` → DID → PDS from the DID document → `createSession`. The
85password goes to that PDS and nowhere else, is never written to disk, and is
86dropped once the session exists.
Sign in with a Bluesky identity 5192124 nandi 20d ago87
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 20d ago88Either way freeq sees only a token. The SASL mechanism is
89`ATPROTO-CHALLENGE` in both cases — `method: "web-token"`, which the server
90resolves through its own token store, or `method: "pds-session"` with the
91server's nonce echoed back so the token cannot be replayed elsewhere.
92
93A refused sign-in is reported and the connection carries on as a guest.
Sign in with a Bluesky identity 5192124 nandi 20d ago94
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago95## Android
96
Take every jolt-native half from the release, and only from there a008d3b nandi 18d ago97An APK whose native halves come from jolt-native's release and whose Jolt half
98is frq's: `libvidya.so` (the Rust/egui C ABI, which owns the event loop as the
99NativeActivity's own library), `libjoltmoq.so` (the media plane) and
100`libjoltapp.so` (frq compiled to a Chez boot image, linked against both).
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago101
102```bash
Write the build in babashka, and pin the babashka 34832a8 nandi 18d ago103./android/build-apk.bb run # build, install, launch on a connected device
104./android/build-apk.bb log # logcat, filtered
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago105```
106
Take every jolt-native half from the release, and only from there a008d3b nandi 18d ago107Needs an SDK and a cross-built Chez in `~/.cache/vidya-chez-android`; the NDK
108comes down through `scripts/android-ndk.dotslash`. `just apk` builds the same
109APK as a buck2 graph, which is the incremental way in.
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago110
111TLS does not work there: jolt reaches OpenSSL through the dynamic loader, and
112Android has no public `libssl` to load. The connect screen falls back to the
113plain `:6667` listener on its own, which is why the plain transport is the raw
114`socket`/`connect`/`send`/`recv` calls rather than jolt's `java.net.Socket`
115surface — that surface does not work on Android either, while the syscalls do.
116
117## What the PoC covers
118
119* TLS (`:6697`, via jolt.mvn-http's OpenSSL bindings) or plain TCP (`:6667`)
120* Guest connect (`NICK`/`USER`), `001` welcome, `PING`/`PONG` keepalive
121* Auto-joins `#test` on `irc.freeq.at`
122* Join channels, channel buffers with unread counts, send and receive `PRIVMSG`
Ask for the backlog freeq restores channels without 94e59a2 nandi 20d ago123* Backlog on join, and `CHATHISTORY` for the channels freeq restores instead
Say when each thing was said dbf3b86 nandi 20d ago124* Twelve-hour timestamps from the server's own clock, with a heading wherever
125 the day changes
Answer a message, not just read that one was answered 4876db8 nandi 20d ago126* A chip above a reply quoting what it answers, and a click that goes there;
127 ↩ beside a sender to answer them, with `+draft/reply` on the way out
Pick any emoji, in colour 18c5ccd nandi 20d ago128* Emoji reactions: colour pills under a message, ☺ beside the sender to open a
129 picker over every emoji Vidya can draw (popular first, then Unicode's own
130 groups, searchable by name), and a second click on a pill to take yours off
131 — sent as `TAGMSG`, and restored from the server's own tally when the
132 backlog comes back
Show the pictures people paste 56cdac3 nandi 20d ago133* Inline previews for PNG links, fetched once and cached under
Click a picture to see it full size 563ada3 nandi 20d ago134 `$XDG_CACHE_HOME/frq/media`; click one to see it full size
Send a picture by pasting it 8a491ba nandi 19d ago135* Ctrl+V in the draft attaches the picture on the clipboard: it is previewed
136 under the box and uploaded to freeq's media endpoint while you write the line
137 it goes with, and only on the way out does it become the link — which is the
138 whole of what sending an image over IRC means. The draft itself is never
139 written into. Text pastes as text, as it always did: the picture path is the
140 keystroke the field had no text to answer with
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago141* Join/part notices, DMs bucketed under the sender's nick
142* Discover list, search over buffers, disconnect
Remember which rooms this client has been in 1d062fd nandi 20d ago143* The rooms you have opened, remembered across runs and listed in the order
144 you last used them (`$XDG_CONFIG_HOME/frq/channels.edn`)
Order the chat list by what you were last in 75e557e nandi 20d ago145* Conversations listed most recently opened first
Show who is talking, with their Bluesky picture f5548bd nandi 20d ago146* Bluesky avatars beside the sender, resolved from the DID freeq tags each
147 message with
Calls f31ad3d nandi 19d ago148* Calls: a Call button opens one in a channel, a banner offers Join where
149 somebody already has, and in one there is mute, deafen, video and leave. Mute
150 and deafen are separate — a deafened microphone still carries your voice.
151 Whoever turns a camera on appears as a tile; the self-view is labelled You
152 and sits last, where it cannot push a face you are talking to off the row
153
154## Calls
155
156Signaling is IRC and lives here: `+freeq.at/av-start`, `av-join` and `av-leave`
157go out as TAGMSGs and the server broadcasts `+freeq.at/av-state` back, which is
158what actually moves this client's state — a press is optimistic, and the server
159settles it. Losing a race to open a call (`start-collision`) is answered by
160joining the call that won rather than by reporting an error, since the person
161asked to be in a call in that room and there is one.
162
163Media is not IRC and is not here. Audio and video ride MoQ — Media over QUIC —
164through freeq's SFU, and that is `libjoltmoq`: Opus, H.264, capture and
165transport, lifted out of sleek rather than written a second time in jolt.
166`src/frq/av.jolt` is the whole of what frq says to it, and two of its rules
167shape this side:
168
169* **Nothing calls back.** Status and video are polled, drained by a timer that
170 glimmer runs on the loop thread — the only thread allowed to touch a node.
171* **A frame is borrowed.** The decoder's own buffer is handed to Vidya as a
172 pointer and painted by an `:image` with a `:feed`. The pixels never become a
173 jolt value and are never copied on this side, which is the only way thirty
174 frames a second is affordable here.
175
176The SFU is dialled once the server has minted a token, not when we ask to join:
177a remote SFU refuses a connection without one, and the MoQ client then retries
178in a loop that looks exactly like a hang.
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago179
180## Limits
181
182* **TLS and plain TCP only** — no WebSocket, no iroh. On Android, plain only.
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 20d ago183* **No `did:key` signing, no credential gates, no E2EE.** Sign-in of either
184 kind needs TLS, so it is desktop-only — the Android build connects as a
185 guest.
Remember an OAuth sign-in across restarts 4aa71e7 nandi 20d ago186* **Only the broker token is persisted**, and only for OAuth. An app-password
187 sign-in is not remembered.
Show the pictures people paste 56cdac3 nandi 20d ago188* **Previews are PNG only** — the tree backend's decoder reads no other
189 format, and a fetch needs TLS, so the phone shows links. The link is left in
190 place either way.
191* **Nothing evicts the media cache.**
Calls f31ad3d nandi 19d ago192* **Calls are desktop-only.** `libjoltmoq` is not built for Android here, and
193 the camera and microphone paths that are would still need the runtime
194 permissions the APK does not ask for.
195* **One call at a time**, which is the media plane's rule and the microphone's.
196* **No call is offered in a DM** — freeq's AV signaling is a channel's.
Send a picture by pasting it 8a491ba nandi 19d ago197* **Pasting a picture needs a sign-in and a desktop.** The upload is filed
198 under the DID of a live session, so a guest cannot make one; and it is read
199 off the clipboard through the ABI's `vidya_clipboard_image_png`, which
200 arboard backs on desktop and nothing backs on Android. It also shares
201 nothing to your PDS and posts nothing to Bluesky — those fields are opt-in
202 and this client does not send them.
Calls f31ad3d nandi 19d ago203* **No scrollback trimming or threads.**
Stop mistaking a quiet connection for a closed one a225fb1 nandi 20d ago204* A sent line waits up to 200ms for the reader thread to flush it.
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago205* Message lists are keyed vboxes; glimmer-vidya has no `:listbox` yet.