@dcl/protocol 1.0.0-2705199166.commit-ad4bfef → 1.0.0-27167791416.commit-a470b13

package/out-ts/google/protobuf/empty.gen.ts

@@ -0,0 +1,72 @@
+/* eslint-disable */
+import _m0 from "protobufjs/minimal";
+
+export const protobufPackage = "google.protobuf";
+
+/**
+ * A generic empty message that you can re-use to avoid defining duplicated
+ * empty messages in your APIs. A typical example is to use it as the request
+ * or the response type of an API method. For instance:
+ *
+ *     service Foo {
+ *       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ *     }
+ */
+export interface Empty {
+}
+
+function createBaseEmpty(): Empty {
+  return {};
+}
+
+export namespace Empty {
+  export function encode(_: Empty, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): Empty {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseEmpty();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(_: any): Empty {
+    return {};
+  }
+
+  export function toJSON(_: Empty): unknown {
+    const obj: any = {};
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<Empty>, I>>(base?: I): Empty {
+    return Empty.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<Empty>, I>>(_: I): Empty {
+    const message = createBaseEmpty();
+    return message;
+  }
+}
+
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+
+export type DeepPartial<T> = T extends Builtin ? T
+  : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
+  : T extends { $case: string } ? { [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]> } & { $case: T["$case"] }
+  : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
+  : Partial<T>;
+
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P
+  : P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };

package/out-ts/quests.gen.ts

@@ -0,0 +1,3 @@
+/* eslint-disable */
+
+export const protobufPackage = "decentraland.quests";

package/out-ts/sdk-apis.gen.ts

@@ -0,0 +1,3 @@
+/* eslint-disable */
+
+export const protobufPackage = "decentraland.sdk";

package/out-ts/sdk-components.gen.ts

@@ -0,0 +1,3 @@
+/* eslint-disable */
+
+export const protobufPackage = "decentraland.sdk.components";

package/out-ts/sdk-development.gen.ts

@@ -0,0 +1,3 @@
+/* eslint-disable */
+
+export const protobufPackage = "decentraland.sdk.development";

package/out-ts/social.gen.ts

@@ -0,0 +1,3 @@
+/* eslint-disable */
+
+export const protobufPackage = "decentraland.social";

package/package.json

@@ -1,21 +1,37 @@
 {
   "name": "@dcl/protocol",
-  "version": "1.0.0-2705199166.commit-ad4bfef",
+  "version": "1.0.0-27167791416.commit-a470b13",
   "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/decentraland/protocol.git"
   },
+  "homepage": "https://github.com/decentraland/protocol#readme",
+  "bugs": "https://github.com/decentraland/protocol/issues",
   "keywords": [],
   "author": "",
-  "license": "ISC",
+  "license": "Apache-2.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "./scripts/check-proto-compabitility.sh"
+  },
   "devDependencies": {
-    "proto-compatibility-tool": "^1.0.0"
+    "@protobuf-ts/protoc": "^2.11.0",
+    "proto-compatibility-tool": "^1.1.2-20220925163655.commit-25bd040",
+    "typescript": "^5.0.4"
+  },
+  "config": {
+    "protocVersion": "22.2"
+  },
+  "dependencies": {
+    "@dcl/ts-proto": "1.154.0",
+    "protobufjs": "7.2.4"
   },
   "files": [
-    "kernel",
-    "renderer-protocol",
-    "ecs"
+    "proto",
+    "out-ts",
+    "out-js",
+    "public"
   ],
-  "commit": "ad4bfef541a776b556a207d7ff98062a23ab7fc7"
+  "commit": "a470b131fb9cef8d22b3e5561dd5545e19f951e1"
 }

package/proto/buf.yaml

