@series-inc/rundot-syncplay 5.23.0-beta.7

package/dist/local-authority-wire.d.ts

@@ -0,0 +1,142 @@
+import type { DeterministicCommandTimeline, DeterministicPlayerCommand } from './commands.js';
+import { type DeterministicLocalAuthorityInputMessage, type DeterministicLocalAuthorityRuntime } from './local-authority.js';
+export declare const deterministicLocalAuthorityWireProtocol = "rdm-local-authority/v1";
+export type DeterministicLocalAuthorityWireKind = 'input-bundle' | 'command-bundle' | 'ack' | 'correction' | 'snapshot' | 'snapshot-request' | 'snapshot-offer' | 'snapshot-chunk' | 'snapshot-complete';
+export interface DeterministicLocalAuthorityWireEnvelope {
+    readonly schemaVersion: 1;
+    readonly protocol: typeof deterministicLocalAuthorityWireProtocol;
+    readonly kind: DeterministicLocalAuthorityWireKind;
+    readonly sequence: number;
+    readonly payload: Readonly<Record<string, unknown>>;
+    readonly auth?: DeterministicLocalAuthorityWireAuth;
+    readonly checksum: string;
+}
+export interface DeterministicLocalAuthorityWireAuth {
+    readonly senderId: string;
+    readonly signature: string;
+}
+export interface DeterministicLocalAuthorityWireSignOptions {
+    readonly senderId: string;
+    readonly key: string;
+}
+export interface DeterministicLocalAuthorityWireAuthOptions {
+    readonly requireAuth?: boolean;
+    readonly authorityKey?: string;
+    readonly slotKeys?: Readonly<Record<string, string>>;
+}
+export interface DeterministicLocalAuthorityWireApplyResult {
+    readonly accepted: number;
+    readonly rejected: number;
+    readonly rejectionReasons: readonly string[];
+}
+export interface DeterministicLocalAuthorityWireReceiverResult extends DeterministicLocalAuthorityWireApplyResult {
+    readonly kind: DeterministicLocalAuthorityWireKind;
+    readonly appliedAck: boolean;
+    readonly appliedCorrection: boolean;
+    readonly appliedSnapshot: boolean;
+}
+export interface DeterministicLocalAuthorityWireReceiverSnapshot {
+    readonly highestSequence: number;
+    readonly seenSequences: readonly number[];
+    readonly perSenderHighestSequences: Readonly<Record<string, number>>;
+    readonly lastAckFrame: number;
+    readonly lastCorrectionFrame: number;
+    readonly lastSnapshotFrame: number;
+    readonly checksum: string;
+}
+export interface DeterministicLocalAuthorityWireReceiver {
+    receive(envelope: DeterministicLocalAuthorityWireEnvelope, senderSlot?: number): DeterministicLocalAuthorityWireReceiverResult;
+    snapshot(): DeterministicLocalAuthorityWireReceiverSnapshot;
+}
+export interface DeterministicLocalAuthorityWireReceiverOptions {
+    readonly commandTimeline?: DeterministicCommandTimeline;
+    readonly snapshotIdentity?: DeterministicLocalAuthoritySnapshotIdentity;
+    readonly maxSnapshotAgeFrames?: number;
+    readonly sequenceReplayWindow?: number;
+    readonly auth?: DeterministicLocalAuthorityWireAuthOptions;
+}
+export interface DeterministicLocalAuthoritySnapshotIdentity {
+    readonly descriptorHash: string;
+    readonly schemaHash?: string;
+    readonly assetDbHash?: string;
+    readonly configHash?: string;
+}
+export interface DeterministicLocalAuthoritySnapshotTransfer {
+    readonly transferId: string;
+    readonly identity: DeterministicLocalAuthoritySnapshotIdentity;
+    readonly frame: number;
+    readonly snapshotChecksum: string;
+    readonly snapshotBytes: string;
+    readonly chunkSize: number;
+    readonly chunks: readonly string[];
+    readonly chunkChecksums: readonly string[];
+}
+export interface DeterministicLocalAuthorityWireFixtureResult {
+    readonly checksum: string;
+    readonly players: number;
+    readonly frames: number;
+    readonly encodedEnvelopes: number;
+    readonly decodedEnvelopes: number;
+    readonly acceptedInputs: number;
+    readonly rejectedInputs: number;
+    readonly acceptedCommands: number;
+    readonly rejectedCommands: number;
+    readonly malformedRejected: number;
+    readonly forgedSlotRejected: number;
+    readonly staleFrameRejected: number;
+    readonly futureFrameRejected: number;
+    readonly oversizedRejected: number;
+    readonly duplicateInputRejected: number;
+    readonly invalidInputIdRejected: number;
+    readonly ackEnvelopes: number;
+    readonly commandEnvelopes: number;
+    readonly correctionEnvelopes: number;
+    readonly snapshotEnvelopes: number;
+    readonly snapshotRequestEnvelopes: number;
+    readonly snapshotOfferEnvelopes: number;
+    readonly snapshotChunkEnvelopes: number;
+    readonly snapshotCompleteEnvelopes: number;
+    readonly snapshotNegotiationCompletesApplied: number;
+    readonly snapshotNegotiationRejected: number;
+    readonly snapshotDescriptorMismatchRejected: number;
+    readonly snapshotChunkChecksumRejected: number;
+    readonly snapshotMissingChunkRejected: number;
+    readonly staleSnapshotOfferRejected: number;
+    readonly reorderedSequenceAccepted: number;
+    readonly duplicateSequenceRejected: number;
+    readonly replayedEnvelopeRejected: number;
+    readonly staleAckRejected: number;
+    readonly staleCorrectionRejected: number;
+    readonly staleSnapshotRejected: number;
+    readonly wireAuthSignedEnvelopes: number;
+    readonly wireAuthMissingRejected: number;
+    readonly wireAuthSenderMismatchRejected: number;
+    readonly wireAuthSignatureRejected: number;
+    readonly wireAuthHmacSha256Covered: boolean;
+    readonly forgedAuthorityCorrectionRejected: number;
+    readonly forgedAuthoritySnapshotRejected: number;
+    readonly snapshotIdentityRequiredRejected: number;
+    readonly correctionsApplied: number;
+    readonly snapshotsApplied: number;
+    readonly convergenceDrainFrames: number;
+    readonly authorityProjectionChecksum: string;
+    readonly clientProjectionChecksum: string;
+    readonly convergence: boolean;
+}
+export declare function encodeDeterministicLocalAuthorityWireEnvelope(envelope: Omit<DeterministicLocalAuthorityWireEnvelope, 'schemaVersion' | 'protocol' | 'checksum' | 'auth'>, sign?: DeterministicLocalAuthorityWireSignOptions): string;
+export declare function decodeDeterministicLocalAuthorityWireEnvelope(encoded: string): DeterministicLocalAuthorityWireEnvelope;
+export declare function createDeterministicLocalAuthorityWireAuth(envelope: Omit<DeterministicLocalAuthorityWireEnvelope, 'checksum' | 'auth'>, sign: DeterministicLocalAuthorityWireSignOptions): DeterministicLocalAuthorityWireAuth;
+export declare function createDeterministicLocalAuthorityInputBundleEnvelope(sequence: number, inputs: readonly DeterministicLocalAuthorityInputMessage[], sign?: DeterministicLocalAuthorityWireSignOptions): string;
+export declare function createDeterministicLocalAuthorityCommandBundleEnvelope(sequence: number, commands: readonly DeterministicPlayerCommand[], sign?: DeterministicLocalAuthorityWireSignOptions): string;
+export declare function createDeterministicLocalAuthorityAckEnvelope(sequence: number, runtime: DeterministicLocalAuthorityRuntime, sign?: DeterministicLocalAuthorityWireSignOptions): string;
+export declare function createDeterministicLocalAuthorityCorrectionEnvelope(sequence: number, runtime: DeterministicLocalAuthorityRuntime, identityOrSign?: DeterministicLocalAuthoritySnapshotIdentity | DeterministicLocalAuthorityWireSignOptions, sign?: DeterministicLocalAuthorityWireSignOptions): string;
+export declare function createDeterministicLocalAuthoritySnapshotEnvelope(sequence: number, runtime: DeterministicLocalAuthorityRuntime, identityOrSign?: DeterministicLocalAuthoritySnapshotIdentity | DeterministicLocalAuthorityWireSignOptions, sign?: DeterministicLocalAuthorityWireSignOptions): string;
+export declare function createDeterministicLocalAuthoritySnapshotTransfer(runtime: DeterministicLocalAuthorityRuntime, identity: DeterministicLocalAuthoritySnapshotIdentity, transferId: string, chunkSize?: number): DeterministicLocalAuthoritySnapshotTransfer;
+export declare function createDeterministicLocalAuthoritySnapshotRequestEnvelope(sequence: number, identity: DeterministicLocalAuthoritySnapshotIdentity, minFrame: number, sign?: DeterministicLocalAuthorityWireSignOptions): string;
+export declare function createDeterministicLocalAuthoritySnapshotOfferEnvelope(sequence: number, transfer: DeterministicLocalAuthoritySnapshotTransfer, sign?: DeterministicLocalAuthorityWireSignOptions): string;
+export declare function createDeterministicLocalAuthoritySnapshotChunkEnvelope(sequence: number, transfer: DeterministicLocalAuthoritySnapshotTransfer, chunkIndex: number, sign?: DeterministicLocalAuthorityWireSignOptions): string;
+export declare function createDeterministicLocalAuthoritySnapshotCompleteEnvelope(sequence: number, transferId: string, sign?: DeterministicLocalAuthorityWireSignOptions): string;
+export declare function applyDeterministicLocalAuthorityInputBundleEnvelope(runtime: DeterministicLocalAuthorityRuntime, senderSlot: number, envelope: DeterministicLocalAuthorityWireEnvelope): DeterministicLocalAuthorityWireApplyResult;
+export declare function applyDeterministicLocalAuthorityCommandBundleEnvelope(timeline: DeterministicCommandTimeline, senderSlot: number, envelope: DeterministicLocalAuthorityWireEnvelope): DeterministicLocalAuthorityWireApplyResult;
+export declare function createDeterministicLocalAuthorityWireReceiver(runtime: DeterministicLocalAuthorityRuntime, options?: DeterministicLocalAuthorityWireReceiverOptions): DeterministicLocalAuthorityWireReceiver;
+export declare function runDeterministicLocalAuthorityWireFixture(players: number, frames: number, seed: number): DeterministicLocalAuthorityWireFixtureResult;