@dxos/protocols 0.1.35 → 0.1.36-next.ef27157

package/src/proto/dxos/client/services.proto

@@ -8,11 +8,9 @@ import "google/protobuf/empty.proto";
 
 import "dxos/config.proto";
 import "dxos/halo/credentials.proto";
-import "dxos/halo/invitations.proto";
 import "dxos/mesh/teleport/gossip.proto";
 import "dxos/keys.proto";
 
-// TODO(burdon): Restructure all services.
 // TODO(burdon): Reorganize packages (e.g., client.services, echo.database).
 
 package dxos.client.services;
@@ -162,11 +160,33 @@ message Space {
     optional dxos.keys.PublicKey control_feed_key = 1;
     optional dxos.keys.PublicKey data_feed_key = 2;
 
+    repeated dxos.keys.PublicKey control_feeds = 18;
+    repeated dxos.keys.PublicKey data_feeds = 19;
+
+    /// Mutations alredy processed.
     optional timeframe.TimeframeVector current_control_timeframe = 10;
+
+    /// Minimum timeframe to consider the state to be up-to-date.
     optional timeframe.TimeframeVector target_control_timeframe = 11;
+
+    /// All mutations stored in feeds.
+    optional timeframe.TimeframeVector total_control_timeframe = 14;
+
+    /// All mutations known to exist on the network.
+    optional timeframe.TimeframeVector known_control_timeframe = 15;
+    
+    /// Mutations alredy processed.
     optional timeframe.TimeframeVector current_data_timeframe = 12;
+
+    /// Minimum timeframe to consider the state to be up-to-date.
     optional timeframe.TimeframeVector target_data_timeframe = 13;
 
+    /// All mutations stored in feeds.
+    optional timeframe.TimeframeVector total_data_timeframe = 16;
+
+    /// All mutations known to exist on the network.
+    optional timeframe.TimeframeVector known_data_timeframe = 17;
+
     // TODO(dmaretskyi): Snapshot & epoch info.
   }
 
