@dcl/protocol 1.0.0-3490809059.commit-e420af7 → 1.0.0-35089025179.commit-5810768

package/proto/decentraland/kernel/apis/user_identity.proto

@@ -16,6 +16,7 @@ message GetUserPublicKeyResponse {
 }
 
 service UserIdentityService {
+    // @deprecated, only available for SDK6 compatibility. UseGetUserData
     rpc GetUserPublicKey(GetUserPublicKeyRequest) returns (GetUserPublicKeyResponse) {}
     rpc GetUserData(GetUserDataRequest) returns (GetUserDataResponse) {}
 }

package/proto/decentraland/kernel/comms/rfc4/comms.proto

@@ -14,7 +14,15 @@ message Packet {
     Chat chat = 5;
     Scene scene = 6;
     Voice voice = 7;
+    Movement movement = 8;
+    PlayerEmote player_emote = 9;
+    SceneEmote scene_emote = 10;
+    MovementCompressed movement_compressed = 12;
+    LookAtPosition look_at_position = 13;
+    Reaction reaction = 14;
+    ChatReaction chat_reaction = 15;
   }
+  uint32 protocol_version = 11;
 }
 
 message Position {
@@ -31,6 +39,74 @@ message Position {
   float rotation_w = 9;
 }
 
+message Movement {
+  // command number
+  float timestamp = 1;
+  // world position
+  float position_x = 2;
+  float position_y = 3;
+  float position_z = 4;
+  // velocity
+  float velocity_x = 5;
+  float velocity_y = 6;
+  float velocity_z = 7;
+  // animations
+  float movement_blend_value = 8;
+  float slide_blend_value = 9;
+  bool is_grounded = 10;
+  bool is_jumping = 11; // deprecated
+  int32 jump_count = 24;
+  bool is_long_jump = 12;
+  bool is_long_fall = 13;
+  bool is_falling = 14;
+  bool is_stunned = 15;
+  GlideState glide_state = 23;
+  float rotation_y = 16;
+  // interpolation
+  bool is_instant = 17;
+  bool is_emoting = 18;
+  // head-sync (enabled flags + world-space yaw and pitch angles, in degrees)
+  bool head_ik_yaw_enabled = 19;
+  bool head_ik_pitch_enabled = 20;
+  float head_yaw = 21;
+  float head_pitch = 22;
+  enum GlideState {
+      PROP_CLOSED = 0;
+      OPENING_PROP = 1;
+      GLIDING = 2;
+      CLOSING_PROP = 3;
+  }
+  // point-at
+  float point_at_x = 25;
+  float point_at_y = 26;
+  float point_at_z = 27;
+  bool is_pointing_at = 28;
+}
+
+message MovementCompressed {
+  int32 temporal_data = 1; // bit-compressed: timestamp + animations 
+  int64 movement_data = 2; // bit-compressed: position + velocity 
+  int32 head_sync_data = 3; // bit-compressed: enabled flags + yaw + pitch
+  int32 point_at_data = 4; // bit-compressed: flag + point coordinates 
+}
+
+message PlayerEmote {
+  uint32 incremental_id = 1;
+  string urn = 2;
+  float timestamp = 3;
+  optional bool is_stopping = 4; // true means the emote has been stopped in the sender's client
+  // 5 to 10 carried the social-emote fields, which are not part of this protocol.
+  // Numbers and names stay reserved so they are never reassigned a conflicting meaning.
+  reserved 5 to 10;
+  reserved "is_repeating", "interaction_id", "social_emote_outcome", "is_reacting", "social_emote_initiator", "target_avatar";
+  optional uint32 mask = 11; // mask for which bones an animation applies to.
+}
+
+message SceneEmote {
+  string scene_entity_id = 1;
+  string source = 2;
+}
+
 message AnnounceProfileVersion {
   uint32 profile_version = 1;
 
@@ -56,6 +132,9 @@ message ProfileResponse {
 message Chat {
   string message = 1;
   double timestamp = 2;
+  // Extension: optional forwarded_from to identify the original sender when
+  // messages are forwarded through an SFU
+  optional string forwarded_from = 3;
 }
 
 message Scene {
@@ -71,3 +150,25 @@ message Voice {
     VC_OPUS = 0;
   }
 }
+
+// Message sent to force an avatar to look at a position
+message LookAtPosition {
+  float timestamp = 1;
+  // world position
+  float position_x = 2;
+  float position_y = 3;
+  float position_z = 4;
+  string target_avatar_wallet_address = 5;
+}
+
+message Reaction {
+  int32 emoji_index = 1;
+  float timestamp = 2;
+  int32 count = 3;
+}
+
+message ChatReaction {
+  int32 emoji_index = 1;
+  string message_id = 2;
+  string address = 3;
+}

package/proto/decentraland/kernel/comms/rfc5/ws_comms.proto

@@ -68,9 +68,12 @@ message WsIdentification {
 /**
  * This message is received by the peers when the same address logs in in a
  * different session. It should signal that the client should be shut down and not
- * retry any new comms connection.
+ * retry any new comms connection. It can also be used to reject new users joining when
+ * the room capacity has been reached.
  */
-message WsKicked {}
+message WsKicked {
+  string reason = 1;
+}
 
 message WsPacket {
   oneof message {
@@ -98,4 +101,4 @@ message WsPacket {
     // direction: server->client
     WsKicked peer_kicked = 8;
   }
-}
+}

package/proto/decentraland/kernel/comms/v3/archipelago.proto

@@ -1,23 +1,24 @@
 syntax = "proto3";
 
+import "decentraland/common/vectors.proto";
+
 package decentraland.kernel.comms.v3;
 
-enum TransportType {
-  TT_LIVEKIT = 0;
-  TT_WS = 1;
+// Server->Client messsages
+message ChallengeResponseMessage {
+  string challenge_to_sign = 1;
+  bool already_connected = 2;
 }
 
-message Position3DMessage {
-  double x = 1;
-  double y = 2;
-  double z = 3;
+message WelcomeMessage {
+  string peer_id = 1;
 }
 
 message IslandChangedMessage {
   string island_id = 1;
   string conn_str = 2;
   optional string from_island_id = 3;
-  map<string, Position3DMessage> peers = 4;
+  map<string, decentraland.common.Position> peers = 4;
 }
 
 message LeftIslandMessage {
@@ -30,44 +31,67 @@ message JoinIslandMessage {
   string peer_id = 2;
 }
 
-message IslandData {
-  string id = 1;
-  repeated string peers = 2;
-  uint32 max_peers = 3;
-  Position3DMessage center = 4;
-  double radius = 5;
+enum KickedReason {
+  KR_NEW_SESSION = 0;
 }
 
-message IslandStatusMessage {
-  repeated IslandData data = 1;
+message KickedMessage {
+  KickedReason reason = 1;
 }
 
-message TransportInit {
-  TransportType type = 1;
-  uint32 max_island_size = 2;
+message ServerPacket {
+  oneof message {
+    ChallengeResponseMessage challenge_response = 1;
+    WelcomeMessage welcome = 2;
+    IslandChangedMessage island_changed = 3;
+    LeftIslandMessage  left_island = 4;
+    JoinIslandMessage join_island = 5;
+    KickedMessage kicked = 6;
+  }
 }
 
-message TransportHeartbeat {
-  uint32 available_seats = 1;
-  uint32 users_count = 2;
+// Client->Server messsages
+message ChallengeRequestMessage {
+  string address = 1;
 }
 
-message TransportAuthorizationRequest {
-  string request_id = 1;
-  string room_id = 2;
-  repeated string user_ids = 3;
+message SignedChallengeMessage {
+  string auth_chain_json = 1;
 }
 
-message TransportAuthorizationResponse {
-  string request_id = 1;
-  map<string, string> conn_strs = 2;
+message Heartbeat {
+  decentraland.common.Position position = 1;
+  optional string desired_room = 2;
 }
 
-message TransportMessage {
+message ClientPacket {
   oneof message {
-    TransportInit init = 1;
-    TransportHeartbeat heartbeat = 2;
-    TransportAuthorizationRequest auth_request = 3;
-    TransportAuthorizationResponse auth_response = 4;
+    ChallengeRequestMessage challenge_request = 1;
+    SignedChallengeMessage signed_challenge = 2;
+    Heartbeat heartbeat = 3;
   }
 }
+
+// Others
+message IslandData {
+  string id = 1;
+  repeated string peers = 2;
+  uint32 max_peers = 3;
+  decentraland.common.Position center = 4;
+  double radius = 5;
+}
+
+message IslandStatusMessage {
+  repeated IslandData data = 1;
+}
+
+message ServiceStatus {
+  uint64 current_time = 1;
+  optional string commit_hash = 2;
+  uint32 user_count = 3;
+}
+
+message ServiceDiscoveryMessage {
+  string server_name = 1;
+  ServiceStatus status = 2;
+}

package/proto/decentraland/pulse/pulse_client.proto

@@ -0,0 +1,120 @@
+syntax = "proto3";
+
+package decentraland.pulse;
+
+import "decentraland/pulse/pulse_shared.proto";
+import "decentraland/common/options.proto";
+
+message HandshakeRequest {
+	bytes auth_chain = 1;
+  int32 profile_version = 2;
+  optional PlayerInitialState initial_state = 3;
+}
+
+// Describes the initial state of the player if (re-)connected in the middle of the session
+message PlayerInitialState {
+  PlayerState state = 1;
+  optional string emote_id = 2;
+  optional uint32 emote_duration_ms = 3;
+  // Indicates how many milliseconds ago the emote was started
+  optional uint32 emote_start_offset_ms = 4;
+  // Non-empty realm identifier. Rejected if empty.
+  string realm = 5;
+  optional int32 emote_mask = 6;
+}
+
+// Similarly to the LiveKit pipeline, a peer announces the version of its profile but
+// it only does it when it's changed as it's sent reliably and stored on the server for other peers
+message ProfileVersionAnnouncement {
+  int32 version = 1;
+}
+
+// Since the server doesn't simulate the scenes state, it trusts the values from the client
+message PlayerStateInput {
+  PlayerState state = 1;
+}
+
+// Client sends resync request if it has a gap in the known sequences and, thus, can't apply a delta.
+// It's sent reliably to prevent further desynchronization
+message ResyncRequest {
+  uint32 subject_id = 1;
+  // highest seq the client actually has for this subject
+  uint32 known_seq = 2;
+}
+
+// Client → Server. Client requests to start an emote.
+message EmoteStart {
+  string emote_id = 1;
+  optional uint32 duration_ms = 2;
+  PlayerState player_state = 3;
+  optional int32 mask = 4;
+}
+
+// Client → Server. Client requests to stop a looping emote.
+// One-shot emotes are terminated by the server timer.
+message EmoteStop {
+}
+
+// Client → Server. Also announces the peer's realm; peers in different realms never see each
+// other. Must be the first gameplay message after handshake. Same-realm re-teleports are valid.
+message TeleportRequest {
+  int32 parcel_index = 1;
+  uint32 position_x = 2 [(decentraland.common.quantized) = { min: 0, max: 16, bits: 8 }];
+  uint32 position_y = 3 [(decentraland.common.quantized) = { min: 0, max: 200, bits: 13 }];
+  uint32 position_z = 4 [(decentraland.common.quantized) = { min: 0, max: 16, bits: 8 }];
+  // Non-empty realm identifier. Rejected if empty.
+  string realm = 5;
+}
+
+// Inclusive rectangle in parcel coordinates. A single parcel is min == max.
+message ParcelRect {
+  sint32 min_x = 1;
+  sint32 min_z = 2;
+  sint32 max_x = 3;
+  sint32 max_z = 4;
+}
+
+// One realm's slice of a scene listener's area of interest. Parcels only mean anything
+// within a realm — every world numbers its own parcels from 0,0 — so a listener that
+// observes several realms, as an authoritative server cohosting scenes from several worlds
+// does, announces one of these per realm rather than one realm for the whole connection.
+message SceneListenerAoi {
+  // Non-empty realm identifier — same rules as TeleportRequest.realm.
+  string realm = 1;
+  // This realm's parcels as inclusive rects. The sum of rect areas across every announced
+  // realm is capped server-side (SceneListener:MaxParcels) — overlaps count per rect, so
+  // announce disjoint rects.
+  repeated ParcelRect parcel_rects = 2;
+}
+
+// Scene-listener connect: same signed-fetch auth chain as HandshakeRequest, plus a
+// parcel-set area of interest per realm. No initial state — a listener is never a subject.
+message SceneListenerHandshakeRequest {
+  // Signed-fetch headers JSON — identical shape to HandshakeRequest.auth_chain.
+  bytes auth_chain = 1;
+  // Announced AoI, one entry per realm; replaceable afterwards with SceneListenerUpdate.
+  repeated SceneListenerAoi aoi = 2;
+}
+
+// Scene-listener AoI reassignment: replaces the area of interest announced at connect, in
+// place, on an authenticated scene-listener connection. Only valid from a peer that
+// authenticated with SceneListenerHandshakeRequest.
+message SceneListenerUpdate {
+  // The new AoI, replacing (not extending) the current one — realms absent from it are no
+  // longer observed. Same rules and SceneListener:MaxParcels budget as the handshake's.
+  repeated SceneListenerAoi aoi = 1;
+}
+
+message ClientMessage {
+  oneof message {
+    HandshakeRequest handshake = 1;
+    PlayerStateInput input = 2;
+    ResyncRequest resync = 3;
+    ProfileVersionAnnouncement profile_announcement = 4;
+    EmoteStart emote_start = 5;
+    EmoteStop emote_stop = 6;
+    TeleportRequest teleport = 7;
+    SceneListenerHandshakeRequest scene_listener_handshake = 8;
+    SceneListenerUpdate scene_listener_update = 9;
+  }
+}

package/proto/decentraland/pulse/pulse_clusters.proto

@@ -0,0 +1,33 @@
+syntax = "proto3";
+
+package 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`,
+// so the WebSocket Connector and clients stay untouched.
+message PeerClusterChange {
+  // Cluster the peer now belongs to. Stable across passes for an unchanged crowd.
+  string cluster_id = 1;
+
+  // 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.
+  string realm = 2;
+
+  // 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.
+  string session = 3;
+
+  // 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.
+  string displaced_session = 4;
+  string displaced_cluster_id = 5;
+}

package/proto/decentraland/pulse/pulse_server.proto

@@ -0,0 +1,144 @@
+syntax = "proto3";
+
+package decentraland.pulse;
+
+import "decentraland/common/options.proto";
+import "decentraland/pulse/pulse_shared.proto";
+
+message HandshakeResponse {
+  bool success = 1;
+  optional string error = 2;
+}
+
+message PlayerProfileVersionsAnnounced {
+  uint32 subject_id = 1;
+  int32 version = 2;
+}
+
+message PlayerStateDeltaTier0 {
+  uint32 subject_id = 1;
+
+  // Between two consecutive server simulation ticks, the subject may have sent multiple inputs, each incrementing Seq by 1. So
+  // the delta's NewSeq will naturally jump by more than 1 compared to the previous delta — even with zero packet loss.
+  // Without the "BaselineSeq" the client has no way to detect the package loss
+  uint32 baseline_seq = 2;
+  uint32 new_seq = 3;
+  uint32 server_tick = 4;
+
+  // While the player doesn't cross the parcel, this field is omitted from diff
+  optional int32 parcel_index = 5;
+
+  // X position inside the parcel
+  optional uint32 position_x = 6 [(decentraland.common.quantized) = { min:  0,  max:   16, bits: 8 }];
+
+  // Y position
+  optional uint32 position_y = 7 [(decentraland.common.quantized) = { min:  0,  max:   200, bits: 13 }];
+
+  // Z position inside the parcel
+  optional uint32 position_z = 8 [(decentraland.common.quantized) = { min:  0,  max:   16, bits: 8 }];
+
+  // Power-law quantized: a sign bit + 7-bit magnitude curve over [-50, 50]. Zero is exactly
+  // representable (a stopped peer reports an exact 0 instead of the linear quantizer's ±0.196
+  // residual that drove foreign-avatar drift), and pow=2 concentrates resolution at the low speeds
+  // where avatars actually move, leaving only the visually-irrelevant extremes coarse.
+  optional uint32 velocity_x = 9 [(decentraland.common.quantized_power) = { max: 50, pow: 2, bits: 8 }];
+  optional uint32 velocity_y = 10 [(decentraland.common.quantized_power) = { max: 50, pow: 2, bits: 8 }];
+  optional uint32 velocity_z = 11 [(decentraland.common.quantized_power) = { max: 50, pow: 2, bits: 8 }];
+
+  optional uint32 rotation_y = 12 [(decentraland.common.quantized) = { min:  0,  max:   360.0, bits: 7 }];
+  optional uint32 movement_blend = 13 [(decentraland.common.quantized) = { min:  0,  max:   3, bits: 5 }];
+  optional uint32 slide_blend = 14 [(decentraland.common.quantized) = { min:  0,  max:   1, bits: 4 }];
+  optional uint32 head_yaw = 15 [(decentraland.common.quantized) = { min:  0,  max:   360.0, bits: 7 }];
+  optional uint32 head_pitch = 16 [(decentraland.common.quantized) = { min:  0,  max:   360.0, bits: 7 }];
+
+  optional uint32 state_flags = 17;
+  optional GlideState glide_state = 18;
+
+  optional int32 jump_count = 19;
+
+  // Absolute world hit position the player is pointing at.
+  // Only meaningful when POINTING_AT is set in `state_flags`.
+  //
+  // X/Z use 17 bits over the world span (~±3000m, covers GenesisCity + border +
+  // raycast cutoff) which yields ~0.046m steps — at least as fine as the player's
+  // own parcel_index + position_x/z combined precision (0.0625m), so no separate
+  // parcel index is needed for point-at.
+  //
+  // Y uses 7 bits over the player altitude range (matches position_y), step ~1.6m.
+  // Point At is not supposed to change frequently so the wire overhead should be minimal
+  optional uint32 point_at_x = 20 [(decentraland.common.quantized) = { min: -3000.0, max: 3000.0, bits: 17 }];
+  optional uint32 point_at_y = 21 [(decentraland.common.quantized) = { min:     0.0, max:  200.0, bits:  7 }];
+  optional uint32 point_at_z = 22 [(decentraland.common.quantized) = { min: -3000.0, max: 3000.0, bits: 17 }];
+}
+
+// Full State is sent to the client when it is out of sync, and can't recover with a diff only
+message PlayerStateFull {
+  uint32 subject_id = 1;
+  uint32 sequence = 2;
+  uint32 server_tick = 3;
+  PlayerState state = 4;
+}
+
+// Notification to the client, that a peer has joined, it can mean connection or entering the area of interest, it's up to the server to decide
+message PlayerJoined {
+  string user_id = 1;
+  int32 profile_version = 2;
+  PlayerStateFull state = 3;
+  string realm = 4;
+}
+
+// Notification to the client, that a peer has left, it can mean disconnection or leaving the area of interest
+message PlayerLeft {
+  uint32 subject_id = 1;
+}
+
+enum EmoteStopReason {
+  COMPLETED = 0;  // one-shot timer expired on the server
+  CANCELLED = 1;  // client sent EmoteStop (looping emotes)
+}
+
+// Server → All Observers
+// Full player state is piggybacked to ensure the emote is played in the right place.
+// Observers use server_tick to scrub animation forward by transit latency.
+message EmoteStarted {
+  uint32 subject_id = 1;
+  uint32 sequence = 2;
+  uint32 server_tick = 3;
+  string emote_id = 4;
+  PlayerState player_state = 5;
+  optional int32 mask = 6;
+}
+
+// Server → All Observers
+// Client resumes MovementInput only after receiving this.
+// Carries full PlayerState so the client can snap to the correct position on resume.
+message EmoteStopped {
+  uint32 subject_id = 1;
+  uint32 server_tick = 2;
+  EmoteStopReason reason = 3;
+  uint32 sequence = 4;
+  PlayerState player_state = 5;
+}
+
+// Server → All Observers
+message TeleportPerformed {
+  uint32 subject_id = 1;
+  uint32 sequence = 2;
+  uint32 server_tick = 3;
+  PlayerState state = 4;
+  string realm = 5;
+}
+
+message ServerMessage {
+  oneof message {
+      HandshakeResponse handshake = 1;
+      PlayerStateFull player_state_full = 2;
+      PlayerStateDeltaTier0 player_state_delta = 3;
+      PlayerJoined player_joined = 4;
+      PlayerLeft player_left = 5;
+      PlayerProfileVersionsAnnounced player_profile_version_announced = 6;
+      EmoteStarted emote_started = 7;
+      EmoteStopped emote_stopped = 8;
+      TeleportPerformed teleported = 9;
+  }
+}

package/proto/decentraland/pulse/pulse_shared.proto

@@ -0,0 +1,57 @@
+syntax = "proto3";
+
+package decentraland.pulse;
+
+import "decentraland/common/options.proto";
+
+enum PlayerAnimationFlags {
+  NONE = 0;
+  GROUNDED = 1;
+  LONG_JUMP = 2;
+  LONG_FALL = 4;
+  FALLING = 8;
+  STUNNED = 16;
+  HEAD_YAW = 32;
+  HEAD_PITCH = 64;
+  POINTING_AT = 128;
+}
+
+enum GlideState {
+  PROP_CLOSED = 0;
+  OPENING_PROP = 1;
+  GLIDING = 2;
+  CLOSING_PROP = 3;
+}
+
+// Quantized identically to PlayerStateDeltaTier0 so a full state and a stream of deltas land on the same grid.
+message PlayerState {
+  int32 parcel_index = 1;
+
+  // Position inside the parcel (X/Z) and world altitude (Y).
+  uint32 position_x = 2 [(decentraland.common.quantized) = { min: 0, max: 16, bits: 8 }];
+  uint32 position_y = 3 [(decentraland.common.quantized) = { min: 0, max: 200, bits: 13 }];
+  uint32 position_z = 4 [(decentraland.common.quantized) = { min: 0, max: 16, bits: 8 }];
+
+  uint32 velocity_x = 5 [(decentraland.common.quantized_power) = { max: 50, pow: 2, bits: 8 }];
+  uint32 velocity_y = 6 [(decentraland.common.quantized_power) = { max: 50, pow: 2, bits: 8 }];
+  uint32 velocity_z = 7 [(decentraland.common.quantized_power) = { max: 50, pow: 2, bits: 8 }];
+
+  uint32 rotation_y = 8 [(decentraland.common.quantized) = { min: 0, max: 360.0, bits: 7 }];
+
+  uint32 movement_blend = 9 [(decentraland.common.quantized) = { min: 0, max: 3, bits: 5 }];
+  uint32 slide_blend = 10 [(decentraland.common.quantized) = { min: 0, max: 1, bits: 4 }];
+
+  optional uint32 head_yaw = 11 [(decentraland.common.quantized) = { min: 0, max: 360.0, bits: 7 }];
+  optional uint32 head_pitch = 12 [(decentraland.common.quantized) = { min: 0, max: 360.0, bits: 7 }];
+
+  uint32 state_flags = 13;
+  GlideState glide_state = 14;
+
+  int32 jump_count = 15;
+
+  // Absolute world hit position the player is pointing at.
+  // Only meaningful when POINTING_AT is set in `state_flags`.
+  optional uint32 point_at_x = 16 [(decentraland.common.quantized) = { min: -3000.0, max: 3000.0, bits: 17 }];
+  optional uint32 point_at_y = 17 [(decentraland.common.quantized) = { min:     0.0, max:  200.0, bits:  7 }];
+  optional uint32 point_at_z = 18 [(decentraland.common.quantized) = { min: -3000.0, max: 3000.0, bits: 17 }];
+}