@dxos/client 2.33.7-dev.c2ba88fb → 2.33.8-dev.8609bc45

package/package.json

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

package/src/api/client.test.ts

@@ -9,7 +9,7 @@ import waitForExpect from 'wait-for-expect';
 
 import { sleep, waitForCondition } from '@dxos/async';
 import { ConfigObject } from '@dxos/config';
-import { generateSeedPhrase, keyPairFromSeedPhrase } from '@dxos/crypto';
+import { generateSeedPhrase, keyPairFromSeedPhrase } from '@dxos/credentials';
 import { throwUnhandledRejection } from '@dxos/debug';
 import { InvitationDescriptor } from '@dxos/echo-db';
 import { Timeframe } from '@dxos/echo-protocol';

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';

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, keyPairFromSeedPhrase, 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>
 }
 
 /**
@@ -88,11 +90,29 @@ export class HaloProxy implements Halo {
   }
 
   /**
-   * Create Profile. Add Identity key if public and secret key are provided. Then initializes profile with given username.
-   * If not public and secret key are provided it relies on keyring to contain an identity key.
+   * Create Profile.
+   * Add Identity key if public and secret key are provided.
+   * Then initializes profile with given username.
+   * If no public and secret key or seedphrase are provided it relies on keyring to contain an identity key.
+   * Seedphrase must not be specified with existing keys.
    * @returns User profile info.
    */
-  async createProfile ({ publicKey, secretKey, username }: CreateProfileOptions = {}): Promise<Profile> {
+  async createProfile ({
+    publicKey,
+    secretKey,
+    username,
+    seedphrase
+  }: CreateProfileOptions = {}): Promise<Profile> {
+    if (seedphrase && (publicKey || secretKey)) {
+      throw new Error('Seedphrase must not be specified with existing keys');
+    }
+
+    if (seedphrase) {
+      const keyPair = keyPairFromSeedPhrase(seedphrase);
+      publicKey = keyPair.publicKey;
+      secretKey = keyPair.secretKey;
+    }
+
     this._profile = await this._serviceProvider.services.ProfileService.createProfile({ publicKey, secretKey, username });
     return this._profile;
   }
@@ -155,20 +175,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 +196,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.
    *

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';

package/src/devtools/feeds.ts

@@ -5,8 +5,8 @@
 import { Readable } from 'readable-stream';
 
 import { Stream } from '@dxos/codec-protobuf';
-import { PublicKey } from '@dxos/crypto';
 import { createBatchStream } from '@dxos/feed-store';
+import { PublicKey } from '@dxos/protocols';
 
 import {
   SubscribeToFeedsRequest,

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/index.ts

@@ -2,6 +2,8 @@
 // Copyright 2020 DXOS.org
 //
 
+export { generateSeedPhrase } from '@dxos/credentials';
+
 export {
   PARTY_ITEM_TYPE, // TODO(burdon): Remove?
   Entity,

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;
 }

package/src/proto/gen/google/protobuf.ts

@@ -13,14 +13,14 @@ import * as dxos_halo_keys from "../dxos/halo/keys";
 import * as dxos_rpc from "../dxos/rpc";
 export interface Empty {
 }
-export interface Any {
-    type_url?: string;
-    value?: Uint8Array;
-}
 export interface Timestamp {
     seconds?: string;
     nanos?: number;
 }
+export interface Any {
+    type_url?: string;
+    value?: Uint8Array;
+}
 export interface FileDescriptorSet {
     file?: FileDescriptorProto[];
 }