@@ -212,7 +232,9 @@ service SpacesService {
   rpc UpdateSpace(UpdateSpaceRequest) returns (google.protobuf.Empty);
   rpc QuerySpaces(google.protobuf.Empty) returns (stream QuerySpacesResponse);
 
+  /// Broadcast an emphemeral message to the space swarm.
   rpc PostMessage(PostMessageRequest) returns (google.protobuf.Empty);
+  /// Subscribe to messages from the space swarm.
   rpc SubscribeMessages(SubscribeMessagesRequest) returns (stream dxos.mesh.teleport.gossip.GossipMessage);
 
   /// Write credentials to the space control feed.
@@ -230,86 +252,80 @@ service SpacesService {
  */
 message Invitation {
   enum Type {
-    /// Requires both to be online with OTP to complete key exchange.
+    /// Requires both to be online to complete key exchange.
     INTERACTIVE = 0;
-    /// Interactive without OTP.
-    /// @deprecated Use authMethod.
-    INTERACTIVE_TESTING = 1;
     /// Guest's identity key is known; invitation can be accepted by any valid peer.
-    OFFLINE = 2;
-    /// Multiple-use invitation with OTP.
-    MULTIUSE_TESTING = 3;
+    OFFLINE = 1;
+    /// Multiple-use interactive invitation.
+    MULTIUSE = 2;
+  }
+
+  enum Kind {
+    DEVICE = 0;
+    SPACE = 1;
+  }
+
+  enum AuthMethod {
+    /// No authnetication is required. Guest should not call `Authenticate`.
+    NONE = 0;
+
+    /// Guest should call `Authenticate` with the shared secret.
+    SHARED_SECRET = 1;
   }
 
   enum State {
     INIT = 0;
     CONNECTING = 1;
     CONNECTED = 2;
-    AUTHENTICATING = 3;
-    SUCCESS = 4;
-    CANCELLED = 5;
-    TIMEOUT = 6;
-    ERROR = 7;
-  }
-
-  enum Error {
-    OK = 0;
-    TIMEOUT = 1;
-    INVALID_OTP = 2;
-    INVALID_OPT_ATTEMPTS = 3;
-    INVALID_CREDENTIALS = 4;
+    READY_FOR_AUTHENTICATION = 3;
+    AUTHENTICATING = 4;
+    SUCCESS = 5;
+    CANCELLED = 6;
+    TIMEOUT = 7;
+    ERROR = 8;
   }
 
-  /// Local identifier.
-  optional string invitation_id = 1;
-
-  /// Determined when created.
-  optional Type type = 2;
+  /// Local identifier (random).
+  string invitation_id = 1;
 
-  optional dxos.halo.invitations.AuthMethod auth_method = 10; // TODO: Fix numbering.
+  /// Determines the behavior of the invitation.
+  Type type = 2;
 
-  /// Local state.
-  optional State state = 3;
+  /// Kind of access the invitation will grant.
+  Kind kind = 3;
 
-  /// Error.
-  optional Error error = 4;
+  /// How the invitation is authenticated.
+  AuthMethod auth_method = 4;
 
   /// Swarm rendezvous (random).
-  optional dxos.keys.PublicKey swarm_key = 5;
+  dxos.keys.PublicKey swarm_key = 5;
 
-  /// Guest's identity (only present if OFFLINE).
-  optional dxos.keys.PublicKey identity_key = 6;
+  /// Local state.
+  State state = 6;
 
-  /// Space to join.
-  optional dxos.keys.PublicKey space_key = 7;
+  /// Timeout (ms).
+  optional int32 timeout = 7;
 
-  /// Authentication code created by host.
-  optional string authentication_code = 8;
+  /// Guest's identity.
+  optional dxos.keys.PublicKey identity_key = 8;
 
-  /// Timeout (ms).
-  optional int32 timeout = 9;
+  /// Space to join (only present if kind is SPACE).
+  optional dxos.keys.PublicKey space_key = 9;
+
+  /// Authentication code created by host (only present if auth_method is SHARED_SECRET).
+  optional string auth_code = 10;
 }
 
 message AuthenticationRequest {
   string invitation_id = 1;
-  string authentication_code = 2;
+  string auth_code = 2;
 }
 
 message CancelInvitationRequest {
   string invitation_id = 1;
 }
 
-// Common TS interface.
-// TODO(burdon): Reconcile with halo/invitations.proto (e.g., common defs like error vs superset of services?)
-
-service DeviceInvitationsService {
-  rpc CreateInvitation(Invitation) returns (stream Invitation);
-  rpc Authenticate(AuthenticationRequest) returns (google.protobuf.Empty);
-  rpc AcceptInvitation(Invitation) returns (stream Invitation);
-  rpc CancelInvitation(CancelInvitationRequest) returns (google.protobuf.Empty);
-}
-
-service SpaceInvitationsService {
+service InvitationsService {
   rpc CreateInvitation(Invitation) returns (stream Invitation);
   rpc Authenticate(AuthenticationRequest) returns (google.protobuf.Empty);
   rpc AcceptInvitation(Invitation) returns (stream Invitation);
@@ -325,7 +341,6 @@ enum ConnectionState {
   ONLINE = 1;
 }
 
-// TODO(mykola): Broden API.
 message NetworkStatus {
   ConnectionState state = 1;
 }

package/src/proto/dxos/config.proto

@@ -6,9 +6,16 @@ syntax = "proto3";
 
 import "google/protobuf/any.proto";
 import "google/protobuf/struct.proto";
+import "google/protobuf/descriptor.proto";
 
 package dxos.config;
 
+option go_package = "github.com/dxos/kube/proto/def/dxos/config";
+
+extend google.protobuf.FieldOptions {
+    optional string env_var = 1000;
+}
+
 message Config {
   optional int32 version = 1;
 
@@ -88,8 +95,8 @@ message Runtime {
     }
 
     message Log {
-      optional string filter = 1 [(env) = "LOG_FILTER"];
-      optional string prefix = 2 [(env) = "LOG_PREFIX"];
+      optional string filter = 1 [(env_var) = "LOG_FILTER"];
+      optional string prefix = 2 [(env_var) = "LOG_PREFIX"];
     }
 
     optional Log log = 1;
@@ -120,7 +127,7 @@ message Runtime {
     optional string org = 1;
     optional string theme = 2;
     optional string website = 3;
-    optional string public_url = 4 [(env) = "PUBLIC_URL"];
+    optional string public_url = 4 [(env_var) = "PUBLIC_URL"];
 
     optional BuildInfo build = 100;
     optional google.protobuf.Struct env = 101;
@@ -167,23 +174,24 @@ message Runtime {
   //
   message Kube {
     message Autoupdate {
-      optional bool enabled = 1;
+      bool enabled = 1;
       /// Seconds
-      optional int64 interval = 2;
+      int32 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; // TODO(burdon): dns_provider.
+      bool enabled = 1;
+      string port = 2;
+      string email = 3;
+      string certfile = 4;
+      string keyfile = 5;
+      string dnsprovider = 6; // TODO(burdon): dns_provider.
     }
 
     message P2P {
-      optional string private_key = 1;
-      optional string port = 2;
+      // TODO(egorgripasov): private_key
+      string privatekey = 1;
+      string port = 2;
       repeated string bootstrap = 3;
     }
 
@@ -191,7 +199,7 @@ message Runtime {
       bool enabled = 1;
       string endpoint = 2;
       /// Seconds
-      int64 interval = 3;
+      int32 interval = 3;
     }
 
     message Trace {
@@ -209,26 +217,33 @@ message Runtime {
     }
 
     message AppTunneling {
-      optional bool enabled = 1;
-      optional string command_template = 2;
-      optional string output_re = 3;
-      optional string port = 4;
+      bool enabled = 1;
+      string command_template = 2;
+      string output_re = 3;
+      string port = 4;
+    }
+
+    message Bots {
+      bool enabled = 1;
+      /// Refresh interval - Seconds
+      int32 interval = 2;
     }
 
     // TODO(burdon): Needs documentation/
-    optional string host = 1;
-    optional string port = 2;
-    optional Autoupdate autoupdate = 3;
-    optional Https https = 4;
-    optional P2P p2p = 5;
-    optional string confhost = 6; // TODO(burdon): ?
+    string host = 1;
+    string port = 2;
+    Autoupdate autoupdate = 3;
+    Https https = 4;
+    P2P p2p = 5;
+    string confhost = 6; // TODO(burdon): ?
     repeated string env = 7;
     repeated string alias = 8;
-    optional Monitoring monitoring = 9;
-    optional Trace trace = 10;
-    optional Telemetry telemetry = 11;
-    optional Gravity gravity = 12;
-    optional AppTunneling app_tunneling = 13;
+    Monitoring monitoring = 9;
+    Trace trace = 10;
+    Telemetry telemetry = 11;
+    Gravity gravity = 12;
+    AppTunneling app_tunneling = 13;
+    Bots bots = 14;
   }
 
   //

package/src/proto/dxos/halo/credentials.proto

@@ -11,6 +11,8 @@ import "google/protobuf/timestamp.proto";
 
 import "dxos/keys.proto";
 
+option go_package = "github.com/dxos/kube/proto/def/dxos/halo/credentials";
+
 //
 // TODO(burdon): Reference/extract these notes to the design doc commentary.
 // Peers maintain Feeds that are admitted to HALO and ECHO Spaces.

package/src/proto/dxos/halo/invitations.proto

@@ -6,16 +6,27 @@ syntax = "proto3";
 
 import "google/protobuf/empty.proto";
 
+import "dxos/client/services.proto";
+import "dxos/echo/timeframe.proto";
 import "dxos/halo/credentials.proto";
 import "dxos/keys.proto";
-import "dxos/echo/timeframe.proto";
 
 package dxos.halo.invitations;
 
-// TODO(burdon): Reconcile with client.services.Invitation. Merge files.
+message IntroductionRequest {
+  /// Guest's profile.
+  optional halo.credentials.ProfileDocument profile = 1;
+}
+
+message IntroductionResponse {
+  dxos.client.services.Invitation.AuthMethod auth_method = 1;
+
+  /// Only present for testing invitation types.
+  optional dxos.keys.PublicKey space_key = 100;
+}
 
 message AuthenticationRequest {
-  string authentication_code = 1;
+  string auth_code = 1;
 }
 
 message AuthenticationResponse {
@@ -29,58 +40,12 @@ message AuthenticationResponse {
   optional Status status = 1;
 }
 
-enum AuthMethod {
-  /// No authnetication is required. Guest should not call `Authenticate`.
-  NONE = 0;
-
-  /// Guest should call `Authenticate` with the shared secret.
-  SHARED_SECRET = 1;
-}
-
-//
-// HALO device invitations.
-//
-
-message HaloAdmissionOffer {
-  dxos.keys.PublicKey identity_key = 1;
-  dxos.keys.PublicKey halo_space_key = 2;
-  dxos.keys.PublicKey genesis_feed_key = 3;
-  optional dxos.echo.timeframe.TimeframeVector control_timeframe = 4;
-}
-
-message HaloAdmissionCredentials {
+message DeviceAdmissionRequest {
   dxos.keys.PublicKey device_key = 1;
   dxos.keys.PublicKey control_feed_key = 2;
   dxos.keys.PublicKey data_feed_key = 3;
 }
 
-service HaloHostService {
-  /// Process admission offer from host.
-  rpc RequestAdmission(google.protobuf.Empty) returns (HaloAdmissionOffer);
-
-  /// Authenticate request.
-  rpc Authenticate(AuthenticationRequest) returns (AuthenticationResponse);
-
-  /// Process admission request from guest.
-  rpc PresentAdmissionCredentials(HaloAdmissionCredentials) returns (google.protobuf.Empty);
-}
-
-//
-// Space agent invitations.
-//
-
-message Introduction {
-  /// Guest's profile.
-  optional halo.credentials.ProfileDocument profile = 1;
-}
-
-message IntroductionResponse {
-  /// Only present for testing invitation types.
-  optional dxos.keys.PublicKey space_key = 1;
-
-  AuthMethod auth_method = 2;
-}
-
 message SpaceAdmissionRequest {
   dxos.keys.PublicKey identity_key = 1;
   dxos.keys.PublicKey device_key = 2;
@@ -88,6 +53,20 @@ message SpaceAdmissionRequest {
   dxos.keys.PublicKey data_feed_key = 4;
 }
 
+message AdmissionRequest {
+  oneof kind {
+    DeviceAdmissionRequest device = 1;
+    SpaceAdmissionRequest space = 2;
+  }
+}
+
+message DeviceAdmissionCredentials {
+  dxos.keys.PublicKey identity_key = 1;
+  dxos.keys.PublicKey halo_space_key = 2;
+  dxos.keys.PublicKey genesis_feed_key = 3;
+  optional dxos.echo.timeframe.TimeframeVector control_timeframe = 4;
+}
+
 message SpaceAdmissionCredentials {
   /// Credential of type `SpaceMember` that grants Guest's identity access to the space.
   dxos.halo.credentials.Credential credential = 1;
@@ -99,13 +78,22 @@ message SpaceAdmissionCredentials {
   optional dxos.echo.timeframe.TimeframeVector data_timeframe = 3;
 }
 
-service SpaceHostService {
-  /// Introduce Guest to the host.
-  rpc Introduce(Introduction) returns (IntroductionResponse);
+message AdmissionResponse {
+  oneof kind {
+    DeviceAdmissionCredentials device = 1;
+    SpaceAdmissionCredentials space = 2;
+  }
+}
+
+/// Host service for two peers exchanging an invitation.
+// TODO(wittjosiah): Handle invitations where guest is the initiatating peer.
+service InvitationHostService {
+  /// Introduce guest to the host.
+  rpc Introduce(IntroductionRequest) returns (IntroductionResponse);
 
   /// Authenticate request.
   rpc Authenticate(AuthenticationRequest) returns (AuthenticationResponse);
 
   /// Process admission credentials.
-  rpc RequestAdmission(SpaceAdmissionRequest) returns (SpaceAdmissionCredentials);
+  rpc Admit(AdmissionRequest) returns (AdmissionResponse);
 }

package/src/proto/dxos/keys.proto

@@ -6,6 +6,8 @@ syntax = "proto3";
 
 package dxos.keys;
 
+option go_package = "github.com/dxos/kube/proto/def/dxos/keys";
+
 message PublicKey {
   bytes data = 1;
 }

package/src/proto/dxos/mesh/signal.proto

@@ -10,7 +10,7 @@ import "google/protobuf/timestamp.proto";
 
 package dxos.mesh.signal;
 
-option go_package = "github.com/dxos/kube/go/signal/pb";
+option go_package = "github.com/dxos/kube/proto/def/dxos/mesh/signal";
 
 message JoinRequest {
   bytes swarm = 1;

package/src/proto/dxos/rpc.proto

@@ -9,7 +9,7 @@ import "google/protobuf/any.proto";
 // TODO(burdon): Move to `dxos.mesh.rpc` (reconcile with @dxos/kube repo).
 package dxos.rpc;
 
-option go_package = "github.com/dxos/kube/go/dxrpc/pb";
+option go_package = "github.com/dxos/kube/proto/def/dxos/rpc";
 
 message RpcMessage {
   oneof content {

package/src/proto/dxos/service/publisher.proto

@@ -10,7 +10,7 @@ import "dxos/config.proto";
 
 package dxos.service.publisher;
 
-option go_package = "github.com/dxos/kube/publisher/pb";
+option go_package = "github.com/dxos/kube/proto/def/dxos/service/publisher";
 
 message PublishRequest {
   dxos.config.Package package = 1;

package/src/proto/dxos/service/supervisor.proto

@@ -11,7 +11,7 @@ import "dxos/keys.proto";
 
 package dxos.service.supervisor;
 
-option go_package = "github.com/dxos/kube/supervisor/core";
+option go_package = "github.com/dxos/kube/proto/def/dxos/service/supervisor";
 
 //
 // Basic methods to operate with KUBE core, inc. authentication & configuration.

package/src/proto/example/testing/rpc.proto

@@ -9,6 +9,8 @@ import "google/protobuf/empty.proto";
 
 package example.testing.rpc;
 
+option go_package = "github.com/dxos/kube/proto/def/example/testing/rpc";
+
 message TestRpcRequest {
   string data = 1;
 }

package/src/proto/gen/dxos/bot.ts

@@ -42,7 +42,6 @@ import * as dxos_mesh_teleport_replicator from "./mesh/teleport/replicator";
 import * as dxos_registry from "./registry";
 import * as dxos_rpc from "./rpc";
 import * as dxos_service_publisher from "./service/publisher";
-import * as dxos_service_scheduler from "./service/scheduler";
 import * as dxos_service_supervisor from "./service/supervisor";
 import * as dxos_type from "./type";
 import * as example_testing_data from "../example/testing/data";