@dxos/echo-db 2.33.8-dev.c77ba621 → 2.33.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-db",
-  "version": "2.33.8-dev.c77ba621",
+  "version": "2.33.8",
   "description": "ECHO database.",
   "license": "MIT",
   "main": "dist/src/index.js",
@@ -10,22 +10,22 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/async": "2.33.8-dev.c77ba621",
-    "@dxos/codec-protobuf": "2.33.8-dev.c77ba621",
-    "@dxos/credentials": "2.33.8-dev.c77ba621",
-    "@dxos/crypto": "2.33.8-dev.c77ba621",
-    "@dxos/debug": "2.33.8-dev.c77ba621",
-    "@dxos/echo-protocol": "2.33.8-dev.c77ba621",
-    "@dxos/feed-store": "2.33.8-dev.c77ba621",
-    "@dxos/mesh-protocol": "2.33.8-dev.c77ba621",
-    "@dxos/model-factory": "2.33.8-dev.c77ba621",
-    "@dxos/network-manager": "2.33.8-dev.c77ba621",
-    "@dxos/object-model": "2.33.8-dev.c77ba621",
-    "@dxos/protocol-plugin-presence": "2.33.8-dev.c77ba621",
-    "@dxos/protocol-plugin-replicator": "2.33.8-dev.c77ba621",
-    "@dxos/protocols": "2.33.8-dev.c77ba621",
-    "@dxos/random-access-multi-storage": "2.33.8-dev.c77ba621",
-    "@dxos/util": "2.33.8-dev.c77ba621",
+    "@dxos/async": "2.33.8",
+    "@dxos/codec-protobuf": "2.33.8",
+    "@dxos/credentials": "2.33.8",
+    "@dxos/crypto": "2.33.8",
+    "@dxos/debug": "2.33.8",
+    "@dxos/echo-protocol": "2.33.8",
+    "@dxos/feed-store": "2.33.8",
+    "@dxos/mesh-protocol": "2.33.8",
+    "@dxos/model-factory": "2.33.8",
+    "@dxos/network-manager": "2.33.8",
+    "@dxos/object-model": "2.33.8",
+    "@dxos/protocol-plugin-presence": "2.33.8",
+    "@dxos/protocol-plugin-replicator": "2.33.8",
+    "@dxos/protocols": "2.33.8",
+    "@dxos/random-access-multi-storage": "2.33.8",
+    "@dxos/util": "2.33.8",
     "base-x": "~3.0.9",
     "buffer-json-encoding": "^1.0.2",
     "debug": "^4.3.3",
