@dcl/protocol 1.0.0-2731649607.commit-890a990 → 1.0.0-27574288540.commit-f0df3e0

package/proto/decentraland/kernel/apis/testing.proto

@@ -0,0 +1,100 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+import "decentraland/common/vectors.proto";
+
+service TestingService {
+  // sends a test result to the test runner
+  rpc LogTestResult(TestResult) returns (TestResultResponse) {}
+  // send a list of all planned tests to the test runner
+  rpc Plan(TestPlan) returns (TestPlanResponse) {}
+  // sets the camera position and rotation in the engine
+  rpc SetCameraTransform (SetCameraTransformTestCommand) returns (SetCameraTransformTestCommandResponse) {}
+  // @internal
+  // take a screenshot and compare it with a stored one
+  //  it hides the explorer hud and ui, primary player and players of avatar scenes
+  rpc TakeAndCompareScreenshot (TakeAndCompareScreenshotRequest) returns (TakeAndCompareScreenshotResponse) {}
+}
+
+message TakeAndCompareScreenshotRequest {
+  // the source path in the scene where the screenshot is stored, 
+  //  the snapshot taken is compared with the stored one
+  string src_stored_snapshot = 1;
+  // the camera position where is set before and while taking the screenshot, relative to base scene
+  decentraland.common.Vector3 camera_position = 2;
+  // the camera position where is target to before and while taking the screenshot, relative to base scene
+  decentraland.common.Vector3 camera_target = 3;
+  // width x height screenshot size
+  decentraland.common.Vector2 screenshot_size = 4;
+  // comparison method choice and parameters values
+  oneof comparison_method {
+    ComparisonMethodGreyPixelDiff grey_pixel_diff = 5;
+  }
+
+  message ComparisonMethodGreyPixelDiff {}
+  
+  enum SnapshotMode {
+    // only visible 3d scene and ui scene
+    SM_3D_AND_UI = 0;
+    // only visible 3d scene
+    SM_3D_ONLY = 1;
+    // only visible ui scene
+    SM_UI_ONLY = 2;
+  };
+  SnapshotMode snapshot_mode = 6;
+}
+
+
+message TakeAndCompareScreenshotResponse {
+  bool stored_snapshot_found = 1;
+  oneof comparison_method_result {
+    ComparisonMethodGreyPixelDiffResult grey_pixel_diff = 2;
+  }
+
+  message ComparisonMethodGreyPixelDiffResult {
+    float similarity = 1;
+  }
+}
+
+message TestResult {
+    string name = 1;
+    bool ok = 2;
+    optional string error = 3;
+    optional string stack = 4;
+
+    // how many ADR-148 ticks were spent running this test
+    uint32 total_frames = 5;
+
+    // total time in seconds spent running this test
+    float total_time = 6;
+}
+message TestResultResponse {}
+
+message TestPlan {
+  message TestPlanEntry {
+    string name = 1;
+  }
+
+  repeated TestPlanEntry tests = 1;
+}
+message TestPlanResponse {}
+
+message SetCameraTransformTestCommand {
+  Vector3 position = 1;
+  Quaternion rotation = 2;
+
+  message Vector3 {
+    float x = 1;
+    float y = 2;
+    float z = 3;
+  }
+
+  message Quaternion {
+    float x = 1;
+    float y = 2;
+    float z = 3;
+    float w = 4;
+  }
+}
+message SetCameraTransformTestCommandResponse {}
+

package/{kernel/apis/UserActionModule.proto → proto/decentraland/kernel/apis/user_action_module.proto}

@@ -1,4 +1,5 @@
 syntax = "proto3";
+package decentraland.kernel.apis;
 
 message RequestTeleportRequest {
     string destination = 1;
@@ -7,5 +8,6 @@ message RequestTeleportRequest {
 message RequestTeleportResponse {}
 
 service UserActionModuleService {
+    // @deprecated, only available for SDK6 compatibility. Use RestrictedActions/TeleportTo
     rpc RequestTeleport(RequestTeleportRequest) returns (RequestTeleportResponse) {}
 }

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

@@ -0,0 +1,22 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+import "decentraland/common/sdk/user_data.proto";
+
+message GetUserDataRequest {}
+
+message GetUserDataResponse {
+    optional decentraland.common.sdk.UserData data = 1;
+}
+
+message GetUserPublicKeyRequest {}
+
+message GetUserPublicKeyResponse {
+    optional string address = 1;
+}
+
+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

@@ -0,0 +1,176 @@
+// This file maps to the definition in https://rfc.decentraland.org/rfc/RFC-4
+// It is mandatory to also update that RFC when modifying this file
+
+syntax = "proto3";
+
+package decentraland.kernel.comms.rfc4;
+
+message Packet {
+  oneof message {
+    Position position = 1;
+    AnnounceProfileVersion profile_version = 2;
+    ProfileRequest profile_request = 3;
+    ProfileResponse profile_response = 4;
+    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 {
+  // command number
+  uint32 index = 1;
+  // world position
+  float position_x = 3;
+  float position_y = 4;
+  float position_z = 5;
+  // quaternion
+  float rotation_x = 6;
+  float rotation_y = 7;
+  float rotation_z = 8;
+  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
+  optional bool is_repeating = 5; // true when it is not the first time the looping animation plays
+  optional int32 interaction_id = 6; // identifies an interaction univocaly, established when the start animation is triggered
+  optional int32 social_emote_outcome = 7; // -1 means it does not use an outcome animation
+  optional bool is_reacting = 8; // to a social emote started by other user
+  optional string social_emote_initiator = 9; // wallet address of the user that initiated social emote
+  optional string target_avatar = 10; // wallet address of the user whose avatar is the target of a directed emote
+  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;
+
+  // Extension: optional download_url to fetch the profile from a profile service
+  // optional string download_url = 2;
+}
+
+message ProfileRequest {
+  string address = 4;
+  uint32 profile_version = 3;
+}
+
+message ProfileResponse {
+  string serialized_profile = 1;
+  string base_url = 2;
+
+  // Extension: when Lambdas serializes profiles for the RPC, we could extend
+  // this format to prevent transmitting the serialized JSON and leverage protobuf
+  // directly
+  // Profile profile = 2;
+}
+
+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 {
+  string scene_id = 1;
+  bytes data = 2;
+}
+
+message Voice {
+  bytes encoded_samples = 1;
+  uint32 index = 2;
+  VoiceCodec codec = 3;
+  enum VoiceCodec {
+    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

@@ -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;
+}