@solarpunkltd/swarm-chat-js 7.2.0 → 8.0.0

package/dist/message.js

@@ -1,308 +1,2 @@
-import { Bytes as e, EthAddress as t, Identifier as n, PrivateKey as r, Reference as i, Signature as a } from "@ethersphere/bee-js";
-import { z as o } from "zod";
-//#region src/message/message.ts
-var s = 7, c = 2048, l = 128, u = 500, d = 20, f = {
-	TEXT: "text",
-	THREAD: "thread",
-	REACTION: "reaction"
-};
-function p(e) {
-	let t = 0;
-	for (let n of e) t++;
-	return t;
-}
-function m(e) {
-	return o.string().regex(RegExp(`^[0-9a-f]{${e}}$`), `expected ${e} lowercase hex characters`);
-}
-function h(e, t) {
-	return o.string().refine((n) => {
-		let r = p(n);
-		return r >= e && r <= t;
-	}, `expected ${e} to ${t} characters`);
-}
-var g = m(32), _ = o.strictObject({
-	v: o.literal(7),
-	topic: h(1, 128),
-	id: g,
-	type: o.enum([
-		f.TEXT,
-		f.THREAD,
-		f.REACTION
-	]),
-	target: o.union([o.literal(""), g]),
-	text: h(1, 500),
-	name: h(1, 20),
-	addr: m(40),
-	ts: o.number().int().nonnegative().max(2 ** 53 - 1),
-	sig: m(130)
-}).refine((e) => e.type === f.TEXT == (e.target === ""), {
-	message: "a text message has no target, a thread reply or a reaction names one",
-	path: ["target"]
-}), v = class extends Error {
-	constructor(e, t) {
-		super(`chat message refused (${e}): ${t}`), this.reason = e, this.name = "ChatMessageError";
-	}
-}, y = new TextEncoder(), b = new TextDecoder("utf-8", { fatal: !0 });
-function x(e) {
-	return y.encode(JSON.stringify([
-		e.v,
-		e.topic,
-		e.id,
-		e.type,
-		e.target,
-		e.text,
-		e.name,
-		e.addr,
-		e.ts
-	]));
-}
-function S(e) {
-	let t = {
-		v: e.v,
-		topic: e.topic,
-		id: e.id,
-		type: e.type,
-		target: e.target,
-		text: e.text,
-		name: e.name,
-		addr: e.addr,
-		ts: e.ts,
-		sig: e.sig
-	};
-	return y.encode(JSON.stringify(t));
-}
-function C() {
-	let e = crypto.getRandomValues(/* @__PURE__ */ new Uint8Array(16));
-	return Array.from(e, (e) => e.toString(16).padStart(2, "0")).join("");
-}
-function w(e) {
-	return e.issues.map((e) => `${e.path.join(".") || "message"}: ${e.message}`).join(", ");
-}
-function T(e, t) {
-	let n = e instanceof r ? e : new r(e), i = {
-		v: 7,
-		topic: t.topic,
-		id: t.id ?? C(),
-		type: t.type,
-		target: t.target ?? "",
-		text: t.text,
-		name: t.name,
-		addr: n.publicKey().address().toHex(),
-		ts: t.ts ?? Date.now()
-	}, a = {
-		...i,
-		sig: "0".repeat(130)
-	}, o = _.safeParse(a);
-	if (!o.success) throw new v("shape", w(o.error));
-	let s = S(a).byteLength;
-	if (s > 2048) throw new v("too-large", `${s} bytes, the cap is ${c}`);
-	let l = {
-		...i,
-		sig: n.sign(x(i)).toHex()
-	};
-	return {
-		message: l,
-		bytes: S(l)
-	};
-}
-function E(e) {
-	try {
-		return new a(e.sig).recoverPublicKey(x(e)).address().toHex() === e.addr;
-	} catch {
-		return !1;
-	}
-}
-function D(e) {
-	let t = _.safeParse(e);
-	return t.success ? E(t.data) ? {
-		ok: !0,
-		message: t.data
-	} : {
-		ok: !1,
-		reason: "signature",
-		detail: "the signature was not made by addr over these fields"
-	} : {
-		ok: !1,
-		reason: "shape",
-		detail: w(t.error)
-	};
-}
-function O(e) {
-	if (e.byteLength > 2048) return {
-		ok: !1,
-		reason: "too-large",
-		detail: `${e.byteLength} bytes, the cap is ${c}`
-	};
-	let t;
-	try {
-		t = b.decode(e);
-	} catch {
-		return {
-			ok: !1,
-			reason: "not-utf8",
-			detail: "the payload is not valid UTF-8"
-		};
-	}
-	let n;
-	try {
-		n = JSON.parse(t);
-	} catch {
-		return {
-			ok: !1,
-			reason: "not-json",
-			detail: "the payload is not JSON"
-		};
-	}
-	return D(n);
-}
-//#endregion
-//#region src/message/entry.ts
-var k = 4096, A = o.string().regex(/^[0-9a-f]{64}([0-9a-f]{64})?$/, "expected a 64 or 128 hex character reference"), j = o.number().int().nonnegative().max(2 ** 53 - 1), M = o.strictObject({
-	ref: A,
-	toSeq: j
-}), N = o.strictObject({
-	v: o.literal(7),
-	seq: j,
-	at: j,
-	msg: _,
-	history: M.nullable()
-}), P = o.strictObject({
-	seq: j,
-	at: j,
-	msg: _
-}), F = o.strictObject({
-	v: o.literal(7),
-	topic: o.string().min(1),
-	fromSeq: j,
-	toSeq: j,
-	messages: o.array(o.unknown()),
-	prev: M.nullable()
-}).refine((e) => e.fromSeq <= e.toSeq, {
-	message: "fromSeq is after toSeq",
-	path: ["fromSeq"]
-}), I = new TextDecoder("utf-8", { fatal: !0 });
-function L(e) {
-	let t;
-	try {
-		t = I.decode(e);
-	} catch {
-		return {
-			ok: !1,
-			reason: "not-utf8",
-			detail: "the payload is not valid UTF-8"
-		};
-	}
-	try {
-		return {
-			ok: !0,
-			value: JSON.parse(t)
-		};
-	} catch {
-		return {
-			ok: !1,
-			reason: "not-json",
-			detail: "the payload is not JSON"
-		};
-	}
-}
-function R(e) {
-	return e.issues.map((e) => `${e.path.join(".") || "value"}: ${e.message}`).join(", ");
-}
-function z(e, t, n) {
-	let r = L(e);
-	if (!r.ok) return r;
-	let i = N.safeParse(r.value);
-	return i.success ? i.data.seq === t ? i.data.msg.topic === n ? {
-		ok: !0,
-		value: i.data
-	} : {
-		ok: !1,
-		reason: "mismatch",
-		detail: "the message belongs to another chat"
-	} : {
-		ok: !1,
-		reason: "mismatch",
-		detail: `seq ${i.data.seq} at index ${t}`
-	} : {
-		ok: !1,
-		reason: "shape",
-		detail: R(i.error)
-	};
-}
-function B(e, t, n) {
-	let r = L(e);
-	if (!r.ok) return r;
-	let i = F.safeParse(r.value);
-	if (!i.success) return {
-		ok: !1,
-		reason: "shape",
-		detail: R(i.error)
-	};
-	if (i.data.topic !== t || i.data.toSeq !== n.toSeq) return {
-		ok: !1,
-		reason: "mismatch",
-		detail: "the file is not the one its link names"
-	};
-	let { fromSeq: a, toSeq: o, prev: s } = i.data, c = [], l = 0;
-	for (let e of i.data.messages) {
-		let n = P.safeParse(e);
-		n.success && n.data.seq >= a && n.data.seq <= o && n.data.msg.topic === t ? c.push(n.data) : l++;
-	}
-	return {
-		ok: !0,
-		value: {
-			topic: t,
-			fromSeq: a,
-			toSeq: o,
-			rows: c,
-			prev: s,
-			skipped: l
-		}
-	};
-}
-//#endregion
-//#region src/message/note.ts
-var V = 1, H = 2e3, U = 3e4, W = 256, G = o.strictObject({
-	v: o.literal(1),
-	newest: o.number().int().min(-1).max(2 ** 53 - 1),
-	writtenAt: o.number().int().nonnegative().max(2 ** 53 - 1)
-});
-function K(e) {
-	if (!Number.isInteger(e) || e <= 0) throw RangeError(`a note slot is a positive whole number of milliseconds, not ${e}`);
-}
-function q(e, t) {
-	return K(t), Math.floor(e / t);
-}
-function J(e, t) {
-	return K(t), (e + 1) * t;
-}
-function Y(e, t, n) {
-	return `${e}/note/${t}/${n}`;
-}
-function X(e, t, r) {
-	return n.fromString(Y(e, t, r));
-}
-function Z(n, r, a, o) {
-	let s = X(n, r, a);
-	return new i(e.keccak256(e.concat(s.toUint8Array(), new t(o).toUint8Array())));
-}
-var Q = new TextEncoder(), $ = new TextDecoder("utf-8", { fatal: !0 });
-function ee(e) {
-	let t = {
-		v: 1,
-		newest: e.newest,
-		writtenAt: e.writtenAt
-	};
-	return Q.encode(JSON.stringify(t));
-}
-function te(e) {
-	if (e.length > 256) return null;
-	try {
-		let t = G.safeParse(JSON.parse($.decode(e)));
-		return t.success ? t.data : null;
-	} catch {
-		return null;
-	}
-}
-//#endregion
-export { v as ChatMessageError, U as DEFAULT_NOTE_HEARTBEAT_MS, H as DEFAULT_NOTE_SLOT_MS, k as MAX_ENTRY_BYTES, c as MAX_MESSAGE_BYTES, d as MAX_NAME_CHARACTERS, W as MAX_NOTE_BYTES, u as MAX_TEXT_CHARACTERS, l as MAX_TOPIC_CHARACTERS, s as MESSAGE_VERSION, f as MessageType, V as NOTE_VERSION, _ as chatMessageSchema, D as checkChatMessage, p as countCharacters, T as createChatMessage, S as encodeChatMessage, ee as encodeSlotNote, N as feedEntrySchema, E as hasValidSignature, F as historyFileSchema, M as historyLinkSchema, P as historyRowSchema, C as newMessageId, Z as noteAddress, X as noteIdentifier, Y as noteIdentifierText, J as noteSlotEnd, q as noteSlotOf, O as parseChatMessage, z as parseFeedEntry, B as parseHistoryFile, te as parseSlotNote, x as signedBytes, G as slotNoteSchema };
+import { A as e, B as t, C as n, D as r, E as i, F as a, H as o, I as s, L as c, M as l, N as u, O as d, P as f, R as p, S as m, T as h, V as g, _, a as v, b as y, c as b, d as x, f as S, g as C, h as w, i as T, j as E, k as D, l as O, m as k, n as A, o as j, p as M, r as N, s as P, t as F, u as I, v as L, w as R, x as z, y as B, z as V } from "./message-Dbh8qrpg.js";
+export { V as CHAT_BINDING_TITLE, m as ChatMessageError, F as DEFAULT_NOTE_HEARTBEAT_MS, A as DEFAULT_NOTE_SLOT_MS, t as MAX_BINDING_CHARACTERS, M as MAX_ENTRY_BYTES, n as MAX_MESSAGE_BYTES, R as MAX_NAME_CHARACTERS, N as MAX_NOTE_BYTES, h as MAX_TEXT_CHARACTERS, i as MAX_TOPIC_CHARACTERS, r as MESSAGE_VERSION, d as MessageType, D as MessageVia, T as NOTE_VERSION, y as OWN_FEED_TOPIC_PREFIX, g as chatBindingSchema, e as chatMessageSchema, o as checkChatBinding, E as countCharacters, l as createChatMessage, u as encodeChatMessage, v as encodeSlotNote, k as feedEntrySchema, f as hasValidSignature, w as historyFileSchema, C as historyLinkSchema, _ as historyRowSchema, a as newMessageId, j as noteAddress, P as noteIdentifier, b as noteIdentifierText, O as noteSlotEnd, I as noteSlotOf, z as ownFeedTopic, s as parseChatMessage, L as parseFeedEntry, B as parseHistoryFile, x as parseSlotNote, c as signedBytes, S as slotNoteSchema, p as verifyChatMessage };

