@dxos/client 2.27.10-dev.84c4750a → 2.28.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client",
-  "version": "2.27.10-dev.84c4750a",
+  "version": "2.28.0",
   "license": "AGPL-3.0",
   "author": "DXOS.org",
   "main": "dist/src/index.js",
@@ -10,21 +10,21 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/async": "2.27.10-dev.84c4750a",
-    "@dxos/codec-protobuf": "2.27.10-dev.84c4750a",
-    "@dxos/config": "2.27.10-dev.84c4750a",
-    "@dxos/credentials": "2.27.10-dev.84c4750a",
-    "@dxos/crypto": "2.27.10-dev.84c4750a",
-    "@dxos/debug": "2.27.10-dev.84c4750a",
-    "@dxos/echo-db": "2.27.10-dev.84c4750a",
-    "@dxos/echo-protocol": "2.27.10-dev.84c4750a",
-    "@dxos/feed-store": "2.27.10-dev.84c4750a",
-    "@dxos/model-factory": "2.27.10-dev.84c4750a",
-    "@dxos/network-manager": "2.27.10-dev.84c4750a",
-    "@dxos/object-model": "2.27.10-dev.84c4750a",
-    "@dxos/protocol": "2.27.10-dev.84c4750a",
-    "@dxos/rpc": "2.27.10-dev.84c4750a",
-    "@dxos/util": "2.27.10-dev.84c4750a",
+    "@dxos/async": "2.28.0",
+    "@dxos/codec-protobuf": "2.28.0",
+    "@dxos/config": "2.28.0",
+    "@dxos/credentials": "2.28.0",
+    "@dxos/crypto": "2.28.0",
+    "@dxos/debug": "2.28.0",
+    "@dxos/echo-db": "2.28.0",
+    "@dxos/echo-protocol": "2.28.0",
+    "@dxos/feed-store": "2.28.0",
+    "@dxos/model-factory": "2.28.0",
+    "@dxos/network-manager": "2.28.0",
+    "@dxos/object-model": "2.28.0",
+    "@dxos/protocol": "2.28.0",
+    "@dxos/rpc": "2.28.0",
+    "@dxos/util": "2.28.0",
     "@polkadot/keyring": "6.11.1",
     "@polkadot/util": "6.11.1",
     "@polkadot/util-crypto": "6.11.1",
@@ -41,9 +41,9 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@dxos/random-access-multi-storage": "2.27.10-dev.84c4750a",
-    "@dxos/testutils": "2.27.9",
-    "@dxos/toolchain-node-library": "2.27.9",
+    "@dxos/random-access-multi-storage": "2.28.0",
+    "@dxos/testutils": "2.28.0",
+    "@dxos/toolchain-node-library": "2.28.0",
     "@types/debug": "^4.1.7",
     "@types/jest": "^26.0.7",
     "@types/level-js": "~4.0.1",

package/src/api/halo-proxy.ts

