@dxos/protocols 0.1.23 → 0.1.24

package/src/proto/dxos/echo/feed.proto

@@ -9,6 +9,7 @@ import "google/protobuf/any.proto";
 import "dxos/halo/credentials.proto";
 import "dxos/echo/snapshot.proto";
 import "dxos/echo/timeframe.proto";
+import "dxos/echo/object.proto";
 
 // TODO(burdon): Standardize position of "package" (i.e., before/after imports).
 // TODO(burdon): Move Item specific to echo.item?
@@ -20,7 +21,14 @@ package dxos.echo.feed;
  */
 message FeedMessage {
   dxos.echo.timeframe.TimeframeVector timeframe = 1;
-  google.protobuf.Any payload = 2;
+
+  message Payload{
+    oneof payload {
+      CredentialsMessage credential = 10;
+      DataMessage data = 11;
+    }
+  }
+  Payload payload = 2;
 }
 
 /**
@@ -31,53 +39,9 @@ message CredentialsMessage {
 }
 
 /**
- * Wrapper for all ECHO messages.
- */
-// TODO(burdon): Reconcile with HaloMessage (and other "Message" types).
-message EchoEnvelope {
-  string item_id = 1;
-
-  // Create item.
-  optional ItemGenesis genesis = 10;
-
-  // Item system mutations.
-  optional ItemMutation item_mutation = 11;
-
-  // Model-specific mutations.
-  optional bytes mutation = 12;
-
-  /// Set the model to the provided snapshot.
-  optional snapshot.ModelSnapshot snapshot = 13;
-}
-
-// TODO(burdon): Document (different from parent/child).?
-// TODO(dmaretskyi): Refactor so that entity mutation message is oneof between item mutation and link mutation: items have parents, and links have from/to.
-message LinkData {
-  string source = 1;
-  string target = 2;
-}
-
-/**
- * Item creation.
+ * A container ECHO database messages in data feeds.
  */
