@dcl/protocol 1.0.0-2731649607.commit-890a990 → 1.0.0-27358757907.commit-3c70e8a

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

@@ -0,0 +1,86 @@
+syntax = "proto3";
+
+import "decentraland/common/vectors.proto";
+
+package decentraland.kernel.comms.v3;
+
+// Server->Client messsages
+message ChallengeResponseMessage {
+  string challenge_to_sign = 1;
+  bool already_connected = 2;
+}
+
+message WelcomeMessage {
+  string peer_id = 1;
+}
+
+message IslandChangedMessage {
+  string island_id = 1;
+  string conn_str = 2;
+  optional string from_island_id = 3;
+  map<string, decentraland.common.Position> peers = 4;
+}
+
+message LeftIslandMessage {
+  string island_id = 1;
+  string peer_id = 2;
+}
+
+message JoinIslandMessage {
+  string island_id = 1;
+  string peer_id = 2;
+}
+
+enum KickedReason {
+  KR_NEW_SESSION = 0;
+}
+
+message KickedMessage {
+  KickedReason reason = 1;
+}
+
+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;
+  }
+}
+
+// Client->Server messsages
+message ChallengeRequestMessage {
+  string address = 1;
+}
+
+message SignedChallengeMessage {
+  string auth_chain_json = 1;
+}
+
+message Heartbeat {
+  decentraland.common.Position position = 1;
+  optional string desired_room = 2;
+}
+
+message ClientPacket {
+  oneof message {
+    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;
+}

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

@@ -0,0 +1,64 @@
+syntax = "proto3";
+
+package decentraland.kernel.comms.v3;
+
+message Position {
+    double time = 2;
+    float position_x = 3;
+    float position_y = 4;
+    float position_z = 5;
+    float rotation_x = 6;
+    float rotation_y = 7;
+    float rotation_z = 8;
+    float rotation_w = 9;
+}
+
+message Profile {
+    double time = 2;
+    string profile_version = 3;
+    enum ProfileType {
+        PT_LOCAL = 0;
+        PT_DEPLOYED = 1;
+    }
+    ProfileType profile_type = 4;
+}
+
+message ProfileRequest {
+    double time = 2;
+    string profile_version = 3;
+    string user_id = 4;
+}
+
+message ProfileResponse {
+    double time = 2;
+    string serialized_profile = 3;
+}
+
+message Chat {
+    double time = 2;
+    string message_id = 3;
+    string text = 4;
+}
+
+message Scene {
+    double time = 2;
+    string scene_id = 3;
+    string data = 4;
+}
+
+message Voice {
+    bytes encoded_samples = 2;
+    uint32 index = 3;
+}
+
+message Data {
+  oneof message {
+    Position position = 1;
+    Profile profile = 2;
+    ProfileRequest profile_request = 3;
+    ProfileResponse profile_response = 4;
+    Chat chat = 5;
+    Scene scene = 6;
+    Voice voice = 7;
+  }
+}

package/proto/decentraland/pulse/pulse_client.proto

@@ -0,0 +1,77 @@
+syntax = "proto3";
+
+package decentraland.pulse;
+
+import "decentraland/common/vectors.proto";
+import "decentraland/pulse/pulse_shared.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;
+  decentraland.common.Vector3 position = 2;
+  // Non-empty realm identifier. Rejected if empty.
+  string realm = 3;
+}
+
+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;
+  }
+}

package/proto/decentraland/pulse/pulse_server.proto

@@ -0,0 +1,138 @@
+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 }];
+
+  optional uint32 velocity_x = 9 [(decentraland.common.quantized) = { min:  -50,  max:   50, bits: 8 }];
+  optional uint32 velocity_y = 10 [(decentraland.common.quantized) = { min:  -50,  max:   50, bits: 8 }];
+  optional uint32 velocity_z = 11 [(decentraland.common.quantized) = { min:  -50,  max:   50, 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;
+}
+
+// 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;
+}
+
+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,48 @@
+syntax = "proto3";
+
+package decentraland.pulse;
+
+import "decentraland/common/vectors.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;
+}
+
+message PlayerState {
+  int32 parcel_index = 1;
+
+  decentraland.common.Vector3 position = 2;
+  decentraland.common.Vector3 velocity = 3;
+
+  float rotation_y = 4;
+
+  float movement_blend = 5;
+  float slide_blend = 6;
+
+  optional float head_yaw = 7;
+  optional float head_pitch = 8;
+
+  uint32 state_flags = 9;
+  GlideState glide_state = 10;
+
+  int32 jump_count = 11;
+
+  // Absolute world hit position the player is pointing at.
+  // Only meaningful when POINTING_AT is set in `state_flags`.
+  optional decentraland.common.Vector3 point_at = 12;
+}

package/proto/decentraland/quests/definitions.proto

