@dxos/protocols 2.33.6 → 2.33.7-dev.40cf0994

package/src/proto/dxos/devtools.proto

@@ -8,17 +8,22 @@ package dxos.devtools;
 
 import "google/protobuf/empty.proto";
 import "google/protobuf/timestamp.proto";
+
 import "./echo/feed.proto";
 import "./echo/snapshot.proto";
 import "./halo/keys.proto";
 import "./halo/signed.proto";
 import "./rpc.proto";
 
+//
+// DevtoolsHost
+//
+
 service DevtoolsHost {
   //
   // General
   //
-  
+
   // Subscribe to server-to-client events.
   rpc Events(google.protobuf.Empty) returns (stream Event);
 
@@ -28,7 +33,6 @@ service DevtoolsHost {
   rpc ResetStorage(ResetStorageRequest) returns (google.protobuf.Empty);
 
   rpc EnableDebugLogging(EnableDebugLoggingRequest) returns (EnableDebugLoggingResponse);
-
   rpc DisableDebugLogging(EnableDebugLoggingRequest) returns (EnableDebugLoggingResponse);
 
   //
@@ -44,12 +48,9 @@ service DevtoolsHost {
   //
 
   rpc SubscribeToParties(SubscribeToPartiesRequest) returns (stream SubscribeToPartiesResponse);
-
   rpc SubscribeToItems(SubscribeToItemsRequest) returns (stream SubscribeToItemsResponse);
-
   rpc SubscribeToFeeds(SubscribeToFeedsRequest) returns (stream SubscribeToFeedsResponse);
-
-  rpc SubscribeToFeed(SubscribeToFeedRequest) returns (stream SubscribeToFeedResponse);
+  rpc SubscribeToFeedBlocks(SubscribeToFeedBlocksRequest) returns (stream SubscribeToFeedBlocksResponse);
 
   rpc GetPartySnapshot(GetPartySnapshotRequest) returns (GetPartySnapshotResponse);
   rpc SavePartySnapshot(SavePartySnapshotRequest) returns (SavePartySnapshotResponse);
@@ -60,13 +61,9 @@ service DevtoolsHost {
   //
 
   rpc GetNetworkPeers(GetNetworkPeersRequest) returns (GetNetworkPeersResponse);
-
   rpc SubscribeToNetworkTopics(google.protobuf.Empty) returns (stream SubscribeToNetworkTopicsResponse);
-
   rpc SubscribeToSignalStatus(google.protobuf.Empty) returns (stream SubscribeToSignalStatusResponse);
-
   rpc SubscribeToSignalTrace(google.protobuf.Empty) returns (stream SubscribeToSignalTraceResponse);
-
   rpc SubscribeToSwarmInfo(SubscribeToSwarmInfoRequest) returns (stream SubscribeToSwarmInfoResponse);
 }
 
@@ -83,6 +80,8 @@ message GetConfigResponse {
   string config = 1;
 }
 
+// EnableDebugLogging
+
 message EnableDebugLoggingRequest {
   string namespaces = 1;
 }
@@ -91,6 +90,8 @@ message EnableDebugLoggingResponse {
   string enabledNamespaces = 1;
 }
 
+// DisableDebugLogging
+
 message DisableDebugLoggingRequest {
   string namespaces = 1;
 }
@@ -99,12 +100,16 @@ message DisableDebugLoggingResponse {
   string enabledNamespaces = 1;
 }
 
+// SubscribeToKeyringKeys
+
 message SubscribeToKeyringKeysRequest {}
 
 message SubscribeToKeyringKeysResponse {
   repeated KeyRecord keys = 1;
 }
 
+// SubscribeToCredential
+
 message SubscribeToCredentialMessagesRequest {
   PubKey partyKey = 1;
 }
@@ -113,8 +118,12 @@ message SubscribeToCredentialMessagesResponse {
   repeated SignedMessage messages = 1;
 }
 
+// ResetStorage
+
 message ResetStorageRequest {}
 
+// GetNetworkPeers
+
 message GetNetworkPeersRequest {
   bytes topic = 1;
 }
@@ -125,29 +134,34 @@ message GetNetworkPeersResponse {
 
     // PeerState enum.
     string state = 2;
-  
+
     repeated bytes connections = 3;
   }
 
   repeated PeerInfo peers = 1;
 }
 
-message SubscribeToPartiesRequest {}
+// SubscribeToParties
+
+message SubscribeToPartiesRequest {
+  repeated PubKey partyKeys = 1;
+}
 
 message SubscribeToPartiesResponse {
   message PartyInfo {
-    string key = 1;
+    PubKey key = 1;
     bool isOpen = 2;
     bool isActive = 3;
-    int32 feedKeys = 4;
-    map<string, string> properties = 5;
-
-    TimeframeVector timeframe = 10;
+    TimeframeVector timeframe = 4;
+    repeated PubKey feeds = 5;
+    map<string, string> properties = 6;
   }
 
   repeated PartyInfo parties = 1;
 }
 
+// SubscribeToItems
+
 message SubscribeToItemsRequest {}
 
 message SubscribeToItemsResponse {
@@ -155,24 +169,32 @@ message SubscribeToItemsResponse {
   string data = 1;
 }
 
-message SubscribeToFeedsRequest {}
+// SubscribeToFeeds
+
+message SubscribeToFeedsRequest {
+  PubKey partyKey = 1;
+  repeated PubKey feedKeys = 2;
+}
 
 message SubscribeToFeedsResponse {
-  message Party {
-    PubKey key = 1;
-    repeated PubKey feeds = 2;
+  message Feed {
+    PubKey feedKey = 1;
+    int32 length = 2;
   }
 
-  repeated Party parties = 1;
+  repeated Feed feeds = 1;
 }
 
-message SubscribeToFeedRequest {
+// SubscribeToFeedMessages
+
+message SubscribeToFeedBlocksRequest {
   PubKey partyKey = 1;
   PubKey feedKey = 2;
+  int32 maxBlocks = 3;
 }
 
-message SubscribeToFeedResponse {
-  message EchoFeedBlock {
+message SubscribeToFeedBlocksResponse {
+  message Block {
     bytes key = 1;
     int32 seq = 2;
     bool sync = 3;
@@ -180,9 +202,11 @@ message SubscribeToFeedResponse {
     FeedMessage data = 5;
   }
 
-  repeated EchoFeedBlock blocks = 1;
+  repeated Block blocks = 1;
 }
 
+// GetPartySnapshot
+
 message GetPartySnapshotRequest {
   required PubKey partyKey = 1;
 }
@@ -191,6 +215,8 @@ message GetPartySnapshotResponse {
   PartySnapshot snapshot = 1;
 }
 
+// SavePartySnapshot
+
 message SavePartySnapshotRequest {
   required PubKey partyKey = 1;
 }
@@ -199,8 +225,12 @@ message SavePartySnapshotResponse {
   PartySnapshot snapshot = 1;
 }
 
+// ClearSnapshots
+
 message ClearSnapshotsRequest {}
 
+// SubscribeToNetworkTopics
+
 message SubscribeToNetworkTopicsResponse {
   message Topic {
     PubKey topic = 1;
@@ -210,16 +240,18 @@ message SubscribeToNetworkTopicsResponse {
   repeated Topic topics = 1;
 }
 
+// SubscribeToSignalStatus
+
 message SubscribeToSignalStatusResponse {
   message SignalServer {
     string host = 1;
 
     // SignalApi.State enum.
     string state = 2;
-    
+
     string error = 3;
 
-    // Number of milliseconds before reconnection. 
+    // Number of milliseconds before reconnection.
     // TODO(dmaretskyi): Represent as absolute timestamp.
     int32 reconnectIn = 4;
 
@@ -231,11 +263,15 @@ message SubscribeToSignalStatusResponse {
   repeated SignalServer servers = 1;
 }
 
+// SubscribeToSignalTrace
+
 message SubscribeToSignalTraceResponse {
   // JSON-encoded events.
   repeated string events = 1;
 }
 
+// SubscribeToSwarmInfo
+
 message SubscribeToSwarmInfoRequest {}
 
 message SubscribeToSwarmInfoResponse {
@@ -261,11 +297,17 @@ message SubscribeToSwarmInfoResponse {
   repeated SwarmInfo data = 1;
 }
 
-message SetTracingOptionsRequest {
-  bool enable = 1;
-}
+//
+// TracingService
+//
 
 service TracingService {
   rpc SetTracingOptions(SetTracingOptionsRequest) returns (google.protobuf.Empty);
   rpc SubscribeToRpcTrace (google.protobuf.Empty) returns (stream RpcMessage);
-}
+}
+
+// SetTracingOptions
+
+message SetTracingOptionsRequest {
+  bool enable = 1;
+}

package/src/proto/dxos/halo/keys.proto

@@ -31,43 +31,43 @@ message PrivKey {
 
 message KeyRecord {
   /**
-   * - The `KeyType` type of the key. This is often unknown for keys from other sources.
+   * The `KeyType` type of the key. This is often unknown for keys from other sources.
    */
   required KeyType type = 1;
 
   /**
-   * - The public key as a Buffer (required).
+   * The public key as a Buffer (required).
    */
   required PubKey publicKey = 2;
 
   /**
-   * - The secret key as a Buffer (this will never be visible outside the Keyring).
+   * The secret key as a Buffer (this will never be visible outside the Keyring).
    */
   PrivKey secretKey = 3;
 
   /**
-   * - Is this key from a Greeting "hint"?
+   * Is this key from a Greeting "hint"?
    */
   bool hint = 4;
 
   /**
-   * - Is this our key? Usually true if `secretKey` is present,
-   *          may be false for "inception keys" such as the Party key.
+   * Determines if this is our key?
+   * Usually true if `secretKey` is present; may be false for "inception keys" such as the Party key.
    */
-  bool own = 5;
+  bool own = 5; // TODO(burdon): Rename "local" or "private".
 
   /**
-   * - Is this key to be trusted?
+   * Is this key to be trusted?
    */
-  bool trusted = 6;
+  bool trusted = 6; // TODO(burdon): Rename "trust". How is this determined?
 
   /**
-   * - An RFC-3339 date/time string for when the key was added to the Keyring.
+   * An RFC-3339 date/time string for when the key was added to the Keyring.
    */
   string added = 7;
 
   /**
-   * - An RFC-3339 date/time string for when the key was created.
+   * An RFC-3339 date/time string for when the key was created.
    */
   string created = 8;
 }

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

@@ -27,7 +27,7 @@ export interface DevtoolsHost {
     subscribeToParties: (request: SubscribeToPartiesRequest) => Stream<SubscribeToPartiesResponse>;
     subscribeToItems: (request: SubscribeToItemsRequest) => Stream<SubscribeToItemsResponse>;
     subscribeToFeeds: (request: SubscribeToFeedsRequest) => Stream<SubscribeToFeedsResponse>;
-    subscribeToFeed: (request: SubscribeToFeedRequest) => Stream<SubscribeToFeedResponse>;
+    subscribeToFeedBlocks: (request: SubscribeToFeedBlocksRequest) => Stream<SubscribeToFeedBlocksResponse>;
     getPartySnapshot: (request: GetPartySnapshotRequest) => Promise<GetPartySnapshotResponse>;
     savePartySnapshot: (request: SavePartySnapshotRequest) => Promise<SavePartySnapshotResponse>;
     clearSnapshots: (request: ClearSnapshotsRequest) => Promise<void>;
@@ -84,18 +84,19 @@ export namespace GetNetworkPeersResponse {
     }
 }
 export interface SubscribeToPartiesRequest {
+    partyKeys?: dxos_halo_keys.PubKey[];
 }
 export interface SubscribeToPartiesResponse {
     parties?: SubscribeToPartiesResponse.PartyInfo[];
 }
 export namespace SubscribeToPartiesResponse {
     export interface PartyInfo {
-        key?: string;
+        key?: dxos_halo_keys.PubKey;
         isOpen?: boolean;
         isActive?: boolean;
-        feedKeys?: number;
-        properties?: Partial<Record<string, string>>;
         timeframe?: dxos_echo_timeframe.TimeframeVector;
+        feeds?: dxos_halo_keys.PubKey[];
+        properties?: Partial<Record<string, string>>;
     }
 }
 export interface SubscribeToItemsRequest {
@@ -104,25 +105,28 @@ export interface SubscribeToItemsResponse {
     data?: string;
 }
 export interface SubscribeToFeedsRequest {
+    partyKey?: dxos_halo_keys.PubKey;
+    feedKeys?: dxos_halo_keys.PubKey[];
 }
 export interface SubscribeToFeedsResponse {
-    parties?: SubscribeToFeedsResponse.Party[];
+    feeds?: SubscribeToFeedsResponse.Feed[];
 }
 export namespace SubscribeToFeedsResponse {
-    export interface Party {
-        key?: dxos_halo_keys.PubKey;
-        feeds?: dxos_halo_keys.PubKey[];
+    export interface Feed {
+        feedKey?: dxos_halo_keys.PubKey;
+        length?: number;
     }
 }
-export interface SubscribeToFeedRequest {
+export interface SubscribeToFeedBlocksRequest {
     partyKey?: dxos_halo_keys.PubKey;
     feedKey?: dxos_halo_keys.PubKey;
+    maxBlocks?: number;
 }
-export interface SubscribeToFeedResponse {
-    blocks?: SubscribeToFeedResponse.EchoFeedBlock[];
+export interface SubscribeToFeedBlocksResponse {
+    blocks?: SubscribeToFeedBlocksResponse.Block[];
 }
-export namespace SubscribeToFeedResponse {
-    export interface EchoFeedBlock {
+export namespace SubscribeToFeedBlocksResponse {
+    export interface Block {
         key?: Uint8Array;
         seq?: number;
         sync?: boolean;
@@ -198,10 +202,10 @@ export namespace SubscribeToSwarmInfoResponse {
         }
     }
 }
-export interface SetTracingOptionsRequest {
-    enable?: boolean;
-}
 export interface TracingService {
     setTracingOptions: (request: SetTracingOptionsRequest) => Promise<void>;
     subscribeToRpcTrace: (request: void) => Stream<dxos_rpc.RpcMessage>;
 }
+export interface SetTracingOptionsRequest {
+    enable?: boolean;
+}

package/src/proto/gen/dxos/halo/keys.ts

@@ -32,36 +32,36 @@ export interface PrivKey {
 }
 export interface KeyRecord {
     /**
-     * - The `KeyType` type of the key. This is often unknown for keys from other sources.
+     * The `KeyType` type of the key. This is often unknown for keys from other sources.
      */
     type: KeyType;
     /**
-     * - The public key as a Buffer (required).
+     * The public key as a Buffer (required).
      */
     publicKey: PubKey;
     /**
-     * - The secret key as a Buffer (this will never be visible outside the Keyring).
+     * The secret key as a Buffer (this will never be visible outside the Keyring).
      */
     secretKey?: PrivKey;
     /**
-     * - Is this key from a Greeting "hint"?
+     * Is this key from a Greeting "hint"?
      */
     hint?: boolean;
     /**
-     * - Is this our key? Usually true if `secretKey` is present,
-     * may be false for "inception keys" such as the Party key.
+     * Determines if this is our key?
+     * Usually true if `secretKey` is present; may be false for "inception keys" such as the Party key.
      */
     own?: boolean;
     /**
-     * - Is this key to be trusted?
+     * Is this key to be trusted?
      */
     trusted?: boolean;
     /**
-     * - An RFC-3339 date/time string for when the key was added to the Keyring.
+     * An RFC-3339 date/time string for when the key was added to the Keyring.
      */
     added?: string;
     /**
-     * - An RFC-3339 date/time string for when the key was created.
+     * An RFC-3339 date/time string for when the key was created.
      */
     created?: string;
 }