-// TODO(burdon): EntityGenesis?
-message ItemGenesis {
-  optional string item_type = 1;
-  string model_type = 2;
-  optional string model_version = 3;
-  optional LinkData link = 4;
-}
-
-/**
- * Item mutation.
- */
-message ItemMutation {
-  enum Action {
-    NOOP = 0;
-    DELETE = 1;
-    RESTORE = 2;
-  }
-
-  optional string parent_id = 1;  // TODO(burdon): Define Action type?
-  optional Action action = 2;
+message DataMessage {
+  // TODO(dmaretskyi): Batch.
+  dxos.echo.object.EchoObject object = 1;
 }

package/src/proto/dxos/echo/metadata.proto

@@ -46,8 +46,12 @@ message SpaceMetadata {
   /// Key of the wriatable data feed.
   optional dxos.keys.PublicKey data_feed_key = 3;
 
-  // Latest timeframe reached while processing space messages.
-  optional timeframe.TimeframeVector latest_timeframe = 5;
+
+  // Latest control timeframe reached while processing space messages.
+  optional timeframe.TimeframeVector control_timeframe = 8;
+
+  // Latest data timeframe reached while processing space messages.
+  optional timeframe.TimeframeVector data_timeframe = 5;
 
   optional string snapshot = 7;
 }

package/src/proto/dxos/echo/model/{object.proto → document.proto}

@@ -4,7 +4,7 @@
 
 syntax = "proto3";
 
-package dxos.echo.model.object;
+package dxos.echo.model.document;
 
 //
 // Object mutation messages.
@@ -106,7 +106,8 @@ message Query {
  * State snapshot.
  */
 message ObjectSnapshot {
-  Value root                          = 1;
+  optional string type                = 1;
+  Value root                          = 2;
 }
 
 /**
@@ -138,5 +139,6 @@ message YJS {
  * Set of mutations.
  */
 message ObjectMutationSet {
-  repeated ObjectMutation mutations   = 1;
+  optional string type = 1;
+  repeated ObjectMutation mutations   = 2;
 }

package/src/proto/dxos/echo/object.proto

@@ -0,0 +1,79 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/any.proto";
+
+import "dxos/halo/credentials.proto";
+import "dxos/echo/timeframe.proto";
+
+package dxos.echo.object;
+
+/**
+ * Wrapper for all ECHO messages.
+ */
+message EchoObject {
+  message Genesis {
+    string model_type = 2;
+
+    optional string model_version = 3;
+  }
+
+  message Snapshot {
+    // TODO(dmaretskyi): Change to enum?
+    optional bool deleted = 1; 
+
+    optional string parent_id = 2;
+
+    /// Set the model to the provided snapshot.
+    optional google.protobuf.Any model = 10 [preserve_any = true]; 
+  }
+
+  message Mutation {
+    optional MutationMeta meta = 1;
+
+    enum Action {
+      NOOP = 0;
+      DELETE = 1;
+      RESTORE = 2;
+    }
+
+    /// Set parent id
+    optional string parent_id = 10;
+    
+    optional Action action = 11;
+
+    // Encoded model mutation, format is defined by model's codec.
+    optional google.protobuf.Any model = 12 [preserve_any = true];
+  }
+
+  string object_id = 1;
+
+  /// Metadata for the genesis mutation.
+  optional MutationMeta meta = 2;
+
+  /// Present in mutations creating new items and snapshots. 
+  optional Genesis genesis = 10;
+
+  optional Snapshot snapshot = 13;
+  
+  /// May be present in snapshots. In that case the mutations must be applied on top of the snapshot.
+  repeated Mutation mutations = 14;
+}
+
+message MutationMeta {
+  optional dxos.keys.PublicKey feed_key = 1;
+  optional int32 seq = 2;
+  optional dxos.keys.PublicKey member_key = 3;
+
+  optional timeframe.TimeframeVector timeframe = 4;
+
+  /// If this mutation was created by this client, this field will be set to the tag in the mutation.
+  optional string client_tag = 5;
+}
+
+message EchoObjectBatch {
+  repeated EchoObject objects = 1;
+}

package/src/proto/dxos/echo/service.proto

@@ -4,51 +4,35 @@
 
 syntax = "proto3";
 
-import "dxos/echo/feed.proto";
+import "dxos/echo/object.proto";
 import "dxos/echo/snapshot.proto";
 import "dxos/echo/timeframe.proto";
 import "dxos/keys.proto";
 
 package dxos.echo.service;
 
-message SubscribeEntitySetRequest {
+message SubscribeRequest {
   dxos.keys.PublicKey space_key = 1;
 }
 
-message SubscribeEntitySetResponse {
-  // TODO(dmaretskyi): This is wrong, the first one should use item snapshot, and deleted should be just list of ids.
-  repeated feed.EchoEnvelope added = 1;
-  repeated feed.EchoEnvelope deleted = 2;
-}
+message EchoEvent {
+  /// If this event comes as a response to this client wirting the mutation, this field will be set to the tag in the mutation.
+  optional string client_tag = 1;
 
-message SubscribeEntityStreamRequest {
-  dxos.keys.PublicKey space_key = 1;
-  string item_id = 2;
-}
+  /// For mutations read from the feed store those fields will be set to the position of the mutation in the feed.
+  optional dxos.keys.PublicKey feed_key = 2;
+  optional int32 seq = 3;
 
-message SubscribeEntityStreamResponse {
-  message Mutation {
-    message Metadata {
-     dxos.keys.PublicKey feed_key = 1;
-     dxos.keys.PublicKey member_key = 2;
-      int32 seq = 3;
-      timeframe.TimeframeVector timeframe = 4;
-    }
-
-    feed.EchoEnvelope data = 1;
-    Metadata meta = 2;
-  }
-
-  oneof kind {
-    // TODO(dmaretskyi): Move snapshot into EchoEnvelope?
-    snapshot.ItemSnapshot snapshot = 1;
-    Mutation mutation = 2;
-  }
+  dxos.echo.object.EchoObjectBatch batch = 10;
 }
 
 message WriteRequest {
   dxos.keys.PublicKey space_key = 1;
-  feed.EchoEnvelope mutation = 2;
+  
+  /// Ephermal tag to correlate events in the subscription.
+  optional string client_tag = 2;
+
+  dxos.echo.object.EchoObjectBatch batch = 10;
 }
 
 message MutationReceipt {
@@ -57,7 +41,6 @@ message MutationReceipt {
 }
 
 service DataService {
-  rpc SubscribeEntitySet(SubscribeEntitySetRequest) returns (stream SubscribeEntitySetResponse);
-  rpc SubscribeEntityStream(SubscribeEntityStreamRequest) returns (stream SubscribeEntityStreamResponse);
+  rpc Subscribe(SubscribeRequest) returns (stream EchoEvent);
   rpc Write(WriteRequest) returns (MutationReceipt); // TODO(burdon): Rename SubmitMutation.
 }

package/src/proto/dxos/echo/snapshot.proto

@@ -5,20 +5,20 @@
 syntax = "proto3";
 
 import "dxos/echo/timeframe.proto";
+import "dxos/echo/object.proto";
 import "dxos/halo/signed.proto";
 import "dxos/keys.proto";
 
 package dxos.echo.snapshot;
 
-//
-// Snapshots define full space state at a given point in time.
-// They must have enough information to be able to recover the space state without reading the feed messages.
-//
-// Each snapshot is identified by a space key and a timeframe.
-// The timeframe defines the set of feed messages that have already been processed.
-// When loading from the snapshot, application would skip all of the feed messages up to (and including) the provided timeframe.
-//
-
+/**
+ * Snapshots define full space state at a given point in time.
+ * They must have enough information to be able to recover the space state without reading the feed messages.
+ *
+ * Each snapshot is identified by a space key and a timeframe.
+ * The timeframe defines the set of feed messages that have already been processed.
+ * When loading from the snapshot, application would skip all of the feed messages up to (and including) the provided timeframe.
+ */
 message SpaceSnapshot {
   bytes space_key = 1;
   optional timeframe.TimeframeVector timeframe = 2;
@@ -27,72 +27,12 @@ message SpaceSnapshot {
   // TODO(dmaretskyi): Convert to google.protobuf.Timestamp.
   optional int32 timestamp = 3;
 
-  optional HaloStateSnapshot halo = 11;
-  // TODO(dmaretskyi): Rename to EchoSnapshot.
-  DatabaseSnapshot database = 12;
-}
-
-// TODO(dmaretskyi): Rename to HaloSnapshot.
-// For now we just store and replay a list of all halo messages as thier number is expected to be relatively low.
-message HaloStateSnapshot {
-  repeated dxos.halo.signed.Message messages = 1;
-}
-
-//
-// Database Snapshot
-//
-
-message DatabaseSnapshot {
-  repeated ItemSnapshot items = 1;
-  repeated LinkSnapshot links = 2;
-}
-
-message ItemSnapshot {
-  optional string item_id = 1;
-  optional string item_type = 2;
-  string model_type = 3;
-  optional string model_version = 4;
-  optional string parent_id = 5;
-  optional ModelSnapshot model = 6;
-}
-
-message LinkSnapshot {
-  optional string link_id = 1;
-  optional string link_type = 2;
-  string model_type = 3;
-  optional string model_version = 4;
-  string source = 5;
-  string target = 6;
-  optional ModelSnapshot model = 7;
+  EchoSnapshot database = 11;
 }
 
 /**
- * Represents the reified state of a state machine.
- * The snapshots make consist of a custom snapshot object and/or a list of mutations
- * that are applied to the snapshot or the initial state.
+ * Database Snapshot
  */
-// TODO(burdon): Rename?
-message ModelSnapshot {
-  /**
-   * Encoded model snapshot (defined by the model's codec).
-   * If undefined the state machine will be initialized with it's default state.
-   */
-  optional bytes snapshot = 1;
-
-  /**
-   * Mutations to be applied on top of the snapshot, or on top of initial state if the snapshot is undefined.
-   */
-  repeated ModelMutation mutations = 2;
-}
-
-message ModelMutation {
-  // Encoded model mutation, format is defined by model's codec.
-  bytes mutation = 1;
-  ModelMutationMeta meta = 2;
-}
-
-message ModelMutationMeta {
-  dxos.keys.PublicKey feed_key = 1;
-  int32 seq = 2;
-  dxos.keys.PublicKey member_key = 3;
+message EchoSnapshot {
+  repeated object.EchoObject items = 1;
 }

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

@@ -8,6 +8,7 @@ import "google/protobuf/empty.proto";
 
 import "dxos/halo/credentials.proto";
 import "dxos/keys.proto";
+import "dxos/echo/timeframe.proto";
 
 package dxos.halo.invitations;
 
@@ -73,6 +74,9 @@ message SpaceAdmissionRequest {
 message SpaceAdmissionCredentials {
   /// Credential of type `SpaceMember` that grants Guest's identity access to the space.
   dxos.halo.credentials.Credential credential = 1;
+
+  optional dxos.echo.timeframe.TimeframeVector control_timeframe = 2;
+  optional dxos.echo.timeframe.TimeframeVector data_timeframe = 3;
 }
 
 service SpaceHostService {

package/src/proto/dxos/mesh/teleport/notarization.proto

@@ -0,0 +1,28 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+import "dxos/keys.proto";
+import "dxos/halo/credentials.proto";
+
+package dxos.mesh.teleport.notarization;
+
+message NotarizeRequest {
+  /**
+   * Write specified credentials to the control feed of the space.
+   * Credentials with ids that are already present in the control pipeline must be skipped.
+   */
+  repeated dxos.halo.credentials.Credential credentials = 1;
+}
+
+/**
+ * Allows peers to request their credentials be written to the control feed.
+ * Useful for new devices bootstraping their feeds into the space.
+ */
+service NotarizationService {
+  rpc Notarize(NotarizeRequest) returns (google.protobuf.Empty);
+}
+

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

@@ -7,9 +7,10 @@ import * as dxos_devtools_host from "./devtools/host";
 import * as dxos_devtools_swarm from "./devtools/swarm";
 import * as dxos_echo_feed from "./echo/feed";
 import * as dxos_echo_metadata from "./echo/metadata";
+import * as dxos_echo_model_document from "./echo/model/document";
 import * as dxos_echo_model_messenger from "./echo/model/messenger";
-import * as dxos_echo_model_object from "./echo/model/object";
 import * as dxos_echo_model_text from "./echo/model/text";
+import * as dxos_echo_object from "./echo/object";
 import * as dxos_echo_service from "./echo/service";
 import * as dxos_echo_snapshot from "./echo/snapshot";
 import * as dxos_echo_timeframe from "./echo/timeframe";
@@ -35,6 +36,7 @@ import * as dxos_mesh_signal from "./mesh/signal";
 import * as dxos_mesh_swarm from "./mesh/swarm";
 import * as dxos_mesh_teleport_auth from "./mesh/teleport/auth";
 import * as dxos_mesh_teleport_control from "./mesh/teleport/control";
+import * as dxos_mesh_teleport_notarization from "./mesh/teleport/notarization";
 import * as dxos_mesh_teleport_objectsync from "./mesh/teleport/objectsync";
 import * as dxos_mesh_teleport_presence from "./mesh/teleport/presence";
 import * as dxos_mesh_teleport_replicator from "./mesh/teleport/replicator";

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

@@ -7,9 +7,10 @@ import * as dxos_devtools_host from "../devtools/host";
 import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_metadata from "../echo/metadata";
+import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";
-import * as dxos_echo_model_object from "../echo/model/object";
 import * as dxos_echo_model_text from "../echo/model/text";
+import * as dxos_echo_object from "../echo/object";
 import * as dxos_echo_service from "../echo/service";
 import * as dxos_echo_snapshot from "../echo/snapshot";
 import * as dxos_echo_timeframe from "../echo/timeframe";
@@ -35,6 +36,7 @@ import * as dxos_mesh_signal from "../mesh/signal";
 import * as dxos_mesh_swarm from "../mesh/swarm";
 import * as dxos_mesh_teleport_auth from "../mesh/teleport/auth";
 import * as dxos_mesh_teleport_control from "../mesh/teleport/control";
+import * as dxos_mesh_teleport_notarization from "../mesh/teleport/notarization";
 import * as dxos_mesh_teleport_objectsync from "../mesh/teleport/objectsync";
 import * as dxos_mesh_teleport_presence from "../mesh/teleport/presence";
 import * as dxos_mesh_teleport_replicator from "../mesh/teleport/replicator";
@@ -165,6 +167,14 @@ export interface QueryMembersRequest {
 export interface QueryMembersResponse {
     members: dxos_halo_credentials.IdentityProfile;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface WriteCredentialsRequest {
+    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    credentials?: dxos_halo_credentials.Credential[];
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -180,6 +190,7 @@ export interface SpacesService {
     createSpace: (request: void) => Promise<Space>;
     querySpaces: (request: void) => Stream<Space>;
     queryMembers: (request: QueryMembersRequest) => Stream<QueryMembersResponse>;
+    writeCredentials: (request: WriteCredentialsRequest) => Promise<void>;
     queryCredentials: (request: QueryCredentialsRequest) => Stream<dxos_halo_credentials.Credential>;
 }
 /**

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

@@ -7,9 +7,10 @@ import * as dxos_devtools_host from "./devtools/host";
 import * as dxos_devtools_swarm from "./devtools/swarm";
 import * as dxos_echo_feed from "./echo/feed";
 import * as dxos_echo_metadata from "./echo/metadata";
+import * as dxos_echo_model_document from "./echo/model/document";
 import * as dxos_echo_model_messenger from "./echo/model/messenger";
-import * as dxos_echo_model_object from "./echo/model/object";
 import * as dxos_echo_model_text from "./echo/model/text";
+import * as dxos_echo_object from "./echo/object";
 import * as dxos_echo_service from "./echo/service";
 import * as dxos_echo_snapshot from "./echo/snapshot";
 import * as dxos_echo_timeframe from "./echo/timeframe";
@@ -35,6 +36,7 @@ import * as dxos_mesh_signal from "./mesh/signal";
 import * as dxos_mesh_swarm from "./mesh/swarm";
 import * as dxos_mesh_teleport_auth from "./mesh/teleport/auth";
 import * as dxos_mesh_teleport_control from "./mesh/teleport/control";
+import * as dxos_mesh_teleport_notarization from "./mesh/teleport/notarization";
 import * as dxos_mesh_teleport_objectsync from "./mesh/teleport/objectsync";
 import * as dxos_mesh_teleport_presence from "./mesh/teleport/presence";
 import * as dxos_mesh_teleport_replicator from "./mesh/teleport/replicator";
@@ -50,8 +52,27 @@ import * as google_protobuf from "../google/protobuf";
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
-export interface Status {
-    message: string;
+export enum Status {
+    ACTIVE = 0,
+    INACTIVE = 1
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface StatusResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    status?: Status;
+    /**
+     * Deprecated, use `status` instead.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    message?: string;
 }
 /**
  * Defined in:
@@ -63,7 +84,7 @@ export interface SystemService {
      */
     initSession: (request: void) => Promise<void>;
     getConfig: (request: void) => Promise<dxos_config.Config>;
-    getStatus: (request: void) => Promise<Status>;
+    getStatus: (request: void) => Promise<StatusResponse>;
     reset: (request: void) => Promise<void>;
 }
 /**
@@ -148,6 +169,11 @@ export interface Profile {
      *   - proto3_optional = true
      */
     deviceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    haloSpace?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:
@@ -207,6 +233,18 @@ export interface Contact {
 export interface Contacts {
     contacts?: Contact[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SignPresentationRequest {
+    presentation: dxos_halo_credentials.Presentation;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    nonce?: Uint8Array;
+}
 /**
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
@@ -215,6 +253,7 @@ export interface ProfileService {
     createProfile: (request: CreateProfileRequest) => Promise<Profile>;
     recoverProfile: (request: RecoverProfileRequest) => Promise<Profile>;
     subscribeProfile: (request: void) => Stream<SubscribeProfileResponse>;
+    signPresentation: (request: SignPresentationRequest) => Promise<dxos_halo_credentials.Presentation>;
 }
 /**
  * Defined in: