@dxos/echo-db 2.33.5-dev.61c93034 → 2.33.5-dev.97a81dd0

package/src/halo/halo-party.ts

@@ -5,10 +5,10 @@
 import assert from 'assert';
 
 import { Event, synchronized } from '@dxos/async';
-import { KeyHint } from '@dxos/credentials';
+import { KeyHint, Message as HaloMessage } from '@dxos/credentials';
 import { PublicKey } from '@dxos/crypto';
 import { timed } from '@dxos/debug';
-import { Timeframe } from '@dxos/echo-protocol';
+import { Timeframe, WriteReceipt } from '@dxos/echo-protocol';
 import { ModelFactory } from '@dxos/model-factory';
 import { NetworkManager } from '@dxos/network-manager';
 
@@ -114,10 +114,6 @@ export class HaloParty {
     return this._partyCore.processor.credentialMessages.get(this._credentialsSigner.getIdentityKey().publicKey.toHex());
   }
 
-  get memberKeys () {
-    return this._partyCore.processor.memberKeys;
-  }
-
   get credentialMessages () {
     return this._partyCore.processor.credentialMessages;
   }
@@ -200,6 +196,10 @@ export class HaloParty {
     return this;
   }
 
+  writeCredentialsMessage (message: HaloMessage): Promise<WriteReceipt> {
+    return this._partyCore.writeCredentialsMessage(message);
+  }
+
   async createInvitation (authenticationDetails: InvitationAuthenticator, options?: InvitationOptions): Promise<InvitationDescriptor> {
     assert(this._invitationManager, 'HALO party not open.');
     return this._invitationManager.createInvitation(authenticationDetails, options);

package/src/invitations/greeting-responder.ts

@@ -19,7 +19,7 @@ import { keyToString, randomBytes, PublicKey } from '@dxos/crypto';
 import { SwarmKey } from '@dxos/echo-protocol';
 import { FullyConnectedTopology, NetworkManager } from '@dxos/network-manager';
 
-import { PartyProcessor } from '../pipeline';
+import { CredentialWriter, PartyStateProvider } from '../pipeline';
 import { CredentialsSigner } from '../protocol/credentials-signer';
 import { InvitationOptions } from './common';
 import { greetingProtocolProvider } from './greeting-protocol-provider';
@@ -57,7 +57,7 @@ export class GreetingResponder {
 
   constructor (
     private readonly _networkManager: NetworkManager,
-    private readonly _partyProcessor: PartyProcessor,
+    private readonly _partyProcessor: CredentialWriter & PartyStateProvider,
     private readonly _credentialsSigner: CredentialsSigner
   ) {
     this._greeter = new Greeter(

package/src/invitations/invitation-factory.ts

@@ -8,7 +8,7 @@ import { createPartyInvitationMessage } from '@dxos/credentials';
 import { PublicKey } from '@dxos/crypto';
 import { NetworkManager } from '@dxos/network-manager';
 
-import { PartyProcessor } from '../pipeline';
+import { CredentialWriter, PartyStateProvider } from '../pipeline';
 import { CredentialsSigner } from '../protocol/credentials-signer';
 import { defaultInvitationAuthenticator, InvitationAuthenticator, InvitationOptions } from './common';
 import { GreetingResponder } from './greeting-responder';
@@ -19,7 +19,7 @@ import { InvitationDescriptor, InvitationDescriptorType } from './invitation-des
  */
 export class InvitationFactory {
   constructor (
-    private readonly _partyProcessor: PartyProcessor,
+    private readonly _partyProcessor: CredentialWriter & PartyStateProvider,
     // This needs to be a provider in case this is a backend for the HALO party.
     // Then the identity would be changed after this is instantiated.
     private readonly _credentialsSigner: CredentialsSigner,

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

@@ -59,8 +59,8 @@ describe('DataParty', () => {
     const party = await createParty(identity, partyKey.publicKey, []);
     await party.open();
 
-    const feed = await party.feedProvider.createOrOpenWritableFeed();
-    await party.processor.writeHaloMessage(createPartyGenesisMessage(
+    const feed = await party.getWriteFeed();
+    await party.writeCredentialsMessage(createPartyGenesisMessage(
       keyring,
       partyKey,
       feed.key,
@@ -79,8 +79,8 @@ describe('DataParty', () => {
 
     const party = await createParty(identity, partyKey.publicKey, []);
     await party.open();
-    const feed = await party.feedProvider.createOrOpenWritableFeed();
-    await party.processor.writeHaloMessage(createPartyGenesisMessage(
+    const feed = await party.getWriteFeed();
+    await party.writeCredentialsMessage(createPartyGenesisMessage(
       keyring,
       partyKey,
       feed.key,
@@ -103,8 +103,8 @@ describe('DataParty', () => {
 
     const party = await createParty(identityA, partyKey.publicKey, []);
     await party.open();
-    const feed = await party.feedProvider.createOrOpenWritableFeed();
-    await party.processor.writeHaloMessage(createPartyGenesisMessage(
+    const feed = await party.getWriteFeed();
+    await party.writeCredentialsMessage(createPartyGenesisMessage(
       keyring,
       partyKey,
       feed.key,
@@ -128,14 +128,14 @@ describe('DataParty', () => {
 
     const partyA = await createParty(identityA, partyKey.publicKey, []);
     await partyA.open();
-    const feedA = await partyA.feedProvider.createOrOpenWritableFeed();
-    await partyA.processor.writeHaloMessage(createPartyGenesisMessage(
+    const feedA = await partyA.getWriteFeed();
+    await partyA.writeCredentialsMessage(createPartyGenesisMessage(
       keyring,
       partyKey,
       feedA.key,
       partyKey
     ));
-    await partyA.processor.writeHaloMessage(createKeyAdmitMessage(
+    await partyA.writeCredentialsMessage(createKeyAdmitMessage(
       keyring,
       partyKey.publicKey,
       identityA.identityKey,
@@ -164,14 +164,14 @@ describe('DataParty', () => {
 
     const partyA = await createParty(identityA, partyKeyA.publicKey, []);
     await partyA.open();
-    const feedA = await partyA.feedProvider.createOrOpenWritableFeed();
-    await partyA.processor.writeHaloMessage(createPartyGenesisMessage(
+    const feedA = await partyA.getWriteFeed();
+    await partyA.writeCredentialsMessage(createPartyGenesisMessage(
       identityA.keyring,
       partyKeyA,
       feedA.key,
       partyKeyA
     ));
-    await partyA.processor.writeHaloMessage(createKeyAdmitMessage(
+    await partyA.writeCredentialsMessage(createKeyAdmitMessage(
       identityA.keyring,
       partyKeyA.publicKey,
       identityA.identityKey,

package/src/parties/data-party.ts

@@ -5,10 +5,11 @@
 import assert from 'assert';
 
 import { synchronized, Event } from '@dxos/async';
-import { KeyHint } from '@dxos/credentials';
+import { KeyHint, Message as HaloMessage } from '@dxos/credentials';
 import { PublicKey } from '@dxos/crypto';
 import { timed } from '@dxos/debug';
-import { PartyKey, PartySnapshot, Timeframe } from '@dxos/echo-protocol';
+import { PartyKey, PartySnapshot, Timeframe, WriteReceipt } from '@dxos/echo-protocol';
+import { FeedDescriptor } from '@dxos/feed-store';
 import { ModelFactory } from '@dxos/model-factory';
 import { NetworkManager } from '@dxos/network-manager';
 import { ObjectModel } from '@dxos/object-model';
@@ -126,16 +127,6 @@ export class DataParty {
     return this._invitationManager;
   }
 
-  // TODO(burdon): Remove?
-  get feedProvider (): PartyFeedProvider {
-    return this._feedProvider;
-  }
-
-  get preferences (): PartyPreferences {
-    assert(this._preferences, 'Preferences not available.');
-    return this._preferences;
-  }
-
   get title () {
     return this._preferences?.getLastKnownTitle();
   }
@@ -211,6 +202,18 @@ export class DataParty {
     return this;
   }
 
+  async getWriteFeed (): Promise<FeedDescriptor> {
+    return this._feedProvider.createOrOpenWritableFeed();
+  }
+
+  getFeeds (): FeedDescriptor[] {
+    return this._feedProvider.getFeeds();
+  }
+
+  writeCredentialsMessage (message: HaloMessage): Promise<WriteReceipt> {
+    return this._partyCore.writeCredentialsMessage(message);
+  }
+
   get isActive (): boolean {
     assert(this._preferences, 'PartyActivator required');
     return this._preferences.isActive;

package/src/parties/party-factory.ts

@@ -60,10 +60,10 @@ export class PartyFactory {
     // Connect the pipeline.
     await party.open();
 
-    const writableFeed = await party.feedProvider.createOrOpenWritableFeed();
+    const writableFeed = await party.getWriteFeed();
 
     // PartyGenesis (self-signed by Party).
-    await party.processor.writeHaloMessage(createPartyGenesisMessage(
+    await party.writeCredentialsMessage(createPartyGenesisMessage(
       identity.keyring,
       partyKey,
       writableFeed.key,
@@ -71,7 +71,7 @@ export class PartyFactory {
     );
 
     // KeyAdmit (IdentityGenesis in an Envelope signed by Party).
-    await party.processor.writeHaloMessage(createEnvelopeMessage(
+    await party.writeCredentialsMessage(createEnvelopeMessage(
       identity.keyring,
       partyKey.publicKey,
       wrapMessage(identity.identityGenesis),
@@ -80,7 +80,7 @@ export class PartyFactory {
 
     // FeedAdmit (signed by the Device KeyChain).
     // TODO(dmaretskyi): Is this really needed since a feed is already admitted by party genesis message.
-    await party.processor.writeHaloMessage(createFeedAdmitMessage(
+    await party.writeCredentialsMessage(createFeedAdmitMessage(
       identity.keyring,
       partyKey.publicKey,
       writableFeed.key,
@@ -89,7 +89,7 @@ export class PartyFactory {
 
     // IdentityInfo in an Envelope signed by the Device KeyChain.
     if (identity.identityInfo) {
-      await party.processor.writeHaloMessage(createEnvelopeMessage(
+      await party.writeCredentialsMessage(createEnvelopeMessage(
         identity.keyring,
         partyKey.publicKey,
         wrapMessage(identity.identityInfo),
@@ -106,50 +106,6 @@ export class PartyFactory {
     return party;
   }
 
-  /**
-   * Constructs a party object and creates a local write feed for it.
-   * @param partyKey
-   * @param hints
-   */
-  async addParty (partyKey: PartyKey, hints: KeyHint[] = []) {
-    const identity = this._identityProvider() ?? raise(new IdentityNotInitializedError());
-
-    /*
-     * TODO(telackey): We shouldn't have to add our key here, it should be in the hints, but our hint
-     * mechanism is broken by not waiting on the messages to be processed before returning.
-     */
-
-    const feedProvider = this._feedProviderFactory(partyKey);
-    const { feed } = await feedProvider.createOrOpenWritableFeed();
-    const feedKeyPair = identity.keyring.getKey(feed.key);
-    assert(feedKeyPair, 'Keypair for writable feed not found.');
-    const party = new DataParty(
-      partyKey,
-      this._modelFactory,
-      this._snapshotStore,
-      feedProvider,
-      identity.createCredentialsSigner(),
-      identity.preferences,
-      this._networkManager,
-      hints,
-      undefined,
-      this._options
-    );
-
-    await party.open();
-    const isHalo = identity.identityKey.publicKey.equals(partyKey);
-    const signingKey = isHalo ? identity.deviceKey : identity.deviceKeyChain;
-    assert(signingKey, 'No device key or keychain.');
-    // Write the Feed genesis message.
-    await party.processor.writeHaloMessage(createFeedAdmitMessage(
-      identity.keyring,
-      partyKey,
-      feedKeyPair.publicKey,
-      [signingKey]
-    ));
-    return party;
-  }
-
   /**
    * Constructs a party object from an existing set of feeds.
    * @param partyKey
@@ -190,7 +146,6 @@ export class PartyFactory {
   }
 
   async joinParty (invitationDescriptor: InvitationDescriptor, secretProvider: SecretProvider): Promise<DataParty> {
-    const haloInvitation = !!invitationDescriptor.identityKey;
     const originalInvitation = invitationDescriptor;
 
     const identity = this._identityProvider() ?? raise(new IdentityNotInitializedError());
@@ -218,19 +173,18 @@ export class PartyFactory {
 
     await initiator.connect();
     const { partyKey, hints } = await initiator.redeemInvitation(secretProvider);
-    const party = await this.addParty(partyKey, hints);
+    const party = await this.constructParty(partyKey, hints);
+    await party.open();
     await initiator.destroy();
-    if (!haloInvitation) {
-      // Copy our signed IdentityInfo into the new Party.
-      const infoMessage = identity.identityInfo;
-      if (infoMessage) {
-        await party.processor.writeHaloMessage(createEnvelopeMessage(
-          identity.keyring,
-          partyKey,
-          wrapMessage(infoMessage),
-          [identity.deviceKeyChain]
-        ));
-      }
+
+    // Copy our signed IdentityInfo into the new Party.
+    if (identity.identityInfo) {
+      await party.writeCredentialsMessage(createEnvelopeMessage(
+        identity.keyring,
+        partyKey,
+        wrapMessage(identity.identityInfo),
+        [identity.deviceKeyChain]
+      ));
     }
 
     return party;
@@ -247,10 +201,10 @@ export class PartyFactory {
     // Connect the pipeline.
     await party.open();
 
-    const writableFeed = await party.feedProvider.createOrOpenWritableFeed();
+    const writableFeed = await party.getWriteFeed();
 
     // PartyGenesis (self-signed by Party).
-    await party.processor.writeHaloMessage(createPartyGenesisMessage(
+    await party.writeCredentialsMessage(createPartyGenesisMessage(
       identity.keyring,
       partyKey,
       writableFeed.key,
@@ -258,7 +212,7 @@ export class PartyFactory {
     );
 
     // KeyAdmit (IdentityGenesis in an Envelope signed by Party).
-    await party.processor.writeHaloMessage(createEnvelopeMessage(
+    await party.writeCredentialsMessage(createEnvelopeMessage(
       identity.keyring,
       partyKey.publicKey,
       wrapMessage(identity.identityGenesis),
@@ -266,7 +220,7 @@ export class PartyFactory {
     ));
 
     // FeedAdmit (signed by the Device KeyChain).
-    await party.processor.writeHaloMessage(createFeedAdmitMessage(
+    await party.writeCredentialsMessage(createFeedAdmitMessage(
       identity.keyring,
       partyKey.publicKey,
       writableFeed.key,
@@ -275,7 +229,7 @@ export class PartyFactory {
 
     // IdentityInfo in an Envelope signed by the Device KeyChain.
     if (identity.identityInfo) {
-      await party.processor.writeHaloMessage(createEnvelopeMessage(
+      await party.writeCredentialsMessage(createEnvelopeMessage(
         identity.keyring,
         partyKey.publicKey,
         wrapMessage(identity.identityInfo),
@@ -285,7 +239,7 @@ export class PartyFactory {
 
     // const keyAdmitMessage = snapshot.halo?.messages?.[1];
     // assert(keyAdmitMessage);
-    // await party.processor.writeHaloMessage(createEnvelopeMessage(
+    // await party.writeCredentialsMessage(createEnvelopeMessage(
     //   identity.signer,
     //   partyKey.publicKey,
     //   keyAdmitMessage,
@@ -293,7 +247,7 @@ export class PartyFactory {
     // ));
 
     // for(const message of snapshot.halo?.messages?.slice(2) || []) {
-    //   await party.processor.writeHaloMessage(message);
+    //   await party.writeCredentialsMessage(message);
     // }
 
     // Write messages to create ECHO items.

package/src/parties/party-manager.ts

@@ -175,7 +175,8 @@ export class PartyManager {
     }
 
     log(`Adding party partyKey=${partyKey.toHex()} hints=${hints.length}`);
-    const party = await this._partyFactory.addParty(partyKey, hints);
+    const party = await this._partyFactory.constructParty(partyKey, hints);
+    await party.open();
     await this._metadataStore.addParty(party.key);
     this._setParty(party);
     return party;

package/src/pipeline/message-selector.ts

@@ -10,7 +10,7 @@ import { PublicKey } from '@dxos/crypto';
 import { MessageSelector } from '@dxos/echo-protocol';
 
 import { TimeframeClock } from '../database';
-import { PartyProcessor } from './party-processor';
+import { PartyStateProvider } from './party-processor';
 
 const log = debug('dxos:echo-db:message-selector');
 
@@ -23,7 +23,7 @@ const log = debug('dxos:echo-db:message-selector');
  * @param partyProcessor
  * @param timeframeClock
  */
-export const createMessageSelector = (partyProcessor: PartyProcessor, timeframeClock: TimeframeClock): MessageSelector => candidates => {
+export const createMessageSelector = (partyProcessor: PartyStateProvider, timeframeClock: TimeframeClock): MessageSelector => candidates => {
   // Check ECHO message candidates first since they are less expensive than HALO cancidates.
   for (let i = 0; i < candidates.length; i++) {
     const { data: { echo } } = candidates[i];
@@ -51,10 +51,12 @@ export const createMessageSelector = (partyProcessor: PartyProcessor, timeframeC
     }
 
     if (partyProcessor.genesisRequired) {
-      // TODO(telackey): Add check that this is for the right Party.
-      if (getPartyCredentialMessageType(halo) === PartyCredential.Type.PARTY_GENESIS) {
-        return i;
-      }
+      try { // TODO(dmaretskyi): Get getPartyCredentialMessageType crashes for some reason.
+        // TODO(telackey): Add check that this is for the right Party.
+        if (getPartyCredentialMessageType(halo) === PartyCredential.Type.PARTY_GENESIS) {
+          return i;
+        }
+      } catch { }
     }
   }
 

package/src/pipeline/party-core.test.ts

@@ -51,7 +51,7 @@ describe('PartyCore', () => {
     afterTest(async () => party.close());
 
     // PartyGenesis (self-signed by Party).
-    await party.processor.writeHaloMessage(createPartyGenesisMessage(
+    await party.writeCredentialsMessage(createPartyGenesisMessage(
       keyring,
       partyKey,
       feed.key,
@@ -59,7 +59,7 @@ describe('PartyCore', () => {
     );
 
     // FeedAdmit (signed by the Device KeyChain).
-    await party.processor.writeHaloMessage(createFeedAdmitMessage(
+    await party.writeCredentialsMessage(createFeedAdmitMessage(
       keyring,
       partyKey.publicKey,
       feed.key,
@@ -120,7 +120,7 @@ describe('PartyCore', () => {
     const feedKey = await keyring.createKeyRecord({ type: KeyType.FEED });
 
     const eventFired = feedStore.feedOpenedEvent.waitForCount(1);
-    await party.processor.writeHaloMessage(createFeedAdmitMessage(
+    await party.writeCredentialsMessage(createFeedAdmitMessage(
       keyring,
       party.key,
       feedKey.publicKey,
@@ -197,7 +197,7 @@ describe('PartyCore', () => {
     const fullKey = keyring.getFullKey(feedKey.publicKey);
     const feed2 = await feedStore.openReadWriteFeed(fullKey!.publicKey, fullKey!.secretKey!);
 
-    await party.processor.writeHaloMessage(createFeedAdmitMessage(
+    await party.writeCredentialsMessage(createFeedAdmitMessage(
       keyring,
       party.key,
       feed2.key,
@@ -226,7 +226,7 @@ describe('PartyCore', () => {
     const feedKey = await keyring.createKeyRecord({ type: KeyType.FEED });
     const fullKey = keyring.getFullKey(feedKey.publicKey);
 
-    await party.processor.writeHaloMessage(createFeedAdmitMessage(
+    await party.writeCredentialsMessage(createFeedAdmitMessage(
       keyring,
       party.key,
       feedKey.publicKey,
@@ -273,7 +273,7 @@ describe('PartyCore', () => {
 
     const feed2 = await partyFeedProvider.createOrOpenWritableFeed();
 
-    await peer1.party.processor.writeHaloMessage(createFeedAdmitMessage(
+    await peer1.party.writeCredentialsMessage(createFeedAdmitMessage(
       peer1.keyring,
       peer1.party.key,
       feed2.key,

package/src/pipeline/party-core.ts

@@ -5,10 +5,10 @@
 import assert from 'assert';
 
 import { synchronized } from '@dxos/async';
-import { KeyHint, KeyType } from '@dxos/credentials';
+import { KeyHint, KeyType, Message as HaloMessage } from '@dxos/credentials';
 import { PublicKey } from '@dxos/crypto';
 import { timed } from '@dxos/debug';
-import { createFeedWriter, DatabaseSnapshot, PartyKey, PartySnapshot, Timeframe } from '@dxos/echo-protocol';
+import { createFeedWriter, DatabaseSnapshot, PartyKey, PartySnapshot, Timeframe, WriteReceipt } from '@dxos/echo-protocol';
 import { ModelFactory } from '@dxos/model-factory';
 import { SubscriptionGroup } from '@dxos/util';
 
@@ -202,6 +202,11 @@ export class PartyCore {
     return this;
   }
 
+  writeCredentialsMessage (message: HaloMessage): Promise<WriteReceipt> {
+    assert(this._partyProcessor, 'Party not open');
+    return this._partyProcessor?.writeHaloMessage(message);
+  }
+
   /**
    * Create a snapshot of the current state.
    */

package/src/pipeline/party-processor.ts

@@ -12,7 +12,8 @@ import {
   PartyState,
   Message as HaloMessage,
   IdentityEventType,
-  PartyEventType
+  PartyEventType,
+  SignedMessage
 } from '@dxos/credentials';
 import { PublicKey } from '@dxos/crypto';
 import { FeedKey, FeedWriter, IHaloStream, PartyKey, HaloStateSnapshot, WriteReceipt } from '@dxos/echo-protocol';
@@ -20,10 +21,33 @@ import { jsonReplacer } from '@dxos/util';
 
 const log = debug('dxos:echo-db:party-processor');
 
+export interface CredentialWriter {
+  writeHaloMessage (message: HaloMessage): Promise<WriteReceipt>
+}
+
+export interface CredentialProcessor {
+  processMessage (message: IHaloStream): Promise<void>
+}
+
+export interface PartyStateProvider {
+  partyKey: PublicKey
+
+  /**
+   * Whether PartyGenesis was already processed.
+   */
+  genesisRequired: boolean
+  memberKeys: PublicKey[]
+  feedKeys: PublicKey[]
+  getFeedOwningMember (feedKey: FeedKey): PublicKey | undefined
+  isFeedAdmitted (feedKey: FeedKey): boolean
+
+  getOfflineInvitation (invitationID: Buffer): SignedMessage | undefined
+}
+
 /**
  * TODO(burdon): Wrapper/Bridge between HALO APIs.
  */
-export class PartyProcessor {
+export class PartyProcessor implements CredentialWriter, CredentialProcessor, PartyStateProvider {
   private readonly _state: PartyState;
 
   private _outboundHaloStream: FeedWriter<HaloMessage> | undefined;

package/src/pipeline/pipeline.ts

@@ -17,7 +17,7 @@ import { createReadable } from '@dxos/feed-store';
 import { jsonReplacer } from '@dxos/util';
 
 import { TimeframeClock } from '../database';
-import { PartyProcessor } from './party-processor';
+import { CredentialProcessor, PartyStateProvider } from './party-processor';
 
 interface Options {
   readLogger?: (msg: any) => void
@@ -55,17 +55,13 @@ export class Pipeline {
    * @param _options
    */
   constructor (
-    private readonly _partyProcessor: PartyProcessor,
+    private readonly _partyProcessor: CredentialProcessor & PartyStateProvider,
     private readonly _feedStorIterator: FeedStoreIterator,
     private readonly _timeframeClock: TimeframeClock,
     private readonly _feedWriter?: FeedWriter<FeedMessage>,
     private readonly _options: Options = {}
   ) {}
 
-  get partyKey () {
-    return this._partyProcessor.partyKey;
-  }
-
   get isOpen () {
     return this._inboundEchoStream !== undefined;
   }