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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client",
-  "version": "2.33.6",
+  "version": "2.33.7-dev.40cf0994",
   "license": "MIT",
   "author": "DXOS.org",
   "main": "dist/src/index.js",
@@ -10,21 +10,21 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/async": "2.33.6",
-    "@dxos/codec-protobuf": "2.33.6",
-    "@dxos/config": "2.33.6",
-    "@dxos/credentials": "2.33.6",
-    "@dxos/crypto": "2.33.6",
-    "@dxos/debug": "2.33.6",
-    "@dxos/echo-db": "2.33.6",
-    "@dxos/echo-protocol": "2.33.6",
-    "@dxos/feed-store": "2.33.6",
-    "@dxos/model-factory": "2.33.6",
-    "@dxos/network-manager": "2.33.6",
-    "@dxos/object-model": "2.33.6",
-    "@dxos/protocols": "2.33.6",
-    "@dxos/rpc": "2.33.6",
-    "@dxos/util": "2.33.6",
+    "@dxos/async": "2.33.7-dev.40cf0994",
+    "@dxos/codec-protobuf": "2.33.7-dev.40cf0994",
+    "@dxos/config": "2.33.7-dev.40cf0994",
+    "@dxos/credentials": "2.33.7-dev.40cf0994",
+    "@dxos/crypto": "2.33.7-dev.40cf0994",
+    "@dxos/debug": "2.33.7-dev.40cf0994",
+    "@dxos/echo-db": "2.33.7-dev.40cf0994",
+    "@dxos/echo-protocol": "2.33.7-dev.40cf0994",
+    "@dxos/feed-store": "2.33.7-dev.40cf0994",
+    "@dxos/model-factory": "2.33.7-dev.40cf0994",
+    "@dxos/network-manager": "2.33.7-dev.40cf0994",
+    "@dxos/object-model": "2.33.7-dev.40cf0994",
+    "@dxos/protocols": "2.33.7-dev.40cf0994",
+    "@dxos/rpc": "2.33.7-dev.40cf0994",
+    "@dxos/util": "2.33.7-dev.40cf0994",
     "abstract-leveldown": "~7.0.0",
     "assert": "^2.0.0",
     "debug": "^4.3.3",
@@ -37,9 +37,9 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@dxos/eslint-plugin": "~1.0.33",
+    "@dxos/eslint-plugin": "~1.0.34",
     "@dxos/protocols-toolchain": "2.33.6",
-    "@dxos/random-access-multi-storage": "2.33.6",
+    "@dxos/random-access-multi-storage": "2.33.7-dev.40cf0994",
     "@dxos/testutils": "2.33.6",
     "@types/debug": "^4.1.7",
     "@types/jest": "^26.0.7",

package/src/api/client.ts

@@ -261,6 +261,7 @@ export class Client {
    * Registers a new ECHO model.
    * @deprecated
    */
+  // TODO(burdon): Remove (moved to echo).
   registerModel (constructor: ModelConstructor<any>): this {
     this._echo.modelFactory.registerModel(constructor);
     return this;

package/src/api/invitations/invitation-proxy.ts

@@ -69,11 +69,11 @@ export class InvitationProxy {
           reject(err);
           error.emit(err);
         }
-      }, error => {
-        if (error) {
-          console.error(error);
-          reject(error);
+      }, err => {
+        if (err) {
           // TODO(rzadp): Handle retry.
+          console.error(err);
+          reject(error);
         }
       });
     });
@@ -102,10 +102,10 @@ export class InvitationProxy {
         // TODO(dmaretskyi): Should result in an error inside the returned Invitation, rejecting the promise in Invitation.wait().
         throwUnhandledRejection(error);
       }
-    }, error => {
-      if (error && !(error instanceof RpcClosedError)) {
+    }, err => {
+      if (err && !(err instanceof RpcClosedError)) {
         // TODO(dmaretskyi): Should result in an error inside the returned Invitation, rejecting the promise in Invitation.wait().
-        throwUnhandledRejection(error);
+        throwUnhandledRejection(err);
       }
     });
 

package/src/api/proxies/echo-proxy.ts

@@ -5,12 +5,12 @@
 import assert from 'assert';
 
 import { Event, latch } from '@dxos/async';
