@dcl/protocol 1.0.0-2569677750.commit-6ce832a → 1.0.0-25751414897.commit-a9f7d81

package/proto/decentraland/kernel/apis/ethereum_controller.proto

@@ -0,0 +1,64 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+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 hex_encoded_message = 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 {
+    // @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/proto/decentraland/kernel/apis/parcel_identity.proto

@@ -0,0 +1,43 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+import "decentraland/common/content_mapping.proto";
+
+message MappingsResponse  {
+    string parcel_id = 1;
+    string root_cid = 2;
+    repeated decentraland.common.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 {
+    // @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,131 @@
+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;
+}
+
+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;
+}
+
+message SuccessResponse {
+  bool success = 1;
+}
+
+message TriggerEmoteResponse { }
+
+message MovePlayerToResponse {
+  bool success = 1;
+}
+
+message WalkPlayerToRequest {
+  decentraland.common.Vector3 new_relative_position = 1;
+  float stop_threshold = 2;
+  optional float timeout = 3; // max seconds before the request is failed; not passed to the movement scene
+}
+
+message WalkPlayerToResponse {
+  bool success = 1;
+}
+
+message TeleportToResponse { }
+
+message SetUiFocusRequest {
+  string element_id = 1;
+}
+
+message ClearUiFocusRequest { }
+
+message GetUiFocusRequest { }
+
+message UiFocusResponse { 
+  // the element that is/was focussed
+  optional string element_id = 1;
+}
+
+message CopyToClipboardRequest {
+  string text = 1;
+}
+
+message EmptyResponse { }
+
+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) {}
+
+  // WalkPlayerTo will walk the player to a position relative to the current scene,
+  // managed by the movement controller scene. Returns success when the player reaches
+  // within stop_threshold distance, or false if the path is blocked, the player gets
+  // stuck, the player interrupts the walk with manual input, or the optional timeout expires.
+  rpc WalkPlayerTo(WalkPlayerToRequest) returns (WalkPlayerToResponse) {}
+
+  // 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) {}
+
+  // Sets the focus to a specific UI element
+  rpc SetUiFocus(SetUiFocusRequest) returns (UiFocusResponse) {}
+
+  // Clears the focus from any currently focused textentry or dropdown
+  rpc ClearUiFocus(SetUiFocusRequest) returns (UiFocusResponse) {}
+
+  // Returns the element_id of any currently focused textentry or dropdown
+  rpc GetUiFocus(GetUiFocusRequest) returns (UiFocusResponse) {}
+
+  // CopyToClipboard copies the provided text into the clipboard
+  rpc CopyToClipboard(CopyToClipboardRequest) returns (EmptyResponse) {}
+}

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/proto/decentraland/kernel/apis/signed_fetch.proto

@@ -0,0 +1,33 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+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;
+}
+
+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) {}
+}

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/proto/decentraland/kernel/apis/user_action_module.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+package decentraland.kernel.apis;
+
+message RequestTeleportRequest {
+    string destination = 1;
+}
+
+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) {}
+}