@irtio/protocol 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -257,19 +257,31 @@ declare function deltaPayload(codecBytes: Uint8Array): Uint8Array;
 declare function writePayload(codecBytes: Uint8Array): Uint8Array;
 /**
  * The CORRECT frame payload: the schema-codec delta bytes with the judged client write tick
- * (u32) appended (week 8, D19). Additive: the codec's delta decoder never reads past the delta
- * body, so a decoder that does not know about the suffix ignores it; a reader that does
- * (`decodeDeltaFrom`) is left positioned exactly at it.
+ * (u32) appended (week 8, D19), and after it the server tick that write was *applied* at (u32,
+ * bug 1). Additive in both steps: the codec's delta decoder never reads past the delta body, so
+ * a decoder that does not know about a suffix ignores it; a reader that does (`decodeDeltaFrom`)
+ * is left positioned exactly at the first one.
+ *
+ * The two ticks are on different clocks and that is the point. `clientTick` is the client's own
+ * stamp, opaque to the server and echoed verbatim; `appliedTick` is the room's tick counter when
+ * the write landed. A predicting client stamps on its *predicted* clock, which leads authority,
+ * so without the second number it has no way to learn where on the server's clock its intent
+ * actually took effect, and its replay puts it a whole prediction lead too late.
  */
-declare function correctPayload(codecBytes: Uint8Array, clientTick: number): Uint8Array;
+declare function correctPayload(codecBytes: Uint8Array, clientTick: number, appliedTick?: number): Uint8Array;
 /**
  * Reads the `clientTick` suffix a reader is positioned at after `decodeDeltaFrom`, or
  * `undefined` for a pre-week-8 CORRECT payload with no suffix.
  */
 declare function readCorrectClientTick(r: ByteReader): number | undefined;
+/**
+ * Reads the `appliedTick` suffix that follows `clientTick`, or `undefined` from a server that
+ * does not send one. Call only after `readCorrectClientTick`, which leaves the reader on it.
+ */
+declare function readCorrectAppliedTick(r: ByteReader): number | undefined;
 declare function encodeDeltaFrame(codecBytes: Uint8Array): Uint8Array;
 declare function encodeWriteFrame(codecBytes: Uint8Array): Uint8Array;
-declare function encodeCorrectFrame(codecBytes: Uint8Array, clientTick: number): Uint8Array;
+declare function encodeCorrectFrame(codecBytes: Uint8Array, clientTick: number, appliedTick?: number): Uint8Array;
 
 interface Call {
     readonly reqId: number;
@@ -372,4 +384,4 @@ declare const relaySchema: Schema<{
 declare const RELAY_HASH8: Uint8Array;
 declare function isRelayHash8(hash8: Uint8Array): boolean;
 
-export { type Call, type ClientCallable, type Credential, ERROR_CATALOGUE, type ErrorCatalogueEntry, ErrorCode, type ErrorCodeDef, type ErrorCodeName, type ErrorPayload, type Frame, FrameType, type Hello, type Msg, type MsgTarget, PRESENCE_COLLECTION, PROTOCOL_VERSION, type Ping, type Pong, type PresenceRecord, RELAY_HASH8, type Reply, type Welcome, builtinRpcs, correctPayload, decodeCall, decodeErrorPayload, decodeFrame, decodeHello, decodeMsg, decodePing, decodePong, decodeReply, decodeWelcome, deltaPayload, encodeCall, encodeCorrectFrame, encodeDeltaFrame, encodeErrorPayload, encodeFrame, encodeHello, encodeMsg, encodePing, encodePong, encodeReply, encodeWelcome, encodeWriteFrame, errorByCode, formatError, isFrameType, isRelayHash8, presenceEntity, readCorrectClientTick, relaySchema, requestOwnership, rpcByIdOf, rpcIdOf, rpcTable, withBuiltins, writePayload };
+export { type Call, type ClientCallable, type Credential, ERROR_CATALOGUE, type ErrorCatalogueEntry, ErrorCode, type ErrorCodeDef, type ErrorCodeName, type ErrorPayload, type Frame, FrameType, type Hello, type Msg, type MsgTarget, PRESENCE_COLLECTION, PROTOCOL_VERSION, type Ping, type Pong, type PresenceRecord, RELAY_HASH8, type Reply, type Welcome, builtinRpcs, correctPayload, decodeCall, decodeErrorPayload, decodeFrame, decodeHello, decodeMsg, decodePing, decodePong, decodeReply, decodeWelcome, deltaPayload, encodeCall, encodeCorrectFrame, encodeDeltaFrame, encodeErrorPayload, encodeFrame, encodeHello, encodeMsg, encodePing, encodePong, encodeReply, encodeWelcome, encodeWriteFrame, errorByCode, formatError, isFrameType, isRelayHash8, presenceEntity, readCorrectAppliedTick, readCorrectClientTick, relaySchema, requestOwnership, rpcByIdOf, rpcIdOf, rpcTable, withBuiltins, writePayload };

package/dist/index.js

@@ -222,23 +222,28 @@ function deltaPayload(codecBytes) {
 function writePayload(codecBytes) {
   return codecBytes;
 }
-function correctPayload(codecBytes, clientTick) {
-  const w = new ByteWriter(codecBytes.length + 4);
+function correctPayload(codecBytes, clientTick, appliedTick) {
+  const extra = appliedTick === void 0 ? 4 : 8;
+  const w = new ByteWriter(codecBytes.length + extra);
   w.bytes(codecBytes);
   w.u32(clientTick);
+  if (appliedTick !== void 0) w.u32(appliedTick);
   return w.finish();
 }
 function readCorrectClientTick(r) {
   return r.remaining >= 4 ? r.u32() : void 0;
 }
+function readCorrectAppliedTick(r) {
+  return r.remaining >= 4 ? r.u32() : void 0;
+}
 function encodeDeltaFrame(codecBytes) {
   return encodeFrame(FrameType.DELTA, deltaPayload(codecBytes));
 }
 function encodeWriteFrame(codecBytes) {
   return encodeFrame(FrameType.WRITE, writePayload(codecBytes));
 }
-function encodeCorrectFrame(codecBytes, clientTick) {
-  return encodeFrame(FrameType.CORRECT, correctPayload(codecBytes, clientTick));
+function encodeCorrectFrame(codecBytes, clientTick, appliedTick) {
+  return encodeFrame(FrameType.CORRECT, correctPayload(codecBytes, clientTick, appliedTick));
 }
 
 // src/rpc.ts
@@ -436,6 +441,7 @@ export {
   isFrameType,
   isRelayHash8,
   presenceEntity,
+  readCorrectAppliedTick,
   readCorrectClientTick,
   relaySchema,
   requestOwnership,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@irtio/protocol",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "irtio wire protocol: frames, framing, session payloads, error codes, built-in presence",
   "license": "MIT",
   "publishConfig": {
@@ -20,7 +20,7 @@
     "dist"
   ],
   "dependencies": {
-    "@irtio/schema": "0.2.0"
+    "@irtio/schema": "0.3.0"
   },
   "scripts": {
     "build": "tsup",