rollback-netcode 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 someusername6
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,140 @@
+# Rollback Netcode
+
+[![npm version](https://img.shields.io/npm/v/rollback-netcode)](https://www.npmjs.com/package/rollback-netcode)
+[![license](https://img.shields.io/npm/l/rollback-netcode)](https://github.com/someusername6/rollback-netcode/blob/main/LICENSE)
+
+> **Note:** This library is under active development. APIs may change.
+
+A TypeScript library for P2P rollback netcode in browser-based multiplayer games. Supports 4+ players with WebRTC—no dedicated server required.
+
+**[Live Demo](https://someusername6.github.io/rollback-netcode)** | **[API Reference](docs/api.md)** | **[FAQ](docs/faq.md)**
+
+## Features
+
+- **Rollback netcode** - Simulate optimistically, rollback and resimulate on misprediction
+- **N-player support** - 4+ players, not limited to 2
+- **P2P networking** - WebRTC DataChannels, works in any modern browser
+- **Dynamic join/leave** - Players can join or leave during gameplay
+- **Desync detection** - Periodic state hashing with automatic recovery
+- **Transport-agnostic** - WebRTC included, or bring your own
+
+## Installation
+
+```bash
+npm install rollback-netcode
+```
+
+## Quick Start
+
+### 1. Implement the Game Interface
+
+Your game must implement four methods:
+
+```typescript
+import type { Game, PlayerId } from 'rollback-netcode';
+
+class MyGame implements Game {
+  private state = { x: 100, y: 100 };
+
+  serialize(): Uint8Array {
+    const buffer = new ArrayBuffer(8);
+    const view = new DataView(buffer);
+    view.setFloat32(0, this.state.x);
+    view.setFloat32(4, this.state.y);
+    return new Uint8Array(buffer);
+  }
+
+  deserialize(data: Uint8Array): void {
+    const view = new DataView(data.buffer, data.byteOffset, data.byteLength);
+    this.state.x = view.getFloat32(0);
+    this.state.y = view.getFloat32(4);
+  }
+
+  step(inputs: Map<PlayerId, Uint8Array>): void {
+    for (const [, input] of inputs) {
+      if (input[0] & 0x01) this.state.x -= 5;  // left
+      if (input[0] & 0x02) this.state.x += 5;  // right
+      if (input[0] & 0x04) this.state.y -= 5;  // up
+      if (input[0] & 0x08) this.state.y += 5;  // down
+    }
+  }
+
+  hash(): number {
+    return Math.floor(this.state.x * 1000 + this.state.y);
+  }
+}
+```
+
+### 2. Create a Session
+
+```typescript
+import { createSession, WebRTCTransport } from 'rollback-netcode';
+
+const transport = new WebRTCTransport('my-player-id', {
+  onSignal: async (peerId, signal) => {
+    // Send signal to peer via your signaling server
+    await signalingServer.send(peerId, signal);
+  }
+});
+
+signalingServer.onSignal((fromPeerId, signal) => {
+  transport.handleSignal(fromPeerId, signal);
+});
+
+const session = createSession({ game: new MyGame(), transport });
+
+session.on('playerJoined', (player) => console.log(`${player.id} joined`));
+session.on('desync', () => console.log('Desync detected, recovering...'));
+```
+
+### 3. Host or Join
+
+```typescript
+// Host creates a room
+const roomId = await session.createRoom();
+
+// Others join
+await session.joinRoom(roomId, hostPeerId);
+```
+
+### 4. Game Loop
+
+```typescript
+session.start();  // Host only
+
+function gameLoop() {
+  const input = new Uint8Array([
+    (keys.left  ? 0x01 : 0) |
+    (keys.right ? 0x02 : 0) |
+    (keys.up    ? 0x04 : 0) |
+    (keys.down  ? 0x08 : 0)
+  ]);
+
+  session.tick(input);
+  render(game);
+  requestAnimationFrame(gameLoop);
+}
+```
+
+## Examples
+
+See the [`examples/`](examples/) directory:
+
+- **[local-transport](examples/local-transport/)** - Browser demo using simulated network (no server needed)
+- **[webrtc](examples/webrtc/)** - Real WebRTC connections with a minimal signaling server
+
+## Documentation
+
+- [API Reference](docs/api.md) - Full API documentation
+- [FAQ](docs/faq.md) - Common questions answered
+- [Architecture](docs/architecture.md) - Technical design and components
+- [Configuration Tuning](docs/configuration-tuning.md) - Performance tuning guide
+
+## Requirements
+
+- Node.js >= 22.0.0 (development)
+- Modern browser with WebRTC (Chrome 56+, Firefox 44+, Safari 11+, Edge 79+)
+
+## License
+
+[MIT](LICENSE)

package/dist/debug.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Debug logging utilities for the rollback netcode library.
+ *
+ * When debug mode is enabled, these utilities provide detailed logging
+ * of rollback operations, input handling, and network events.
+ */
+/**
+ * Debug logger interface.
+ */
+export interface DebugLogger {
+    /** Log general information */
+    log: (message: string, data?: unknown) => void;
+    /** Log warnings */
+    warn: (message: string, data?: unknown) => void;
+    /** Log detailed trace information */
+    trace: (message: string, data?: unknown) => void;
+}
+/**
+ * Create a debug logger that only outputs when enabled.
+ *
+ * @param enabled - Whether debug logging is enabled
+ * @returns A debug logger instance
+ */
+export declare function createDebugLogger(enabled: boolean): DebugLogger;
+/**
+ * A no-op logger for when debugging is disabled.
+ */
+export declare const noopLogger: DebugLogger;
+//# sourceMappingURL=debug.d.ts.map

package/dist/debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,8BAA8B;IAC9B,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAE/C,mBAAmB;IACnB,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAEhD,qCAAqC;IACrC,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACjD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAgC/D;AAED;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,WAIxB,CAAC"}

package/dist/debug.js

@@ -0,0 +1,56 @@
+/**
+ * Debug logging utilities for the rollback netcode library.
+ *
+ * When debug mode is enabled, these utilities provide detailed logging
+ * of rollback operations, input handling, and network events.
+ */
+/**
+ * Create a debug logger that only outputs when enabled.
+ *
+ * @param enabled - Whether debug logging is enabled
+ * @returns A debug logger instance
+ */
+export function createDebugLogger(enabled) {
+    if (!enabled) {
+        return {
+            log: () => { },
+            warn: () => { },
+            trace: () => { },
+        };
+    }
+    return {
+        log: (message, data) => {
+            if (data !== undefined) {
+                console.log("[rollback]", message, data);
+            }
+            else {
+                console.log("[rollback]", message);
+            }
+        },
+        warn: (message, data) => {
+            if (data !== undefined) {
+                console.warn("[rollback]", message, data);
+            }
+            else {
+                console.warn("[rollback]", message);
+            }
+        },
+        trace: (message, data) => {
+            if (data !== undefined) {
+                console.log("[rollback:trace]", message, data);
+            }
+            else {
+                console.log("[rollback:trace]", message);
+            }
+        },
+    };
+}
+/**
+ * A no-op logger for when debugging is disabled.
+ */
+export const noopLogger = {
+    log: () => { },
+    warn: () => { },
+    trace: () => { },
+};
+//# sourceMappingURL=debug.js.map

package/dist/debug.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.js","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAgBH;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAgB;IACjD,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO;YACN,GAAG,EAAE,GAAG,EAAE,GAAE,CAAC;YACb,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;YACd,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;SACf,CAAC;IACH,CAAC;IAED,OAAO;QACN,GAAG,EAAE,CAAC,OAAe,EAAE,IAAc,EAAE,EAAE;YACxC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACP,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACpC,CAAC;QACF,CAAC;QACD,IAAI,EAAE,CAAC,OAAe,EAAE,IAAc,EAAE,EAAE;YACzC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACP,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACrC,CAAC;QACF,CAAC;QACD,KAAK,EAAE,CAAC,OAAe,EAAE,IAAc,EAAE,EAAE;YAC1C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACP,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;YAC1C,CAAC;QACF,CAAC;KACD,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAgB;IACtC,GAAG,EAAE,GAAG,EAAE,GAAE,CAAC;IACb,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;IACd,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;CACf,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Rollback Netcode Library
+ *
+ * A TypeScript library for P2P rollback netcode in browser-based multiplayer games.
+ *
+ * @example
+ * ```typescript
+ * import { createSession, WebRTCTransport } from 'rollback-netcode';
+ *
+ * // Game implements this interface
+ * const game: Game = {
+ *   serialize: () => { ... },
+ *   deserialize: (data) => { ... },
+ *   step: (inputs) => { ... },
+ *   hash: () => { ... },
+ * };
+ *
+ * // Create session
+ * const session = createSession({
+ *   game,
+ *   transport: new WebRTCTransport('player-1'),
+ * });
+ *
+ * // Host creates room
+ * const roomId = await session.createRoom();
+ *
+ * // Others join
+ * await session.joinRoom(roomId, 'host-peer-id');
+ *
+ * // Game loop
+ * function tick() {
+ *   const localInput = captureInput();
+ *   session.tick(localInput);
+ *   render(game);
+ *   requestAnimationFrame(tick);
+ * }
+ * ```
+ *
+ * @packageDocumentation
+ */
+export { createSession, Session } from "./session/session.js";
+export type { CreateSessionOptions } from "./session/session.js";
+export { StarTopology, MeshTopology, createTopologyStrategy, } from "./session/topology.js";
+export type { TopologyStrategy } from "./session/topology.js";
+export { RollbackEngine } from "./rollback/engine.js";
+export type { RollbackEngineConfig } from "./rollback/engine.js";
+export type { ConnectionMetrics, TransportAdapter, } from "./transport/adapter.js";
+export { LocalTransport, createLocalTransportGroup, } from "./transport/local.js";
+export type { LocalTransportConfig } from "./transport/local.js";
+export { WebRTCTransport } from "./transport/webrtc.js";
+export type { WebRTCTransportConfig, SignalingCallbacks, SignalMessage, } from "./transport/webrtc.js";
+export { TransformingTransport, DEFAULT_TRANSFORMING_TRANSPORT_CONFIG, } from "./transport/transforming.js";
+export type { TransformingTransportConfig } from "./transport/transforming.js";
+export { encodeMessage, decodeMessage, DecodeError, DEFAULT_PROTOCOL_LIMITS, } from "./protocol/encoding.js";
+export type { ProtocolLimits } from "./protocol/encoding.js";
+export { MessageType } from "./protocol/messages.js";
+export type { Message } from "./protocol/messages.js";
+export type { Game, GameOperation, PlayerId, Tick, TickResult, SessionConfig, SessionEvents, PlayerInfo, InputPredictor, Snapshot, PlayerTimeline, ErrorContext, } from "./types.js";
+export { Topology, DesyncAuthority, SessionState, PlayerRole, ErrorSource, PauseReason, PlayerConnectionState, asPlayerId, asTick, validatePlayerId, validateTick, playerIdToPeerId, TICK_MIN, DEFAULT_SESSION_CONFIG, DEFAULT_INPUT_PREDICTOR, MAX_PLAYERS_LIMIT, RollbackError, ValidationError, GameError, validateSessionConfig, } from "./types.js";
+export { createDebugLogger, noopLogger } from "./debug.js";
+export type { DebugLogger } from "./debug.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAGH,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC9D,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAGjE,OAAO,EACN,YAAY,EACZ,YAAY,EACZ,sBAAsB,GACtB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAG9D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAGjE,YAAY,EACX,iBAAiB,EACjB,gBAAgB,GAChB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACN,cAAc,EACd,yBAAyB,GACzB,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,YAAY,EACX,qBAAqB,EACrB,kBAAkB,EAClB,aAAa,GACb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACN,qBAAqB,EACrB,qCAAqC,GACrC,MAAM,6BAA6B,CAAC;AACrC,YAAY,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAC;AAG/E,OAAO,EACN,aAAa,EACb,aAAa,EACb,WAAW,EACX,uBAAuB,GACvB,MAAM,wBAAwB,CAAC;AAChC,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,YAAY,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAGtD,YAAY,EACX,IAAI,EACJ,aAAa,EACb,QAAQ,EACR,IAAI,EACJ,UAAU,EACV,aAAa,EACb,aAAa,EACb,UAAU,EACV,cAAc,EACd,QAAQ,EACR,cAAc,EACd,YAAY,GACZ,MAAM,YAAY,CAAC;AAGpB,OAAO,EACN,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,UAAU,EACV,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,UAAU,EACV,MAAM,EACN,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,QAAQ,EACR,sBAAsB,EACtB,uBAAuB,EACvB,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,SAAS,EACT,qBAAqB,GACrB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC3D,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,57 @@
+/**
+ * Rollback Netcode Library
+ *
+ * A TypeScript library for P2P rollback netcode in browser-based multiplayer games.
+ *
+ * @example
+ * ```typescript
+ * import { createSession, WebRTCTransport } from 'rollback-netcode';
+ *
+ * // Game implements this interface
+ * const game: Game = {
+ *   serialize: () => { ... },
+ *   deserialize: (data) => { ... },
+ *   step: (inputs) => { ... },
+ *   hash: () => { ... },
+ * };
+ *
+ * // Create session
+ * const session = createSession({
+ *   game,
+ *   transport: new WebRTCTransport('player-1'),
+ * });
+ *
+ * // Host creates room
+ * const roomId = await session.createRoom();
+ *
+ * // Others join
+ * await session.joinRoom(roomId, 'host-peer-id');
+ *
+ * // Game loop
+ * function tick() {
+ *   const localInput = captureInput();
+ *   session.tick(localInput);
+ *   render(game);
+ *   requestAnimationFrame(tick);
+ * }
+ * ```
+ *
+ * @packageDocumentation
+ */
+// Core session management
+export { createSession, Session } from "./session/session.js";
+// Topology strategies
+export { StarTopology, MeshTopology, createTopologyStrategy, } from "./session/topology.js";
+// Rollback engine (for advanced use cases)
+export { RollbackEngine } from "./rollback/engine.js";
+export { LocalTransport, createLocalTransportGroup, } from "./transport/local.js";
+export { WebRTCTransport } from "./transport/webrtc.js";
+export { TransformingTransport, DEFAULT_TRANSFORMING_TRANSPORT_CONFIG, } from "./transport/transforming.js";
+// Protocol encoding (for custom transport implementations)
+export { encodeMessage, decodeMessage, DecodeError, DEFAULT_PROTOCOL_LIMITS, } from "./protocol/encoding.js";
+export { MessageType } from "./protocol/messages.js";
+// Enums and values from types
+export { Topology, DesyncAuthority, SessionState, PlayerRole, ErrorSource, PauseReason, PlayerConnectionState, asPlayerId, asTick, validatePlayerId, validateTick, playerIdToPeerId, TICK_MIN, DEFAULT_SESSION_CONFIG, DEFAULT_INPUT_PREDICTOR, MAX_PLAYERS_LIMIT, RollbackError, ValidationError, GameError, validateSessionConfig, } from "./types.js";
+// Debug utilities
+export { createDebugLogger, noopLogger } from "./debug.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,0BAA0B;AAC1B,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG9D,sBAAsB;AACtB,OAAO,EACN,YAAY,EACZ,YAAY,EACZ,sBAAsB,GACtB,MAAM,uBAAuB,CAAC;AAG/B,2CAA2C;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAQtD,OAAO,EACN,cAAc,EACd,yBAAyB,GACzB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAMxD,OAAO,EACN,qBAAqB,EACrB,qCAAqC,GACrC,MAAM,6BAA6B,CAAC;AAGrC,2DAA2D;AAC3D,OAAO,EACN,aAAa,EACb,aAAa,EACb,WAAW,EACX,uBAAuB,GACvB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAmBrD,8BAA8B;AAC9B,OAAO,EACN,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,UAAU,EACV,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,UAAU,EACV,MAAM,EACN,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,QAAQ,EACR,sBAAsB,EACtB,uBAAuB,EACvB,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,SAAS,EACT,qBAAqB,GACrB,MAAM,YAAY,CAAC;AAEpB,kBAAkB;AAClB,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC"}

package/dist/protocol/encoding.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Binary encoding and decoding utilities for protocol messages.
+ *
+ * Message format:
+ * - Byte 0: Message type
+ * - Bytes 1+: Message payload (varies by type)
+ */
+import { type Message } from "./messages.js";
+/**
+ * Error thrown when decoding a message fails.
+ */
+export declare class DecodeError extends Error {
+    readonly messageType: number | undefined;
+    readonly offset: number;
+    readonly expected: number;
+    readonly actual: number;
+    constructor(message: string, messageType: number | undefined, offset: number, expected: number, actual: number);
+}
+/**
+ * Error thrown when encoding a message fails due to invalid values.
+ */
+export declare class EncodeError extends Error {
+    readonly field: string;
+    readonly maxValue: number;
+    readonly actualValue: number;
+    constructor(message: string, field: string, maxValue: number, actualValue: number);
+}
+/**
+ * Maximum size of a single input frame in bytes.
+ * This prevents malicious peers from sending excessively large inputs.
+ * 1KB is more than sufficient for any reasonable game input.
+ */
+export declare const MAX_INPUT_SIZE_PER_FRAME = 1024;
+/**
+ * Maximum total size of an InputMessage in bytes.
+ * This prevents memory exhaustion from malicious messages.
+ * 64KB allows for 255 frames × ~250 bytes each with overhead.
+ */
+export declare const MAX_INPUT_MESSAGE_SIZE = 65536;
+/**
+ * Configurable limits for protocol decoding.
+ * These limits prevent DoS attacks via oversized messages.
+ */
+export interface ProtocolLimits {
+    /**
+     * Maximum length of a string (player ID, room ID, etc.) in bytes.
+     * Prevents memory exhaustion from malicious large strings.
+     * @default 1024
+     */
+    maxStringLength: number;
+    /**
+     * Maximum number of players in a player timeline.
+     * Prevents memory exhaustion from malicious large player lists.
+     * @default 256
+     */
+    maxPlayerCount: number;
+    /**
+     * Maximum size of game state in bytes.
+     * Prevents memory exhaustion from malicious large state payloads.
+     * @default 1000000 (1MB)
+     */
+    maxStateSize: number;
+}
+/**
+ * Default protocol limits.
+ * These values are suitable for most games and provide DoS protection.
+ */
+export declare const DEFAULT_PROTOCOL_LIMITS: ProtocolLimits;
+/**
+ * Encode a message to a binary format.
+ */
+export declare function encodeMessage(message: Message): Uint8Array;
+/**
+ * Decode a binary message.
+ * @param data - The binary data to decode
+ * @param limits - Optional protocol limits for DoS protection (defaults to DEFAULT_PROTOCOL_LIMITS)
+ * @throws DecodeError if the message is malformed, truncated, or exceeds limits
+ */
+export declare function decodeMessage(data: Uint8Array, limits?: ProtocolLimits): Message;
+//# sourceMappingURL=encoding.d.ts.map

package/dist/protocol/encoding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../../src/protocol/encoding.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAUH,OAAO,EAUN,KAAK,OAAO,EAYZ,MAAM,eAAe,CAAC;AAMvB;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK;aAGpB,WAAW,EAAE,MAAM,GAAG,SAAS;aAC/B,MAAM,EAAE,MAAM;aACd,QAAQ,EAAE,MAAM;aAChB,MAAM,EAAE,MAAM;gBAJ9B,OAAO,EAAE,MAAM,EACC,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM;CAS/B;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK;aAGpB,KAAK,EAAE,MAAM;aACb,QAAQ,EAAE,MAAM;aAChB,WAAW,EAAE,MAAM;gBAHnC,OAAO,EAAE,MAAM,EACC,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM;CAKpC;AAmCD;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,OAAO,CAAC;AAE7C;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,QAAQ,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,cAIrC,CAAC;AAiHF;;GAEG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,CAyC1D;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC5B,IAAI,EAAE,UAAU,EAChB,MAAM,GAAE,cAAwC,GAC9C,OAAO,CAwDT"}