@blockcast/fec-worker 0.3.0 → 0.4.0-main.373719cc7317

package/src/fec-worker-types.ts

@@ -2,8 +2,8 @@
  * @blockcast/fec-worker — Shared Type Definitions
  *
  * Defines the Worker message protocol (commands/events), FecTrackStats shape
- * consumed by fec-panel (Phase 5) and CmcdProducer (Phase 6), and auth
- * interface stubs (ALTA + relay block sig).
+ * consumed by fec-panel (Phase 5) and CmcdProducer (Phase 6), and the relay
+ * block signature stub.
  *
  * Types here are importable from both main thread and Worker contexts.
  */
@@ -12,19 +12,16 @@
 
 /**
  * FEC block profile (BLO-35597, ISO/IEC 23008-1 Annex C): the catalog
- * `fec.blockProfile` token. Both profiles carry identical wire tuples whose
- * block math differs, so it is required and never inferred.
- *
- * - `k-padded-v1` (legacy): SBN = floor(SS_ID / K), ESI = SS_ID % K;
- *   SS_Start = SBN * K; repair ESI = K + RS_ID.
- * - `iso-ssbg1-v1` (C.3.3 ssbg_mode1): SS_ID increments by one per source
- *   packet mod 2^32; a block is `[SS_Start, SS_Start + SSB_length)` keyed by
- *   SS_Start; `k` is only the maximum SSB_length; repair ESI =
- *   SSB_length + RS_ID.
+ * `fec.blockProfile` token. Required and never inferred; the only profile is
+ * `iso-ssbg1-v1` (C.3.3 ssbg_mode1): SS_ID increments by one per source
+ * packet mod 2^32; a block is `[SS_Start, SS_Start + SSB_length)` keyed by
+ * SS_Start; `k` is only the maximum SSB_length; repair ESI =
+ * SSB_length + RS_ID. The retired `k-padded-v1` token is refused like any
+ * unknown one.
  *
  * Mirrors @blockcast/mmt-base `FecBlockProfile`.
  */
