@dxos/protocols 0.7.5-main.9d26e3a → 0.7.5-main.b19bfc8

package/src/proto/dxos/edge/signal.proto

@@ -0,0 +1,59 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/any.proto";
+import "google/protobuf/timestamp.proto";
+
+import "dxos/keys.proto";
+import "dxos/edge/messenger.proto";
+
+package dxos.edge.signal;
+
+message JoinRequest {
+  dxos.keys.PublicKey topic = 1;
+  dxos.edge.messenger.Peer peer = 2;
+}
+
+message LeaveRequest {
+  dxos.keys.PublicKey topic = 1;
+  dxos.edge.messenger.Peer peer = 2;
+}
+
+message Message {
+  dxos.edge.messenger.Peer author = 1;
+  dxos.edge.messenger.Peer recipient = 2;
+  google.protobuf.Any payload = 3;
+}
+
+/// Goes on Pub/Sub swarm topic and as a Join stream in RPC.
+message SwarmEvent {
+  dxos.keys.PublicKey topic = 1;
+
+  // Announce peer available on swarm.
+  message PeerAvailable {
+    dxos.edge.messenger.Peer peer = 1;
+
+    google.protobuf.Timestamp since = 2;
+
+    // When, if at all (handle the default value as not), this availability would expires were it not re-announced, like
+    // periodically in Pub/Sub with some margin such that Pub/Sub network partitions lead to offline statuses.
+    optional google.protobuf.Timestamp until = 3;
+
+    /// Only relevant in Pub/Sub. Optional, the host topic to eagerly send PeerAvailable messages back to.
+    optional bytes announce_back_to_host = 4;
+  }
+
+  message PeerLeft {
+    dxos.edge.messenger.Peer peer = 1;
+  }
+
+  oneof event {
+    /// The peer was announced as available on the swarm.
+    PeerAvailable peer_available = 2;
+    /// The peer left, or their announcement timed out.
+    PeerLeft peer_left = 3;
+  }
+}

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

