@dcl/protocol 1.0.0-10043247792.commit-428d1eb

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

@@ -0,0 +1,104 @@
+// This file maps to the definition in https://rfc.decentraland.org/rfc/RFC-5
+// It is mandatory to also update that RFC when modifying this file
+
+syntax = "proto3";
+
+package decentraland.kernel.comms.rfc5;
+
+/**
+ * Sent to the clients when the challenge is validated and they are authenticated.
+ */
+message WsWelcome {
+  uint32 alias = 1;
+  map<uint32, string> peer_identities = 2;
+}
+
+/**
+ * Sent to the clients when a user connects and their identity is authenticated.
+ */
+message WsPeerJoin {
+  uint32 alias = 1;
+  string address = 2;
+}
+
+/**
+ * Sent to the clients when a user gets disconnected.
+ */
+message WsPeerLeave {
+  uint32 alias = 1;
+}
+
+/**
+ * This is the data package for all user messages.
+ */
+message WsPeerUpdate {
+  uint32 from_alias = 1;
+  bytes body = 2;
+  bool unreliable = 3;
+}
+
+
+/**
+ * Sent to the clients as first message, it contains a challenge string and a
+ * hint about if the same address is connected to another room. In such case,
+ * after authentication, the server may decide to end the former connection. This
+ * hint exists for UX purposes of the explorers for cases like multiple running
+ * instances of the explorer.
+ */
+message WsChallengeRequired {
+  string challenge_to_sign = 1;
+  bool already_connected = 2;
+}
+
+/**
+ * Response to WsChallengeRequired, signed using the AuthChain mechanism.
+ */
+message WsSignedChallenge {
+  string auth_chain_json = 1;
+}
+
+/**
+ * This is the first message sent by the clients, it us used to identify the client
+ * in the server.
+ */
+message WsIdentification {
+  string address = 1;
+}
+
+/**
+ * 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. It can also be used to reject new users joining when
+ * the room capacity has been reached.
+ */
+message WsKicked {
+  string reason = 1;
+}
+
+message WsPacket {
+  oneof message {
+    // direction: server->client
+    WsWelcome welcome_message = 1;
+
+    // direction: server->client
+    WsPeerJoin peer_join_message = 2;
+
+    // direction: client->(server)->client
+    WsPeerUpdate peer_update_message = 3;
+
+    // direction: server->client
+    WsChallengeRequired challenge_message = 4;
+
+    // direction: client->server
+    WsSignedChallenge signed_challenge_for_server = 5;
+
+    // direction: server->client
+    WsPeerLeave peer_leave_message = 6;
+
+    // direction: client->server
+    WsIdentification peer_identification = 7;
+
+    // direction: server->client
+    WsKicked peer_kicked = 8;
+  }
+}

package/proto/decentraland/kernel/comms/v1/broker.proto

@@ -0,0 +1,114 @@
+syntax = "proto3";
+
+package decentraland.kernel.comms.v1;
+
+enum MessageType {
+  MT_UNKNOWN_MESSAGE_TYPE = 0;
+  MT_WELCOME = 1;
+  MT_CONNECT = 2;
+  MT_WEBRTC_OFFER = 3;
+  MT_WEBRTC_ANSWER = 4;
+  MT_WEBRTC_ICE_CANDIDATE = 5;
+  MT_PING = 6;
+  MT_SUBSCRIPTION = 7;
+  MT_AUTH = 8;
+
+  MT_TOPIC = 9;
+  MT_TOPIC_FW = 10;
+
+  MT_TOPIC_IDENTITY = 11;
+  MT_TOPIC_IDENTITY_FW = 12;
+}
+
+enum Role {
+  R_UNKNOWN_ROLE = 0;
+  R_CLIENT = 1;
+  R_COMMUNICATION_SERVER = 2;
+}
+
+enum Format {
+  F_UNKNOWN_FORMAT = 0;
+  F_PLAIN = 1;
+  F_GZIP = 2;
+}
+
+// NOTE: coordination messsages
+
+message CoordinatorMessage {
+  MessageType type = 1;
+}
+
+message WelcomeMessage {
+  MessageType type = 1;
+  uint64 alias = 2;
+  repeated uint64 available_servers = 3;
+}
+
+message ConnectMessage {
+  MessageType type = 1;
+  uint64 from_alias = 2;
+  uint64 to_alias = 3;
+}
+
+message WebRtcMessage {
+  MessageType type = 1;
+  uint64 from_alias = 2;
+  uint64 to_alias = 3;
+  bytes data = 4;
+}
+
+// NOTE: comm server messsages
+
+message MessageHeader {
+  MessageType type = 1;
+}
+
+message PingMessage {
+  MessageType type = 1;
+  double time = 2;
+}
+
+// NOTE: topics is a space separated string in the format specified by Format
+message SubscriptionMessage {
+  MessageType type = 1;
+  Format format = 2;
+  bytes topics = 3;
+}
+
+// NOTE: comm server messsages
+
+message AuthMessage {
+  MessageType type = 1;
+  Role role = 2;
+  bytes body = 3;
+}
+
+message TopicMessage {
+  MessageType type = 1;
+  uint64 from_alias = 2;
+  string topic = 3;
+  bytes body = 4;
+}
+
+message TopicFWMessage {
+  MessageType type = 1;
+  uint64 from_alias = 2;
+  bytes body = 3;
+}
+
+message TopicIdentityMessage {
+  MessageType type = 1;
+  uint64 from_alias = 2;
+  string topic = 3;
+  bytes identity = 4;
+  Role role = 5;
+  bytes body = 6;
+}
+
+message TopicIdentityFWMessage {
+  MessageType type = 1;
+  uint64 from_alias = 2;
+  bytes identity = 3;
+  Role role = 4;
+  bytes body = 5;
+}