-export type FecBlockProfile = "k-padded-v1" | "iso-ssbg1-v1";
+export type FecBlockProfile = "iso-ssbg1-v1";
 
 /** Per-track FEC configuration. Matches design spec section 3.2 FecTrackConfig. */
 export interface FecTrackConfig {
@@ -51,26 +48,31 @@ export interface FecTrackConfig {
 	repairCount: number;
 	/** Bytes per symbol */
 	symbolSize: number;
-	/** Retained decoder horizon as a BLOCK COUNT (SBN distance), not D.
-	 *  `isRetiredSbn` retires blocks more than this many blocks behind
-	 *  `liveSbn` (serial order on SS_ID, BLO-35597 iso:5) and
-	 *  `MmtFecDecoder::new` documents it as "the number of interleaved blocks".
-	 *  Under `iso-ssbg1-v1` the distance is `isoBlocksBehind(SS_ID, live SS_ID, k)`
-	 *  (block-order.ts), the lower bound every ISO receiver layer shares.
+	/** Retained decoder horizon as a BLOCK COUNT, not D. `isRetiredSbn`
+	 *  retires blocks more than this many blocks behind the live SS_ID, by
+	 *  `isoBlocksBehind(SS_ID, live SS_ID, k)` (block-order.ts), the lower
+	 *  bound every ISO receiver layer shares, and `MmtFecDecoder::new`
+	 *  documents it as "the number of interleaved blocks".
 	 *  Never assign `deriveFecInterleaveDepth()` here — that returns media units
 	 *  per block, which is a different quantity (BLO-35597). */
 	interleaveDepth: number;
-	/** Interleave depth in milliseconds (D * frameDurationMs) */
+	/**
+	 * Catalog interleave span in integer milliseconds. A positive value is the complete
+	 * source-plus-repair span; zero represents an absent/zero catalog span and
+	 * carries no elapsed-time deadline.
+	 */
 	interleaveMs: number;
-	/** Catalog-derived source+repair delivery window used for decoder cleanup. */
+	/**
+	 * Positive cleanup budget. For a positive `interleaveMs` this is the
+	 * catalog span plus its explicit reorder allowance. For zero it is a
+	 * receiver-local bound only, never an inferred catalog deadline.
+	 */
 	deliveryWindowMs: number;
 	/** FEC encoding mode */
 	fecMode: "subframe" | "object";
 	/** MoQ repair track name (optional) */
 	repairTrack?: string;
 
-	/** Whether ALTA publisher auth is enabled (AUTH-01) */
-	altaEnabled: boolean;
 	/** Whether relay block signature verification is enabled (AUTH-01) */
 	relayBlockSigEnabled: boolean;
 }
@@ -79,8 +81,7 @@ export interface FecTrackConfig {
 
 /** Per-block snapshot for live block visualization and stats. */
 export interface FecBlockSnapshot {
-	/** Block key: the source block number under `k-padded-v1`, the block's
-	 *  SS_Start under `iso-ssbg1-v1`. */
+	/** Block key: the block's SS_Start. */
 	sbn: number;
 	/** Current block state */
 	state: "collecting" | "complete" | "recovered" | "failed";
@@ -103,10 +104,11 @@ export interface FecBlockSnapshot {
 	lastSymbolTs: number;
 	/** Timestamp when block completed (ms), undefined if not yet complete */
 	completedTs?: number;
-	/** Deadline timestamp for block completion (ms) */
+	/**
+	 * Cleanup timestamp (ms). It is the catalog completion deadline when
+	 * `config.interleaveMs > 0`, and a local retention timestamp otherwise.
+	 */
 	deadlineTs: number;
-	/** Count of source symbols with valid ALTA signature (AUTH-02) */
-	altaVerified: number;
 	/** Relay block signature validity: true/false after verification, null if not yet verified (AUTH-02) */
 	relayBlockSigValid: boolean | null;
 }
@@ -131,45 +133,12 @@ export interface FecTrackStats {
 	/** Recovery success rate 0-100 */
 	recoveryRate: number;
 
-	/** Packets with valid publisher ALTA signature */
-	altaVerified: number;
-	/** Packets with MAC / signature / hash-chain mismatch (tamper-confirmed) */
-	altaFailed: number;
-	/** Packets that couldn't be verified due to missing trailer / not-ready verifier /
-	 *  late-joiner bootstrap gap. Neither tamper nor error — just unverifiable. */
-	altaPending: number;
-	/** Deferred-queue entries evicted by cap (queue full). Separate counter so
-	 *  cap misconfiguration is distinguishable from natural bootstrap-gap noise. */
-	altaPendingEvictedCap: number;
-	/** Deferred-queue entries evicted by TTL (retry window expired). */
-	altaPendingEvictedTtl: number;
-	/** verifyDetached / parse threw an exception (WASM trap, OOM, unmarshal panic).
-	 *  Not counted as altaFailed because the cause isn't crypto — helps ops
-	 *  distinguish infrastructure flake from tamper. */
-	altaError: number;
-	/** True if ALTA was enabled at configure time but the verifier WASM init
-	 *  failed. Ops alerting should treat this as "ALTA disabled due to error",
-	 *  distinct from "ALTA disabled by config" (altaEnabled flag not present). */
-	altaInitFailed: boolean;
-	/** Diagnostic: last ≤16 altaFailed events with full context (seq, error
-	 *  string from the verifier, auth+payload lengths, and which code path
-	 *  raised the failure). Bounded so it can't blow memory. Intended for
-	 *  investigation — not a stable API; consumers should treat it as
-	 *  opt-in and defensive (may be undefined). */
-	altaFailedDetails?: Array<{
-		seq: number;
-		error: string;
-		authLen: number;
-		payloadLen: number;
-		path: string;
-	}>;
 	/** Blocks with valid relay signature */
 	relayBlocksVerified: number;
 	/** Blocks with invalid relay signature */
 	relayBlocksFailed: number;
 
-	/** Live media position: the newest source block number under
-	 *  `k-padded-v1`, the newest accepted SS_ID / SS_Start under `iso-ssbg1-v1`. */
+	/** Live media position: the newest accepted SS_ID / SS_Start. */
 	liveSbn: number;
 	/** Active block snapshots */
 	blocks: FecBlockSnapshot[];
@@ -220,13 +189,14 @@ export interface FecTrackStats {
 	 */
 	sourceDroppedDuplicate?: number;
 	/**
-	 * `iso-ssbg1-v1` only: accepted source symbols whose block never became
-	 * known (no repair symbol named a range containing them) before their
-	 * SS_ID fell behind the retained horizon. They were already fed to the
-	 * decoder and routed directly; this counts the bookkeeping retired with
-	 * them, i.e. evidence that a block's repair symbols never arrived.
+	 * Accepted source symbols whose block never became known (no repair
+	 * symbol named a range containing them) before their SS_ID fell behind
+	 * the retained horizon. They were already fed to the decoder and routed
+	 * directly; this counts the bookkeeping retired with them, i.e. evidence
+	 * that a block's repair symbols never arrived. The decoder retires its
+	 * own copies by the same horizon inside `cleanup_by_ss_start`.
 	 */
-	sourceUnplacedRetired?: number;
+	sourceUnplacedRetired: number;
 	/** Native decoder counters, converted to numbers so browser diagnostics remain JSON-safe. */
 	decoder?: {
 		sourcePackets: number;
@@ -262,11 +232,9 @@ export type FecWorkerErrorCode =
 
 /** Per-frame metadata emitted with frame events from Worker. */
 export interface FrameMeta {
-	/** ALTA verification result: true/false after check, null when ALTA not configured (AUTH-04) */
-	altaVerified: boolean | null;
 	/** Whether this frame was recovered via FEC (not received directly) */
 	recovered: boolean;
-	/** Block key this frame belongs to: SBN (`k-padded-v1`) or SS_Start (`iso-ssbg1-v1`) */
+	/** Block key this frame belongs to: the block's SS_Start */
 	sbn: number;
 	/** Encoding Symbol ID within the recovered source block (0..ssbLength-1).
 	 *  Under `iso-ssbg1-v1` a recovered frame is the full T-byte ssbg_mode1
@@ -289,51 +257,29 @@ export type FecWorkerCommand =
 			type: "configure";
 			config: FecTrackConfig;
 			wasmModule: WebAssembly.Module;
-			/**
-			 * ALTA public key as PKCS#8 SubjectPublicKeyInfo DER bytes (self-describing).
-			 * Algorithm (Ed25519 or ECDSA P-256) is auto-detected from the SPKI OID.
-			 * Ed25519 SPKI is 44 bytes; P-256 uncompressed is 91 bytes.
-			 */
-			altaPublicKey?: ArrayBuffer;
-			/** Pre-compiled ALTA WASM module. Structured-cloneable (NOT transferable) — do not add to transfer list. */
-			altaWasmModule?: WebAssembly.Module;
 	  }
 	| {
 			type: "feedSource";
 			/** Flat 32-bit Source Symbol ID from the MMTP Source FEC Payload ID
-			 *  (ISO 23008-1 §C.5.2). Under `k-padded-v1` the WASM decoder derives
-			 *  SBN = floor(ssId/K) and ESI = ssId % K internally — do NOT
-			 *  pre-compute. Under `iso-ssbg1-v1` SS_IDs are consecutive per source
-			 *  packet mod 2^32 and the block comes from a repair's range. */
+			 *  (ISO 23008-1 §C.5.2). SS_IDs are consecutive per source packet mod
+			 *  2^32 and the block comes from a repair's range — do NOT
+			 *  pre-compute a block. */
 			ssId: number;
-			/** `k-padded-v1`: the source symbol. `iso-ssbg1-v1`: the protected
-			 *  packet exactly, unpadded and without its SS_ID (at most T-2 bytes). */
+			/** The protected packet exactly, unpadded and without its SS_ID (at
+			 *  most T-2 bytes). */
 			data: ArrayBuffer;
 			ts: number;
-			/** Optional ALTA authenticator bytes (detached mode — 08-07 MMTP
-			 *  trailer). Present when the source packet carried a
-			 *  `[0xF0A1][len][auth]` trailer and ALTA is enabled at the worker.
-			 *  When omitted, the worker skips verification and the packet
-			 *  counts as `altaPending`. */
-			altaAuth?: ArrayBuffer;
-			/** Byte offset within `data` where the signed MMTP payload ends
-			 *  (== where the trailer began on the wire). Required when
-			 *  `altaAuth` is present. Worker constructs
-			 *  `payload = new Uint8Array(data, 0, altaPayloadEnd)` for
-			 *  `verifyDetached(altaAuth, payload)`. */
-			altaPayloadEnd?: number;
 	  }
 	| {
 			type: "feedRepair";
 			/** SS_Start: SS_ID of the first source symbol in the block, from the
-			 *  MMTP Repair FEC Payload ID (ISO 23008-1 §C.5.3). `k-padded-v1`:
-			 *  = SBN * configured K. `iso-ssbg1-v1`: any uint32; the block key. */
+			 *  MMTP Repair FEC Payload ID (ISO 23008-1 §C.5.3): any uint32; the
+			 *  block key. */
 			ssStart: number;
 			/** Authored source-symbol count for this block; 1..configured K. */
 			ssbLength: number;
 			/** RS_ID: repair symbol index within the block; WASM maps to repair
-			 *  ESI = configured K + RS_ID (`k-padded-v1`) or SSB_length + RS_ID
-			 *  (`iso-ssbg1-v1`). */
+			 *  ESI = SSB_length + RS_ID. */
 			rsId: number;
 			data: ArrayBuffer;
 			ts: number;
@@ -358,7 +304,7 @@ export type FecWorkerCommand =
 	| {
 			type: "cleanup";
 			/** Every timed-out block covered by this coalesced queue-drain barrier,
-			 *  by block key: SBN (`k-padded-v1`) or SS_Start (`iso-ssbg1-v1`). */
+			 *  by block key (SS_Start). */
 			sbns: number[];
 	  }
 	| { type: "reset" }