@dcl/protocol 1.0.0-3175139283.commit-c671437 → 1.0.0-3199325469.commit-c9bc23f

package/README.md

@@ -1 +1,20 @@
 # Protocol definitions
+
+This module is intended to be installed as a node_module via `npm install @dcl/protocol`.
+
+It is recommended that every project compiles the needed files only as part of its build process. Some imports are required:
+
+- `-I=$(pwd)/node_modules/protobufjs`
+- `-I=$(pwd)/node_modules/@dcl/protocol`
+
+An example compilation looks like this:
+
+```bash
+protoc \
+  --plugin=./node_modules/.bin/protoc-gen-ts_proto \
+  --ts_proto_opt=esModuleInterop=true,returnObservable=false,outputServices=generic-definitions,fileSuffix=.gen \
+  --ts_proto_out="$(pwd)/out-ts" \
+  -I="$(pwd)/node_modules/protobufjs" \
+  -I="$(pwd)/node_modules/@dcl/protocol" \
+  "$(pwd)/node_modules/@dcl/protocol/bff-services.proto"
+```

package/bff/authentication-service.proto

@@ -17,6 +17,9 @@ message SignedChallenge {
 
 message WelcomePeerInformation {
   string peer_id = 1;
+
+  // list of available modules in this BFF
+  repeated string available_modules = 2;
 }
 
 service BffAuthenticationService {

package/bff/comms-director-service.proto

@@ -0,0 +1,33 @@
+syntax = "proto3";
+
+// CommsDirector are formalized at https://rfc.decentraland.org/adr/ADR-81
+
+import "google/protobuf/empty.proto";
+import "common/Vectors.proto";
+
+package decentraland.bff;
+
+message WorldCommand {
+  oneof command {
+    SetCommsAdapter set_comms_adapter = 1;
+  }
+}
+
+message SetCommsAdapter {
+  string connection_string = 1;
+}
+
+message Heartbeat {
+  decentraland.common.Position position = 1;
+  optional string desired_room = 2;
+}
+
+service CommsDirectorService {
+  // every couple seconds AND at the beginning, the explorers must send a heartbeat
+  // to make the comms director aware of their location
+  rpc SendHeartbeat(Heartbeat) returns (google.protobuf.Empty) {}
+
+  // before sending the first heartbeat, it is required that the explorers subscribe
+  // to a list of comms commands
+  rpc GetCommsCommands(google.protobuf.Empty) returns (stream WorldCommand) {}
+}

package/bff/comms-service.proto

@@ -1,35 +1,12 @@
 syntax = "proto3";
 
+import public "bff/topics-service.proto";
 package decentraland.bff;
 
 message Subscription {
   uint32 subscription_id = 1;
 }
 
-message SubscriptionRequest {
-  string topic = 1;
-}
-
-message PeerTopicSubscriptionResultElem {
-  bytes payload = 1;
-  string topic = 2;
-  string sender = 3;
-}
-
-message SystemTopicSubscriptionResultElem {
-  bytes payload = 1;
-  string topic = 2;
-}
-
-message PublishToTopicRequest {
-  string topic = 1;
-  bytes payload = 2;
-}
-
-message PublishToTopicResult {
-  bool ok = 1;
-}
-
 message UnsubscriptionResult {
   bool ok = 1;
 }
@@ -43,7 +20,6 @@ service CommsService {
   rpc GetSystemMessages(Subscription) returns (stream SystemTopicSubscriptionResultElem) {}
   rpc UnsubscribeToSystemMessages(Subscription) returns (UnsubscriptionResult) {}
 
-
   // send a peer message to a topic
   rpc PublishToTopic(PublishToTopicRequest) returns (PublishToTopicResult) {}
-}
+}

package/bff/http-endpoints.proto

@@ -13,29 +13,26 @@ message AboutResponse {
   LambdasInfo lambdas = 5;
   BffInfo bff = 6;
 
-  message BaseService {
-    bool healthy = 1;
-    optional string version = 2;
-    optional string commit_hash = 3;
-    optional string public_url = 4;
-  }
-
   message AboutConfiguration {
     optional string realm_name = 1;
+    uint32 network_id = 2;
+    repeated string global_scenes_urn = 3;
+    repeated string scenes_urn = 4;
   }
+
   message ContentInfo {
     // common properties
     bool healthy = 1;
     optional string version = 2;
     optional string commit_hash = 3;
-    optional string public_url = 4;
+    string public_url = 4;
   }
   message LambdasInfo {
     // common properties
     bool healthy = 1;
     optional string version = 2;
     optional string commit_hash = 3;
-    optional string public_url = 4;
+    string public_url = 4;
   }
   message CommsInfo {
     // common properties
@@ -46,15 +43,17 @@ message AboutResponse {
     // specific properties
     string protocol = 50;
     optional int32 users_count = 51;
+    optional string fixed_adapter = 52;
   }
   message BffInfo {
     // common properties
     bool healthy = 1;
     optional string version = 2;
     optional string commit_hash = 3;
-    optional string public_url = 4;
+    string public_url = 4;
     // specific properties
     optional int32 user_count = 51;
+    optional string protocol_version = 52;
   }
 }
 

package/bff/topics-service.proto

@@ -0,0 +1,35 @@
+syntax = "proto3";
+
+package decentraland.bff;
+
+message SubscriptionRequest {
+  string topic = 1;
+}
+
+message PeerTopicSubscriptionResultElem {
+  bytes payload = 1;
+  string topic = 2;
+  string sender = 3;
+}
+
+message SystemTopicSubscriptionResultElem {
+  bytes payload = 1;
+  string topic = 2;
+}
+
+message PublishToTopicRequest {
+  string topic = 1;
+  bytes payload = 2;
+}
+
+message PublishToTopicResult {
+  bool ok = 1;
+}
+
+service TopicsService {
+  rpc PeerSubscription(SubscriptionRequest) returns (stream PeerTopicSubscriptionResultElem) {}
+  rpc SystemSubscription(SubscriptionRequest) returns (stream SystemTopicSubscriptionResultElem) {}
+
+  // send a peer message to a topic
+  rpc PublishToTopic(PublishToTopicRequest) returns (PublishToTopicResult) {}
+}

package/bff-services.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+// This version is used to check compatibility between Kernel<>BFF
+// Update it manually using semantic versioning. Patches may be skipped.
+package v1_0_0;
+
+// This file only imports all the services for the BFF to help the compiler
+// resolve all dependencies
+
+import public "bff/authentication-service.proto";
+import public "bff/http-endpoints.proto";
+import public "bff/topics-service.proto";
+import public "bff/comms-director-service.proto";
+
+// TO BE DELETED
+import public "bff/comms-service.proto";

package/{kernel/apis/common → common}/ContentMapping.proto

@@ -1,4 +1,5 @@
 syntax = "proto3";
+package decentraland.common;
 
 message ContentMapping {
     string file = 1;

package/common/Entity.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+package decentraland.common;
+import "common/ContentMapping.proto";
+
+// Entity schema compliant with https://rfc.decentraland.org/adr/ADR-80
+
+message Entity {
+  repeated string id = 1;
+  repeated string pointers = 2;
+  string metadata = 3;
+  uint32 timestamp = 4;
+  repeated ContentMapping content = 5;
+}

package/common/Vectors.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+package decentraland.common;
+
+message Position {
+  float x = 1;
+  float y = 2;
+  float z = 3;
+}
+
+message Vector3 {
+  float x = 1;
+  float y = 2;
+  float z = 3;
+}
+
+message Vector2 {
+  float x = 1;
+  float y = 2;
+}

package/ecs/components/Animator.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1042;
 
 message PBAnimator {

package/ecs/components/AudioSource.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1020;
 
 message PBAudioSource {  

package/ecs/components/AudioStream.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1021;
 
 message PBAudioStream {  

package/ecs/components/AvatarAttach.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1073;
 
 enum AvatarAnchorPoint {

package/ecs/components/AvatarModifierArea.proto

@@ -1,8 +1,8 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1070;
-import "common/Vector3.proto";
+import "ecs/components/common/Vector3.proto";
 
 enum AvatarModifier {
   HIDE_AVATARS = 0;

package/ecs/components/AvatarShape.proto

@@ -1,8 +1,8 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1080;
-import "common/Color3.proto";
+import "ecs/components/common/Color3.proto";
 
 message PBAvatarShape {
   string id = 1;

package/ecs/components/Billboard.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1090;
 
 message PBBillboard {

package/ecs/components/BoxShape.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1013;
 
 message PBBoxShape {  

package/ecs/components/CameraMode.proto

@@ -1,8 +1,8 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1072;
-import "common/CameraModeValue.proto";
+import "ecs/components/common/CameraModeValue.proto";
 
 message PBCameraMode {
   CameraModeValue mode = 1;

package/ecs/components/CameraModeArea.proto

@@ -1,9 +1,9 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1071;
-import "common/Vector3.proto";
-import "common/CameraModeValue.proto";
+import "ecs/components/common/Vector3.proto";
+import "ecs/components/common/CameraModeValue.proto";
 
 message PBCameraModeArea {
   Vector3 area = 1;

package/ecs/components/CylinderShape.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1016;
 
 message PBCylinderShape {  

package/ecs/components/GltfContainer.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1041;
 
 message PBGltfContainer {

package/ecs/components/Material.proto

@@ -1,9 +1,9 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1017;
 
-import "common/Color3.proto";
+import "ecs/components/common/Color3.proto";
 
 enum TextureWrapMode {
     Repeat = 0;

package/ecs/components/MeshCollider.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1019;
 
 enum ColliderLayer {

package/ecs/components/MeshRenderer.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1018;
 
 message PBMeshRenderer {

package/ecs/components/NFTShape.proto

@@ -1,9 +1,9 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1040;
 
-import "common/Color3.proto";
+import "ecs/components/common/Color3.proto";
 
 message PBNFTShape {
   enum PictureFrameStyle {

package/ecs/components/OnPointerDown.proto

@@ -1,8 +1,8 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1060;
-import "common/ActionButton.proto";
+import "ecs/components/common/ActionButton.proto";
 
 message PBOnPointerDown {
   optional ActionButton button = 1; // default=ActionButton.ANY

package/ecs/components/OnPointerDownResult.proto

@@ -1,9 +1,9 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1066;
-import "common/Vector3.proto";
-import "common/ActionButton.proto";
+import "ecs/components/common/Vector3.proto";
+import "ecs/components/common/ActionButton.proto";
 
 message PBOnPointerDownResult {
   ActionButton button = 2;

package/ecs/components/OnPointerUp.proto

@@ -1,8 +1,8 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1061;
-import "common/ActionButton.proto";
+import "ecs/components/common/ActionButton.proto";
 
 message PBOnPointerUp {
   optional ActionButton button = 1; // default=ActionButton.ANY

package/ecs/components/OnPointerUpResult.proto

@@ -1,9 +1,9 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1065;
-import "common/Vector3.proto";
-import "common/ActionButton.proto";
+import "ecs/components/common/Vector3.proto";
+import "ecs/components/common/ActionButton.proto";
 
 message PBOnPointerUpResult {
   ActionButton button = 2;

package/ecs/components/PlaneShape.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1014;
 
 message PBPlaneShape {  

package/ecs/components/PointerEvents.proto

@@ -1,8 +1,8 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1062;
-import "common/ActionButton.proto";
+import "ecs/components/common/ActionButton.proto";
 
 enum PointerEventType {
   UP = 0;

package/ecs/components/PointerEventsResult.proto

@@ -1,10 +1,10 @@
 syntax = "proto3";
 
-import "common/id.proto";
-import "RaycastResult.proto";
-import "PointerEvents.proto";
+import "ecs/components/common/id.proto";
+import "ecs/components/RaycastResult.proto";
+import "ecs/components/PointerEvents.proto";
 option (ecs_component_id) = 1063;
-import "common/ActionButton.proto";
+import "ecs/components/common/ActionButton.proto";
 
 // the renderer will set this component to the root entity once per frame with all the events
 message PBPointerEventsResult {

package/ecs/components/PointerLock.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1074;
 
 message PBPointerLock {

package/ecs/components/README.md

@@ -6,7 +6,7 @@ Inside each proto, we need to have at least this template:
 ```proto
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = XXXX;
 
 message PBComponentName {

package/ecs/components/Raycast.proto

@@ -1,9 +1,9 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1067;
 
-import "common/Vector3.proto";
+import "ecs/components/common/Vector3.proto";
 
 enum RaycastQueryType {
     HIT_FIRST = 0;

package/ecs/components/RaycastResult.proto

@@ -1,7 +1,7 @@
 syntax = "proto3";
 
-import "common/id.proto";
-import "common/Vector3.proto";
+import "ecs/components/common/id.proto";
+import "ecs/components/common/Vector3.proto";
 
 option (ecs_component_id) = 1068;
 

package/ecs/components/SphereShape.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1015;
 
 message PBSphereShape {  

package/ecs/components/TextShape.proto

@@ -1,9 +1,9 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1030;
 
-import "common/Color3.proto";
+import "ecs/components/common/Color3.proto";
 
 message PBTextShape {
   string text = 1;

package/ecs/components/UiStyles.proto

@@ -1,9 +1,9 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1053;
 
-import "common/Color4.proto";
+import "ecs/components/common/Color4.proto";
 
 message PBUiStyles {
   optional Color4 background_color = 1; // default=(0.0, 0.0, 0.0, 0.0)

package/ecs/components/UiText.proto

@@ -1,9 +1,9 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1052;
 
-import "common/Color3.proto";
+import "ecs/components/common/Color3.proto";
 
 enum TextAlign {
   Center = 0;

package/ecs/components/UiTransform.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1050;
 
 enum YGPositionType {

package/ecs/components/VisibilityComponent.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "common/id.proto";
+import "ecs/components/common/id.proto";
 option (ecs_component_id) = 1081;
 
 message PBVisibilityComponent {

package/ecs/components/common/ActionButton.proto

@@ -10,7 +10,7 @@ enum ActionButton {
   RIGHT = 6;
   LEFT = 7;
   JUMP = 8;
-  WALK = 9; 
+  WALK = 9;
   ACTION_3 = 10;
   ACTION_4 = 11;
   ACTION_5 = 12;

package/kernel/apis/EnvironmentAPI.proto

@@ -3,7 +3,7 @@ syntax = "proto3";
 import "common/ContentMapping.proto";
 
 message MinimalRunnableEntity {
-    repeated ContentMapping content = 1;
+    repeated decentraland.common.ContentMapping content = 1;
     string metadata_json = 2;
 }
 

package/kernel/apis/ParcelIdentity.proto

@@ -5,7 +5,7 @@ import "common/ContentMapping.proto";
 message MappingsResponse  {
     string parcel_id = 1;
     string root_cid = 2;
-    repeated ContentMapping contents = 3;
+    repeated decentraland.common.ContentMapping contents = 3;
 }
 
 message Land {