@dxos/protocols 2.33.9-dev.d9963f00 → 2.33.9-dev.eb69ac10

package/src/proto/dxos/config.proto

@@ -11,54 +11,54 @@ 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 {
@@ -89,66 +89,66 @@ message Runtime {
         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,23 +158,23 @@ 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.
@@ -182,67 +182,67 @@ message Runtime {
       *
       * TODO(dmaretskyi): Deprecate this and move it to keyring.
       */
-      string account_uri = 2;
+      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

@@ -39,16 +39,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 +63,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 +79,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

@@ -29,16 +29,16 @@ 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/snapshot.proto

@@ -20,10 +20,11 @@ import "../halo/keys.proto";
 
 message PartySnapshot {
   bytes partyKey = 1;
-  TimeframeVector timeframe = 2;
+  optional TimeframeVector timeframe = 2;
 
   // Unix timestamp of the snapshot creation time. For information purposes only.
-  int32 timestamp = 3;
+  // TODO(dmaretskyi): Convert to google.protobuf.Timestamp.
+  optional int32 timestamp = 3;
 
   HaloStateSnapshot halo = 11;
   // TODO(dmaretskyi): Rename to EchoSnapshot.
@@ -48,7 +49,7 @@ message DatabaseSnapshot {
 message ItemSnapshot {
   optional string itemId = 1;
   optional string itemType = 2;
-  optional string modelType = 3;
+  string modelType = 3;
   optional string modelVersion = 4;
   optional string parentId = 5;
   optional ModelSnapshot model = 6;
@@ -57,7 +58,7 @@ message ItemSnapshot {
 message LinkSnapshot {
   optional string linkId = 1;
   optional string linkType = 2;
-  optional string modelType = 3;
+  string modelType = 3;
   optional string modelVersion = 4;
   required string source = 5;
   required string target = 6;

package/src/proto/dxos/halo/auth.proto

@@ -23,8 +23,8 @@ message Auth {
   PubKey identityKey = 3;  
   
   /// The publicKey of the authenticating Identity.
-  PubKey feedKey = 4;      
+  optional PubKey feedKey = 4;      
 
   /// FeedAdmit message to the should be written to a control feed in case the `feedKey` is not admitted to the party.
-  google.protobuf.Any feed_admit = 5;
+  optional google.protobuf.Any feed_admit = 5;
 }

package/src/proto/dxos/halo/greet.proto

@@ -57,7 +57,7 @@ message Command {
   Type command = 1;
 
   // Auth secret (PIN, hash, AuthMessage, etc.).
-  bytes secret = 2;
+  optional bytes secret = 2;
 
   // TODO(burdon): These seem to be signed messages? In which case we already know the type.
   // TODO(dboreham): static typing of contained messages is not yet supported, change from any when it is.

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

@@ -43,33 +43,33 @@ message KeyRecord {
   /**
    * The secret key as a Buffer (this will never be visible outside the Keyring).
    */
-  PrivKey secretKey = 3;
+  optional PrivKey secretKey = 3;
 
   /**
    * Is this key from a Greeting "hint"?
    */
-  bool hint = 4;
+  optional bool hint = 4;
 
   /**
    * 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; // TODO(burdon): Rename "local" or "private".
+  optional bool own = 5; // TODO(burdon): Rename "local" or "private".
 
   /**
    * Is this key to be trusted?
    */
-  bool trusted = 6; // TODO(burdon): Rename "trust". How is this determined?
+  optional 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.
    */
-  string added = 7;
+  optional string added = 7;
 
   /**
    * An RFC-3339 date/time string for when the key was created.
    */
-  string created = 8;
+  optional string created = 8;
 }
 
 message KeyRecordList {

package/src/proto/dxos/halo/signed.proto

@@ -23,20 +23,27 @@ message SignedMessage {
   // Provides the common metadata needed for all signed objects.
   //
   message Signed {
-    required string created = 1;                    // RFC-3339 datetime string.
+    /// RFC-3339 datetime string.
+    required string created = 1;                    
     required bytes nonce = 2;
-    required google.protobuf.Any payload = 10;      // The payload to be signed.
+    /// The payload to be signed.
+    required google.protobuf.Any payload = 10;      
   }
 
   //
   // The signature data itself.
   //
   message Signature {
-    required PubKey key = 1;                        // The publicKey of the keypair that made this signature.
-    required bytes signature = 2;                   // The bytes of the signature.
-    KeyChain keyChain = 3;                          // Optional. The certification chain of SignedMessages for this key.
+    /// The publicKey of the keypair that made this signature.
+    required PubKey key = 1;                        
+    /// The bytes of the signature.
+    required bytes signature = 2;                   
+    /// The certification chain of SignedMessages for this key.
+    optional KeyChain keyChain = 3;                 
   }
 
-  required Signed signed = 1;                       // The signed message contents.
-  repeated Signature signatures = 2;                // An array of Signatures, one for each key that signed the message.
+  /// The signed message contents.
+  required Signed signed = 1;                       
+  /// An array of Signatures, one for each key that signed the message.
+  repeated Signature signatures = 2;                
 }

package/src/proto/dxos/rpc.proto

@@ -8,6 +8,8 @@ import "google/protobuf/any.proto";
 
 package dxos.rpc;
 
+option go_package = "github.com/dxos/kube/go/dxrpc/pb";
+
 message RpcMessage {
   oneof content {
     Request request = 1;
@@ -34,8 +36,16 @@ message Response {
   oneof content {
     google.protobuf.Any payload = 2;
     Error error = 3;
-    // Sent when stream is closed without an error.
+    /// Sent when stream is closed without an error.
     bool close = 4;
+
+    /**
+     * Sent when the server has processed a request with a streaming response.
+     *
+     * Can be skipped by the server.
+     * In this case the first payload should be treated as the server being ready.
+     */
+    bool stream_ready = 5;
   }
 }
 
@@ -45,9 +55,9 @@ message StreamClose {
 }
 
 message Error {
-  string name = 1;
-  string message = 2;
-  string stack = 3;
+  optional string name = 1;
+  optional string message = 2;
+  optional string stack = 3;
 }
 
 message MessageTrace {