@@ -0,0 +1,47 @@
+version: v1
+breaking:
+  use:
+    - WIRE_JSON
+  ignore:
+    - google
+lint:
+  use:
+    - DIRECTORY_SAME_PACKAGE
+    - PACKAGE_DEFINED
+    - PACKAGE_DIRECTORY_MATCH
+    - PACKAGE_SAME_DIRECTORY
+    - ENUM_PASCAL_CASE
+    - ENUM_VALUE_UPPER_SNAKE_CASE
+    - FIELD_LOWER_SNAKE_CASE
+    - MESSAGE_PASCAL_CASE
+    - ONEOF_LOWER_SNAKE_CASE
+    - PACKAGE_LOWER_SNAKE_CASE
+    - RPC_PASCAL_CASE
+    - SERVICE_PASCAL_CASE
+    - PACKAGE_SAME_CSHARP_NAMESPACE
+    - PACKAGE_SAME_GO_PACKAGE
+    - PACKAGE_SAME_JAVA_MULTIPLE_FILES
+    - PACKAGE_SAME_JAVA_PACKAGE
+    - PACKAGE_SAME_PHP_NAMESPACE
+    - PACKAGE_SAME_RUBY_PACKAGE
+    - PACKAGE_SAME_SWIFT_PREFIX
+    - ENUM_FIRST_VALUE_ZERO
+    - ENUM_NO_ALLOW_ALIAS
+    - IMPORT_NO_WEAK
+    - IMPORT_NO_PUBLIC
+    - IMPORT_USED
+    - FILE_LOWER_SNAKE_CASE
+    # Ignored:the default value is used
+    # - ENUM_ZERO_VALUE_SUFFIX
+    # Ignored: if a prefix is needed in the target language, implement a preprocessor
+    # - ENUM_VALUE_PREFIX
+    # Not wished
+    # - PACKAGE_VERSION_SUFFIX
+    # TODO: See if this needs to be added
+    # - RPC_REQUEST_RESPONSE_UNIQUE
+    # - RPC_REQUEST_STANDARD_NAME
+    # - RPC_RESPONSE_STANDARD_NAME
+    # - SERVICE_SUFFIX
+  ignore:
+    - google
+    - decentraland/renderer/engine_interface.proto

package/proto/decentraland/common/border_rect.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+package decentraland.common;
+
+// Defines indents from respective edges
+message BorderRect {
+  float top = 1;
+  float left = 2;
+  float right = 3;
+  float bottom = 4;
+}
+
+// Defines a rect with x, y, width and height
+message Rect {
+  float x = 1;
+  float y = 2;
+  float width = 3;
+  float height = 4;
+}

package/proto/decentraland/common/colors.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+package decentraland.common;
+
+message Color3 {
+  float r = 1;
+  float g = 2;
+  float b = 3;
+}
+
+message Color4 {
+  float r = 1;
+  float g = 2;
+  float b = 3;
+  float a = 4;
+}
+
+// A range of Color4 values. Randomized or lerped between start and end.
+message ColorRange {
+  Color4 start = 1;
+  Color4 end = 2;
+}

package/proto/decentraland/common/content_mapping.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+package decentraland.common;
+
+message ContentMapping {
+    string file = 1;
+    string hash = 2;
+}

package/proto/decentraland/common/entity.proto

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

package/proto/decentraland/common/floats.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+package decentraland.common;
+
+// A range of float values. Randomized or lerped between start and end.
+message FloatRange {
+  float start = 1;
+  float end = 2;
+}

package/{kernel/apis/UserIdentity.proto → proto/decentraland/common/sdk/user_data.proto}

@@ -1,4 +1,5 @@
 syntax = "proto3";
