@dcl/protocol 1.0.0-3825036757.commit-42e850e → 1.0.0-38388253132.commit-8d2c084

package/out-ts/decentraland/pulse/pulse_clusters.gen.ts

@@ -0,0 +1,422 @@
+/* eslint-disable */
+import Long from "long";
+import _m0 from "protobufjs/minimal";
+
+export const protobufPackage = "decentraland.pulse";
+
+/**
+ * Published by Pulse to NATS on `peer.{address}.cluster_change` whenever a peer's post-debounce
+ * cluster assignment changes. Pulse is the sole author of cluster membership.
+ *
+ * A "cluster" is Pulse's own grouping of co-located peers, derived by union-find over occupied
+ * area-of-interest grid cells. It is deliberately a different concept from archipelago's "island":
+ * clusters have no size cap, are realm-partitioned, and carry no transport connection details.
+ * Comms Gatekeeper subscribes here, mints the LiveKit connection string (the ban check is
+ * authority-local to gatekeeper), and re-emits the legacy
+ * decentraland.kernel.comms.v3.IslandChangedMessage on `engine.peer.{address}.island_changed.{session}`,
+ * so the WebSocket Connector and clients stay untouched.
+ */
+export interface PeerClusterChange {
+  /** Cluster the peer now belongs to. Stable across passes for an unchanged crowd. */
+  clusterId: string;
+  /**
+   * The peer's realm. Clusters never span realms, so this qualifies cluster_id and keeps the
+   * event self-contained — consumers never have to join against the topology feed.
+   */
+  realm: string;
+  /**
+   * Session that owns this assignment: the lower-cased ephemeral address of the auth chain the
+   * peer authenticated with (the wallet itself for a chain without a delegation). Two devices of
+   * one wallet carry different values; one device's reconnects carry the same one.
+   */
+  session: string;
+  /**
+   * Set only on the first publish of a new session for a wallet that still had a retained
+   * assignment under another session: that other session, and the cluster it was last published
+   * into. Empty on every other event, including a same-session reconnect.
+   */
+  displacedSession: string;
+  displacedClusterId: string;
+  /**
+   * Unfinished takeovers survive notification loss and later ownership changes.
+   * Gatekeeper must complete every entry before issuing current-session credentials.
+   */
+  pendingTakeovers: PendingTakeover[];
+  /**
+   * Confirmed revocation floor in whole Unix seconds. Present zero is a first assignment;
+   * absence means this response cannot authorize credentials (old producer or blocked state).
+   * Consumers reject uint64 values outside the JavaScript safe-integer range.
+   */
+  tokenNotBefore?: number | undefined;
+}
+
+/**
+ * Retained by Pulse until the matching completion is applied. IDs are globally unique;
+ * another takeover in the same room receives a new ID. Hints never create new IDs.
+ */
+export interface PendingTakeover {
+  takeoverId: string;
+  displacedSession: string;
+  displacedClusterId: string;
+}
+
+/**
+ * Gatekeeper-only publication on peer.{wallet}.takeover_completed. A duplicate or unknown
+ * ID has no effect. The effective cutoff must exceed the takeover's prior token floor.
+ */
+export interface TakeoverCompleted {
+  takeoverId: string;
+  revokeBefore: number;
+}
+
+function createBasePeerClusterChange(): PeerClusterChange {
+  return {
+    clusterId: "",
+    realm: "",
+    session: "",
+    displacedSession: "",
+    displacedClusterId: "",
+    pendingTakeovers: [],
+    tokenNotBefore: undefined,
+  };
+}
+
+export namespace PeerClusterChange {
+  export function encode(message: PeerClusterChange, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.clusterId !== "") {
+      writer.uint32(10).string(message.clusterId);
+    }
+    if (message.realm !== "") {
+      writer.uint32(18).string(message.realm);
+    }
+    if (message.session !== "") {
+      writer.uint32(26).string(message.session);
+    }
+    if (message.displacedSession !== "") {
+      writer.uint32(34).string(message.displacedSession);
+    }
+    if (message.displacedClusterId !== "") {
+      writer.uint32(42).string(message.displacedClusterId);
+    }
+    for (const v of message.pendingTakeovers) {
+      PendingTakeover.encode(v!, writer.uint32(58).fork()).ldelim();
+    }
+    if (message.tokenNotBefore !== undefined) {
+      writer.uint32(64).uint64(message.tokenNotBefore);
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): PeerClusterChange {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBasePeerClusterChange();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.clusterId = reader.string();
+          continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+
+          message.realm = reader.string();
+          continue;
+        case 3:
+          if (tag !== 26) {
+            break;
+          }
+
+          message.session = reader.string();
+          continue;
+        case 4:
+          if (tag !== 34) {
+            break;
+          }
+
+          message.displacedSession = reader.string();
+          continue;
+        case 5:
+          if (tag !== 42) {
+            break;
+          }
+
+          message.displacedClusterId = reader.string();
+          continue;
+        case 7:
+          if (tag !== 58) {
+            break;
+          }
+
+          message.pendingTakeovers.push(PendingTakeover.decode(reader, reader.uint32()));
+          continue;
+        case 8:
+          if (tag !== 64) {
+            break;
+          }
+
+          message.tokenNotBefore = longToNumber(reader.uint64() as Long);
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): PeerClusterChange {
+    return {
+      clusterId: isSet(object.clusterId) ? String(object.clusterId) : "",
+      realm: isSet(object.realm) ? String(object.realm) : "",
+      session: isSet(object.session) ? String(object.session) : "",
+      displacedSession: isSet(object.displacedSession) ? String(object.displacedSession) : "",
+      displacedClusterId: isSet(object.displacedClusterId) ? String(object.displacedClusterId) : "",
+      pendingTakeovers: Array.isArray(object?.pendingTakeovers)
+        ? object.pendingTakeovers.map((e: any) => PendingTakeover.fromJSON(e))
+        : [],
+      tokenNotBefore: isSet(object.tokenNotBefore) ? Number(object.tokenNotBefore) : undefined,
+    };
+  }
+
+  export function toJSON(message: PeerClusterChange): unknown {
+    const obj: any = {};
+    message.clusterId !== undefined && (obj.clusterId = message.clusterId);
+    message.realm !== undefined && (obj.realm = message.realm);
+    message.session !== undefined && (obj.session = message.session);
+    message.displacedSession !== undefined && (obj.displacedSession = message.displacedSession);
+    message.displacedClusterId !== undefined && (obj.displacedClusterId = message.displacedClusterId);
+    if (message.pendingTakeovers) {
+      obj.pendingTakeovers = message.pendingTakeovers.map((e) => e ? PendingTakeover.toJSON(e) : undefined);
+    } else {
+      obj.pendingTakeovers = [];
+    }
+    message.tokenNotBefore !== undefined && (obj.tokenNotBefore = Math.round(message.tokenNotBefore));
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<PeerClusterChange>, I>>(base?: I): PeerClusterChange {
+    return PeerClusterChange.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<PeerClusterChange>, I>>(object: I): PeerClusterChange {
+    const message = createBasePeerClusterChange();
+    message.clusterId = object.clusterId ?? "";
+    message.realm = object.realm ?? "";
+    message.session = object.session ?? "";
+    message.displacedSession = object.displacedSession ?? "";
+    message.displacedClusterId = object.displacedClusterId ?? "";
+    message.pendingTakeovers = object.pendingTakeovers?.map((e) => PendingTakeover.fromPartial(e)) || [];
+    message.tokenNotBefore = object.tokenNotBefore ?? undefined;
+    return message;
+  }
+}
+
+function createBasePendingTakeover(): PendingTakeover {
+  return { takeoverId: "", displacedSession: "", displacedClusterId: "" };
+}
+
+export namespace PendingTakeover {
+  export function encode(message: PendingTakeover, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.takeoverId !== "") {
+      writer.uint32(10).string(message.takeoverId);
+    }
+    if (message.displacedSession !== "") {
+      writer.uint32(18).string(message.displacedSession);
+    }
+    if (message.displacedClusterId !== "") {
+      writer.uint32(26).string(message.displacedClusterId);
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): PendingTakeover {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBasePendingTakeover();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.takeoverId = reader.string();
+          continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+
+          message.displacedSession = reader.string();
+          continue;
+        case 3:
+          if (tag !== 26) {
+            break;
+          }
+
+          message.displacedClusterId = reader.string();
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): PendingTakeover {
+    return {
+      takeoverId: isSet(object.takeoverId) ? String(object.takeoverId) : "",
+      displacedSession: isSet(object.displacedSession) ? String(object.displacedSession) : "",
+      displacedClusterId: isSet(object.displacedClusterId) ? String(object.displacedClusterId) : "",
+    };
+  }
+
+  export function toJSON(message: PendingTakeover): unknown {
+    const obj: any = {};
+    message.takeoverId !== undefined && (obj.takeoverId = message.takeoverId);
+    message.displacedSession !== undefined && (obj.displacedSession = message.displacedSession);
+    message.displacedClusterId !== undefined && (obj.displacedClusterId = message.displacedClusterId);
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<PendingTakeover>, I>>(base?: I): PendingTakeover {
+    return PendingTakeover.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<PendingTakeover>, I>>(object: I): PendingTakeover {
+    const message = createBasePendingTakeover();
+    message.takeoverId = object.takeoverId ?? "";
+    message.displacedSession = object.displacedSession ?? "";
+    message.displacedClusterId = object.displacedClusterId ?? "";
+    return message;
+  }
+}
+
+function createBaseTakeoverCompleted(): TakeoverCompleted {
+  return { takeoverId: "", revokeBefore: 0 };
+}
+
+export namespace TakeoverCompleted {
+  export function encode(message: TakeoverCompleted, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.takeoverId !== "") {
+      writer.uint32(10).string(message.takeoverId);
+    }
+    if (message.revokeBefore !== 0) {
+      writer.uint32(16).uint64(message.revokeBefore);
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): TakeoverCompleted {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseTakeoverCompleted();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.takeoverId = reader.string();
+          continue;
+        case 2:
+          if (tag !== 16) {
+            break;
+          }
+
+          message.revokeBefore = longToNumber(reader.uint64() as Long);
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): TakeoverCompleted {
+    return {
+      takeoverId: isSet(object.takeoverId) ? String(object.takeoverId) : "",
+      revokeBefore: isSet(object.revokeBefore) ? Number(object.revokeBefore) : 0,
+    };
+  }
+
+  export function toJSON(message: TakeoverCompleted): unknown {
+    const obj: any = {};
+    message.takeoverId !== undefined && (obj.takeoverId = message.takeoverId);
+    message.revokeBefore !== undefined && (obj.revokeBefore = Math.round(message.revokeBefore));
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<TakeoverCompleted>, I>>(base?: I): TakeoverCompleted {
+    return TakeoverCompleted.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<TakeoverCompleted>, I>>(object: I): TakeoverCompleted {
+    const message = createBaseTakeoverCompleted();
+    message.takeoverId = object.takeoverId ?? "";
+    message.revokeBefore = object.revokeBefore ?? 0;
+    return message;
+  }
+}
+
+declare const self: any | undefined;
+declare const window: any | undefined;
+declare const global: any | undefined;
+const tsProtoGlobalThis: any = (() => {
+  if (typeof globalThis !== "undefined") {
+    return globalThis;
+  }
+  if (typeof self !== "undefined") {
+    return self;
+  }
+  if (typeof window !== "undefined") {
+    return window;
+  }
+  if (typeof global !== "undefined") {
+    return global;
+  }
+  throw "Unable to locate global object";
+})();
+
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+
+export type DeepPartial<T> = T extends Builtin ? T
+  : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
+  : T extends { $case: string } ? { [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]> } & { $case: T["$case"] }
+  : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
+  : Partial<T>;
+
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P
+  : P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };
+
+function longToNumber(long: Long): number {
+  if (long.gt(Number.MAX_SAFE_INTEGER)) {
+    throw new tsProtoGlobalThis.Error("Value is larger than Number.MAX_SAFE_INTEGER");
+  }
+  return long.toNumber();
+}
+
+if (_m0.util.Long !== Long) {
+  _m0.util.Long = Long as any;
+  _m0.configure();
+}
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}