@@ -128,6 +128,22 @@ export class HaloProxy extends InvitationProxy {
     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 getGlobalPreference (key: string): Promise<string | undefined> {
+    return (await this._serviceProvider.services.HaloService.getGlobalPreference({ key })).value;
+  }
+
+  async setDevicePreference (key: string, value: string): Promise<void> {
+    await this._serviceProvider.services.HaloService.setDevicePreference({ key, value });
+  }
+
+  async getDevicePreference (key: string): Promise<string | undefined> {
+    return (await this._serviceProvider.services.HaloService.getDevicePreference({ key })).value;
+  }
+
   /**
    * Allocate resources and set-up internal subscriptions.
    *

package/src/client/client.test.ts

@@ -5,6 +5,7 @@
 import assert from 'assert';
 import expect from 'expect';
 import { it as test } from 'mocha';
+import waitForExpect from 'wait-for-expect';
 
 import { sleep, waitForCondition } from '@dxos/async';
 import { ConfigObject } from '@dxos/config';
@@ -201,6 +202,26 @@ describe('Client', () => {
 
         expect(invitee.halo.profile).not.toBeUndefined();
       }).timeout(5000);
+
+      test('DXNS Account is synced between devices', async () => {
+        const { inviter, invitee } = await prepareInvitations();
+
+        const DXNSAccount = 'd3abd23e3f36a61a9e5d58e4b6286f89649594eedbd096b3a6e256ca1fe4c147';
+        await inviter.halo.setGlobalPreference('DXNSAccount', DXNSAccount);
+
+        const invitation = await inviter.halo.createInvitation();
+        await invitee.halo.acceptInvitation(invitation.descriptor).wait();
+
+        await waitForExpect(async () => {
+          expect(await invitee.halo.getGlobalPreference('DXNSAccount')).toEqual(DXNSAccount);
+        });
+
+        // The preference can be changed and synced back.
+        await invitee.halo.setGlobalPreference('DXNSAccount', '123');
+        await waitForExpect(async () => {
+          expect(await inviter.halo.getGlobalPreference('DXNSAccount')).toEqual('123');
+        }, 10_000, 100);
+      }).timeout(10_000);
     });
 
     describe('data', () => {

package/src/client/service-host/services/halo.ts

@@ -3,16 +3,26 @@
 //
 
 import PolkadotKeyring from '@polkadot/keyring';
-import { hexToU8a, u8aToHex } from '@polkadot/util';
 import { cryptoWaitReady } from '@polkadot/util-crypto';
 import assert from 'assert';
 
 import { Stream } from '@dxos/codec-protobuf';
 import { KeyRecord, KeyType } from '@dxos/credentials';
 import { ECHO } from '@dxos/echo-db';
+import { ObjectModel } from '@dxos/object-model';
 import { SubscriptionGroup } from '@dxos/util';
 
-import { AddKeyRecordRequest, Contacts, HaloService as IHaloService, SignRequest, SignResponse } from '../../../proto/gen/dxos/client';
+import {
+  AddKeyRecordRequest,
+  Contacts,
+  HaloService as IHaloService,
+  SignRequest,
+  SignResponse,
+  SetPreferenceRequest,
+  GetPreferenceRequest,
+  GetPreferenceResponse
+
+} from '../../../proto/gen/dxos/client';
 import { resultSetToStream } from '../../../util';
 import { CreateServicesOpts } from './interfaces';
 
@@ -50,7 +60,7 @@ export class HaloService implements IHaloService {
     assert(await this.echo.halo.keyring.getKey(request.keyRecord.publicKey), 'Key not inserted correctly.');
   }
 
-  private async polkadotSign (key: KeyRecord, payload: SignRequest['payload']): Promise<SignResponse> {
+  private async polkadotSign (key: KeyRecord, payload: Uint8Array): Promise<SignResponse> {
     await cryptoWaitReady();
 
     assert(key.secretKey, 'Secret key is missing.');
@@ -58,9 +68,8 @@ export class HaloService implements IHaloService {
     const keyring = new PolkadotKeyring({ type: 'sr25519' });
     const keypair = keyring.addFromUri(key.secretKey.toString());
 
-    const signature = u8aToHex(keypair.sign(hexToU8a(payload), { withType: true }));
     return {
-      signed: signature
+      signed: keypair.sign(payload, { withType: true })
     };
   }
 
@@ -68,10 +77,41 @@ export class HaloService implements IHaloService {
     assert(request.publicKey, 'Provide a publicKey of the key that should be used for signing.');
     const key = await this.echo.halo.keyring.getFullKey(request.publicKey);
     assert(key, 'Key not found.');
-    if (key.type === KeyType.DXNS) {
+    if (key.type === KeyType.DXNS_ADDRESS) {
+      assert(request.payload, 'No payload to sign.');
       return this.polkadotSign(key, request.payload);
     }
-    throw new Error('Only DXNS key signing is supported.');
+    throw new Error('Only DXNS Address key signing is supported.');
+  }
+
+  async setGlobalPreference (request: SetPreferenceRequest): Promise<void> {
+    assert(request.key, 'Missing key of property.');
+    const preferences: ObjectModel | undefined = this.echo.halo.identity.preferences?.getGlobalPreferences()?.model;
+    assert(preferences, 'Preferences failed to load.');
+    await preferences.setProperty(request.key, request.value);
+  }
+
+  async getGlobalPreference (request: GetPreferenceRequest): Promise<GetPreferenceResponse> {
+    assert(request.key, 'Missing key of property.');
+    const preferences: ObjectModel | undefined = this.echo.halo.identity.preferences?.getGlobalPreferences()?.model;
+    return {
+      value: preferences?.getProperty(request.key)
+    };
+  }
+
+  async setDevicePreference (request: SetPreferenceRequest): Promise<void> {
+    assert(request.key, 'Missing key of property.');
+    const preferences: ObjectModel | undefined = this.echo.halo.identity.preferences?.getDevicePreferences()?.model;
+    assert(preferences, 'Preferences failed to load.');
+    await preferences.setProperty(request.key, request.value);
+  }
+
+  async getDevicePreference (request: GetPreferenceRequest): Promise<GetPreferenceResponse> {
+    assert(request.key, 'Missing key of property.');
+    const preferences: ObjectModel | undefined = this.echo.halo.identity.preferences?.getDevicePreferences()?.model;
+    return {
+      value: preferences?.getProperty(request.key)
+    };
   }
 }
 

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

@@ -91,15 +91,29 @@ export interface SignRequest {
      * - The public key of the key that is supposed to be used for signing.
      */
     publicKey?: ReturnType<typeof substitutions["dxos.halo.keys.PubKey"]["decode"]>;
-    payload?: ReturnType<typeof substitutions["google.protobuf.Any"]["decode"]>;
+    payload?: Uint8Array;
 }
 export interface SignResponse {
-    signed?: ReturnType<typeof substitutions["google.protobuf.Any"]["decode"]>;
+    signed?: Uint8Array;
+}
+export interface SetPreferenceRequest {
+    key?: string;
+    value?: string;
+}
+export interface GetPreferenceRequest {
+    key?: string;
+}
+export interface GetPreferenceResponse {
+    value?: string;
 }
 export interface HaloService {
     subscribeContacts: (request: void) => Stream<Contacts>;
     addKeyRecord: (request: AddKeyRecordRequest) => Promise<void>;
     sign: (request: SignRequest) => Promise<SignResponse>;
+    setGlobalPreference: (request: SetPreferenceRequest) => Promise<void>;
+    getGlobalPreference: (request: GetPreferenceRequest) => Promise<GetPreferenceResponse>;
+    setDevicePreference: (request: SetPreferenceRequest) => Promise<void>;
+    getDevicePreference: (request: GetPreferenceRequest) => Promise<GetPreferenceResponse>;
 }
 export interface Party {
     publicKey: ReturnType<typeof substitutions["dxos.halo.keys.PubKey"]["decode"]>;

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

@@ -183,7 +183,11 @@ export namespace Runtime {
              */
             accountUri?: string;
             /**
-             * Public address of the DXNS Account - not a secret.
+             * Public Polkadot Address.
+             */
+            address?: string;
+            /**
+             * Public address of a DXNS Account.
              */
             account?: string;
             faucet?: string;

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

@@ -16,7 +16,7 @@ export enum KeyType {
     DEVICE = 2,
     PARTY = 3,
     FEED = 4,
-    DXNS = 5
+    DXNS_ADDRESS = 5
 }
 export interface PubKey {
     data?: Uint8Array;

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

@@ -10,8 +10,6 @@ import * as dxos_echo_service from "../dxos/echo/service";
 import * as dxos_echo_snapshot from "../dxos/echo/snapshot";
 import * as dxos_halo_keys from "../dxos/halo/keys";
 import * as dxos_rpc from "../dxos/rpc";
-export interface Empty {
-}
 export interface Timestamp {
     seconds?: string;
     nanos?: number;
@@ -255,6 +253,8 @@ export namespace GeneratedCodeInfo {
         end?: number;
     }
 }
+export interface Empty {
+}
 export interface Any {
     type_url?: string;
     value?: Uint8Array;