-import { PublicKey } from '@dxos/crypto';
 import { failUndefined } from '@dxos/debug';
 import { InvitationDescriptor, PARTY_ITEM_TYPE, ResultSet } from '@dxos/echo-db';
 import { PartyKey, PartySnapshot } from '@dxos/echo-protocol';
 import { ModelConstructor, ModelFactory } from '@dxos/model-factory';
 import { ObjectModel } from '@dxos/object-model';
+import { PublicKey } from '@dxos/protocols';
 import { ComplexMap, SubscriptionGroup } from '@dxos/util';
 
 import { ClientServiceHost, ClientServiceProvider } from '../../services';
@@ -119,12 +119,14 @@ export class EchoProxy implements Echo {
 
             partyProxy._processPartyUpdate(party);
             this._partiesChanged.emit();
-          }, () => {});
+          });
+
           this._subscriptions.push(() => partyStream.close());
         }
       }
+
       this._partiesChanged.emit();
-    }, () => {});
+    });
 
     this._subscriptions.push(() => partiesStream.close());
 

package/src/api/proxies/halo-proxy.ts

@@ -3,9 +3,9 @@
 //
 
 import { Event } from '@dxos/async';
-import { KeyRecord } from '@dxos/credentials';
-import { PublicKey } from '@dxos/crypto';
+import { DeviceInfo, KeyRecord } from '@dxos/credentials';
 import { Contact, CreateProfileOptions, InvitationDescriptor, PartyMember, ResultSet } from '@dxos/echo-db';
+import { PublicKey } from '@dxos/protocols';
 import { SubscriptionGroup } from '@dxos/util';
 
 import { Profile, SignRequest, SignResponse } from '../../proto/gen/dxos/client';