@@ -35,10 +35,10 @@
     "pify": "~5.0.0"
   },
   "devDependencies": {
-    "@dxos/browser-mocha": "2.33.7",
+    "@dxos/browser-mocha": "2.33.8",
     "@dxos/eslint-plugin": "~1.0.34",
-    "@dxos/protocols-toolchain": "2.33.7",
-    "@dxos/testutils": "2.33.7",
+    "@dxos/protocols-toolchain": "2.33.8",
+    "@dxos/testutils": "2.33.8",
     "@types/columnify": "^1.5.1",
     "@types/debug": "^4.1.7",
     "@types/faker": "^5.5.1",

package/src/echo.test.ts

@@ -8,10 +8,12 @@ import expect from 'expect';
 import { it as test } from 'mocha';
 
 import { latch, promiseTimeout, waitForCondition } from '@dxos/async';
-import { defaultSecretProvider, defaultSecretValidator } from '@dxos/credentials';
-import { generateSeedPhrase, humanize, keyPairFromSeedPhrase } from '@dxos/crypto';
+import {
+  defaultSecretProvider, defaultSecretValidator, generateSeedPhrase, keyPairFromSeedPhrase
+} from '@dxos/credentials';
 import { ObjectModel } from '@dxos/object-model';
 import { afterTest } from '@dxos/testutils';
+import { humanize } from '@dxos/util';
 
 import { ECHO } from './echo';
 import { Contact } from './halo';

package/src/halo/halo-factory.ts

@@ -10,12 +10,12 @@ import {
   createIdentityInfoMessage,
   createKeyAdmitMessage,
   createPartyGenesisMessage,
+  keyPairFromSeedPhrase,
   Keyring,
   KeyType,
   Filter,
   SecretProvider
 } from '@dxos/credentials';
-import { keyToString, keyPairFromSeedPhrase } from '@dxos/crypto';
 import { ModelFactory } from '@dxos/model-factory';
 import { NetworkManager } from '@dxos/network-manager';
 import { ObjectModel } from '@dxos/object-model';
@@ -151,7 +151,7 @@ export class HaloFactory {
   }
 
   private async _joinHalo (invitationDescriptor: InvitationDescriptor, secretProvider: SecretProvider) {
-    log(`Admitting device with invitation: ${keyToString(invitationDescriptor.invitation)}`);
+    log(`Admitting device with invitation: ${PublicKey.stringify(invitationDescriptor.invitation)}`);
     assert(invitationDescriptor.identityKey);
 
     let identityKey = this._keyring.findKey(Keyring.signingFilter({ type: KeyType.IDENTITY }));

package/src/halo/halo.test.ts

@@ -5,8 +5,9 @@
 import expect from 'expect';
 import { it as test } from 'mocha';
 
-import { defaultSecretProvider, Keyring } from '@dxos/credentials';
-import { generateSeedPhrase, keyPairFromSeedPhrase } from '@dxos/crypto';
+import {
+  defaultSecretProvider, generateSeedPhrase, keyPairFromSeedPhrase, Keyring
+} from '@dxos/credentials';
 import { codec } from '@dxos/echo-protocol';
 import { FeedStore } from '@dxos/feed-store';
 import { ModelFactory } from '@dxos/model-factory';

package/src/halo/halo.ts

@@ -7,11 +7,12 @@ import debug from 'debug';
 
 import { synchronized } from '@dxos/async';
 import { KeyRecord, Keyring, KeyType, SecretProvider } from '@dxos/credentials';
-import { createKeyPair, humanize, KeyPair } from '@dxos/crypto';
+import { createKeyPair, KeyPair } from '@dxos/crypto';
 import { raise } from '@dxos/debug';
 import { ModelFactory } from '@dxos/model-factory';
 import { NetworkManager } from '@dxos/network-manager';
 import { PublicKey } from '@dxos/protocols';
+import { humanize } from '@dxos/util';
 
 import { ResultSet } from '../api';
 import { InvitationAuthenticator, InvitationDescriptor, InvitationOptions } from '../invitations';
@@ -225,6 +226,7 @@ export class HALO {
    */
   async createInvitation (authenticationDetails: InvitationAuthenticator, options?: InvitationOptions) {
     assert(this.identity?.halo, 'HALO not initialized.');
+
     return this.identity.halo.createInvitation(authenticationDetails, options);
   }
 

package/src/halo/types.ts

@@ -6,4 +6,5 @@ export interface CreateProfileOptions {
   publicKey?: Uint8Array
   secretKey?: Uint8Array
   username?: string
+  seedphrase?: string
 }

package/src/invitations/greeting-initiator.ts

@@ -23,7 +23,6 @@ import {
   SignedMessage,
   NotarizeResponse
 } from '@dxos/credentials';
-import { keyToString } from '@dxos/crypto';
 import { FullyConnectedTopology, NetworkManager } from '@dxos/network-manager';
 import { PublicKey } from '@dxos/protocols';
 
@@ -88,10 +87,10 @@ export class GreetingInitiator {
     // Therefore at present the greeter discovers the invitation id from session metadata, via the invitee's peer id.
     // TODO(dboreham): Invitation is actually invitationID.
     const localPeerId = invitation;
-    log('Local PeerId:', keyToString(localPeerId));
+    log('Local PeerId:', PublicKey.stringify(localPeerId));
     this._greeterPlugin = new GreetingCommandPlugin(Buffer.from(localPeerId), new Greeter().createMessageHandler());
 
-    log(keyToString(localPeerId), 'connecting to', keyToString(swarmKey));
+    log(PublicKey.stringify(localPeerId), 'connecting to', PublicKey.stringify(swarmKey));
 
     const peerJoinedWaiter = waitForEvent(this._greeterPlugin, 'peer:joined',
       (remotePeerId: any) => remotePeerId && Buffer.from(responderPeerId).equals(remotePeerId),

package/src/invitations/greeting-protocol-provider.ts

@@ -2,8 +2,8 @@
 // Copyright 2020 DXOS.org
 //
 
-import { keyToString } from '@dxos/crypto';
 import { protocolFactory } from '@dxos/network-manager';
+import { PublicKey } from '@dxos/protocols';
 
 /**
  * Creates a duplex connection with a single peer using a common rendezvous key as topic.
@@ -16,6 +16,6 @@ import { protocolFactory } from '@dxos/network-manager';
 // TODO(dboreham): Write a test to check resources are released (no resource leaks).
 export const greetingProtocolProvider = (rendezvousKey: any, peerId: Buffer | Uint8Array, protocolPlugins: any[]) => protocolFactory({
   getTopics: () => [rendezvousKey],
-  session: { peerId: keyToString(peerId) },
+  session: { peerId: PublicKey.stringify(peerId) },
   plugins: protocolPlugins
 });

package/src/invitations/greeting-responder.ts

@@ -16,7 +16,7 @@ import {
   SecretValidator
   , Message as HaloMessage
 } from '@dxos/credentials';
-import { keyToString, randomBytes } from '@dxos/crypto';
+import { randomBytes } from '@dxos/crypto';
 import { FeedWriter, SwarmKey } from '@dxos/echo-protocol';
 import { FullyConnectedTopology, NetworkManager } from '@dxos/network-manager';
 import { PublicKey } from '@dxos/protocols';
@@ -130,11 +130,11 @@ export class GreetingResponder {
     // TODO(dboreham): Add tests for idempotence and transactional integrity over the greet flow.
     (this._greeterPlugin as any).once('peer:joined', (joinedPeerId: Buffer) => {
       if (joinedPeerId.equals(invitation.id)) {
-        log(`Initiator connected: ${keyToString(joinedPeerId)}`);
+        log(`Initiator connected: ${PublicKey.stringify(joinedPeerId)}`);
         this._state = GreetingState.CONNECTED;
         this.connected.emit(invitation.id);
       } else {
-        log(`Unexpected initiator connected: ${keyToString(joinedPeerId)}`);
+        log(`Unexpected initiator connected: ${PublicKey.stringify(joinedPeerId)}`);
       }
     });
 
@@ -158,7 +158,7 @@ export class GreetingResponder {
       label: 'Greeting responder'
     });
 
-    log(`Greeting for: ${this._partyProcessor.partyKey.toHex()} on swarmKey ${keyToString(this._swarmKey)}`);
+    log(`Greeting for: ${this._partyProcessor.partyKey.toHex()} on swarmKey ${PublicKey.stringify(this._swarmKey)}`);
 
     this._state = GreetingState.LISTENING;
     log('Listening');

package/src/invitations/halo-recovery-initiator.ts

@@ -19,7 +19,7 @@ import {
   SignedMessage,
   codec
 } from '@dxos/credentials';
-import { keyToBuffer, keyToString, randomBytes, verify } from '@dxos/crypto';
+import { randomBytes, verify } from '@dxos/crypto';
 import { FullyConnectedTopology, NetworkManager } from '@dxos/network-manager';
 import { PublicKey } from '@dxos/protocols';
 
@@ -66,7 +66,7 @@ export class HaloRecoveryInitiator {
 
     // This is a temporary connection, there is no need to any special or permanent ID.
     this._peerId = randomBytes();
-    log('Local PeerId:', keyToString(this._peerId));
+    log('Local PeerId:', PublicKey.stringify(this._peerId));
 
     const swarmKey = this._credentialsSigner.getIdentityKey().publicKey.asBuffer();
 
@@ -102,7 +102,7 @@ export class HaloRecoveryInitiator {
 
     // Send to the first peer (any peer will do).
     const peer = this._greeterPlugin.peers[0];
-    const responderPeerId = keyToBuffer(peer.getSession().peerId);
+    const responderPeerId = PublicKey.bufferize(peer.getSession().peerId);
 
     // Synthesize an "invitationID" which is the signature of both peerIds signed by our Identity key.
     const signature = this._credentialsSigner.signer.rawSign(

package/src/invitations/invitation-descriptor.ts

@@ -6,7 +6,7 @@ import assert from 'assert';
 import base from 'base-x';
 import stableStringify from 'json-stable-stringify';
 
-import { keyToBuffer, keyToString, ripemd160 } from '@dxos/crypto';
+import { ripemd160 } from '@dxos/crypto';
 import { SwarmKey } from '@dxos/echo-protocol';
 import * as proto from '@dxos/echo-protocol';
 import { PublicKey } from '@dxos/protocols';
@@ -46,8 +46,8 @@ export class InvitationDescriptor {
   static fromQueryParameters (queryParameters: InvitationQueryParameters): InvitationDescriptor {
     const { hash, swarmKey, invitation, identityKey, type } = queryParameters;
 
-    const descriptor = new InvitationDescriptor(parseInvitationType(type), keyToBuffer(swarmKey),
-      keyToBuffer(invitation), identityKey ? PublicKey.from(identityKey) : undefined);
+    const descriptor = new InvitationDescriptor(parseInvitationType(type), PublicKey.bufferize(swarmKey),
+      PublicKey.bufferize(invitation), identityKey ? PublicKey.from(identityKey) : undefined);
 
     if (hash !== descriptor.hash) {
       throw new InvalidInvitationError();
@@ -104,8 +104,8 @@ export class InvitationDescriptor {
    */
   toQueryParameters (): InvitationQueryParameters {
     const query: Partial<InvitationQueryParameters> = {
-      swarmKey: keyToString(this.swarmKey),
-      invitation: keyToString(this.invitation),
+      swarmKey: PublicKey.stringify(this.swarmKey),
+      invitation: PublicKey.stringify(this.invitation),
       type: stringifyInvitationType(this.type)
     };
 

package/src/invitations/offline-invitation-claimer.ts

@@ -20,7 +20,7 @@ import {
   SignedMessage,
   codec
 } from '@dxos/credentials';
-import { keyToBuffer, keyToString, randomBytes } from '@dxos/crypto';
+import { randomBytes } from '@dxos/crypto';
 import { FullyConnectedTopology, NetworkManager } from '@dxos/network-manager';
 import { PublicKey } from '@dxos/protocols';
 
@@ -66,7 +66,7 @@ export class OfflineInvitationClaimer {
 
     // This is a temporary connection, there is no need to any special or permanent ID.
     const localPeerId = randomBytes();
-    log('Local PeerId:', keyToString(localPeerId));
+    log('Local PeerId:', PublicKey.stringify(localPeerId));
 
     this._greeterPlugin = new GreetingCommandPlugin(localPeerId, async () => false);
 
@@ -100,7 +100,7 @@ export class OfflineInvitationClaimer {
     const { invitation: invitationID } = this._invitationDescriptor;
 
     // Send to the first peer (any peer will do).
-    const responderPeerId = keyToBuffer(this._greeterPlugin.peers[0].getSession().peerId);
+    const responderPeerId = PublicKey.bufferize(this._greeterPlugin.peers[0].getSession().peerId);
 
     // We expect to receive a new swarm/rendezvousKey to use for the full Greeting process.
     const claimResponse = await this._greeterPlugin.send(

package/src/parties/party-factory.ts

@@ -13,13 +13,13 @@ import {
   SecretProvider,
   wrapMessage
 } from '@dxos/credentials';
-import { humanize, keyToString } from '@dxos/crypto';
 import { failUndefined, raise, timed } from '@dxos/debug';
 import { createFeedWriter, FeedMessage, PartyKey, PartySnapshot, Timeframe } from '@dxos/echo-protocol';
 import { ModelFactory } from '@dxos/model-factory';
 import { NetworkManager } from '@dxos/network-manager';
 import { ObjectModel } from '@dxos/object-model';
 import { PublicKey } from '@dxos/protocols';
+import { humanize } from '@dxos/util';
 
 import {
   createDataPartyAdmissionMessages,
@@ -154,8 +154,8 @@ export class PartyFactory {
       const invitationClaimer = new OfflineInvitationClaimer(this._networkManager, invitationDescriptor);
       await invitationClaimer.connect();
       invitationDescriptor = await invitationClaimer.claim();
-      log(`Party invitation ${keyToString(originalInvitation.invitation)} triggered interactive Greeting`,
-        `at ${keyToString(invitationDescriptor.invitation)}`);
+      log(`Party invitation ${PublicKey.stringify(originalInvitation.invitation)} triggered interactive Greeting`,
+        `at ${PublicKey.stringify(invitationDescriptor.invitation)}`);
       await invitationClaimer.destroy();
     }
 

package/src/parties/party-manager.test.ts

@@ -19,10 +19,10 @@ import {
 } from '@dxos/credentials';
 import {
   createKeyPair,
-  humanize,
   randomBytes,
   sign,
-  SIGNATURE_LENGTH, verify
+  SIGNATURE_LENGTH,
+  verify
 } from '@dxos/crypto';
 import { checkType } from '@dxos/debug';
 import { codec, EchoEnvelope, Timeframe } from '@dxos/echo-protocol';
@@ -33,6 +33,7 @@ import { ObjectModel } from '@dxos/object-model';
 import { PublicKey } from '@dxos/protocols';
 import { createStorage, StorageType } from '@dxos/random-access-multi-storage';
 import { afterTest, testTimeout } from '@dxos/testutils';
+import { humanize } from '@dxos/util';
 
 import { defaultInvitationAuthenticator, OfflineInvitationClaimer } from '../invitations';
 import { Item } from '../packlets/database';

package/src/pipeline/feed-muxer.ts

@@ -7,7 +7,6 @@ import debug from 'debug';
 
 import { Event } from '@dxos/async';
 import { Message as HaloMessage } from '@dxos/credentials';
-import { keyToString } from '@dxos/crypto';
 import { checkType } from '@dxos/debug';
 import {
   createFeedMeta, EchoEnvelope, FeedMessage, FeedStoreIterator, FeedWriter, IEchoStream, mapFeedWriter, Timeframe
@@ -139,7 +138,8 @@ export class FeedMuxer {
 
           if (message.echo) {
             const memberKey = this._partyProcessor.getFeedOwningMember(PublicKey.from(block.key));
-            assert(memberKey, `Ownership of feed ${keyToString(block.key)} could not be determined.`);
+            // TODO(wittjosiah): Is actually a Buffer for some reason. See todo in IFeedGenericBlock.
+            assert(memberKey, `Ownership of feed ${PublicKey.stringify(block.key as unknown as Buffer)} could not be determined.`);
 
             // Validate messge.
             const { itemId } = message.echo;

package/src/protocol/identity-credentials.ts

@@ -2,8 +2,11 @@
 // Copyright 2022 DXOS.org
 //
 
-import { createIdentityInfoMessage, createKeyAdmitMessage, createPartyGenesisMessage, KeyChain, KeyRecord, Keyring, KeyType, SignedMessage } from '@dxos/credentials';
-import { humanize } from '@dxos/crypto';
+import {
+  createIdentityInfoMessage, createKeyAdmitMessage, createPartyGenesisMessage,
+  KeyChain, KeyRecord, Keyring, KeyType, SignedMessage
+} from '@dxos/credentials';
+import { humanize } from '@dxos/util';
 
 import { ContactManager, Preferences } from '../halo';
 import { CredentialsSigner } from './credentials-signer';

package/src/protocol/party-protocol-factory.ts

@@ -4,7 +4,7 @@
 
 import debug from 'debug';
 
-import { discoveryKey, keyToString } from '@dxos/crypto';
+import { discoveryKey } from '@dxos/crypto';
 import { PartyKey } from '@dxos/echo-protocol';
 import { Protocol } from '@dxos/mesh-protocol';
 import { MMSTTopology, NetworkManager, Plugin } from '@dxos/network-manager';
@@ -93,7 +93,7 @@ export class PartyProtocolFactory {
 
       userSession: {
         // TODO(burdon): See deprecated `protocolFactory` in HALO.
-        peerId: keyToString(this._peerId.asBuffer()),
+        peerId: this._peerId.toHex(),
         // TODO(telackey): This ought to be the CredentialsProvider itself, so that fresh credentials can be minted.
         credentials: this._credentials.get().toString('base64')
       },

package/src/protocol/replicator-plugin.ts

@@ -4,7 +4,6 @@
 
 import debug from 'debug';
 
-import { keyToString } from '@dxos/crypto';
 import { Replicator } from '@dxos/protocol-plugin-replicator';
 
 import { PartyFeedProvider } from '../pipeline';
@@ -18,7 +17,7 @@ export const createReplicatorPlugin = (feedProvider: PartyFeedProvider) =>
   new Replicator({
     load: async () => {
       const feeds = feedProvider.getFeeds();
-      log(`Loading feeds: ${feeds.map(feed => keyToString(feed.key))}`);
+      log(`Loading feeds: ${feeds.map(feed => feed.key.toHex())}`);
       return feeds.map((feed) => ({ discoveryKey: feed.feed.discoveryKey }));
     },
 

package/src/snapshots/snapshot-generator.ts

@@ -4,7 +4,7 @@
 
 import debug from 'debug';
 
-import { humanize } from '@dxos/crypto';
+import { humanize } from '@dxos/util';
 
 import { TimeframeClock } from '../packlets/database';
 import { PartyPipeline } from '../pipeline';

package/src/snapshots/snapshot-store.ts

@@ -5,8 +5,8 @@
 import assert from 'assert';
 import debug from 'debug';
 
-import { keyToString } from '@dxos/crypto';
 import { schema, PartyKey, PartySnapshot } from '@dxos/echo-protocol';
+import { PublicKey } from '@dxos/protocols';
 import { Directory } from '@dxos/random-access-multi-storage';
 
 const log = debug('dxos:snapshot-store');
@@ -44,7 +44,7 @@ export class SnapshotStore {
 
   async save (snapshot: PartySnapshot) {
     assert(snapshot.partyKey);
-    const file = this._directory.createOrOpen(keyToString(snapshot.partyKey), { truncate: true, size: 0 });
+    const file = this._directory.createOrOpen(PublicKey.stringify(snapshot.partyKey), { truncate: true, size: 0 });
 
     try {
       const data = schema.getCodecForType('dxos.echo.snapshot.PartySnapshot').encode(snapshot);