+package decentraland.common.sdk;
 
 message Snapshots {
     string face256 = 1;
@@ -22,20 +23,3 @@ message UserData {
     int32 version = 5;
     AvatarForUserData avatar = 6;
 }
-
-message GetUserDataRequest {}
-
-message GetUserDataResponse {
-    optional UserData data = 1;
-}
-
-message GetUserPublicKeyRequest {}
-
-message GetUserPublicKeyResponse {
-    optional string address = 1;
-}
-
-service UserIdentityService {
-    rpc GetUserPublicKey(GetUserPublicKeyRequest) returns (GetUserPublicKeyResponse) {}
-    rpc GetUserData(GetUserDataRequest) returns (GetUserDataResponse) {}
-}

package/proto/decentraland/common/texture.proto

@@ -0,0 +1,45 @@
+syntax = "proto3";
+package decentraland.common;
+import "decentraland/common/vectors.proto";
+
+enum TextureWrapMode {
+  TWM_REPEAT = 0;
+  TWM_CLAMP = 1;
+  TWM_MIRROR = 2;
+}
+
+enum TextureFilterMode {
+  TFM_POINT = 0;
+  TFM_BILINEAR = 1;
+  TFM_TRILINEAR = 2;
+}
+
+message Texture {
+  string src = 1;
+  optional TextureWrapMode wrap_mode = 2; // default = TextureWrapMode.Clamp
+  optional TextureFilterMode filter_mode = 3; // default = FilterMode.Bilinear
+
+  // Final uv = offset + (input_uv * tiling)
+  optional Vector2 offset = 4; // default = Vector2.Zero; Offset for texture positioning, only works for the texture property in PbrMaterial or UnlitMaterial.
+  optional Vector2 tiling = 5; // default = Vector2.One; Tiling multiplier for texture repetition, only works for the texture property in PbrMaterial or UnlitMaterial.
+}
+
+message AvatarTexture {
+  string user_id = 1;
+  optional TextureWrapMode wrap_mode = 2; // default = TextureWrapMode.Clamp
+  optional TextureFilterMode filter_mode = 3; // default = FilterMode.Bilinear
+}
+
+message VideoTexture {
+  uint32 video_player_entity = 1;
+  optional TextureWrapMode wrap_mode = 2; // default = TextureWrapMode.Clamp
+  optional TextureFilterMode filter_mode = 3; // default = FilterMode.Bilinear
+}
+
+message TextureUnion {
+  oneof tex {
+    Texture texture = 1; // default = null
+    AvatarTexture avatar_texture = 2; // default = null
+    VideoTexture video_texture = 3; // default = null
+  }
+}

package/proto/decentraland/common/vectors.proto

@@ -0,0 +1,26 @@
+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;
+}
+
+message Quaternion {
+  float x = 1;
+  float y = 2;
+  float z = 3;
+  float w = 4;
+}

package/proto/decentraland/kernel/apis/comms_api.proto

@@ -0,0 +1,61 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+enum VideoTrackSourceType {
+  VTST_UNKNOWN = 0;
+  VTST_CAMERA = 1;
+  VTST_SCREEN_SHARE = 2;
+}
+
+message VideoTracksActiveStreamsRequest {
+}
+
+message VideoTracksActiveStreamsResponse {
+    repeated VideoTracksActiveStreamsData streams = 1;
+}
+
+message VideoTracksActiveStreamsData {
+    string identity = 1;
+    string track_sid = 2;
+    VideoTrackSourceType source_type = 3;
+}
+
+message SubscribeToTopicRequest {
+  string topic = 1;
+}
+
+message SubscribeToTopicResponse {}
+
+message UnsubscribeFromTopicRequest {
+  string topic = 1;
+}
+
+message UnsubscribeFromTopicResponse {}
+
+message PublishDataRequest {
+  string topic = 1;
+  string data = 2;
+}
+
+message PublishDataResponse {}
+
+message ConsumeMessagesRequest {
+  string topic = 1;
+}
+
+message ConsumeMessages {
+  string sender = 1;
+  string data = 2;
+}
+
+message ConsumeMessagesResponse {
+  repeated ConsumeMessages messages = 1;
+}
+
+service CommsApiService {
+  rpc GetActiveVideoStreams(VideoTracksActiveStreamsRequest) returns (VideoTracksActiveStreamsResponse) {}
+  rpc SubscribeToTopic(SubscribeToTopicRequest) returns (SubscribeToTopicResponse) {}
+  rpc UnsubscribeFromTopic(UnsubscribeFromTopicRequest) returns (UnsubscribeFromTopicResponse) {}
+  rpc PublishData(PublishDataRequest) returns (PublishDataResponse) {}
+  rpc ConsumeMessages(ConsumeMessagesRequest) returns (ConsumeMessagesResponse) {}
+}

