@dcl/protocol 1.0.0-2569677750.commit-6ce832a → 1.0.0-2611857113.commit-45ed75b

package/kernel/apis/EngineAPI.proto

@@ -0,0 +1,184 @@
+syntax = "proto3";
+
+message OpenExternalUrlBody {
+    string url = 1;
+}
+
+message OpenNFTDialogBody {
+    string asset_contract_address = 1; 
+    string token_id = 2; 
+    optional string comment = 3;
+}
+
+message CreateEntityBody {
+    string id = 1;
+}
+
+message RemoveEntityBody {
+    string id = 1;
+}
+
+message UpdateEntityComponentBody {
+    string entity_id = 1;
+    int32 class_id = 2;
+    string name = 3;
+    string json = 4;
+}
+
+message AttachEntityComponentBody {
+    string entity_id = 1;
+    string name = 2;
+    string id = 3;
+}
+
+message ComponentRemovedBody {
+    string entity_id = 1;
+    string name = 2;
+}
+
+message SetEntityParentBody {
+    string entity_id = 1;
+    string parent_id = 2;
+}
+
+enum QueryType {
+    InvalidQueryType = 0;
+    HitFirst = 1; 
+    HitAll = 2; 
+    HitFirstAvatar = 3; 
+    HitAllAvatars = 4;
+}
+
+message QueryBody {
+    QueryType query_id = 1;
+    string payload = 2;
+}
+
+message ComponentCreatedBody {
+    string id = 1;
+    int32 class_id = 2;
+    string name = 3;
+}
+
+message ComponentDisposedBody {
+    string id = 1;
+}
+
+message ComponentUpdatedBody {
+    string id = 1;
+    string json = 2;
+}
+
+message InitMessagesFinishedBody {
+
+}
+
+message Payload {
+    optional OpenExternalUrlBody open_external_url = 1;
+    optional OpenNFTDialogBody open_nft_dialog = 2;
+    optional CreateEntityBody create_entity = 3;
+    optional RemoveEntityBody remove_entity = 4;
+    optional UpdateEntityComponentBody update_entity_component = 5;
+    optional AttachEntityComponentBody attach_entity_component = 6;
+    optional ComponentRemovedBody component_removed = 7;
+    optional SetEntityParentBody set_entity_parent = 8;
+    optional QueryBody query = 9;
+    optional ComponentCreatedBody component_created = 10;
+    optional ComponentDisposedBody component_disposed = 11;
+    optional ComponentUpdatedBody component_updated = 12;
+    optional InitMessagesFinishedBody init_messages_finished = 13;
+}
+
+enum EAType {
+    InvalidEAType = 0;
+    OpenExternalUrl = 1;
+    OpenNFTDialog = 2;
+    CreateEntity = 3;
+    RemoveEntity = 4;
+    UpdateEntityComponent = 5;
+    AttachEntityComponent = 6;
+    ComponentRemoved = 7;
+    SetEntityParent = 8;
+    Query = 9;
+    ComponentCreated = 10;
+    ComponentDisposed = 11;
+    ComponentUpdated = 12;
+    InitMessagesFinished = 13;
+}
+
+message EntityAction {
+    EAType type = 1;
+    optional string tag = 2;
+    Payload payload = 3;
+}
+
+message ManyEntityAction {
+    repeated EntityAction actions = 1;
+}
+
+message SendBatchResponse {}
+
+message UnsubscribeRequest {
+    string event_id = 1;
+}
+message SubscribeRequest {
+    string event_id = 1;
+}
+message SubscribeResponse {}
+message UnsubscribeResponse {}
+
+
+// Events
+enum EventDataType {
+    Generic = 0;
+    PositionChanged = 1;
+    RotationChanged = 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 PullEventsRequest {}
+message PullEventsResponse {
+    repeated EventData events = 1;
+}
+
+service EngineAPIService {
+  rpc SendBatch(ManyEntityAction) returns (SendBatchResponse) {}
+  rpc Subscribe(SubscribeRequest) returns (SubscribeResponse) {}
+  rpc Unsubscribe(UnsubscribeRequest) returns (UnsubscribeResponse) {}
+  rpc PullEvents(PullEventsRequest) returns (PullEventsResponse) {}
+}

package/kernel/apis/EnvironmentAPI.proto

@@ -0,0 +1,68 @@
+syntax = "proto3";
+
+message ContentMapping {
+    string file = 1;
+    string hash = 2;
+}
+
+message BootstrapDataResponse {
+    string scene_id = 1;
+    string name = 2;
+    string main = 3;
+    string base_url = 4;
+    bool use_f_p_s_throttling = 5;
+    repeated ContentMapping mappings = 6;
+    string json_payload = 7;
+}
+
+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 clientUri = 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 {
+    rpc GetBootstrapData(GetBootstrapDataRequest) returns (BootstrapDataResponse) {}
+    rpc IsPreviewMode(IsPreviewModeRequest) returns (PreviewModeResponse) {}
+    rpc GetPlatform(GetPlatformRequest) returns (GetPlatformResponse) {}
+    rpc AreUnsafeRequestAllowed(AreUnsafeRequestAllowedRequest) returns (AreUnsafeRequestAllowedResponse) {}
+    rpc GetCurrentRealm(GetCurrentRealmRequest) returns (GetCurrentRealmResponse) {}
+    rpc GetExplorerConfiguration(GetExplorerConfigurationRequest) returns (GetExplorerConfigurationResponse) {}
+    rpc GetDecentralandTime(GetDecentralandTimeRequest) returns (GetDecentralandTimeResponse) {}
+}

package/kernel/apis/EthereumController.proto

@@ -0,0 +1,53 @@
+syntax = "proto3";
+
+message RequirePaymentRequest {
+    string to_address = 1;
+    float amount = 2;
+    string currency = 3;
+}
+
+message RequirePaymentResponse {
+    string json_any_response = 1;
+}
+
+message SignMessageRequest {
+    map<string, string> message = 1;
+}
+
+message SignMessageResponse {
+    string message = 1;
+    string hexEncodedMessage = 2;
+    string signature = 3;
+}
+
+message ConvertMessageToObjectRequest {
+    string message = 1;
+}
+
+message ConvertMessageToObjectResponse {
+    map<string, string> dict = 1;
+}
+
+message SendAsyncRequest {
+    int32 id = 1;
+    string method = 2;
+    string json_params = 3;
+}
+
+message SendAsyncResponse {
+    string json_any_response = 1;
+}
+
+message GetUserAccountRequest {}
+
+message GetUserAccountResponse {
+    optional string address = 1;
+}
+
+service EthereumControllerService {
+    rpc RequirePayment(RequirePaymentRequest) returns (RequirePaymentResponse) {}
+    rpc SignMessage(SignMessageRequest) returns (SignMessageResponse) {}
+    rpc ConvertMessageToObject(ConvertMessageToObjectRequest) returns (ConvertMessageToObjectResponse) {}
+    rpc SendAsync(SendAsyncRequest) returns (SendAsyncResponse) {}
+    rpc GetUserAccount(GetUserAccountRequest) returns (GetUserAccountResponse) {}
+}

package/kernel/apis/ExperimentalAPI.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+message SendToRendererRequest {
+    bytes data = 1;
+}
+message SendToResponse {}
+
+message MessageFromRendererRequest {}
+message MessageFromRendererResponse {
+    bytes data = 1;
+}
+
+service ExperimentalAPIService {
+  rpc SendToRenderer(SendToRendererRequest) returns (SendToResponse) {}
+  rpc MessageFromRenderer(MessageFromRendererRequest) returns (stream MessageFromRendererResponse) {}
+}

package/kernel/apis/ParcelIdentity.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+
+message ContentMapping {
+    string file = 1;
+    string hash = 2;
+}
+
+message MappingsResponse  {
+    string parcel_id = 1;
+    string root_cid = 2;
+    repeated ContentMapping contents = 3;
+}
+
+message Land {
+    string scene_id = 1;
+    string scene_json_data = 2;
+    string base_url = 3;
+    string base_url_bundles = 4;
+    MappingsResponse mappings_response = 5;
+}
+
+message GetParcelRequest {}
+message GetParcelResponse {
+    Land land = 1;
+    string cid = 2;
+}
+
+message GetSceneIdRequest {}
+message GetSceneIdResponse {
+    string scene_id = 1;
+}
+
+message GetIsEmptyRequest {}
+message GetIsEmptyResponse {
+    bool is_empty = 1;
+}
+
+service ParcelIdentityService {
+    rpc GetParcel(GetParcelRequest) returns (GetParcelResponse) {}
+    rpc GetSceneId(GetSceneIdRequest) returns (GetSceneIdResponse) {}
+    rpc GetIsEmpty(GetIsEmptyRequest) returns (GetIsEmptyResponse) {}
+}

package/kernel/apis/Permissions.proto

@@ -0,0 +1,30 @@
+syntax = "proto3";
+
+enum PermissionItem {
+    ALLOW_TO_MOVE_PLAYER_INSIDE_SCENE = 0;
+    ALLOW_TO_TRIGGER_AVATAR_EMOTE = 1;
+    USE_WEB3_API = 2;
+    USE_WEBSOCKET = 3;
+    USE_FETCH = 4;
+}
+
+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 {
+    rpc HasPermission(HasPermissionRequest) returns (PermissionResponse) {}
+    rpc HasManyPermissions(HasManyPermissionRequest) returns (HasManyPermissionResponse) {}
+}

package/kernel/apis/Players.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+
+import "UserIdentity.proto";
+
+message Player {
+    string user_id = 1;
+}
+
+message PlayersGetUserDataResponse {
+    optional UserData data = 1;
+}
+
+message PlayerListResponse {
+    repeated Player players = 1;
+}
+
+message GetPlayerDataRequest {
+    string user_id = 1;
+}
+
+message GetPlayersInSceneRequest {}
+message GetConnectedPlayersRequest {}
+
+service PlayersService {
+    rpc GetPlayerData(GetPlayerDataRequest) returns (PlayersGetUserDataResponse) {}
+    rpc GetPlayersInScene(GetPlayersInSceneRequest) returns (PlayerListResponse) {}
+    rpc GetConnectedPlayers(GetConnectedPlayersRequest)  returns (PlayerListResponse) {}
+}

package/kernel/apis/PortableExperiences.proto

@@ -0,0 +1,40 @@
+syntax = "proto3";
+
+message KillRequest {
+    string pid = 1;
+}
+
+message KillResponse {
+    bool status = 1;
+}
+
+message SpawnRequest {
+    string pid = 1;
+}
+
+message SpawnResponse {
+    string pid = 1;
+    string parent_cid = 2;
+}
+
+message PxRequest {
+    string pid = 1;
+}
+
+message GetPortableExperiencesLoadedRequest {}
+
+message GetPortableExperiencesLoadedResponse {
+    repeated SpawnResponse loaded = 1;
+}
+
+message ExitRequest {}
+message ExitResponse {
+    bool status = 1;
+}
+
+service PortableExperiencesService {
+    rpc Spawn(SpawnRequest) returns (SpawnResponse) {}
+    rpc Kill(KillRequest) returns (KillResponse) {}
+    rpc Exit(ExitRequest) returns (ExitResponse) {}
+    rpc GetPortableExperiencesLoaded(GetPortableExperiencesLoadedRequest) returns (GetPortableExperiencesLoadedResponse) {}
+}

package/kernel/apis/RestrictedActions.proto

@@ -0,0 +1,25 @@
+syntax = "proto3";
+
+message Vector3 {
+    float x = 1;
+    float y = 2;
+    float z = 3;
+}
+
+message MovePlayerToResponse { }
+
+message MovePlayerToRequest {
+    Vector3 new_relative_position = 1;
+    optional Vector3 camera_target = 2;
+}
+
+message TriggerEmoteResponse { }
+
+message TriggerEmoteRequest {
+    string predefined_emote = 1;
+}
+
+service RestrictedActionsService {
+    rpc MovePlayerTo(MovePlayerToRequest) returns (MovePlayerToResponse) {}
+    rpc TriggerEmote(TriggerEmoteRequest) returns (TriggerEmoteResponse) {}
+}

package/kernel/apis/SceneStateStorageController.proto

@@ -0,0 +1,114 @@
+syntax = "proto3";
+
+// Auxiliary types
+
+message SerializedSceneState {
+  repeated SerializedEntity entities = 1;
+}
+
+message SerializedComponent {
+    int32 type = 1;
+    string value_json = 2;
+}
+
+message SerializedEntity {
+    string id = 1;
+    repeated SerializedComponent components = 2;
+}
+
+// RPC Request and Response Messages
+
+message GetProjectManifestRequest {
+    string project_id = 1;
+}
+
+message GetProjectManifestResponse {
+    optional SerializedSceneState state = 1;
+}
+
+message GetProjectManifestByCoordinatesRequest {
+    string land = 1;
+}
+
+message GetProjectManifestByCoordinatesResponse {
+    optional SerializedSceneState state = 1;
+
+}
+
+message CreateProjectWithCoordsRequest {
+    string coordinates = 1;
+}
+
+message CreateProjectWithCoordsResponse {
+    bool ok = 1;
+}
+
+message SaveSceneStateRequest {
+    SerializedSceneState serialized_scene_state = 1;
+}
+
+message SaveSceneStateResponse {
+    bool ok = 1;
+    optional string error = 2;
+}
+
+message SaveProjectInfoRequest {
+    SerializedSceneState scene_state = 1;
+    string project_name = 2;
+    string project_description = 3;
+    string project_screenshot = 4;
+}
+
+message SaveProjectInfoResponse {
+    bool ok = 1;
+}
+
+message PublishSceneStateRequest {
+    string scene_id = 1;
+    string scene_name = 2;
+    string scene_description = 3;
+    string scene_screenshot = 4;
+    SerializedSceneState scene_state = 5;
+}
+
+message PublishSceneStateResponse {
+    bool ok = 1;
+    optional string error = 2;
+}
+
+message GetStoredStateRequest {
+    string scene_id = 1;
+}
+
+message GetStoredStateResponse {
+    optional SerializedSceneState state = 1;
+}
+
+
+message CreateProjectFromStateDefinitionRequest {}
+
+message CreateProjectFromStateDefinitionResponse {
+    optional SerializedSceneState state = 1;
+}
+
+
+message SendAssetsToRendererRequest {
+    SerializedSceneState state = 1;
+}
+
+message SendAssetsToRendererResponse {
+    string state = 1;
+}
+
+
+service SceneStateStorageControllerService {
+    rpc GetProjectManifest(GetProjectManifestRequest) returns (GetProjectManifestResponse) {}
+    rpc GetProjectManifestByCoordinates(GetProjectManifestByCoordinatesRequest) returns (GetProjectManifestByCoordinatesResponse) {}
+    rpc CreateProjectWithCoords(CreateProjectWithCoordsRequest) returns (CreateProjectWithCoordsResponse) {}
+    rpc SaveSceneState(SaveSceneStateRequest) returns (SaveSceneStateResponse) {}
+    rpc SaveProjectInfo(SaveProjectInfoRequest) returns (SaveProjectInfoResponse) {}
+    rpc PublishSceneState(PublishSceneStateRequest) returns (PublishSceneStateResponse) {}
+    rpc GetStoredState(GetStoredStateRequest) returns (GetStoredStateResponse) {}
+    rpc CreateProjectFromStateDefinition(CreateProjectFromStateDefinitionRequest) returns (CreateProjectFromStateDefinitionResponse) {}
+    rpc SendAssetsToRenderer(SendAssetsToRendererRequest) returns (SendAssetsToRendererResponse) {}
+}

package/kernel/apis/SignedFetch.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+message FlatFetchInit {
+    optional string method = 1;
+    optional string body = 2;
+    map<string, string> headers = 3;
+}
+
+message FlatFetchResponse {
+    bool ok = 1;
+    int32 status = 2;
+    string status_text = 3;
+    map<string, string> headers = 4;
+    string body = 5;
+}
+
+message SignedFetchRequest {
+    string url = 1;
+    optional FlatFetchInit init = 2;
+}
+
+service SignedFetchService {
+    rpc SignedFetch(SignedFetchRequest) returns (FlatFetchResponse) {}
+}

package/kernel/apis/SocialController.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+message InitRequest {}
+message SocialEvent {
+  string event = 1;
+  string payload = 2;
+}
+
+message GetAvatarEventsResponse {
+  repeated SocialEvent events = 1;
+}
+
+service SocialControllerService {
+    rpc PullAvatarEvents(InitRequest) returns (GetAvatarEventsResponse) {}
+}

package/kernel/apis/UserActionModule.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+message RequestTeleportRequest {
+    string destination = 1;
+}
+
+message RequestTeleportResponse {}
+
+service UserActionModuleService {
+    rpc RequestTeleport(RequestTeleportRequest) returns (RequestTeleportResponse) {}
+}

package/kernel/apis/UserIdentity.proto

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+message Snapshots {
+    string face256 = 1;
+    string body = 2;
+}
+
+message AvatarForUserData {
+    string body_shape = 1;
+    string skin_color = 2;
+    string hair_color = 3;
+    string eye_color = 4;
+    repeated string wearables = 5;
+    Snapshots snapshots = 6;
+}
+
+message UserData {
+    string display_name = 1;
+    optional string public_key = 2;
+    bool has_connected_web3 = 3;
+    string user_id = 4;
+    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) {}
+}