@driftengine/network 3.61.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Drift Technologies
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,9 @@
+DriftEngine
+Copyright 2026 Drift Technologies
+
+This product includes software developed at Drift Technologies
+(https://github.com/drftrun/driftengine).
+
+Licensed under the Apache License, Version 2.0. Section 4(d) of that licence
+requires this NOTICE to be reproduced in any derivative work you distribute,
+in the source, the documentation, or a display generated by the work.

package/README.md

@@ -0,0 +1,125 @@
+# @driftengine/network
+
+A transport seam, rewind and replay, and the two networking models built on them.
+
+**Cost: 2.4 KB gzipped standalone.** Measured by `scripts/size-gate.test.mjs`, which fails if it
+drifts more than 3% — the number comes from the same floors that gate asserts, so a README quoting
+a stale one is a red suite rather than a thing somebody notices.
+
+**Standalone, and the raw figure is the claim.** 6,901 bytes raw against core's 2.79 MB: no
+renderer is in this package's module graph. `boundaries.test.mjs` already makes the argument about
+`@driftengine/physics` — _"a deterministic simulation with no renderer in its module graph, which is
+what an authoritative host runs"_ — and this is the second package it applies to. It imports
+`@driftengine/entities` at runtime and nothing else.
+
+## What is in it
+
+|                                     |                                                                                                                   |
+| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+| `RewindLoop`                        | Rewind to a tick, replay to now. Both models sit on this one                                                      |
+| `InputLog`                          | Every participant's input, over a window that is explicit rather than a modulo                                    |
+| `Snapshotter`                       | The state seam. `worldSnapshotter`, `randomSnapshotter`, `combineSnapshotters`                                    |
+| `Transport`                         | The seam a caller supplies. `LoopbackTransport` with an impairment model, `WebSocketTransport`, `WebRtcTransport` |
+| `LockstepSession`                   | Peers exchange inputs; a wrong guess is unwound; a divergence halts and names its tick                            |
+| `AuthorityHost`, `PredictingClient` | One world is the truth; a client predicts its own player and corrects                                             |
+| `StateInterpolator`                 | Remote bodies drawn between two states the authority sent                                                         |
+| `Fingerprint`                       | A hash of state, so a desync has a tick number                                                                    |
+| `Sim`                               | Opt-in 48.16 fixed point, for a consumer who would rather not depend on an argument about IEEE 754                |
+
+## The one idea
+
+**Prediction and rollback are the same operation.** A lockstep peer that guessed a remote input and
+then learned the real one has to unwind the ticks it computed from the guess. A predicting client
+whose authority disagrees has to unwind the ticks it computed from a world that was wrong. Both are:
+put the state back to tick _T_, correct what was wrong about _T_, and step forward to where we were.
+
+So there is one `RewindLoop` and both models sit on it, rather than two implementations of one
+mechanism.
+
+```ts
+const rewind = new RewindLoop({
+  step: mySimulation, // (dt, tick) => void — the loop's own signature
+  snapshotter: combineSnapshotters([worldSnapshotter(world), randomSnapshotter(rng)]),
+  inputs: new InputLog({ participants: 2, depth: 32, inputBytes: 2 }),
+  fixedDt: 1 / 60,
+  depth: 8, // 133 ms of rewind at 60 Hz
+});
+
+startLoop({
+  simulate: (dt, tick) => rewind.advance(dt, tick),
+  render,
+});
+
+// A packet arrives, possibly for a tick that has already run.
+rewind.supply(participant, tick, payload); // false when it is beyond the window
+```
+
+## What it does not know
+
+**It does not know what an input is.** A payload is a fixed number of bytes a consumer encodes.
+`AGENTS.md` states the rule — engine APIs never take another game's noun — and this is the place
+most netcode gives it up. The size being fixed is what buys the allocation story: one array for the
+session, so neither recording an input nor reading one back during a replay allocates anything.
+
+**It does not know what your state is.** `Snapshotter<S>` is generic over its own slot type, so a
+rewind needs no serialization at all — a snapshot never leaves the process. `worldSnapshotter` is
+one implementation, over `@driftengine/entities`; a simulation whose state is four typed arrays
+writes another in thirty lines.
+
+**It does not decide fairness.** `rewindTo` is public so lag compensation is implementable, and lag
+compensation is not implemented: an authority rewinding the world to a shooter's view of the past is
+a policy about who wins a disputed shot, and that belongs to a game.
+
+## Two things that are easy to get wrong, and are handled here
+
+**A snapshot is taken before the step, not after.** `advance(dt, T)` saves and then steps, so slot
+_T_ holds the world as tick _T_ began — which is what a rewind to _T_ wants, because _T_'s input is
+about to be applied. Saving afterwards makes every rewind land one tick late, and the symptom is a
+world that drifts slowly rather than one that breaks.
+
+**A late input and a late state are different corrections.** A late _input_ means the ticks since
+were computed from a wrong input: `supply` records it and the next `advance` replays. A late _state_
+means they were computed from a wrong world: `reconcileSnapshot` overwrites that tick's state,
+re-saves it, and replays the local inputs over the top — which is what makes a correction converge
+instead of erasing what the player did.
+
+## A rewind snapshot is not a save file
+
+`serializeWorld` in `@driftengine/entities` writes a scene: schemas for migration, values keyed by
+stable field id, and entities _created_ on load. Every one of those is wrong for a rewind, which
+needs the handles it had — an input recorded against entity 4,194,307 must still mean that entity —
+and needs to cost nothing per tick. `WorldSnapshot` is the other artefact, and `world.ts` carries
+the table comparing them.
+
+## Two things a lossy link taught the design
+
+**An input message carries a run of consecutive ticks.** An input is only useful for the tick it
+names, so asking for a lost one and waiting a round trip delivers it after that tick has gone. Every
+packet carries the last four inputs, and a test at 15% loss is what turned that from a nicety into a
+requirement — the control, with one input per packet, does not converge.
+
+**A fingerprint is only comparable at a confirmed tick.** The newest tick is speculative: each peer
+has predicted inputs the other already knows, so their live worlds differ constantly and correctly.
+Comparing them halted a healthy session at tick 32 during development.
+
+**And a third, which cost a consumer a session on a perfect link.** Three windows move independently
+and a session lives inside all of them. `redundancy` says how far back every packet reaches;
+`RewindLoop`'s `depth` says how far back a correction can reach; and the session retains inputs down
+to the oldest tick that rewind window covers, forgetting everything below it every tick. So on any
+session whose redundancy reaches further back than its rewind depth, the oldest word of every packet
+names a tick the log has already been told to forget — which is not a fault, and must not be read as
+one. A copy of a tick this world already applied cannot change it and cannot be evidence of a
+divergence, whatever the log can still say about it; an input for a tick this world _never_ had and
+can no longer apply is fatal, and still halts. Redundancy larger than the rewind depth is a fine
+thing to ask for, and the two numbers do not have to be chosen together.
+
+## Determinism
+
+A rewind is only as good as the simulation's reproducibility. `scripts/determinism.mjs` is the gate:
+the arithmetic a simulation may use is what IEEE 754 fixes exactly, and the twenty-two functions
+ECMAScript declines to specify are refused inside the declared simulation set. `packages/network` is
+in that set, and `packages/core/src/math/exact.ts` supplies the transcendentals it may still need.
+
+**`scripts/exactness-cross.mjs` is how a cross-machine claim becomes a measurement.** It prints what
+this machine computes — golden bits, a seeded stream, and both arms of the conformance fixture — in
+a form another machine's output can be diffed against.

package/dist/authority.d.ts

@@ -0,0 +1,170 @@
+/**
+ * One machine's state is the truth, and everybody else predicts and corrects.
+ *
+ * **The correction is a rewind**, which is why this file is short. A client that mispredicted has
+ * computed some ticks from a world that was wrong; putting the authority's world back at that tick
+ * and replaying the local inputs over it is exactly `reconcileSnapshot`. There is no second
+ * mechanism here, only a different reason for reaching the same one.
+ *
+ * ---
+ *
+ * ## What crosses, and who decides
+ *
+ * A `Replicator` is supplied by the consumer. This package cannot know which of a game's fields are
+ * authoritative, which are cosmetic, or how to pack them — and an engine that did would be a
+ * particular game's engine. What it does own is *when*: the host publishes on a cadence, and the
+ * client applies at the tick the message names.
+ *
+ * ## Prediction is for the local participant only
+ *
+ * A client predicts *its own* entity from its own inputs, immediately, because the whole point is
+ * that a player's controls feel attached to their hands. It does **not** extrapolate other players
+ * forward. Extrapolation is a choice between showing a stale position and showing a wrong one, and
+ * which is worse depends on the game: a wrong position in a shooter decides a hit, and a stale one
+ * in a racing game is a car in the wrong place on a corner. So remote bodies are *interpolated*
+ * between two states the authority actually sent — `StateInterpolator` below — and anything more
+ * aggressive is a consumer's to write.
+ *
+ * ## What is not here
+ *
+ * **Lag compensation.** An authority rewinding the world to a shooter's view of the past, so their
+ * shot hits what was on their screen, is a real technique and a policy about who wins a disputed
+ * shot. `RewindLoop.rewindTo` is public so it can be built; choosing it for every game is not this
+ * package's business.
+ *
+ * **Interest management.** A world large enough that a client should not receive all of it needs
+ * spatial partitioning of replication state. Reversed by a consumer measuring replication bandwidth
+ * as their constraint.
+ */
+import type { InputLog } from './inputLog.ts';
+import type { RewindLoop } from './rewind.ts';
+import { type PeerId, type Transport } from './transport.ts';
+/**
+ * What a consumer packs and unpacks.
+ *
+ * `encode` answers -1 when the state does not fit, for the reason the wire encoders do: the caller
+ * is a frame loop and `AGENTS.md` forbids throwing in one.
+ */
+export interface Replicator {
+    encode(into: Uint8Array, tick: number): number;
+    apply(from: Uint8Array, tick: number): void;
+}
+export interface AuthorityOptions<S> {
+    readonly transport: Transport;
+    readonly loop: RewindLoop<S>;
+    readonly inputs: InputLog;
+    readonly replicator: Replicator;
+    /**
+     * How often the authoritative state is published, in ticks.
+     *
+     * **Three at 60 Hz is twenty a second**, which is what most shipped netcode settles near: often
+     * enough that a correction is small, rare enough that the bandwidth is a fraction of what a
+     * per-tick broadcast costs. A consumer whose state is tiny can publish every tick and one whose
+     * world is large should publish less and send deltas.
+     */
+    readonly stateEvery?: number;
+    /** Room for one encoded state. 8 KB by default; a state that does not fit is a state to delta. */
+    readonly maxStateBytes?: number;
+}
+/** The machine whose world is the truth. */
+export declare class AuthorityHost<S> {
+    private readonly transport;
+    private readonly loop;
+    private readonly inputs;
+    private readonly replicator;
+    private readonly stateEvery;
+    private readonly outgoing;
+    private readonly decoded;
+    private published;
+    constructor(options: AuthorityOptions<S>);
+    /** How many state messages have gone out. For a consumer measuring what replication costs. */
+    get publishedStates(): number;
+    poll(): void;
+    /**
+     * Take a tick, then publish if this is a publishing tick.
+     *
+     * **The state is encoded *after* the step**, so it describes the world at the end of `tick`, and
+     * a client applying it reconciles at `tick + 1`. Publishing before the step would send the world
+     * as it was when the tick began, which is the state the client already had.
+     */
+    advance(dt: number, tick: number): void;
+}
+export interface ClientOptions<S> {
+    readonly transport: Transport;
+    readonly loop: RewindLoop<S>;
+    readonly inputs: InputLog;
+    readonly replicator: Replicator;
+    readonly self: PeerId;
+    /** Predict the local participant. Off means wait for the authority, which is the control. */
+    readonly predict?: boolean;
+    /** Recent inputs carried in every packet, for the reason `LockstepSession` documents. */
+    readonly redundancy?: number;
+}
+/** A machine that predicts its own player and corrects toward the authority. */
+export declare class PredictingClient<S> {
+    readonly self: PeerId;
+    private readonly transport;
+    private readonly loop;
+    private readonly inputs;
+    private readonly replicator;
+    private readonly predict;
+    private readonly redundancy;
+    private readonly recent;
+    private readonly outgoing;
+    private readonly decoded;
+    private recentFrom;
+    private recentCount;
+    private correctionsValue;
+    private lastAppliedState;
+    constructor(options: ClientOptions<S>);
+    /** How many authoritative states have been applied. Each one is a rewind. */
+    get corrections(): number;
+    /**
+     * Send this input and, when predicting, apply it locally on the same tick.
+     *
+     * **No input delay**, unlike lockstep. A delay there buys exactness for everybody; here the
+     * authority is the source of truth anyway, so delaying the local input would add latency to the
+     * player's own controls and buy nothing.
+     */
+    submit(tick: number, payload: Uint8Array): void;
+    poll(): void;
+    advance(dt: number, tick: number): void;
+    private remember;
+}
+/**
+ * Two authoritative states and where between them to draw.
+ *
+ * **Rendering at a delay is what stops a remote body teleporting.** States arrive every few ticks
+ * and unevenly; drawing the newest one puts a body wherever the last packet said, which on a jittery
+ * link is a stutter. Drawing *between* the two most recent, a fixed distance behind the newest, costs
+ * that distance in latency and buys smooth motion — and the latency is honest, because the position
+ * shown is one the authority actually published rather than one guessed forward.
+ *
+ * This owns the timing and none of the content: `sample` answers which two payloads and how far
+ * between, and the consumer decodes and blends. It cannot do otherwise, since the payload's shape is
+ * the consumer's.
+ */
+export declare class StateInterpolator {
+    readonly delayTicks: number;
+    private readonly ticks;
+    private readonly payloads;
+    private readonly lengths;
+    private count;
+    private cursor;
+    constructor(capacity?: number, maxBytes?: number, delayTicks?: number);
+    /** Keep a state. The bytes are copied, because the transport reuses its buffer. */
+    push(tick: number, payload: Uint8Array): void;
+    /**
+     * The two states to blend at `renderTick`, and how far between them, or null.
+     *
+     * `alpha` is clamped to [0, 1]: past the newest state it holds there rather than extrapolating,
+     * which is the same choice `TickTrace.sample` makes at the end of a recording and for the same
+     * reason — a character who has finished should look like they finished.
+     */
+    sample(renderTick: number): {
+        from: Uint8Array;
+        to: Uint8Array;
+        alpha: number;
+    } | null;
+    private slice;
+}