package/proto/decentraland/kernel/apis/communications_controller.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+message RealSendRequest {
+  string message = 1;
+}
+
+message RealSendResponse {}
+
+message SendBinaryRequest {
+  repeated bytes data = 1;  // @deprecated old broadcasted messages. Use peerData with an empty array for broadcasting.
+  repeated PeerMessageData peer_data = 2; // peer-to-peer messages
+}
+
+message PeerMessageData {
+  repeated bytes data = 1;
+  repeated string address = 2; // if address is empty, its a broadcast message
+}
+
+message SendBinaryResponse {
+  repeated bytes data = 1;
+}
+
+service CommunicationsControllerService {
+  // @deprecated - This API should use a bidirectional binary stream in sdk7
+  // https://github.com/decentraland/sdk/issues/582
+  rpc Send(RealSendRequest) returns (RealSendResponse) {}
+  rpc SendBinary(SendBinaryRequest) returns (SendBinaryResponse) {}
+}

package/{kernel/apis/DevTools.proto → proto/decentraland/kernel/apis/dev_tools.proto}

@@ -1,4 +1,5 @@
 syntax = "proto3";
+package decentraland.kernel.apis;
 
 message DevToolsBody {
     string type = 1;
@@ -7,6 +8,8 @@ message DevToolsBody {
 
 message EventResponse {}
 
+// @deprecated
 service DevToolsService {
+    // @deprecated
     rpc Event(DevToolsBody) returns (EventResponse) {}
 }

package/proto/decentraland/kernel/apis/engine_api.proto

@@ -0,0 +1,118 @@
+syntax = "proto3";
+
+package decentraland.kernel.apis;
+
+import "decentraland/sdk/ecs6/engine_interface_ecs6.proto";
+
+message ManyEntityAction {
+  repeated decentraland.sdk.ecs6.EntityAction actions = 1;
+}
+
+message SendBatchResponse {
+  repeated EventData events = 1;
+}
+
+message UnsubscribeRequest {
+  string event_id = 1;
+}
+message SubscribeRequest {
+  string event_id = 1;
+}
+message SubscribeResponse {}
+message UnsubscribeResponse {}
+
+// Events
+enum EventDataType {
+  EDT_GENERIC = 0;
+  EDT_POSITION_CHANGED = 1;
+  EDT_ROTATION_CHANGED = 2;
+}
+
+message GenericPayload {
+  string event_id = 3;
+  string event_data = 4;
+}
+
+message ReadOnlyVector3 {
+  float x = 1;
+  float y = 2;
+  float z = 3;
+}
+
+message ReadOnlyQuaternion {
+  float x = 1;
+  float y = 2;
+  float z = 3;
+  float w = 4;
+}
+
+message PositionChangedPayload {
+  ReadOnlyVector3 position = 1;
+  ReadOnlyVector3 camera_position = 2;
+  float player_height = 3;
+}
+
+message RotationChangedPayload {
+  ReadOnlyVector3 rotation = 1;
+  ReadOnlyQuaternion quaternion = 2;
+}
+
+message EventData {
+  EventDataType type = 1;
+  optional GenericPayload generic = 2;
+  optional PositionChangedPayload position_changed = 3;
+  optional RotationChangedPayload rotation_changed = 4;
+}
+
+message CrdtSendToRendererRequest {
+  bytes data = 1;
+}
+
+message CrdtSendToResponse {
+  // list of CRDT messages coming back from the renderer
+  repeated bytes data = 1;
+}
+
+message CrdtGetStateRequest {}
+message CrdtGetStateResponse {
+  // returns true if the returned state has scene-created entities
+  bool has_entities = 1;
+  // static entities data (root entity, camera, etc) and scene-created entities
+  repeated bytes data = 2;
+}
+
+// deprecated
+message CrdtMessageFromRendererRequest {}
+// deprecated
+message CrdtMessageFromRendererResponse {
+  repeated bytes data = 1;
+}
+
+message IsServerRequest {}
+message IsServerResponse {
+  bool is_server = 1;
+}
+
+service EngineApiService {
+  // support for legacy SDK events.
+
+  // @deprecated
+  rpc SendBatch(ManyEntityAction) returns (SendBatchResponse) {}
+  // @deprecated
+  rpc Subscribe(SubscribeRequest) returns (SubscribeResponse) {}
+  // @deprecated
+  rpc Unsubscribe(UnsubscribeRequest) returns (UnsubscribeResponse) {}
+
+  // send information of the CRDT messages to the renderer. It returns the CRDT changes back from the renderer
+  // like raycast responses or the player's position
+  rpc CrdtSendToRenderer(CrdtSendToRendererRequest) returns (CrdtSendToResponse) {}
+
+  // retrieves the current _full_ state of the entities from the renderer. This function is used to hidrate
+  // the state of the scenes when the code of the worker is stopped/resumed
+  rpc CrdtGetState(CrdtSendToRendererRequest) returns (CrdtGetStateResponse) {}
+
+  // @deprecated, this response was merged into CrdtSendToResponse
+  rpc CrdtGetMessageFromRenderer(CrdtMessageFromRendererRequest) returns (CrdtMessageFromRendererResponse) {}
+
+  rpc IsServer(IsServerRequest) returns (IsServerResponse) {}
+}

package/proto/decentraland/kernel/apis/environment_api.proto

@@ -0,0 +1,76 @@
+syntax = "proto3";
+
+package decentraland.kernel.apis;
+
+import "decentraland/common/content_mapping.proto";
+
+message MinimalRunnableEntity {
+  repeated decentraland.common.ContentMapping content = 1;
+  string metadata_json = 2;
+}
+
+message BootstrapDataResponse {
+  string id = 1;
+  string base_url = 4;
+  MinimalRunnableEntity entity = 2;
+  bool use_f_p_s_throttling = 5;
+}
+
+message PreviewModeResponse {
+  bool is_preview = 1;
+}
+
+message AreUnsafeRequestAllowedResponse {
+  bool status = 1;
+}
+
+message GetPlatformResponse {
+  string platform = 1;
+}
+
+message EnvironmentRealm {
+  string domain = 1;
+  string layer = 2;
+  string room = 3;
+  string server_name = 4;
+  string display_name = 5;
+  string protocol = 6;
+}
+
+message GetCurrentRealmResponse {
+  optional EnvironmentRealm current_realm = 1;
+}
+
+message GetExplorerConfigurationResponse {
+  string client_uri = 1;
+  map<string, string> configurations = 2;
+}
+
+message GetDecentralandTimeResponse {
+  int32 seconds = 1;
+}
+
+message GetBootstrapDataRequest {}
+message IsPreviewModeRequest {}
+message GetPlatformRequest {}
+message AreUnsafeRequestAllowedRequest {}
+message GetCurrentRealmRequest {}
+message GetExplorerConfigurationRequest {}
+message GetDecentralandTimeRequest {}
+
+service EnvironmentApiService {
+  // @deprecated, only available for SDK6 compatibility. Use runtime_api instead
+  rpc GetBootstrapData(GetBootstrapDataRequest) returns (BootstrapDataResponse) {}
+  // @deprecated, only available for SDK6 compatibility. Needs migration
+  rpc IsPreviewMode(IsPreviewModeRequest) returns (PreviewModeResponse) {}
+  // @deprecated, only available for SDK6 compatibility
+  rpc GetPlatform(GetPlatformRequest) returns (GetPlatformResponse) {}
+  // @deprecated, only available for SDK6 compatibility
+  rpc AreUnsafeRequestAllowed(AreUnsafeRequestAllowedRequest) returns (AreUnsafeRequestAllowedResponse) {}
+  // @deprecated, use GetCurrentRealm from runtime_api instead
+  rpc GetCurrentRealm(GetCurrentRealmRequest) returns (GetCurrentRealmResponse) {}
+  // @deprecated, only available for SDK6 compatibility
+  rpc GetExplorerConfiguration(GetExplorerConfigurationRequest) returns (GetExplorerConfigurationResponse) {}
+  // @deprecated, use GetTime from runtime_api instead
+  rpc GetDecentralandTime(GetDecentralandTimeRequest) returns (GetDecentralandTimeResponse) {}
+}