@@ -139,6 +139,8 @@ message IdentityRecovery {
   dxos.keys.PublicKey identity_key = 1;
   /// Public key derived from the recovery seedphrase.
   dxos.keys.PublicKey recovery_key = 2;
+  /// Algorithm used to derive the recovery key (e.g., ED25519, ES256, etc.).
+  string algorithm = 3;
 }
 
 message ProfileDocument {

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

@@ -13,12 +13,14 @@ package dxos.mesh.signal;
 
 option go_package = "github.com/dxos/dxos/proto/def/dxos/mesh/signal";
 
+/// @deprecated
 message JoinRequest {
   bytes swarm = 1;
   bytes peer = 2;
   optional google.protobuf.Struct metadata = 3;
 }
 
+/// @deprecated
 message Message {
   // TODO(egor): Rename to `sender`.
   bytes author = 1;
@@ -27,11 +29,13 @@ message Message {
   optional google.protobuf.Struct metadata = 4;
 }
 
+/// @deprecated
 message ReceptionRequest {
   bytes peer = 1;
 }
 
 /// Goes on Pub/Sub swarm topic and as a Join stream in RPC.
+/// @deprecated
 message SwarmEvent {
   // Announce peer available on swarm.
   message PeerAvailable {
@@ -60,6 +64,7 @@ message SwarmEvent {
 }
 
 /// Goes on a Pub/Sub host topic.
+/// @deprecated
 message HostEvent {
   message AnnounceBack {
       bytes swarm = 1;
@@ -71,12 +76,14 @@ message HostEvent {
 }
 
 /// Goes on Pub/Sub peer topic.
+/// @deprecated
 message PeerEvent {
   oneof event {
     Message message = 1;
   }
 }
 
+/// @deprecated
 enum SignalState {
   /// Connection is being established.
   CONNECTING = 0;
@@ -93,6 +100,7 @@ enum SignalState {
 }
 
 // TOOD(burdon): Rename.
+/// @deprecated
 service Signal {
   rpc Join(JoinRequest) returns (stream SwarmEvent);
   rpc ReceiveMessages(ReceptionRequest) returns (stream Message);

package/src/proto/gen/dxos/agent/dashboard.ts

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

package/src/proto/gen/dxos/agent/echoproxy.ts

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

package/src/proto/gen/dxos/agent/epoch.ts

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

package/src/proto/gen/dxos/agent/functions.ts

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "./echo/query.js";
 import * as dxos_echo_service from "./echo/service.js";
 import * as dxos_echo_snapshot from "./echo/snapshot.js";
 import * as dxos_echo_timeframe from "./echo/timeframe.js";
+import * as dxos_edge_calls from "./edge/calls.js";
 import * as dxos_edge_messenger from "./edge/messenger.js";
+import * as dxos_edge_signal from "./edge/signal.js";
 import * as dxos_error from "./error.js";
 import * as dxos_gravity from "./gravity.js";
 import * as dxos_halo_credentials from "./halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";
@@ -63,6 +65,184 @@ import * as dxos_value from "../value.js";
 import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface Metrics {
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    values?: Metrics.KeyPair[];
+}
+export namespace Metrics {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface KeyPair {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        key?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        value?: dxos_value.Value;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        stats?: dxos_value.Stats;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface ControlMetricsRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    reset?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    record?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface ControlMetricsResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    recording?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryMetricsRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    interval?: number;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryMetricsResponse {
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    metrics: Metrics;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export enum LogLevel {
+    NONE = 0,
+    TRACE = 5,
+    DEBUG = 10,
+    VERBOSE = 11,
+    INFO = 12,
+    WARN = 13,
+    ERROR = 14
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryLogsRequest {
+    filters?: QueryLogsRequest.Filter[];
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    options?: QueryLogsRequest.MatchingOptions;
+}
+export namespace QueryLogsRequest {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export enum MatchingOptions {
+        NONE = 0,
+        INCLUSIVE = 1,
+        EXPLICIT = 2
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface Filter {
+        level: LogLevel;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        pattern?: string;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface LogEntry {
+    level: LogLevel;
+    message: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    meta?: LogEntry.Meta;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    error?: dxos_error.Error;
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+}
+export namespace LogEntry {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface Meta {
+        file: string;
+        line: number;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        resourceId?: number;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface LoggingService {
+    controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
+    queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
+    queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/invitation.proto}
@@ -255,184 +435,6 @@ export namespace Invitation {
         EXPIRED = 9
     }
 }
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface Metrics {
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-    values?: Metrics.KeyPair[];
-}
-export namespace Metrics {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface KeyPair {
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        key?: string;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        value?: dxos_value.Value;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        stats?: dxos_value.Stats;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface ControlMetricsRequest {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    reset?: boolean;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    record?: boolean;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface ControlMetricsResponse {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    recording?: boolean;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryMetricsRequest {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    interval?: number;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryMetricsResponse {
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-    metrics: Metrics;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export enum LogLevel {
-    NONE = 0,
-    TRACE = 5,
-    DEBUG = 10,
-    VERBOSE = 11,
-    INFO = 12,
-    WARN = 13,
-    ERROR = 14
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryLogsRequest {
-    filters?: QueryLogsRequest.Filter[];
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    options?: QueryLogsRequest.MatchingOptions;
-}
-export namespace QueryLogsRequest {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export enum MatchingOptions {
-        NONE = 0,
-        INCLUSIVE = 1,
-        EXPLICIT = 2
-    }
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface Filter {
-        level: LogLevel;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        pattern?: string;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface LogEntry {
-    level: LogLevel;
-    message: string;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    meta?: LogEntry.Meta;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    error?: dxos_error.Error;
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-}
-export namespace LogEntry {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface Meta {
-        file: string;
-        line: number;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        resourceId?: number;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface LoggingService {
-    controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
-    queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
-    queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
-}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -591,6 +593,7 @@ export interface SystemService {
  *   {@link file://./../../../dxos/client/services.proto}
  */
 export interface Identity {
+    did: string;
     identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
      * Options:
@@ -603,19 +606,75 @@ export interface Identity {
      */
     profile?: dxos_halo_credentials.ProfileDocument;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface RequestRecoveryChallengeResponse {
+    deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    challenge: string;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
 export interface RecoverIdentityRequest {
-    seedphrase: string;
+    recoveryCode?: string;
+    external?: RecoverIdentityRequest.ExternalSignature;
+}
+export namespace RecoverIdentityRequest {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/services.proto}
+     */
+    export interface ExternalSignature {
+        identityDid: string;
+        deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+        controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+        signature: Uint8Array;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        clientDataJson?: Uint8Array;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        authenticatorData?: Uint8Array;
+    }
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface CreateRecoveryPhraseResponse {
-    seedphrase: string;
+export interface CreateRecoveryCredentialRequest {
+    /**
+     * Optional recovery key. If not provided, a new key will be generated.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    recoveryKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Algorithm used to generate the recovery key.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    algorithm?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface CreateRecoveryCredentialResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    recoveryCode?: string;
 }
 /**
  * Defined in:
@@ -662,8 +721,9 @@ export interface CreateIdentityRequest {
  */
 export interface IdentityService {
     createIdentity: (request: CreateIdentityRequest, options?: RequestOptions) => Promise<Identity>;
+    requestRecoveryChallenge: (request: void, options?: RequestOptions) => Promise<RequestRecoveryChallengeResponse>;
     recoverIdentity: (request: RecoverIdentityRequest, options?: RequestOptions) => Promise<Identity>;
-    createRecoveryPhrase: (request: void, options?: RequestOptions) => Promise<CreateRecoveryPhraseResponse>;
+    createRecoveryCredential: (request: CreateRecoveryCredentialRequest, options?: RequestOptions) => Promise<CreateRecoveryCredentialResponse>;
     queryIdentity: (request: void, options?: RequestOptions) => Stream<QueryIdentityResponse>;
     updateProfile: (request: dxos_halo_credentials.ProfileDocument, options?: RequestOptions) => Promise<Identity>;
     signPresentation: (request: SignPresentationRequest, options?: RequestOptions) => Promise<dxos_halo_credentials.Presentation>;
@@ -1249,6 +1309,13 @@ export namespace NetworkStatus {
 export interface UpdateConfigRequest {
     swarm: ConnectionState;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface SubscribeSwarmStateRequest {
+    topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -1256,6 +1323,11 @@ export interface UpdateConfigRequest {
 export interface NetworkService {
     updateConfig: (request: UpdateConfigRequest, options?: RequestOptions) => Promise<void>;
     queryStatus: (request: void, options?: RequestOptions) => Stream<NetworkStatus>;
+    joinSwarm: (request: dxos_edge_signal.JoinRequest, options?: RequestOptions) => Promise<void>;
+    leaveSwarm: (request: dxos_edge_signal.LeaveRequest, options?: RequestOptions) => Promise<void>;
+    subscribeSwarmState: (request: SubscribeSwarmStateRequest, options?: RequestOptions) => Stream<dxos_edge_messenger.SwarmResponse>;
+    sendMessage: (request: dxos_edge_signal.Message, options?: RequestOptions) => Promise<void>;
+    subscribeMessages: (request: dxos_edge_messenger.Peer, options?: RequestOptions) => Stream<dxos_edge_signal.Message>;
 }
 /**
  * Defined in:

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "./echo/query.js";
 import * as dxos_echo_service from "./echo/service.js";
 import * as dxos_echo_snapshot from "./echo/snapshot.js";
 import * as dxos_echo_timeframe from "./echo/timeframe.js";
+import * as dxos_edge_calls from "./edge/calls.js";
 import * as dxos_edge_messenger from "./edge/messenger.js";
+import * as dxos_edge_signal from "./edge/signal.js";
 import * as dxos_error from "./error.js";
 import * as dxos_gravity from "./gravity.js";
 import * as dxos_halo_credentials from "./halo/credentials.js";