package/proto/decentraland/kernel/comms/v1/comms.proto

@@ -0,0 +1,68 @@
+syntax = "proto3";
+
+package decentraland.kernel.comms.v1;
+
+message AuthData {
+  string signature = 1;
+  string identity = 2;
+  string timestamp = 3;
+  string access_token = 4;
+}
+
+enum Category {
+  C_UNKNOWN = 0;
+  C_POSITION = 1;
+  C_PROFILE = 2;
+  C_CHAT = 3;
+  C_SCENE_MESSAGE = 4;
+  C_PROF_REQ = 5;
+  C_PROF_RES = 6;
+}
+
+message DataHeader {
+  Category category = 1;
+}
+
+message PositionData {
+  Category category = 1;
+  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;
+  bool immediate = 10;
+}
+
+message ProfileData {
+  Category category = 1;
+  double time = 2;
+  string profile_version = 3;
+  enum ProfileType {
+    PT_LOCAL = 0;
+    PT_DEPLOYED = 1;
+  }
+  ProfileType profile_type = 4;
+}
+
+message ProfileRequestData {
+  Category category = 1;
+  double time = 2;
+  string profile_version = 3;
+  string user_id = 4;
+}
+
+message ProfileResponseData {
+  Category category = 1;
+  double time = 2;
+  string serialized_profile = 3;
+}
+
+message ChatData {
+  Category category = 1;
+  double time = 2;
+  string message_id = 3;
+  string text = 4;
+}

package/proto/decentraland/kernel/comms/v2/comms.proto

@@ -0,0 +1,61 @@
+syntax = "proto3";
+
+package decentraland.kernel.comms.v2;
+
+message CommsMessage {
+  double time = 1;
+  oneof data {
+    PositionData position_data = 2;
+    ProfileData profile_data = 3;
+    ChatData chat_data = 4;
+    SceneData scene_data = 5;
+    VoiceData voice_data = 6;
+    ProfileRequestData profile_request_data = 7;
+    ProfileResponseData profile_response_data = 8;
+  }
+}
+
+message PositionData {
+  float position_x = 1;
+  float position_y = 2;
+  float position_z = 3;
+  float rotation_x = 4;
+  float rotation_y = 5;
+  float rotation_z = 6;
+  float rotation_w = 7;
+  bool immediate = 8;
+}
+
+message ProfileData {
+  string profile_version = 1;
+  string user_id = 2;
+  enum ProfileType {
+    PT_DEPLOYED = 0;
+    PT_LOCAL = 1;
+  }
+  ProfileType profile_type = 3;
+}
+
+message ProfileRequestData {
+  string profile_version = 1;
+  string user_id = 2;
+}
+
+message ProfileResponseData {
+  string serialized_profile = 1;
+}
+
+message ChatData {
+  string message_id = 1;
+  string text = 2;
+}
+
+message SceneData {
+  string scene_id = 1;
+  string text = 2;
+}
+
+message VoiceData {
+  bytes encoded_samples = 1;
+  uint32 index = 2;
+}

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/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) {}
+}