@bcts/spqr 1.0.0-alpha.21

package/dist/index.d.cts

@@ -0,0 +1,115 @@
+//#region src/types.d.ts
+/** Secret key material (32 bytes) */
+type Secret = Uint8Array;
+/** Opaque serialized state (protobuf bytes) */
+type SerializedState = Uint8Array;
+/** Opaque serialized message (protobuf V1Msg bytes) */
+type SerializedMessage = Uint8Array;
+/** Interface for random byte generation */
+type RandomBytes = (length: number) => Uint8Array;
+/** Result of send() */
+interface Send {
+  state: SerializedState;
+  msg: SerializedMessage;
+  key: Secret | null;
+}
+/** Result of recv() */
+interface Recv {
+  state: SerializedState;
+  key: Secret | null;
+}
+/** Parameters for initializing SPQR */
+interface Params {
+  direction: Direction;
+  version: Version;
+  minVersion: Version;
+  authKey: Uint8Array;
+  chainParams: ChainParams;
+}
+/** Chain configuration parameters */
+interface ChainParams {
+  maxJump: number;
+  maxOooKeys: number;
+}
+/** Protocol version */
+declare enum Version {
+  V0 = 0,
+  V1 = 1
+}
+/** Communication direction */
+declare enum Direction {
+  A2B = 0,
+  B2A = 1
+}
+/** Current version negotiation status */
+type CurrentVersion = {
+  type: "still_negotiating";
+  version: Version;
+  minVersion: Version;
+} | {
+  type: "negotiation_complete";
+  version: Version;
+};
+//#endregion
+//#region src/error.d.ts
+/**
+ * Copyright © 2025 Signal Messenger, LLC
+ * Copyright © 2026 Parity Technologies
+ *
+ * Error types for the SPQR protocol.
+ */
+declare class SpqrError extends Error {
+  readonly code: SpqrErrorCode;
+  readonly detail?: unknown | undefined;
+  constructor(message: string, code: SpqrErrorCode, detail?: unknown | undefined);
+}
+declare enum SpqrErrorCode {
+  StateDecode = "STATE_DECODE",
+  NotImplemented = "NOT_IMPLEMENTED",
+  MsgDecode = "MSG_DECODE",
+  MacVerifyFailed = "MAC_VERIFY_FAILED",
+  EpochOutOfRange = "EPOCH_OUT_OF_RANGE",
+  EncodingDecoding = "ENCODING_DECODING",
+  Serialization = "SERIALIZATION",
+  VersionMismatch = "VERSION_MISMATCH",
+  MinimumVersion = "MINIMUM_VERSION",
+  KeyJump = "KEY_JUMP",
+  KeyTrimmed = "KEY_TRIMMED",
+  KeyAlreadyRequested = "KEY_ALREADY_REQUESTED",
+  ErroneousDataReceived = "ERRONEOUS_DATA_RECEIVED",
+  SendKeyEpochDecreased = "SEND_KEY_EPOCH_DECREASED",
+  InvalidParams = "INVALID_PARAMS",
+  ChainNotAvailable = "CHAIN_NOT_AVAILABLE"
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Return an empty (V0) serialized state.
+ */
+declare function emptyState(): SerializedState;
+/**
+ * Create an initial serialized state from parameters.
+ *
+ * For V0, returns an empty state. For V1+, initializes the inner V1
+ * state machine and version negotiation.
+ */
+declare function initialState(params: Params): SerializedState;
+/**
+ * Produce the next outgoing message from the current state.
+ *
+ * Returns the updated state, serialized message, and optional message key.
+ */
+declare function send(state: SerializedState, rng: RandomBytes): Send;
+/**
+ * Process an incoming message and transition the state.
+ *
+ * Returns the updated state and optional message key.
+ */
+declare function recv(state: SerializedState, msg: SerializedMessage): Recv;
+/**
+ * Inspect the current version negotiation status of a serialized state.
+ */
+declare function currentVersion(state: SerializedState): CurrentVersion;
+//#endregion
+export { type ChainParams, type CurrentVersion, Direction, type Params, type RandomBytes, type Recv, type Secret, type Send, type SerializedMessage, type SerializedState, SpqrError, SpqrErrorCode, Version, currentVersion, emptyState, initialState, recv, send };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/error.ts","../src/index.ts"],"mappings":";;KAWY,MAAA,GAAS,UAAA;;KAMT,eAAA,GAAkB,UAAA;;KAGlB,iBAAA,GAAoB,UAAA;AAGhC;AAAA,KAAY,WAAA,IAAe,MAAA,aAAmB,UAAA;;UAG7B,IAAA;EACf,KAAA,EAAO,eAAA;EACP,GAAA,EAAK,iBAAA;EACL,GAAA,EAAK,MAAA;AAAA;;UAIU,IAAA;EACf,KAAA,EAAO,eAAA;EACP,GAAA,EAAK,MAAA;AAAA;;UAUU,MAAA;EACf,SAAA,EAAW,SAAA;EACX,OAAA,EAAS,OAAA;EACT,UAAA,EAAY,OAAA;EACZ,OAAA,EAAS,UAAA;EACT,WAAA,EAAa,WAAA;AAAA;;UAIE,WAAA;EACf,OAAA;EACA,UAAA;AAAA;AAXF;AAAA,aAeY,OAAA;EACV,EAAA;EACA,EAAA;AAAA;;aAIU,SAAA;EACV,GAAA;EACA,GAAA;AAAA;;KAIU,cAAA;EACN,IAAA;EAA2B,OAAA,EAAS,OAAA;EAAS,UAAA,EAAY,OAAA;AAAA;EACzD,IAAA;EAA8B,OAAA,EAAS,OAAA;AAAA;;;;AA/D7C;;;;;cCJa,SAAA,SAAkB,KAAA;EAAA,SAGX,IAAA,EAAM,aAAA;EAAA,SACN,MAAA;cAFhB,OAAA,UACgB,IAAA,EAAM,aAAA,EACN,MAAA;AAAA;AAAA,aAOR,aAAA;EACV,WAAA;EACA,cAAA;EACA,SAAA;EACA,eAAA;EACA,eAAA;EACA,gBAAA;EACA,aAAA;EACA,eAAA;EACA,cAAA;EACA,OAAA;EACA,UAAA;EACA,mBAAA;EACA,qBAAA;EACA,qBAAA;EACA,aAAA;EACA,iBAAA;AAAA;;;;ADRF;;iBE0CgB,UAAA,CAAA,GAAc,eAAA;;;;;;;iBAcd,YAAA,CAAa,MAAA,EAAQ,MAAA,GAAS,eAAA;;;;;;iBAqC9B,IAAA,CAAK,KAAA,EAAO,eAAA,EAAiB,GAAA,EAAK,WAAA,GAAc,IAAA;AFtFhE;;;;;AAAA,iBE+KgB,IAAA,CAAK,KAAA,EAAO,eAAA,EAAiB,GAAA,EAAK,iBAAA,GAAoB,IAAA;;;;iBAyGtD,cAAA,CAAe,KAAA,EAAO,eAAA,GAAkB,cAAA"}

package/dist/index.d.mts

@@ -0,0 +1,115 @@
+//#region src/types.d.ts
+/** Secret key material (32 bytes) */
+type Secret = Uint8Array;
+/** Opaque serialized state (protobuf bytes) */
+type SerializedState = Uint8Array;
+/** Opaque serialized message (protobuf V1Msg bytes) */
+type SerializedMessage = Uint8Array;
+/** Interface for random byte generation */
+type RandomBytes = (length: number) => Uint8Array;
+/** Result of send() */
+interface Send {
+  state: SerializedState;
+  msg: SerializedMessage;
+  key: Secret | null;
+}
+/** Result of recv() */
+interface Recv {
+  state: SerializedState;
+  key: Secret | null;
+}
+/** Parameters for initializing SPQR */
+interface Params {
+  direction: Direction;
+  version: Version;
+  minVersion: Version;
+  authKey: Uint8Array;
+  chainParams: ChainParams;
+}
+/** Chain configuration parameters */
+interface ChainParams {
+  maxJump: number;
+  maxOooKeys: number;
+}
+/** Protocol version */
+declare enum Version {
+  V0 = 0,
+  V1 = 1
+}
+/** Communication direction */
+declare enum Direction {
+  A2B = 0,
+  B2A = 1
+}
+/** Current version negotiation status */
+type CurrentVersion = {
+  type: "still_negotiating";
+  version: Version;
+  minVersion: Version;
+} | {
+  type: "negotiation_complete";
+  version: Version;
+};
+//#endregion
+//#region src/error.d.ts
+/**
+ * Copyright © 2025 Signal Messenger, LLC
+ * Copyright © 2026 Parity Technologies
+ *
+ * Error types for the SPQR protocol.
+ */
+declare class SpqrError extends Error {
+  readonly code: SpqrErrorCode;
+  readonly detail?: unknown | undefined;
+  constructor(message: string, code: SpqrErrorCode, detail?: unknown | undefined);
+}
+declare enum SpqrErrorCode {
+  StateDecode = "STATE_DECODE",
+  NotImplemented = "NOT_IMPLEMENTED",
+  MsgDecode = "MSG_DECODE",
+  MacVerifyFailed = "MAC_VERIFY_FAILED",
+  EpochOutOfRange = "EPOCH_OUT_OF_RANGE",
+  EncodingDecoding = "ENCODING_DECODING",
+  Serialization = "SERIALIZATION",
+  VersionMismatch = "VERSION_MISMATCH",
+  MinimumVersion = "MINIMUM_VERSION",
+  KeyJump = "KEY_JUMP",
+  KeyTrimmed = "KEY_TRIMMED",
+  KeyAlreadyRequested = "KEY_ALREADY_REQUESTED",
+  ErroneousDataReceived = "ERRONEOUS_DATA_RECEIVED",
+  SendKeyEpochDecreased = "SEND_KEY_EPOCH_DECREASED",
+  InvalidParams = "INVALID_PARAMS",
+  ChainNotAvailable = "CHAIN_NOT_AVAILABLE"
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Return an empty (V0) serialized state.
+ */
+declare function emptyState(): SerializedState;
+/**
+ * Create an initial serialized state from parameters.
+ *
+ * For V0, returns an empty state. For V1+, initializes the inner V1
+ * state machine and version negotiation.
+ */
+declare function initialState(params: Params): SerializedState;
+/**
+ * Produce the next outgoing message from the current state.
+ *
+ * Returns the updated state, serialized message, and optional message key.
+ */
+declare function send(state: SerializedState, rng: RandomBytes): Send;
+/**
+ * Process an incoming message and transition the state.
+ *
+ * Returns the updated state and optional message key.
+ */
+declare function recv(state: SerializedState, msg: SerializedMessage): Recv;
+/**
+ * Inspect the current version negotiation status of a serialized state.
+ */
+declare function currentVersion(state: SerializedState): CurrentVersion;
+//#endregion
+export { type ChainParams, type CurrentVersion, Direction, type Params, type RandomBytes, type Recv, type Secret, type Send, type SerializedMessage, type SerializedState, SpqrError, SpqrErrorCode, Version, currentVersion, emptyState, initialState, recv, send };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/error.ts","../src/index.ts"],"mappings":";;KAWY,MAAA,GAAS,UAAA;;KAMT,eAAA,GAAkB,UAAA;;KAGlB,iBAAA,GAAoB,UAAA;AAGhC;AAAA,KAAY,WAAA,IAAe,MAAA,aAAmB,UAAA;;UAG7B,IAAA;EACf,KAAA,EAAO,eAAA;EACP,GAAA,EAAK,iBAAA;EACL,GAAA,EAAK,MAAA;AAAA;;UAIU,IAAA;EACf,KAAA,EAAO,eAAA;EACP,GAAA,EAAK,MAAA;AAAA;;UAUU,MAAA;EACf,SAAA,EAAW,SAAA;EACX,OAAA,EAAS,OAAA;EACT,UAAA,EAAY,OAAA;EACZ,OAAA,EAAS,UAAA;EACT,WAAA,EAAa,WAAA;AAAA;;UAIE,WAAA;EACf,OAAA;EACA,UAAA;AAAA;AAXF;AAAA,aAeY,OAAA;EACV,EAAA;EACA,EAAA;AAAA;;aAIU,SAAA;EACV,GAAA;EACA,GAAA;AAAA;;KAIU,cAAA;EACN,IAAA;EAA2B,OAAA,EAAS,OAAA;EAAS,UAAA,EAAY,OAAA;AAAA;EACzD,IAAA;EAA8B,OAAA,EAAS,OAAA;AAAA;;;;AA/D7C;;;;;cCJa,SAAA,SAAkB,KAAA;EAAA,SAGX,IAAA,EAAM,aAAA;EAAA,SACN,MAAA;cAFhB,OAAA,UACgB,IAAA,EAAM,aAAA,EACN,MAAA;AAAA;AAAA,aAOR,aAAA;EACV,WAAA;EACA,cAAA;EACA,SAAA;EACA,eAAA;EACA,eAAA;EACA,gBAAA;EACA,aAAA;EACA,eAAA;EACA,cAAA;EACA,OAAA;EACA,UAAA;EACA,mBAAA;EACA,qBAAA;EACA,qBAAA;EACA,aAAA;EACA,iBAAA;AAAA;;;;ADRF;;iBE0CgB,UAAA,CAAA,GAAc,eAAA;;;;;;;iBAcd,YAAA,CAAa,MAAA,EAAQ,MAAA,GAAS,eAAA;;;;;;iBAqC9B,IAAA,CAAK,KAAA,EAAO,eAAA,EAAiB,GAAA,EAAK,WAAA,GAAc,IAAA;AFtFhE;;;;;AAAA,iBE+KgB,IAAA,CAAK,KAAA,EAAO,eAAA,EAAiB,GAAA,EAAK,iBAAA,GAAoB,IAAA;;;;iBAyGtD,cAAA,CAAe,KAAA,EAAO,eAAA,GAAkB,cAAA"}