@dxos/protocols 0.1.0

package/src/proto/dxos/client.proto

@@ -0,0 +1,254 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+
+import "dxos/config.proto";
+import "dxos/echo/snapshot.proto";
+import "dxos/echo/timeframe.proto";
+import "dxos/halo/invitations.proto";
+import "dxos/halo/keys.proto";
+import "dxos/keys.proto";
+
+package dxos.client;
+
+//
+// SYSTEM
+//
+
+service SystemService {
+  rpc GetConfig(google.protobuf.Empty) returns (dxos.config.Config);
+  rpc Reset (google.protobuf.Empty) returns (google.protobuf.Empty);
+}
+
+//
+// Invitations shared across HALO and ECHO.
+// TODO(burdon): Consolidate with invitation protobufs.
+//
+
+enum InvitationState {
+  WAITING_FOR_CONNECTION = 0;
+  CONNECTED = 1;
+  SUCCESS = 2;
+  ERROR = 3;
+}
+
+/// Invitation process created by sender.
+message InvitationRequest {
+  optional dxos.halo.invitations.InvitationDescriptor descriptor = 1;
+
+  InvitationState state = 2;
+
+  /// Only if state == ERROR.
+  optional string error = 3;
+}
+
+/// Invitation that is being redeemed.
+message RedeemedInvitation {
+  string id = 1;
+
+  InvitationState state = 2;
+
+  /// Only if state == ERROR.
+  optional string error = 3;
+
+  /// Only on party invitations that are finished.
+  optional dxos.keys.PublicKey party_key = 4;
+}
+
+message AuthenticateInvitationRequest {
+  /// Id from corresponding RedeemedInvitation.
+  string process_id = 1;
+  bytes secret = 2;
+}
+
+//
+// HALO
+//
+
+message Profile {
+  dxos.keys.PublicKey public_key = 1;
+  optional string username = 2;
+}
+
+message SubscribeProfileResponse {
+  optional Profile profile = 1;
+}
+
+message CreateProfileRequest {
+  optional string username = 1;
+  optional bytes public_key = 2;
+  optional bytes secret_key = 3;
+}
+
+message RecoverProfileRequest {
+  string seed_phrase = 1;
+}
+message Contact {
+  dxos.keys.PublicKey public_key = 1;
+  optional string display_name = 2;
+}
+
+message Contacts {
+  repeated Contact contacts = 1;
+}
+
+service ProfileService {
+  rpc CreateProfile(CreateProfileRequest) returns (Profile);
+  rpc RecoverProfile(RecoverProfileRequest) returns (Profile);
+  rpc SubscribeProfile (google.protobuf.Empty) returns (stream SubscribeProfileResponse);
+
+  rpc CreateInvitation(google.protobuf.Empty) returns (stream InvitationRequest);
+  rpc AcceptInvitation(dxos.halo.invitations.InvitationDescriptor) returns (stream RedeemedInvitation);
+  rpc AuthenticateInvitation(AuthenticateInvitationRequest) returns (google.protobuf.Empty);
+}
+
+message AddKeyRecordRequest {
+  dxos.halo.keys.KeyRecord key_record = 1;
+}
+
+message SignRequest {
+  /**
+   * - The public key of the key that is supposed to be used for signing.
+   */
+  dxos.keys.PublicKey public_key = 1;
+
+  bytes payload = 2;
+}
+
+message SignResponse {
+  bytes signed = 2;
+}
+
+message SetPreferenceRequest {
+  string key = 1;
+  string value = 2;
+}
+
+message GetPreferenceRequest {
+  string key = 1;
+}
+
+message GetPreferenceResponse {
+  string value = 1;
+}
+
+service HaloService {
+  rpc Sign(SignRequest) returns (SignResponse);
+  rpc AddKeyRecord(AddKeyRecordRequest) returns (google.protobuf.Empty);
+
+  rpc SubscribeContacts(google.protobuf.Empty) returns (stream Contacts);
+
+  rpc SetGlobalPreference(SetPreferenceRequest) returns (google.protobuf.Empty);
+  rpc GetGlobalPreference(GetPreferenceRequest) returns (GetPreferenceResponse);
+
+  rpc SetDevicePreference(SetPreferenceRequest) returns (google.protobuf.Empty);
+  rpc GetDevicePreference(GetPreferenceRequest) returns (GetPreferenceResponse);
+}
+
+//
+// Spaces
+//
+
+// TODO(burdon): Rename Space.
+message Party {
+  message Member {
+    dxos.keys.PublicKey public_key = 1;
+    optional string display_name = 2;
+  }
+
+  dxos.keys.PublicKey public_key = 1;
+  bool is_open = 2;
+  bool is_active = 3;
+
+  repeated Member members = 4;
+}
+
+message SubscribePartyRequest {
+  dxos.keys.PublicKey party_key = 1;
+}
+
+message GetPartyDetailsRequest {
+  dxos.keys.PublicKey party_key = 1;
+}
+
+message PartyDetails {
+  /// The timeframe of mutations processed by the client.
+  dxos.echo.timeframe.TimeframeVector processed_timeframe = 1;
+}
+
+message SubscribePartyResponse {
+  optional Party party = 1;
+}
+
+message SubscribePartiesResponse {
+  repeated Party parties = 1;
+}
+
+message CreateInvitationRequest {
+  dxos.keys.PublicKey party_key = 1;
+
+  /// When specified the invitation will be of OFFLINE type, not requiring secret exchange.
+  optional dxos.keys.PublicKey invitee_key = 2;
+}
+
+message PartyActivationOptions {
+  bool global = 1;
+  bool device = 2;
+}
+
+message SetPartyStateRequest {
+  dxos.keys.PublicKey party_key = 1;
+
+  optional bool open = 2;
+  optional bool active_global = 3;
+  optional bool active_device = 4;
+}
+
+message SubscribeMembersRequest {
+  dxos.keys.PublicKey party_key = 1;
+}
+
+message SubscribeMembersResponse {
+  message PartyMember {
+    dxos.keys.PublicKey public_key = 1; // TODO(burdon): Rename xxx_key.
+    optional string display_name = 2;
+  }
+
+  repeated PartyMember members = 1;
+}
+
+message CreateSnapshotRequest {
+  dxos.keys.PublicKey party_key = 1;
+}
+
+//
+// Service definition
+//
+
+// TODO(burdon): Rename SpaceService.
+service PartyService {
+  rpc SubscribeToParty (SubscribePartyRequest) returns (stream SubscribePartyResponse);
+  rpc SubscribeParties (google.protobuf.Empty) returns (stream SubscribePartiesResponse);
+
+  rpc GetPartyDetails(GetPartyDetailsRequest) returns (PartyDetails);
+
+  rpc CreateParty(google.protobuf.Empty) returns (Party);
+  rpc CloneParty(dxos.echo.snapshot.PartySnapshot) returns (Party);
+
+  /// Open and close or activate and deactivate a party.
+  rpc SetPartyState(SetPartyStateRequest) returns (Party);
+
+  // TODO(burdon): Rename.
+  rpc CreateInvitation(CreateInvitationRequest) returns (stream InvitationRequest);
+  rpc AcceptInvitation(dxos.halo.invitations.InvitationDescriptor) returns (stream RedeemedInvitation);
+  rpc AuthenticateInvitation(AuthenticateInvitationRequest) returns (google.protobuf.Empty);
+
+  // TODO(rzadp): Remove and join with Subscribing to Party.
+  rpc SubscribeMembers (SubscribeMembersRequest) returns (stream SubscribeMembersResponse);
+
+  rpc CreateSnapshot(CreateSnapshotRequest) returns (echo.snapshot.PartySnapshot);
+}

