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

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

package/{kernel/apis/EthereumController.proto → proto/decentraland/kernel/apis/ethereum_controller.proto}

@@ -1,4 +1,5 @@
 syntax = "proto3";
+package decentraland.kernel.apis;
 
 message RequirePaymentRequest {
     string to_address = 1;
@@ -16,7 +17,7 @@ message SignMessageRequest {
 
 message SignMessageResponse {
     string message = 1;
-    string hexEncodedMessage = 2;
+    string hex_encoded_message = 2;
     string signature = 3;
 }
 
@@ -45,9 +46,19 @@ message GetUserAccountResponse {
 }
 
 service EthereumControllerService {
+    // @deprecated, only available for SDK6 compatibility. This was a low level API that can
+    // be replaced by any ethereum library on top of the provider
     rpc RequirePayment(RequirePaymentRequest) returns (RequirePaymentResponse) {}
+    // @deprecated, only available for SDK6 compatibility. This was a low level API that can
+    // be replaced by any ethereum library on top of the provider
     rpc SignMessage(SignMessageRequest) returns (SignMessageResponse) {}
+    // @deprecated, only available for SDK6 compatibility. This was a low level API that can
+    // be replaced by any ethereum library on top of the provider
     rpc ConvertMessageToObject(ConvertMessageToObjectRequest) returns (ConvertMessageToObjectResponse) {}
+
     rpc SendAsync(SendAsyncRequest) returns (SendAsyncResponse) {}
+
+    // @deprecated, only available for SDK6 compatibility. This was a low level API that can
+    // be replaced by any ethereum library on top of the provider
     rpc GetUserAccount(GetUserAccountRequest) returns (GetUserAccountResponse) {}
 }

package/{kernel/apis/ParcelIdentity.proto → proto/decentraland/kernel/apis/parcel_identity.proto}

@@ -1,14 +1,12 @@
 syntax = "proto3";
+package decentraland.kernel.apis;
 
-message ContentMapping {
-    string file = 1;
-    string hash = 2;
-}
+import "decentraland/common/content_mapping.proto";
 
 message MappingsResponse  {
     string parcel_id = 1;
     string root_cid = 2;
-    repeated ContentMapping contents = 3;
+    repeated decentraland.common.ContentMapping contents = 3;
 }
 
 message Land {
@@ -36,7 +34,10 @@ message GetIsEmptyResponse {
 }
 
 service ParcelIdentityService {
+    // @deprecated, only available for SDK6 compatibility
     rpc GetParcel(GetParcelRequest) returns (GetParcelResponse) {}
+    // @deprecated, only available for SDK6 compatibility
     rpc GetSceneId(GetSceneIdRequest) returns (GetSceneIdResponse) {}
+    // @deprecated, only available for SDK6 compatibility
     rpc GetIsEmpty(GetIsEmptyRequest) returns (GetIsEmptyResponse) {}
 }

package/proto/decentraland/kernel/apis/permissions.proto

@@ -0,0 +1,36 @@
+syntax = "proto3";
+
+package decentraland.kernel.apis;
+
+enum PermissionItem {
+  PI_ALLOW_TO_MOVE_PLAYER_INSIDE_SCENE = 0;
+  PI_ALLOW_TO_TRIGGER_AVATAR_EMOTE = 1;
+  PI_USE_WEB3_API = 2;
+  PI_USE_WEBSOCKET = 3;
+  PI_USE_FETCH = 4;
+  PI_ALLOW_MEDIA_HOSTNAMES = 5;
+  PI_OPEN_EXTERNAL_LINK = 6;
+}
+
+message PermissionResponse {
+  bool has_permission = 1;
+}
+
+message HasPermissionRequest {
+  PermissionItem permission = 1;
+}
+
+message HasManyPermissionRequest {
+  repeated PermissionItem permissions = 1;
+}
+
+message HasManyPermissionResponse {
+  repeated bool has_many_permission = 1;
+}
+
+service PermissionsService {
+  // @deprecated, only available for SDK6 compatibility
+  rpc HasPermission(HasPermissionRequest) returns (PermissionResponse) {}
+  // @deprecated, only available for SDK6 compatibility
+  rpc HasManyPermissions(HasManyPermissionRequest) returns (HasManyPermissionResponse) {}
+}

package/proto/decentraland/kernel/apis/players.proto

@@ -0,0 +1,35 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+import "decentraland/common/sdk/user_data.proto";
+
+message Player {
+    string user_id = 1;
+}
+
+message PlayersGetUserDataResponse {
+    optional decentraland.common.sdk.UserData data = 1;
+}
+
+message PlayerListResponse {
+    repeated Player players = 1;
+}
+
+message GetPlayerDataRequest {
+    string user_id = 1;
+}
+
+message GetPlayersInSceneRequest {}
+message GetConnectedPlayersRequest {}
+
+service PlayersService {
+    // Returns data about a specific player, by id
+    // NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
+    rpc GetPlayerData(GetPlayerDataRequest) returns (PlayersGetUserDataResponse) {}
+    // Returns a list of all the ids of players who are currently standing within the parcels of the scene
+    // NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
+    rpc GetPlayersInScene(GetPlayersInSceneRequest) returns (PlayerListResponse) {}
+    // Returns a list of all the ids of players who are currently connected to the same server and grouped together
+    // NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
+    rpc GetConnectedPlayers(GetConnectedPlayersRequest)  returns (PlayerListResponse) {}
+}

package/proto/decentraland/kernel/apis/portable_experiences.proto

@@ -0,0 +1,55 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+message KillRequest {
+    string pid = 1;
+}
+
+message KillResponse {
+    bool status = 1;
+}
+
+message SpawnRequest {
+    optional string pid = 1;
+    optional string ens = 2;
+}
+
+message SpawnResponse {
+    string pid = 1;
+    string parent_cid = 2;
+    string name = 3;
+    optional string ens = 4;
+}
+
+message PxRequest {
+    string pid = 1;
+}
+
+message GetPortableExperiencesLoadedRequest {}
+
+message GetPortableExperiencesLoadedResponse {
+    repeated SpawnResponse loaded = 1;
+}
+
+message ExitRequest {}
+message ExitResponse {
+    bool status = 1;
+}
+
+service PortableExperiencesService {
+    // Spawns a new portable experience that is detached from the current scene.
+    // Spawned portable experiences can only be controlled by 1) the user (from the UI)
+    // and 2) from the parent scene. If the parent scene gets unloaded i.e. by distance,
+    // once the player re-loads the parent it will inherit the children portable experiences
+    // to gain control over them.
+    rpc Spawn(SpawnRequest) returns (SpawnResponse) {}
+    // Kill a child portable experience, this method only works if the child was
+    // spawned by the same process trying to kill it.
+    rpc Kill(KillRequest) returns (KillResponse) {}
+    // Kill the current scene if the current scene is a portable experience. Other
+    // kind of scenes are not allowed to finish their programs like portable experiences.
+    rpc Exit(ExitRequest) returns (ExitResponse) {}
+    // Gets a list of running portable experiences for the current user. Be mindful
+    // about the performance penalty of calling this function all frames.
+    rpc GetPortableExperiencesLoaded(GetPortableExperiencesLoadedRequest) returns (GetPortableExperiencesLoadedResponse) {}
+}

package/proto/decentraland/kernel/apis/restricted_actions.proto

@@ -0,0 +1,100 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+import "decentraland/common/vectors.proto";
+
+message MovePlayerToRequest {
+  decentraland.common.Vector3 new_relative_position = 1;
+  optional decentraland.common.Vector3 camera_target = 2;
+  optional decentraland.common.Vector3 avatar_target = 3;
+  optional float duration = 4; // by default (no duration param) the player is instantly moved and not interpolated
+}
+
+message TeleportToRequest {
+  decentraland.common.Vector2 world_coordinates = 1;
+}
+
+message TriggerEmoteRequest {
+  string predefined_emote = 1;
+  optional uint32 mask = 2;
+}
+
+message ChangeRealmRequest {
+  string realm = 1;
+  optional string message = 2;
+}
+
+message OpenExternalUrlRequest {
+  string url = 1;
+}
+
+message OpenNftDialogRequest {
+  string urn = 1;
+}
+
+message UnblockPointerRequest {}
+
+message CommsAdapterRequest {
+  string connection_string = 1;
+}
+
+message TriggerSceneEmoteRequest {
+  string src = 1;
+  optional bool loop = 2;
+  optional uint32 mask = 3;
+}
+
+message SuccessResponse {
+  bool success = 1;
+}
+
+message TriggerEmoteResponse { }
+
+message MovePlayerToResponse { 
+  bool success = 1;
+}
+
+message TeleportToResponse { }
+
+message CopyToClipboardRequest {
+  string text = 1;
+}
+
+message EmptyResponse { }
+
+message StopEmoteRequest { }
+
+service RestrictedActionsService {
+  // MovePlayerTo will move the player to a position relative to the current scene.
+  // If 'duration' field is used in the request, the success response depends on the
+  // whole interpolation being completed or interrupted (e.g: by input movement)
+  rpc MovePlayerTo(MovePlayerToRequest) returns (MovePlayerToResponse) {}
+
+  // TeleportTo will move the user to the specified world LAND parcel coordinates
+  rpc TeleportTo(TeleportToRequest) returns (TeleportToResponse) {}
+
+  // TriggerEmote will trigger an emote in this current user
+  rpc TriggerEmote(TriggerEmoteRequest) returns (TriggerEmoteResponse) {}
+
+  // ChangeRealm prompts the user to change to a specific realm
+  rpc ChangeRealm(ChangeRealmRequest) returns (SuccessResponse) {}
+
+  // OpenExternalUrl prompts the user to open an external link
+  rpc OpenExternalUrl(OpenExternalUrlRequest) returns (SuccessResponse) {}
+
+  // OpenNftDialog opens an NFT dialog.
+  rpc OpenNftDialog(OpenNftDialogRequest) returns (SuccessResponse) {}
+
+  // Asks the explorer to connect to other communications adapter, this feature
+  // can be used to join private game servers
+  rpc SetCommunicationsAdapter(CommsAdapterRequest) returns (SuccessResponse) {}
+
+  // TriggerSceneEmote will trigger an scene emote file in this current user
+  rpc TriggerSceneEmote(TriggerSceneEmoteRequest) returns (SuccessResponse) {}
+
+  // CopyToClipboard copies the provided text into the clipboard
+  rpc CopyToClipboard(CopyToClipboardRequest) returns (EmptyResponse) {}
+
+  // StopEmote will stop the current emote
+  rpc StopEmote(StopEmoteRequest) returns (SuccessResponse) {}
+}

package/proto/decentraland/kernel/apis/runtime.proto

@@ -0,0 +1,71 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+import "decentraland/common/content_mapping.proto";
+import "decentraland/sdk/components/realm_info.proto";
+
+// This API will contain all the information related to the world runtime.
+// Things related to the user, players or the scene itself has they own api, and
+// won't live here. (UserIdentity, Players, ParcelIdentity)
+
+message GetRealmResponse {
+  optional decentraland.sdk.components.PBRealmInfo realm_info = 1;
+}
+
+message GetWorldTimeResponse {
+  int32 seconds = 1;
+}
+
+message GetRealmRequest {}
+message GetWorldTimeRequest {}
+
+message ReadFileRequest {
+  // name of the deployed file
+  string file_name = 1;
+}
+message ReadFileResponse {
+  // contents of the file
+  bytes content = 1;
+  // deployed hash/CID
+  string hash = 2;
+}
+
+message CurrentSceneEntityRequest {}
+message CurrentSceneEntityResponse {
+  // this is either the entityId or the full URN of the scene that is running
+  string urn = 1;
+  // contents of the deployed entities
+  repeated decentraland.common.ContentMapping content = 2;
+  // JSON serialization of the entity.metadata field
+  string metadata_json = 3;
+  // baseUrl used to resolve all content files
+  string base_url = 4;
+}
+
+message GetExplorerInformationRequest {}
+message GetExplorerInformationResponse {
+  // the agent that current explorer is identified as
+  string agent = 1;
+  // options: "desktop", "mobile", "vr", "web"
+  string platform = 2;
+  // custom configurations set in the explorer
+  map<string, string> configurations = 3;
+}
+
+service RuntimeService {
+  // Provides information about the current realm
+  rpc GetRealm(GetRealmRequest) returns (GetRealmResponse) {}
+  // Provides information about the Decentraland Time, which is coordinated
+  // across players.
+  rpc GetWorldTime(GetWorldTimeRequest) returns (GetWorldTimeResponse) {}
+  // Returns the file content of a deployed asset. If the file doesn't
+  // exist or cannot be retrieved, the RPC call throws an error.
+  // This method is called to load any assets deployed among the scene,
+  // runtime may cache this response much more than the provided "fetch" function.
+  rpc ReadFile(ReadFileRequest) returns (ReadFileResponse) {}
+  // Returns information about the current scene. This is the replacement of GetBootstrapData
+  rpc GetSceneInformation(CurrentSceneEntityRequest) returns (CurrentSceneEntityResponse) {}
+
+  // Provides information about the explorer
+  rpc GetExplorerInformation(GetExplorerInformationRequest) returns (GetExplorerInformationResponse) {}
+}

package/proto/decentraland/kernel/apis/scene.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+import "decentraland/common/content_mapping.proto";
+
+message GetSceneRequest {}
+message GetSceneResponse {
+    string cid = 1;
+    string metadata = 2;
+    string base_url = 3;
+    repeated decentraland.common.ContentMapping contents = 4;
+}
+
+service SceneService {
+    rpc GetSceneInfo(GetSceneRequest) returns (GetSceneResponse) {}
+}

package/{kernel/apis/SignedFetch.proto → proto/decentraland/kernel/apis/signed_fetch.proto}

@@ -1,4 +1,5 @@
 syntax = "proto3";
+package decentraland.kernel.apis;
 
 message FlatFetchInit {
     optional string method = 1;
@@ -19,6 +20,14 @@ message SignedFetchRequest {
     optional FlatFetchInit init = 2;
 }
 
+message GetHeadersResponse {
+    map<string, string> headers = 1;
+}
+
 service SignedFetchService {
+    // SignedFetch is used to authenticate JSON requests in name of the users,
+    // a special scoped signature is generated following the https://adr.decentraland.org/adr/ADR-44
     rpc SignedFetch(SignedFetchRequest) returns (FlatFetchResponse) {}
+
+    rpc GetHeaders(SignedFetchRequest) returns (GetHeadersResponse) {}
 }

package/proto/decentraland/kernel/apis/social_controller.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+message InitRequest {}
+message SocialEvent {
+    string event = 1;
+    string payload = 2;
+}
+
+message GetAvatarEventsResponse {
+    repeated SocialEvent events = 1;
+}
+
+service SocialControllerService {
+    // @deprecated, only available for SDK6 compatibility. This was a low level
+    // API used for the AvatarScene, it will be replaced by Foreign Entities in
+    // SDK7
+    rpc PullAvatarEvents(InitRequest) returns (GetAvatarEventsResponse) {}
+}