nandi/frqpublic Fork 0
9afdfa4b60d28ae8f9335cb9011809d631b8cdc4
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 · 214 lines · 10.9 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 19d 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 19d 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 19d ago23src/frq/clock.jolt the reader's own zone, twelve-hour times, day headings
Pick any emoji, in colour 18c5ccd nandi 19d 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 19d 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 bb from the flake, so a checkout needs nix and nothing else 270bee0 nandi 16d ago44The scripts under `scripts/` are babashka, reached through `scripts/bb`: a bb
45on `PATH` if there is one — the dev shell puts one there — and otherwise the
46flake's `.#bb`, built once and kept under `build/`. Nothing has to be installed
47for that but Nix.
48
Take every jolt-native half from the release, and only from there a008d3b nandi 18d ago49`just lib` fetches both shared objects this client loads —
50[jolt-native](https://gitlab.com/nandithebull/jolt-native)'s `libvidya`, the
51retained-tree ABI glimmer paints through, and `libjoltmoq`, the AV media plane
52— out of that project's release, by the digests in `scripts/*.dotslash`, and
53links them into `build/lib`. Nothing is compiled: no Rust toolchain, and no
54jolt-native checkout beside this one. It needs `patchelf`, and only to name
55libasound in `libjoltmoq.so`, which v0.1.3 does not — see the comment in
56`scripts/lib.bb`; that goes away with the release that links it. `just bump` moves every pin to the
57latest release at once, and `just bump v0.1.2` to a named one.
58
59`just run` is `jolt -M:frq` with `LD_LIBRARY_PATH` pointed at `build/lib`. It
60connects to `irc.freeq.at:6697` over TLS and joins `#test`. Untick TLS on the
61connect 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 ago62plain listener:
63
64```bash
65cargo run --release --bin freeq-server # in the freeq checkout
66```
67
Sign in with a Bluesky identity 5192124 nandi 20d ago68## Signing in
69
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 20d ago70Three modes on the connect screen.
Sign in with a Bluesky identity 5192124 nandi 20d ago71
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 20d ago72**Bluesky** (OAuth, the default way in) follows sleek's flow: frq binds a
73loopback port, puts it in `return_to`, and opens
74`auth.freeq.at/auth/login?handle=…`. The broker runs the OAuth dance with the
75PDS and redirects back to that port with the handoff in the URL *fragment*, so
76it never reaches a server as a query string. The page frq serves there has one
77job: POST the fragment back to itself. What comes back is a single-use SASL
78`web-token` and a durable `broker_token`; later connections mint a fresh token
79from the durable one at `/session` and skip the browser.
Sign in with a Bluesky identity 5192124 nandi 20d ago80
Remember an OAuth sign-in across restarts 4aa71e7 nandi 20d ago81The durable token is saved to `$XDG_CONFIG_HOME/frq/session.edn` (mode 600) so
Connect on launch when an account is remembered 9237cf4 nandi 19d ago82a restart resumes without one, along with the handle and nick it belongs to —
83and it connects on its own at launch when one is there.
Remember an OAuth sign-in across restarts 4aa71e7 nandi 20d ago84The web-token beside it is single-use and deliberately not saved. A token the
85broker no longer honours is dropped — from disk and memory — and the browser
86flow runs once more, rather than failing the same way on every Connect.
87
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 20d ago88**App password** signs in without a browser, straight to the user's own PDS:
89`resolveHandle` → DID → PDS from the DID document → `createSession`. The
90password goes to that PDS and nowhere else, is never written to disk, and is
91dropped once the session exists.
Sign in with a Bluesky identity 5192124 nandi 20d ago92
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 20d ago93Either way freeq sees only a token. The SASL mechanism is
94`ATPROTO-CHALLENGE` in both cases — `method: "web-token"`, which the server
95resolves through its own token store, or `method: "pds-session"` with the
96server's nonce echoed back so the token cannot be replayed elsewhere.
97
98A refused sign-in is reported and the connection carries on as a guest.
Sign in with a Bluesky identity 5192124 nandi 20d ago99
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago100## Android
101
Take every jolt-native half from the release, and only from there a008d3b nandi 18d ago102An APK whose native halves come from jolt-native's release and whose Jolt half
103is frq's: `libvidya.so` (the Rust/egui C ABI, which owns the event loop as the
104NativeActivity's own library), `libjoltmoq.so` (the media plane) and
105`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 ago106
107```bash
Build the APK as derivations only, and retire the buck2 graph 3bc3aaa nandi 16d ago108just apk run # build, install, launch on a connected device
109just apk log # logcat, filtered
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago110```
111
Build the APK as derivations only, and retire the buck2 graph 3bc3aaa nandi 16d ago112Needs nothing on the machine but Nix and an `adb`: the build is
113[`nix/android.nix`](nix/android.nix), and the SDK, the NDK, the arm64 Chez
114cross target and the OpenSSL the app carries are all built or fetched there.
115`nix build .#apk` is the same thing without adb; on a machine with a remote
116builder, hand it the store rather than a `builders` entry —
117`FRQ_NIX_STORE=ssh-ng://eu.nixbuild.net just apk`, and see the header of
118`nix/android.nix` for why.
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago119
120TLS does not work there: jolt reaches OpenSSL through the dynamic loader, and
121Android has no public `libssl` to load. The connect screen falls back to the
122plain `:6667` listener on its own, which is why the plain transport is the raw
123`socket`/`connect`/`send`/`recv` calls rather than jolt's `java.net.Socket`
124surface — that surface does not work on Android either, while the syscalls do.
125
126## What the PoC covers
127
128* TLS (`:6697`, via jolt.mvn-http's OpenSSL bindings) or plain TCP (`:6667`)
129* Guest connect (`NICK`/`USER`), `001` welcome, `PING`/`PONG` keepalive
130* Auto-joins `#test` on `irc.freeq.at`
131* Join channels, channel buffers with unread counts, send and receive `PRIVMSG`
Ask for the backlog freeq restores channels without 94e59a2 nandi 19d ago132* Backlog on join, and `CHATHISTORY` for the channels freeq restores instead
Say when each thing was said dbf3b86 nandi 19d ago133* Twelve-hour timestamps from the server's own clock, with a heading wherever
134 the day changes
Answer a message, not just read that one was answered 4876db8 nandi 19d ago135* A chip above a reply quoting what it answers, and a click that goes there;
136 ↩ beside a sender to answer them, with `+draft/reply` on the way out
Pick any emoji, in colour 18c5ccd nandi 19d ago137* Emoji reactions: colour pills under a message, ☺ beside the sender to open a
138 picker over every emoji Vidya can draw (popular first, then Unicode's own
139 groups, searchable by name), and a second click on a pill to take yours off
140 — sent as `TAGMSG`, and restored from the server's own tally when the
141 backlog comes back
Show the pictures people paste 56cdac3 nandi 19d ago142* Inline previews for PNG links, fetched once and cached under
Click a picture to see it full size 563ada3 nandi 19d ago143 `$XDG_CACHE_HOME/frq/media`; click one to see it full size
Send a picture by pasting it 8a491ba nandi 19d ago144* Ctrl+V in the draft attaches the picture on the clipboard: it is previewed
145 under the box and uploaded to freeq's media endpoint while you write the line
146 it goes with, and only on the way out does it become the link — which is the
147 whole of what sending an image over IRC means. The draft itself is never
148 written into. Text pastes as text, as it always did: the picture path is the
149 keystroke the field had no text to answer with
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago150* Join/part notices, DMs bucketed under the sender's nick
151* Discover list, search over buffers, disconnect
Remember which rooms this client has been in 1d062fd nandi 19d ago152* The rooms you have opened, remembered across runs and listed in the order
153 you last used them (`$XDG_CONFIG_HOME/frq/channels.edn`)
Order the chat list by what you were last in 75e557e nandi 19d ago154* Conversations listed most recently opened first
Show who is talking, with their Bluesky picture f5548bd nandi 19d ago155* Bluesky avatars beside the sender, resolved from the DID freeq tags each
156 message with
Calls f31ad3d nandi 19d ago157* Calls: a Call button opens one in a channel, a banner offers Join where
158 somebody already has, and in one there is mute, deafen, video and leave. Mute
159 and deafen are separate — a deafened microphone still carries your voice.
160 Whoever turns a camera on appears as a tile; the self-view is labelled You
161 and sits last, where it cannot push a face you are talking to off the row
162
163## Calls
164
165Signaling is IRC and lives here: `+freeq.at/av-start`, `av-join` and `av-leave`
166go out as TAGMSGs and the server broadcasts `+freeq.at/av-state` back, which is
167what actually moves this client's state — a press is optimistic, and the server
168settles it. Losing a race to open a call (`start-collision`) is answered by
169joining the call that won rather than by reporting an error, since the person
170asked to be in a call in that room and there is one.
171
172Media is not IRC and is not here. Audio and video ride MoQ — Media over QUIC —
173through freeq's SFU, and that is `libjoltmoq`: Opus, H.264, capture and
174transport, lifted out of sleek rather than written a second time in jolt.
175`src/frq/av.jolt` is the whole of what frq says to it, and two of its rules
176shape this side:
177
178* **Nothing calls back.** Status and video are polled, drained by a timer that
179 glimmer runs on the loop thread — the only thread allowed to touch a node.
180* **A frame is borrowed.** The decoder's own buffer is handed to Vidya as a
181 pointer and painted by an `:image` with a `:feed`. The pixels never become a
182 jolt value and are never copied on this side, which is the only way thirty
183 frames a second is affordable here.
184
185The SFU is dialled once the server has minted a token, not when we ask to join:
186a remote SFU refuses a connection without one, and the MoQ client then retries
187in a loop that looks exactly like a hang.
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 20d ago188
189## Limits
190
191* **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 ago192* **No `did:key` signing, no credential gates, no E2EE.** Sign-in of either
193 kind needs TLS, so it is desktop-only — the Android build connects as a
194 guest.
Remember an OAuth sign-in across restarts 4aa71e7 nandi 20d ago195* **Only the broker token is persisted**, and only for OAuth. An app-password
196 sign-in is not remembered.
Show the pictures people paste 56cdac3 nandi 19d ago197* **Previews are PNG only** — the tree backend's decoder reads no other
198 format, and a fetch needs TLS, so the phone shows links. The link is left in
199 place either way.
200* **Nothing evicts the media cache.**
Calls f31ad3d nandi 19d ago201* **Calls are desktop-only.** `libjoltmoq` is not built for Android here, and
202 the camera and microphone paths that are would still need the runtime
203 permissions the APK does not ask for.
204* **One call at a time**, which is the media plane's rule and the microphone's.
205* **No call is offered in a DM** — freeq's AV signaling is a channel's.
Send a picture by pasting it 8a491ba nandi 19d ago206* **Pasting a picture needs a sign-in and a desktop.** The upload is filed
207 under the DID of a live session, so a guest cannot make one; and it is read
208 off the clipboard through the ABI's `vidya_clipboard_image_png`, which
209 arboard backs on desktop and nothing backs on Android. It also shares
210 nothing to your PDS and posts nothing to Bluesky — those fields are opt-in
211 and this client does not send them.
Calls f31ad3d nandi 19d ago212* **No scrollback trimming or threads.**
Stop mistaking a quiet connection for a closed one a225fb1 nandi 19d ago213* 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 ago214* Message lists are keyed vboxes; glimmer-vidya has no `:listbox` yet.