package/src/proto/dxos/config.proto

@@ -0,0 +1,305 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/any.proto";
+
+package dxos.config;
+
+message Config {
+  optional int32 version = 1;
+
+  //
+  // Package definition.
+  //
+
+  optional Package package = 2;
+
+  //
+  // Runtime configuration.
+  //
+
+  optional Runtime runtime = 3;
+}
+
+message Package {
+  optional string license = 1;
+  repeated Repo repos = 2;
+  repeated Module modules = 3;
+}
+
+// TODO(wittjosiah): Shared with registry types. Factor out?
+message Repo {
+  optional string name = 1;
+  optional string url = 2;
+  optional string version = 3;
+}
+
+message Module {
+  message Build {
+    optional string command = 1;
+    optional string outdir = 2;
+    optional string version = 3;
+    optional string tag = 4;
+  }
+
+  optional string name = 1;
+  optional string type = 2;
+  optional string display_name = 3;
+  optional string description = 4;
+  repeated string tags = 5;
+  optional bytes bundle = 6;
+
+  optional Build build = 100;
+  repeated Repo repos = 101;
+
+  /// Data which will be included as apart of DXNS record.
+  /// The data will be validated based on the type when being published.
+  optional google.protobuf.Any record = 200;
+}
+
+message Runtime {
+  message Client {
+    /// Whether the client services are local with ClientServiceHost or remote and need to be accessed via ClientServiceProxy. Defaults to AUTOMATIC.
+    enum Mode {
+      /// Connects to the browser wallet if avialable, otherwise runs services in the local mode.
+      AUTOMATIC = 0;
+
+      /// Run services in the local mode.
+      LOCAL = 1;
+
+      /// Connect to the browser wallet or to the remote services through the RPC port.
+      REMOTE = 2;
+    }
+
+    message Storage {
+      enum StorageDriver {
+        RAM = 0;
+        IDB = 1;
+        CHROME = 2;
+        FIREFOX = 3;
+        NODE = 4;
+
+        // Only for key storage:
+
+        LEVELJS = 11;
+        JSONDOWN = 12;
+      }
+
+      optional bool persistent = 1;             // TODO(burdon): Replace with type.
+      optional StorageDriver key_storage = 3;   // TODO(burdon): Rename key_store.
+      optional StorageDriver storage_type = 2;  // TODO(burdon): Rename data_store.
+      optional string path = 4;                 // TODO(burdon): Rename data_path.
+    }
+
+    optional string debug = 1 [(env) = "DEBUG"];
+    optional Storage storage = 2;
+    optional bool enable_snapshots = 3;
+
+    /// Milliseconds
+    optional int32 snapshot_interval = 4;
+
+    /// Milliseconds
+    optional int32 invitation_expiration = 5;
+
+    optional Mode mode = 6;
+
+    optional string remote_source = 7;
+  }
+
+  message App {
+    optional string org = 1;
+    optional string theme = 2;
+    optional string website = 3;
+    optional string public_url = 4 [(env) = "PUBLIC_URL"];
+  }
+
+  // CLI configuration
+  message CLI {
+    message AppServe {
+      message Serve {
+        optional string config = 1;
+        optional string login_app = 2;
+        optional string key_phrase = 3;
+      }
+
+      optional Serve serve = 1;
+    }
+
+    message Package {
+      optional string package = 1;
+      optional string channel = 2;
+      optional string bin = 3;
+      optional string config = 4;
+    }
+
+    optional string node_path = 1;
+    optional AppServe app = 2;
+    optional Package console = 3;
+    optional Package mdns = 4;
+    optional Package signal = 5;
+    optional string npm_client = 6;
+    optional string channel = 7;
+  }
+
+  message Props {
+    optional string title = 1;
+  }
+
+  message System {
+    optional string debug = 1;
+  }
+
+  message Kube {
+    message Autoupdate {
+      optional bool enabled = 1;
+      /// Seconds
+      optional int64 interval = 2;
+    }
+
+    message Https {
+      optional bool enabled = 1;
+      optional string port = 2;
+      optional string email = 3;
+      optional string certfile = 4;
+      optional string keyfile = 5;
+      optional string dnsprovider = 6;
+    }
+
+    message P2P {
+      optional string private_key = 1;
+      optional string port = 2;
+      repeated string bootstrap = 3;
+    }
+
+    message Monitoring {
+      bool enabled = 1;
+      string endpoint = 2;
+      /// Seconds
+      int64 interval = 3;
+    }
+
+    message Trace {
+      bool disabled = 1;
+    }
+
+    message Telemetry {
+      bool disabled = 1;
+    }
+
+    optional string host = 1;
+    optional string port = 2;
+    optional Autoupdate autoupdate = 3;
+    optional Https https = 4;
+    optional P2P p2p = 5;
+    optional string confhost = 6;
+    repeated string env = 7;
+    repeated string alias = 8;
+    optional Monitoring monitoring = 9;
+    optional Trace trace = 10;
+    optional Telemetry telemetry = 11;
+  }
+
+  //
+  // DXOS Services.
+  //
+  message Services {
+    message Kube {
+
+      message Endpoints {
+        optional string logs = 1;
+        optional string services = 2;
+        optional string cert = 3;
+      }
+
+      optional Endpoints endpoints = 1;
+      optional string public_url = 2;
+    }
+
+    message AppServer {
+      optional string prefix = 1;
+      optional string server = 2;
+    }
+
+    message Dxns {
+      /// DXNS endpoint.
+      optional string server = 1;
+
+      /**
+       * Substrate account URI. This is a secret.
+       * KUBEs do not serve this with the config but we store it in profile.yml.
+       *
+       * TODO(dmaretskyi): Deprecate this and move it to keyring.
+       */
+      optional string account_uri = 2;
+
+      /**
+       * Public Polkadot Address.
+       */
+      optional string address = 3;
+
+      /**
+       * Public address of a DXNS Account.
+       */
+      optional string account = 4;
+
+      optional string faucet = 5;
+    }
+
+    message Ipfs {
+      optional string server = 1;
+      optional string gateway = 2;
+    }
+
+    message Signal {
+      optional string server = 1;
+      optional string api = 2;
+      optional string status = 3;
+    }
+
+    message Ice {
+      optional string urls = 1;
+      optional string username = 2;
+      optional string credential = 3;
+    }
+
+    message Machine {
+      optional string do_access_token = 1;
+      optional string github_access_token = 2;
+      optional string github_username = 3;
+      optional string dns_domain = 4;
+      optional string npm_access_token = 5;
+    }
+
+    message BotFactory {
+      optional string topic = 1;
+      optional bool persistent = 2;
+      optional int32 retry_attempts = 3;
+      optional int32 retry_interval = 4;
+    }
+
+    message Publisher {
+      optional string server = 1;
+    }
+
+    optional Kube kube = 1;
+    optional AppServer app = 2;
+    optional Dxns dxns = 3;
+    optional Ipfs ipfs = 4;
+    optional Signal signal = 5;
+    repeated Ice ice = 6;
+    optional Machine machine = 7;
+    optional BotFactory bot = 8;
+    optional Publisher publisher = 9;
+  }
+
+  optional Client client = 1;
+  optional App app = 2;
+  optional CLI cli = 3;
+  optional Props props = 4;
+  optional Services services = 5;
+  optional System system = 6;
+  optional Kube kube = 7;
+}