@@ -23,6 +23,9 @@ export interface Halo {
   createProfile (options?: CreateProfileOptions): Promise<Profile>
   recoverProfile (seedPhrase: string): Promise<Profile>
 
+  sign (request: SignRequest): Promise<SignResponse>
+  addKeyRecord (keyRecord: KeyRecord): Promise<void>
+
   /**
    * @deprecated
    */
@@ -32,13 +35,12 @@ export interface Halo {
   createInvitation (): Promise<InvitationRequest>
   acceptInvitation (invitationDescriptor: InvitationDescriptor): Invitation
 
-  addKeyRecord (keyRecord: KeyRecord): Promise<void>
-  sign (request: SignRequest): Promise<SignResponse>
+  queryDevices (): Promise<DeviceInfo[]>
+  setDevicePreference (key: string, value: string): Promise<void>
+  getDevicePreference (key: string): Promise<string | undefined>
 
   setGlobalPreference (key: string, value: string): Promise<void>
   getGlobalPreference (key: string): Promise<string | undefined>
-  setDevicePreference (key: string, value: string): Promise<void>
-  getDevicePreference (key: string): Promise<string | undefined>
 }
 
 /**
@@ -155,20 +157,17 @@ export class HaloProxy implements Halo {
     );
   }
 
-  async addKeyRecord (keyRecord: KeyRecord) {
-    await this._serviceProvider.services.HaloService.addKeyRecord({ keyRecord });
-  }
-
   async sign (request: SignRequest) {
     return await this._serviceProvider.services.HaloService.sign(request);
   }
 
-  async setGlobalPreference (key: string, value: string): Promise<void> {
-    await this._serviceProvider.services.HaloService.setGlobalPreference({ key, value });
+  async addKeyRecord (keyRecord: KeyRecord) {
+    await this._serviceProvider.services.HaloService.addKeyRecord({ keyRecord });
   }
 
-  async getGlobalPreference (key: string): Promise<string | undefined> {
-    return (await this._serviceProvider.services.HaloService.getGlobalPreference({ key })).value;
+  // TODO(burdon): Implement.
+  async queryDevices (): Promise<DeviceInfo[]> {
+    return [];
   }
 
   async setDevicePreference (key: string, value: string): Promise<void> {
@@ -179,6 +178,14 @@ export class HaloProxy implements Halo {
     return (await this._serviceProvider.services.HaloService.getDevicePreference({ key })).value;
   }
 
+  async setGlobalPreference (key: string, value: string): Promise<void> {
+    await this._serviceProvider.services.HaloService.setGlobalPreference({ key, value });
+  }
+
+  async getGlobalPreference (key: string): Promise<string | undefined> {
+    return (await this._serviceProvider.services.HaloService.getGlobalPreference({ key })).value;
+  }
+
   /**
    * Allocate resources and set-up internal subscriptions.
    *
@@ -192,14 +199,16 @@ export class HaloProxy implements Halo {
     profileStream.subscribe(data => {
       this._profile = data.profile;
       this.profileChanged.emit();
-    }, () => {});
+    });
+
     this._subscriptions.push(() => profileStream.close());
 
     const contactsStream = this._serviceProvider.services.HaloService.subscribeContacts();
     contactsStream.subscribe(data => {
       this._contacts = data.contacts as PartyMember[];
       this._contactsChanged.emit();
-    }, () => {});
+    });
+
     this._subscriptions.push(() => contactsStream.close());
 
     await Promise.all([gotProfile, gotContacts]);

package/src/api/proxies/party-proxy.ts

@@ -2,7 +2,6 @@
 // Copyright 2021 DXOS.org
 //
 
-import { PublicKey } from '@dxos/crypto';
 import { failUndefined } from '@dxos/debug';
 import {
   PARTY_ITEM_TYPE,
@@ -17,6 +16,7 @@ import {
 import { PartyKey, PartySnapshot } from '@dxos/echo-protocol';
 import { ModelFactory } from '@dxos/model-factory';
 import { ObjectModel, ObjectProperties } from '@dxos/object-model';
+import { PublicKey } from '@dxos/protocols';
 
 import { Party as PartyProto, PartyDetails } from '../../proto/gen/dxos/client';
 import { ClientServiceHost, ClientServiceProvider, ClientServiceProxy } from '../../services';
@@ -51,6 +51,7 @@ export interface Party {
   setTitle (title: string): Promise<void>
   getTitle (): string
 
+  // TODO(burdon): Rename (info?)
   getDetails(): Promise<PartyDetails>
 
   get properties (): ObjectProperties
@@ -112,7 +113,7 @@ export class PartyProxy implements Party {
     }
   }
 
-  // TODO(burdon): Getter require by react hook.
+  // TODO(burdon): Getter required by react hook.
   get invitationProxy () {
     return this._invitationProxy;
   }

package/src/devtools/devtools-host.ts

@@ -9,7 +9,7 @@ import { getConfig } from './config';
 import { enableDebugLogging, disableDebugLogging } from './debug-logging';
 import { DevtoolsServiceDependencies } from './devtools-context';
 import { DevtoolsHostEvents } from './devtools-host-events';
-import { subscribeToFeed, subscribeToFeeds } from './feeds';
+import { subscribeToFeeds, subscribeToFeedBlocks } from './feeds';
 import { subscribeToItems } from './items';
 import { subscribeToCredentialMessages, subscribeToKeyringKeys } from './keys';
 import {
@@ -22,15 +22,17 @@ import {
 import { getPartySnapshot, savePartySnapshot, subscribeToParties } from './parties';
 import { resetStorage } from './storage';
 
-export const createDevtoolsHost = (context: DevtoolsServiceDependencies, events: DevtoolsHostEvents): DevtoolsHost => ({
+export const createDevtoolsHost = (
+  context: DevtoolsServiceDependencies,
+  events: DevtoolsHostEvents
+): DevtoolsHost => ({
   events: () => new Stream<ClientAPIEvent>(({ next }) => {
     events.ready.on(() => {
       next({ ready: {} });
     });
   }),
   getConfig: async () => {
-    const config = getConfig(context);
-    return config;
+    return getConfig(context);
   },
   resetStorage: async () => {
     await resetStorage(context);
@@ -45,10 +47,10 @@ export const createDevtoolsHost = (context: DevtoolsServiceDependencies, events:
   },
   subscribeToKeyringKeys: () => subscribeToKeyringKeys(context),
   subscribeToCredentialMessages: (request) => subscribeToCredentialMessages(context, request),
-  subscribeToParties: () => subscribeToParties(context),
+  subscribeToParties: (request) => subscribeToParties(context, request),
   subscribeToItems: () => subscribeToItems(context),
-  subscribeToFeeds: () => subscribeToFeeds(context),
-  subscribeToFeed: (request) => subscribeToFeed(context, request),
+  subscribeToFeeds: (request) => subscribeToFeeds(context, request),
+  subscribeToFeedBlocks: (request) => subscribeToFeedBlocks(context, request),
   getPartySnapshot: async (request) => getPartySnapshot(context, request),
   savePartySnapshot: async (request) => savePartySnapshot(context, request),
   clearSnapshots: async () => {

package/src/devtools/feeds.ts

@@ -6,44 +6,79 @@ import { Readable } from 'readable-stream';
 
 import { Stream } from '@dxos/codec-protobuf';
 import { createBatchStream } from '@dxos/feed-store';
+import { PublicKey } from '@dxos/protocols';
 
-import { SubscribeToFeedRequest, SubscribeToFeedResponse, SubscribeToFeedsResponse } from '../proto/gen/dxos/devtools';
+import {
+  SubscribeToFeedsRequest,
+  SubscribeToFeedsResponse,
+  SubscribeToFeedBlocksRequest,
+  SubscribeToFeedBlocksResponse
+} from '../proto/gen/dxos/devtools';
 import { DevtoolsServiceDependencies } from './devtools-context';
 
-export const subscribeToFeeds = ({ echo }: DevtoolsServiceDependencies) => new Stream<SubscribeToFeedsResponse>(({ next }) => {
-  const update = () => {
+export const subscribeToFeeds = (
+  { echo }: DevtoolsServiceDependencies,
+  { partyKey, feedKeys }: SubscribeToFeedsRequest
+) => new Stream<SubscribeToFeedsResponse>(({ next }) => {
+  if (!partyKey || feedKeys?.length === 0) {
+    return;
+  }
+
+  const feedMap = new Map<PublicKey, { feedKey: PublicKey, stream: Readable, length: number }>();
+
+  setImmediate(async () => {
     const { value: parties } = echo.queryParties();
-    next({
-      parties: parties.map(party => ({
-        key: party.key,
-        feeds: party.getFeeds().map(feed => feed.key)
-      }))
-    });
-  };
+    const party = parties.find(party => party.key.equals(partyKey));
+    if (!party) {
+      return;
+    }
 
-  const partySubscriptions: Record<string, () => void> = {};
-  const unsubscribe = echo.queryParties().subscribe((parties) => {
-    parties.forEach((party) => {
-      if (!partySubscriptions[party.key.toHex()]) {
-        // Send updates on timeframe changes.
-        partySubscriptions[party.key.toHex()] = party.timeframeUpdate.on(() => update());
-      }
-    });
+    const feeds = await party.getFeeds();
+    feeds
+      .filter(feed => !feedKeys?.length || feedKeys.some(feedKey => feedKey.equals(feed.key)))
+      .forEach(feed => {
+        let feedInfo = feedMap.get(feed.key);
+        if (!feedInfo) {
+          // TODO(wittjosiah): Start from timeframe?
+          // TODO(wittjosiah): Bi-directional lazy loading to feed into virtualized table.
+          // Tail feed so as to not overload the browser.
+          const feedStream = new Readable({ objectMode: true })
+            .wrap(createBatchStream(feed.feed, {
+              live: true,
+              start: 0
+            }));
 
-    // Send feeds for new parties.
-    update();
-  });
+          feedStream.on('data', blocks => {
+            feedInfo!.length += blocks.length;
+
+            next({
+              feeds: Array.from(feedMap.values()).map(({ feedKey, length }) => ({
+                feedKey,
+                length
+              }))
+            });
+          });
 
-  // Send initial feeds.
-  update();
+          feedInfo = {
+            feedKey: feed.key,
+            stream: feedStream,
+            length: 0
+          };
+
+          feedMap.set(feed.key, feedInfo);
+        }
+      });
+  });
 
   return () => {
-    unsubscribe();
-    Object.values(partySubscriptions).forEach(unsubscribe => unsubscribe());
+    feedMap.forEach(({ stream }) => stream.destroy());
   };
 });
 
-export const subscribeToFeed = ({ echo }: DevtoolsServiceDependencies, { partyKey, feedKey }: SubscribeToFeedRequest) => new Stream<SubscribeToFeedResponse>(({ next }) => {
+export const subscribeToFeedBlocks = (
+  { echo }: DevtoolsServiceDependencies,
+  { partyKey, feedKey, maxBlocks = 10 }: SubscribeToFeedBlocksRequest
+) => new Stream<SubscribeToFeedBlocksResponse>(({ next }) => {
   if (!partyKey || !feedKey) {
     return;
   }
@@ -56,16 +91,19 @@ export const subscribeToFeed = ({ echo }: DevtoolsServiceDependencies, { partyKe
       return;
     }
 
-    const feed = await party.getFeeds().find(feed => feed.key.equals(feedKey));
-    if (!feed) {
+    const descriptor = await party.getFeeds().find(feed => feed.key.equals(feedKey));
+    if (!descriptor) {
       return;
     }
 
     // TODO(wittjosiah): Start from timeframe?
-    // TODO(wittjosiah): Bidirectional lazy loading to feed into virtualized table.
+    // TODO(wittjosiah): Bi-directional lazy loading to feed into virtualized table.
     // Tail feed so as to not overload the browser.
     feedStream = new Readable({ objectMode: true })
-      .wrap(createBatchStream(feed.feed, { live: true, start: Math.max(0, feed.feed.length - 10) }));
+      .wrap(createBatchStream(descriptor.feed, {
+        live: true,
+        start: Math.max(0, descriptor.feed.length - maxBlocks)
+      }));
 
     feedStream.on('data', blocks => {
       next({ blocks });

package/src/devtools/network.ts

@@ -3,8 +3,8 @@
 //
 
 import { Stream } from '@dxos/codec-protobuf';
-import { PublicKey } from '@dxos/crypto';
 import { SignalApi } from '@dxos/network-manager';
+import { PublicKey } from '@dxos/protocols';
 
 import {
   GetNetworkPeersRequest,

package/src/devtools/parties.ts

@@ -9,14 +9,32 @@ import {
   GetPartySnapshotResponse,
   SavePartySnapshotRequest,
   SavePartySnapshotResponse,
+  SubscribeToPartiesRequest,
   SubscribeToPartiesResponse
 } from '../proto/gen/dxos/devtools';
 import { DevtoolsServiceDependencies } from './devtools-context';
 
-export const subscribeToParties = ({ echo }: DevtoolsServiceDependencies) => new Stream<SubscribeToPartiesResponse>(({ next }) => {
+export const subscribeToParties = (
+  { echo }: DevtoolsServiceDependencies,
+  { partyKeys = [] }: SubscribeToPartiesRequest
+) => new Stream<SubscribeToPartiesResponse>(({ next }) => {
   const update = () => {
     const { value: parties } = echo.queryParties();
-    next({ parties: parties.map(party => party.partyInfo) });
+    const filteredParties = parties.filter(
+      party => !partyKeys?.length || partyKeys.some(partyKey => partyKey.equals(party.key)));
+
+    next({
+      parties: filteredParties.map(party => {
+        return {
+          key: party.key,
+          isOpen: party.isOpen,
+          isActive: party.isActive,
+          timeframe: party.timeframe,
+          feeds: party.getFeeds().map(feed => feed.key),
+          properties: party.isOpen ? party.getPropertiesSet().expectOne().model.toObject() : undefined
+        };
+      })
+    });
   };
 
   const partySubscriptions: Record<string, () => void> = {};

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

@@ -22,7 +22,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>;
@@ -79,18 +79,19 @@ export namespace GetNetworkPeersResponse {
     }
 }
 export interface SubscribeToPartiesRequest {
+    partyKeys?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>[];
 }
 export interface SubscribeToPartiesResponse {
     parties?: SubscribeToPartiesResponse.PartyInfo[];
 }
 export namespace SubscribeToPartiesResponse {
     export interface PartyInfo {
-        key?: string;
+        key?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
         isOpen?: boolean;
         isActive?: boolean;
-        feedKeys?: number;
-        properties?: Partial<Record<string, string>>;
         timeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
+        feeds?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>[];
+        properties?: Partial<Record<string, string>>;
     }
 }
 export interface SubscribeToItemsRequest {
@@ -99,25 +100,28 @@ export interface SubscribeToItemsResponse {
     data?: string;
 }
 export interface SubscribeToFeedsRequest {
+    partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    feedKeys?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>[];
 }
 export interface SubscribeToFeedsResponse {
-    parties?: SubscribeToFeedsResponse.Party[];
+    feeds?: SubscribeToFeedsResponse.Feed[];
 }
 export namespace SubscribeToFeedsResponse {
-    export interface Party {
-        key?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-        feeds?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>[];
+    export interface Feed {
+        feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        length?: number;
     }
 }
-export interface SubscribeToFeedRequest {
+export interface SubscribeToFeedBlocksRequest {
     partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    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;
@@ -193,10 +197,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

@@ -27,36 +27,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: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     /**
-     * - 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?: ReturnType<(typeof substitutions)["dxos.halo.keys.PrivKey"]["decode"]>;
     /**
-     * - 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;
 }