@dxos/protocols 2.33.9-dev.7d11f506 → 2.33.9-dev.9bbef4e2

package/src/proto/dxos/client.proto

@@ -5,7 +5,8 @@
 syntax = "proto3";
 
 import "google/protobuf/empty.proto";
-import "config.proto";
+
+import "./config.proto";
 import "./echo/invitation.proto";
 import "./echo/snapshot.proto";
 import "./halo/keys.proto";
@@ -34,12 +35,12 @@ enum InvitationState {
 
 /// Invitation process created by sender.
 message InvitationRequest {
-  InvitationDescriptor descriptor = 1;
+  optional InvitationDescriptor descriptor = 1;
 
   InvitationState state = 2;
 
   /// Only if state == ERROR.
-  string error = 3;
+  optional string error = 3;
 }
 
 /// Invitation that is being redeemed.
@@ -49,10 +50,10 @@ message RedeemedInvitation {
   InvitationState state = 2;
 
   /// Only if state == ERROR.
-  string error = 3;
+  optional string error = 3;
 
   /// Only on party invitations that are finished.
-  dxos.halo.keys.PubKey partyKey = 4;
+  optional dxos.halo.keys.PubKey partyKey = 4;
 }
 
 message AuthenticateInvitationRequest {
@@ -67,17 +68,17 @@ message AuthenticateInvitationRequest {
 
 message Profile {
   required dxos.halo.keys.PubKey publicKey = 1;
-  string username = 2;
+  optional string username = 2;
 }
 
 message SubscribeProfileResponse {
-  Profile profile = 1;
+  optional Profile profile = 1;
 }
 
 message CreateProfileRequest {
-  string username = 1;
-  bytes publicKey = 2;
-  bytes secretKey = 3;
+  optional string username = 1;
+  optional bytes publicKey = 2;
+  optional bytes secretKey = 3;
 }
 
 message RecoverProfileRequest {
@@ -86,7 +87,7 @@ message RecoverProfileRequest {
 
 message Contact {
   dxos.halo.keys.PubKey publicKey = 1;
-  string displayName = 2;
+  optional string displayName = 2;
 }
 
 message Contacts {
@@ -154,7 +155,7 @@ service HaloService {
 message Party {
   message Member {
     required dxos.halo.keys.PubKey publicKey = 1;
-    string displayName = 2;
+    optional string displayName = 2;
   }
 
   required dxos.halo.keys.PubKey publicKey = 1;
@@ -179,7 +180,7 @@ message PartyDetails {
 }
 
 message SubscribePartyResponse {
-  Party party = 1;
+  optional Party party = 1;
 }
 
 
@@ -191,7 +192,7 @@ message CreateInvitationRequest {
   required dxos.halo.keys.PubKey partyKey = 1;
 
   /// When specified the invitation will be of OFFLINE type, not requiring secret exchange.
-  dxos.halo.keys.PubKey inviteeKey = 2;
+  optional dxos.halo.keys.PubKey inviteeKey = 2;
 }
 
 message PartyActivationOptions {
@@ -202,9 +203,9 @@ message PartyActivationOptions {
 message SetPartyStateRequest {
   required dxos.halo.keys.PubKey partyKey = 1;
 
-  bool open = 2;
-  bool activeGlobal = 3;
-  bool activeDevice = 4;
+  optional bool open = 2;
+  optional bool activeGlobal = 3;
+  optional bool activeDevice = 4;
 }
 
 message SubscribeMembersRequest {
@@ -214,7 +215,7 @@ message SubscribeMembersRequest {
 message SubscribeMembersResponse {
   message PartyMember {
     required dxos.halo.keys.PubKey publicKey = 1;
-    string displayName = 2;
+    optional string displayName = 2;
   }
 
   repeated PartyMember members = 1;

package/src/proto/dxos/config.proto

@@ -4,61 +4,61 @@
 
 syntax = "proto3";
 
+package dxos.config;
+
 import "google/protobuf/any.proto";
 import "google/protobuf/timestamp.proto";
 import "google/protobuf/descriptor.proto";
 
-package dxos.config;
-
 message Config {
-  int32 version = 1;
+  optional int32 version = 1;
 
   //
   // Package definition.
   //
 
-  Package package = 2;
+  optional Package package = 2;
 
   //
   // Runtime configuration.
   //
 
-  Runtime runtime = 3;
+  optional Runtime runtime = 3;
 }
 
 message Package {
-  string license = 1;
+  optional string license = 1;
   repeated Repo repos = 2;
   repeated Module modules = 3;
 }
 
 // TODO(wittjosiah): Shared with registry types. Factor out?
 message Repo {
-  string name = 1;
-  string url = 2;
-  string version = 3;
+  optional string name = 1;
+  optional string url = 2;
+  optional string version = 3;
 }
 
 message Module {
   message Build {
-    string command = 1;
-    string outdir = 2;
-    string version = 3;
-    string tag = 4;
+    optional string command = 1;
+    optional string outdir = 2;
+    optional string version = 3;
+    optional string tag = 4;
   }
 
-  string name = 1;
-  string type = 2;
-  string display_name = 3;
-  string description = 4;
+  optional string name = 1;
+  optional string type = 2;
+  optional string display_name = 3;
+  optional string description = 4;
   repeated string tags = 5;
 
-  Build build = 100;
+  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.
-  google.protobuf.Any record = 200;
+  optional google.protobuf.Any record = 200;
 }
 
 message Runtime {
@@ -82,73 +82,73 @@ message Runtime {
         CHROME = 2;
         FIREFOX = 3;
         NODE = 4;
-        
+
         // Only for key storage:
 
         LEVELJS = 11;
         JSONDOWN = 12;
       }
 
-      bool persistent = 1;
-      StorageDriver storage_type = 2;
-      StorageDriver key_storage = 3;
-      string path = 4;
+      optional bool persistent = 1;
+      optional StorageDriver storage_type = 2;
+      optional StorageDriver key_storage = 3;
+      optional string path = 4;
     }
 
-    string debug = 1 [(env) = "DEBUG"];
-    Storage storage = 2;
-    bool enable_snapshots = 3;
+    optional string debug = 1 [(env) = "DEBUG"];
+    optional Storage storage = 2;
+    optional bool enable_snapshots = 3;
 
     /// Milliseconds
-    int32 snapshot_interval = 4;
+    optional int32 snapshot_interval = 4;
 
     /// Milliseconds
-    int32 invitation_expiration = 5;
+    optional int32 invitation_expiration = 5;
 
-    Mode mode = 6;
+    optional Mode mode = 6;
   }
 
   message App {
-    string org = 1;
-    string theme = 2;
-    string website = 3;
-    string public_url = 4 [(env) = "PUBLIC_URL"];
+    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 {
-        string config = 1;
-        string login_app = 2;
-        string key_phrase = 3;
+        optional string config = 1;
+        optional string login_app = 2;
+        optional string key_phrase = 3;
       }
 
-      Serve serve = 1;
+      optional Serve serve = 1;
     }
 
     message Package {
-      string package = 1;
-      string channel = 2;
-      string bin = 3;
-      string config = 4;
+      optional string package = 1;
+      optional string channel = 2;
+      optional string bin = 3;
+      optional string config = 4;
     }
 
-    string node_path = 1;
-    AppServe app = 2;
-    Package console = 3;
-    Package mdns = 4;
-    Package signal = 5;
-    string npm_client = 6;
-    string channel = 7;
+    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 {
-    string title = 1;
+    optional string title = 1;
   }
 
   message System {
-    string debug = 1;
+    optional string debug = 1;
   }
 
   //
@@ -158,91 +158,91 @@ message Runtime {
     message Kube {
 
       message Endpoints {
-        string logs = 1;
-        string services = 2;
-        string cert = 3;
+        optional string logs = 1;
+        optional string services = 2;
+        optional string cert = 3;
       }
-    
-      Endpoints endpoints = 1;
-      string public_url = 2;
+
+      optional Endpoints endpoints = 1;
+      optional string public_url = 2;
     }
 
     message AppServer {
-      string prefix = 1;
-      string server = 2;
+      optional string prefix = 1;
+      optional string server = 2;
     }
 
     message Dxns {
       /// DXNS endpoint.
-      string server = 1;
+      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.
-      */
-      string account_uri = 2;
+       * 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.
-      */
-      string address = 3;
+       */
+      optional string address = 3;
 
       /**
        * Public address of a DXNS Account.
-      */
-      string account = 4;
+       */
+      optional string account = 4;
 
-      string faucet = 5;
+      optional string faucet = 5;
     }
 
     message Ipfs {
-      string server = 1;
-      string gateway = 2;
+      optional string server = 1;
+      optional string gateway = 2;
     }
 
     message Signal {
-      string server = 1;
-      string api = 2;
-      string status = 3;
+      optional string server = 1;
+      optional string api = 2;
+      optional string status = 3;
     }
 
     message Ice {
-      string urls = 1;
-      string username = 2;
-      string credential = 3;
+      optional string urls = 1;
+      optional string username = 2;
+      optional string credential = 3;
     }
 
     message Machine {
-      string do_access_token = 1;
-      string github_access_token = 2;
-      string github_username = 3;
-      string dns_domain = 4;
-      string npm_access_token = 5;
+      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 {
-      string topic = 1;
-      bool persistent = 2;
-      int32 retry_attempts = 3;
-      int32 retry_interval = 4;
+      optional string topic = 1;
+      optional bool persistent = 2;
+      optional int32 retry_attempts = 3;
+      optional int32 retry_interval = 4;
     }
 
-    Kube kube = 1;
-    AppServer app = 2;
-    Dxns dxns = 3;
-    Ipfs ipfs = 4;
-    Signal signal = 5;
+    optional Kube kube = 1;
+    optional AppServer app = 2;
+    optional Dxns dxns = 3;
+    optional Ipfs ipfs = 4;
+    optional Signal signal = 5;
     repeated Ice ice = 6;
-    Machine machine = 7;
-    BotFactory bot = 8;
+    optional Machine machine = 7;
+    optional BotFactory bot = 8;
   }
 
-  Client client = 1;
-  App app = 2;
-  CLI cli = 3;
-  Props props = 4;
-  Services services = 5;
-  System system = 6;
+  optional Client client = 1;
+  optional App app = 2;
+  optional CLI cli = 3;
+  optional Props props = 4;
+  optional Services services = 5;
+  optional System system = 6;
 }

package/src/proto/dxos/devtools.proto

@@ -83,21 +83,21 @@ message GetConfigResponse {
 // EnableDebugLogging
 
 message EnableDebugLoggingRequest {
-  string namespaces = 1;
+  optional string namespaces = 1;
 }
 
 message EnableDebugLoggingResponse {
-  string enabledNamespaces = 1;
+  optional string enabledNamespaces = 1;
 }
 
 // DisableDebugLogging
 
 message DisableDebugLoggingRequest {
-  string namespaces = 1;
+  optional string namespaces = 1;
 }
 
 message DisableDebugLoggingResponse {
-  string enabledNamespaces = 1;
+  optional string enabledNamespaces = 1;
 }
 
 // SubscribeToKeyringKeys
@@ -111,7 +111,7 @@ message SubscribeToKeyringKeysResponse {
 // SubscribeToCredential
 
 message SubscribeToCredentialMessagesRequest {
-  PubKey partyKey = 1;
+  optional PubKey partyKey = 1;
 }
 
 message SubscribeToCredentialMessagesResponse {
@@ -188,9 +188,9 @@ message SubscribeToFeedsResponse {
 // SubscribeToFeedMessages
 
 message SubscribeToFeedBlocksRequest {
-  PubKey partyKey = 1;
-  PubKey feedKey = 2;
-  int32 maxBlocks = 3;
+  optional PubKey partyKey = 1;
+  optional PubKey feedKey = 2;
+  optional int32 maxBlocks = 3;
 }
 
 message SubscribeToFeedBlocksResponse {
@@ -212,7 +212,7 @@ message GetPartySnapshotRequest {
 }
 
 message GetPartySnapshotResponse {
-  PartySnapshot snapshot = 1;
+  optional PartySnapshot snapshot = 1;
 }
 
 // SavePartySnapshot
@@ -222,7 +222,7 @@ message SavePartySnapshotRequest {
 }
 
 message SavePartySnapshotResponse {
-  PartySnapshot snapshot = 1;
+  optional PartySnapshot snapshot = 1;
 }
 
 // ClearSnapshots
@@ -234,7 +234,7 @@ message ClearSnapshotsRequest {}
 message SubscribeToNetworkTopicsResponse {
   message Topic {
     PubKey topic = 1;
-    string label = 2;
+    optional string label = 2;
   }
 
   repeated Topic topics = 1;
@@ -249,7 +249,7 @@ message SubscribeToSignalStatusResponse {
     // SignalApi.State enum.
     string state = 2;
 
-    string error = 3;
+    optional string error = 3;
 
     // Number of milliseconds before reconnection.
     // TODO(dmaretskyi): Represent as absolute timestamp.
@@ -279,16 +279,16 @@ message SubscribeToSwarmInfoResponse {
   message SwarmInfo {
     PubKey id = 1;
     PubKey topic = 2;
-    string label = 3;
+    optional string label = 3;
     bool isActive = 4;
     message ConnectionInfo {
       message Json {
-        string data = 1;
+        optional string data = 1;
       }
       string state = 1;
       PubKey sessionId = 2;
       PubKey remotePeerId = 3;
-      string transport = 4;
+      optional string transport = 4;
       repeated string protocolExtensions = 5;
       repeated Json events = 6;
     }

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

@@ -8,6 +8,7 @@ syntax = "proto3";
 package dxos.echo.feed;
 
 import "google/protobuf/any.proto";
+
 import "./snapshot.proto";
 import "./timeframe.proto";
 
@@ -39,16 +40,16 @@ message EchoEnvelope {
   string itemId = 1;
 
   // Create item.
-  ItemGenesis genesis = 10;
+  optional ItemGenesis genesis = 10;
 
   // Item system mutations.
-  ItemMutation itemMutation = 11;
+  optional ItemMutation itemMutation = 11;
 
   // Model-specific mutations.
-  bytes mutation = 12;
+  optional bytes mutation = 12;
 
   /// Set the model to the provided snapshot.
-  ModelSnapshot snapshot = 13;
+  optional ModelSnapshot snapshot = 13;
 }
 
 // TODO(burdon): Document (different from parent/child).?
@@ -63,10 +64,10 @@ message LinkData {
  */
 // TODO(burdon): EntityGenesis?
 message ItemGenesis {
-  string itemType = 1;
+  optional string itemType = 1;
   string modelType = 2;
-  string modelVersion = 3;
-  LinkData link = 4;
+  optional string modelVersion = 3;
+  optional LinkData link = 4;
 }
 
 /**
@@ -79,6 +80,6 @@ message ItemMutation {
     RESTORE = 2;
   }
 
-  string parentId = 1;  // TODO(burdon): Define Action type?
-  Action action = 2;
+  optional string parentId = 1;  // TODO(burdon): Define Action type?
+  optional Action action = 2;
 }

package/src/proto/dxos/echo/invitation.proto

@@ -22,8 +22,8 @@ message InvitationDescriptor {
   bytes invitation = 3;
 
   /// Only present if type == OFFLINE.
-  bytes identityKey = 4;
+  optional bytes identityKey = 4;
 
   /// Must be stripped out when passing to another peer.
-  bytes secret = 5;
+  optional bytes secret = 5;
 }

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

@@ -7,12 +7,13 @@ syntax = "proto3";
 package dxos.echo.metadata;
 
 import "google/protobuf/timestamp.proto";
+
 import "../halo/keys.proto";
 
 message EchoMetadata {
   /**
    * Version number that is inceremnted every time there's a breaking change to the storage schema.
-   * 
+   *
    * This is used to detect if the storage schema has changed since the last time the client was run.
    * Loading data from a different version will might result in an error.
    */
@@ -29,17 +30,17 @@ message PartyMetadata {
   /// Party key.
   PubKey key = 1;
 
-  PubKey genesis_feed_key = 6;
+  optional PubKey genesis_feed_key = 6;
 
   /// Key of the wriatable control feed.
-  PubKey control_feed_key = 4;
+  optional PubKey control_feed_key = 4;
 
   /// Key of the wriatable data feed.
-  PubKey data_feed_key = 3;
+  optional PubKey data_feed_key = 3;
 
   // Latest timeframe reached while processing party messages.
-  TimeframeVector latest_timeframe = 5;
+  optional TimeframeVector latest_timeframe = 5;
 
   /// List of all feed associated with the party.
   repeated PubKey feed_keys = 2;
-}
+}

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

@@ -5,8 +5,8 @@
 syntax = "proto3";
 
 import "../halo/keys.proto";
-import "feed.proto";
-import "snapshot.proto";
+import "./feed.proto";
+import "./snapshot.proto";
 
 package dxos.echo.service;
 
@@ -59,6 +59,6 @@ service DataService {
   rpc SubscribeEntitySet(SubscribeEntitySetRequest) returns (stream SubscribeEntitySetResponse);
 
   rpc SubscribeEntityStream(SubscribeEntityStreamRequest) returns (stream SubscribeEntityStreamResponse);
-   
+
   rpc Write(WriteRequest) returns (MutationReceipt);
 }