@@ -0,0 +1,185 @@
+syntax = "proto3";
+package decentraland.quests;
+
+import "google/protobuf/empty.proto";
+
+// Errors 
+message InvalidQuest {}
+
+message NotUUID {}
+
+message InternalServerError {}
+
+message NotFoundQuestInstance {}
+
+message QuestAlreadyStarted {}
+
+message NotOwner {}
+
+message IgnoredEvent {}
+
+message StartQuestRequest {
+  string quest_id = 1;
+}
+
+message StartQuestResponse {
+  /* There are a few valid reasons to not be accepted:
+  *  - Quest is not found
+  *  - Quest is deactivated (the owner deleted it)
+  *  - User already started the quest
+  *  - Internal errors (DB connection failed or something like that) */
+  message Accepted {}
+  oneof response {
+    Accepted accepted = 1;
+    InvalidQuest invalid_quest = 2;
+    NotUUID not_uuid_error = 3;
+    InternalServerError internal_server_error = 4;
+    QuestAlreadyStarted quest_already_started = 5;
+  }
+}
+
+message AbortQuestRequest {
+  string quest_instance_id = 1;
+}
+
+message AbortQuestResponse {
+  /* There are a few valid reasons to not be accepted:
+  *  - Quest instance is not found
+  *  - Quest instance is from another user 
+  *  - Quest instance already aborted
+  *  - Internal errors (DB connection failed or something like that) */
+  message Accepted {}
+  oneof response {
+    Accepted accepted = 1;
+    NotFoundQuestInstance not_found_quest_instance = 2;
+    NotUUID not_uuid_error = 3;
+    NotOwner not_owner = 4;
+    InternalServerError internal_server_error = 5;
+  }
+}
+
+message Event {
+  string id = 1;
+  string address = 2;
+  Action action = 3;
+}
+
+message EventRequest {
+  Action action = 1;
+}
+
+message EventResponse {
+  oneof response {
+    string accepted_event_id = 1;
+    IgnoredEvent ignored_event = 2;
+    InternalServerError internal_server_error = 3;
+  }
+}
+
+message QuestDefinition {
+  repeated Step steps = 1;
+  repeated Connection connections = 2;
+}
+
+message Connection {
+  string step_from = 1;
+  string step_to = 2;
+}
+
+message Step {
+  string id = 1;
+  string description = 2;
+  repeated Task tasks = 3;
+}
+
+message Action {
+  string type = 1;
+  map<string, string> parameters = 2;
+}
+
+message Task {
+  string id = 1;
+  string description = 2;
+  repeated Action action_items = 3;
+}
+
+message StepContent {
+  repeated Task to_dos = 1;
+  repeated Task tasks_completed = 2;
+}
+
+message QuestState {
+  map<string, StepContent> current_steps = 2;
+  fixed32 steps_left = 3;
+  repeated string steps_completed = 4;
+  repeated string required_steps = 5;
+}
+
+message Quest {
+  string id = 1;
+  string name = 2;
+  string description = 3;
+  QuestDefinition definition = 4;
+  string creator_address = 5;
+  string image_url = 6;
+  bool active = 7;
+  fixed32 created_at = 8;
+}
+
+message QuestInstance {
+  string id = 1;
+  Quest quest = 2;
+  QuestState state = 3;
+}
+
+message QuestStateUpdate {
+  string instance_id = 1;
+  QuestState quest_state = 2;
+  string event_id = 3;
+}
+
+message UserUpdate {
+  oneof message {
+    bool subscribed = 1;
+    QuestStateUpdate quest_state_update = 2;
+    QuestInstance new_quest_started = 3;
+    string event_ignored = 4;
+  }
+  string user_address = 5;
+}
+
+message Quests {
+  repeated QuestInstance instances = 1;
+}
+
+message GetAllQuestsResponse {
+  oneof response {
+    Quests quests = 1;
+    InternalServerError internal_server_error = 2;
+  }
+}
+
+message GetQuestDefinitionRequest {
+  string quest_id = 1;
+}
+
+message GetQuestDefinitionResponse {
+  oneof response {
+    Quest quest = 1;
+    InternalServerError internal_server_error = 2;
+  }
+}
+
+service QuestsService {
+  // User actions
+  rpc StartQuest(StartQuestRequest) returns (StartQuestResponse) {}
+  rpc AbortQuest(AbortQuestRequest) returns (AbortQuestResponse) {}
+  rpc SendEvent(EventRequest) returns (EventResponse) {}
+
+  // Listen to changes in quest states and event processing updates
+  rpc Subscribe(google.protobuf.Empty) returns (stream UserUpdate) {}
+
+  // Query quest information
+  rpc GetAllQuests(google.protobuf.Empty) returns (GetAllQuestsResponse) {}
+  rpc GetQuestDefinition(GetQuestDefinitionRequest) returns (GetQuestDefinitionResponse) {}
+}