package/dist/notes.d.ts

@@ -11,6 +11,8 @@ export interface NoteSettings {
     scanBatch: number;
     /** The furthest the clock correction goes either way. */
     clockLimitMs: number;
+    /** The shortest wait between two reads of a note that came back missing, see `pacer.ts` for why. */
+    missingReadSpacingMs: number;
 }
 export declare const DEFAULT_NOTE_SETTINGS: NoteSettings;
 /** A note that was found, and the time slot it was found at. */
@@ -61,6 +63,7 @@ export declare class NoteReader {
         empty: number;
     };
     readonly settings: NoteSettings;
+    private readonly pacer;
     constructor(source: NoteSource, settings: Partial<NoteSettings>, now: () => number);
     /** The newest time slot whose note may be asked for at `now`: over, and the margin past, by the server's clock. */
     lastReadableSlot(now?: number): number;
@@ -70,7 +73,11 @@ export declare class NoteReader {
     get lookBackSlots(): number;
     /** How long a follower goes without finding a note before it stops trusting its clock. */
     get silenceMs(): number;
-    /** One slot's note, or null when there is none to be had. Rejects only when the gateway fails. */
+    /**
+     * One slot's note, or null when there is none to be had. Rejects only when the gateway fails. A note that came back
+     * missing is not asked for again within the spacing, which only an opening tried again or a clock found to run
+     * ahead would do, and is then null without asking.
+     */
     read(slot: number): Promise<SlotNote | null>;
     /**
      * The newest note from slot `newest` back to slot `oldest`, read newest first, `scanBatch` at a time, stopping at

package/dist/pacer.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The shortest wait between two reads of one address that came back missing: three reads a minute at most.
+ *
+ * Bee answers the first few reads of a chunk it cannot find 404, and puts every peer it asked on a skip list for that
+ * chunk for a minute (`ethersphere/bee`, `pkg/retrieval/retrieval.go`, `errSkip` and `skiplistDur = time.Minute`).
+ * Once no peer is left it answers 500 at once, because "no peer left" is not `storage.ErrNotFound`
+ * (`pkg/api/chunk.go`). A chunk written while its address is on that list stays unreadable on that node for up to a
+ * minute. Measured on swarm-dev on 2026-10-12: an address read every second for 20 s and then written was readable
+ * after 33 to 36 s, one nobody had asked for at once. About four reads of a missing address exhaust the list, so one
+ * read every twenty seconds stays under it.
+ */
+export declare const DEFAULT_MISSING_READ_SPACING_MS = 20000;
+/**
+ * Holds back a read of a slot whose address came back missing until `spacingMs` has passed since that answer. A slot
+ * that was found, or never read, may be read at once. A follower keeps one for feed slots and a note reader one for
+ * time slots.
+ */
+export declare class MissingReadPacer {
+    private readonly spacingMs;
+    private readonly now;
+    private readonly missedAt;
+    constructor(spacingMs: number, now: () => number);
+    /** The local time from which `slot` may be read again, which is in the past for an address not held back. */
+    readableAt(slot: number, now?: number): number;
+    mayRead(slot: number, now?: number): boolean;
+    missed(slot: number, now?: number): void;
+    found(slot: number): void;
+    clear(): void;
+    /** A miss recorded after `now` was recorded before the clock was set back, and holds nothing. */
+    private expired;
+}

package/dist/sender.d.ts

@@ -1,5 +1,5 @@
 import type { PrivateKey } from '@ethersphere/bee-js';
-import { type ChatMessage, type ChatMessageDraft } from './message/index.js';
+import { type ChatBinding, type ChatMessage, type ChatMessageDraft, type MessageVia } from './message/index.js';
 /** Writes one payload to the chat's GSOC address. Rejects when the write did not reach the node. */
 export type GsocWrite = (payload: Uint8Array) => Promise<void>;
 export interface SenderSettings {
@@ -26,21 +26,28 @@ export interface SenderEvents {
     /** Read back from the chat feed. */
     confirmed(message: ChatMessage): void;
 }
-export type SendDraft = Omit<ChatMessageDraft, 'name' | 'ts' | 'id'>;
+export type SendDraft = Omit<ChatMessageDraft, 'name' | 'ts' | 'id' | 'via' | 'own' | 'idb'>;
+/** What every message this sender signs says about who sent it and how. */
+export interface SenderProfile {
+    name: string;
+    via: MessageVia;
+    /** The sender's Swarm ID chat binding, for a signed-in sender only. */
+    idb?: ChatBinding;
+}
 /**
  * Sends signed messages as GSOC writes and keeps each one pending until the chat feed shows it. A pending message is
  * written again with the identical bytes, so the server can tell a resend from a new message by its id.
  */
 export declare class Sender {
     private readonly key;
-    private readonly name;
+    private readonly profile;
     private readonly write;
     private readonly events;
     private readonly settings;
     private readonly outgoing;
     private readonly reactions;
     private stopped;
-    constructor(key: PrivateKey, name: string, write: GsocWrite, events: SenderEvents, settings?: SenderSettings);
+    constructor(key: PrivateKey, profile: SenderProfile, write: GsocWrite, events: SenderEvents, settings?: SenderSettings);
     get address(): string;
     /** Builds, signs and writes a message. Throws a ChatMessageError, and writes nothing, for one the server would refuse. */
     send(draft: SendDraft): ChatMessage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solarpunkltd/swarm-chat-js",
-  "version": "7.2.0",
+  "version": "8.0.0",
   "description": "JS library for chatting on Swarm",
   "keywords": [
     "chat",
@@ -46,6 +46,7 @@
     "test": "vitest run"
   },
   "dependencies": {
+    "@ethersphere/core-sdk": "0.1.1",
     "zod": "4.6.5"
   },
   "devDependencies": {