@dxos/echo-db 2.33.5-dev.0a40e013 → 2.33.5-dev.1fc05a51

package/src/protocol/authenticator.ts

@@ -12,19 +12,17 @@ import { CredentialsSigner } from './credentials-signer';
 
 const log = debug('dxos:echo-db:authenticator');
 
-export function createAuthenticator (partyProcessor: PartyProcessor, credentialsSigner: CredentialsSigner): Authenticator {
-  return new PartyAuthenticator(partyProcessor.state, async auth => {
-    if (auth.feedAdmit && auth.feedKey && !partyProcessor.isFeedAdmitted(auth.feedKey)) {
-      log(`Admitting feed of authenticated member: ${auth.feedKey}`);
-      await partyProcessor.writeHaloMessage(createEnvelopeMessage(
-        credentialsSigner.signer,
-        partyProcessor.partyKey,
-        auth.feedAdmit,
-        [credentialsSigner.getDeviceSigningKeys()]
-      ));
-    }
-  });
-}
+export const createAuthenticator = (partyProcessor: PartyProcessor, credentialsSigner: CredentialsSigner): Authenticator => new PartyAuthenticator(partyProcessor.state, async auth => {
+  if (auth.feedAdmit && auth.feedKey && !partyProcessor.isFeedAdmitted(auth.feedKey)) {
+    log(`Admitting feed of authenticated member: ${auth.feedKey}`);
+    await partyProcessor.writeHaloMessage(createEnvelopeMessage(
+      credentialsSigner.signer,
+      partyProcessor.partyKey,
+      auth.feedAdmit,
+      [credentialsSigner.getDeviceSigningKeys()]
+    ));
+  }
+});
 
 export interface CredentialsProvider {
   /**
@@ -33,24 +31,22 @@ export interface CredentialsProvider {
   get (): Buffer
 }
 
-export function createCredentialsProvider (credentialsSigner: CredentialsSigner, partyKey: PartyKey, feedKey: FeedKey): CredentialsProvider {
-  return {
-    get: () => {
-      const authMessage = createAuthMessage(
+export const createCredentialsProvider = (credentialsSigner: CredentialsSigner, partyKey: PartyKey, feedKey: FeedKey): CredentialsProvider => ({
+  get: () => {
+    const authMessage = createAuthMessage(
+      credentialsSigner.signer,
+      partyKey,
+      credentialsSigner.getIdentityKey(),
+      credentialsSigner.getDeviceSigningKeys(),
+      feedKey,
+      undefined,
+      createFeedAdmitMessage(
         credentialsSigner.signer,
         partyKey,
-        credentialsSigner.getIdentityKey(),
-        credentialsSigner.getDeviceSigningKeys(),
         feedKey,
-        undefined,
-        createFeedAdmitMessage(
-          credentialsSigner.signer,
-          partyKey,
-          feedKey,
-          [feedKey, credentialsSigner.getDeviceSigningKeys()]
-        )
-      );
-      return Buffer.from(codec.encode(authMessage));
-    }
-  };
-}
+        [feedKey, credentialsSigner.getDeviceSigningKeys()]
+      )
+    );
+    return Buffer.from(codec.encode(authMessage));
+  }
+});

package/src/protocol/halo-recovery-plugin.ts

@@ -12,9 +12,7 @@ import { HaloRecoveryInitiator, InvitationFactory } from '../invitations';
  * Plugin is intended to be used in HALO party swarm.
  *
  */
-export function createHaloRecoveryPlugin (identityKey: PublicKey, invitationFactory: InvitationFactory, peerId: PublicKey) {
-  return new GreetingCommandPlugin(
-    peerId.asBuffer(),
-    HaloRecoveryInitiator.createHaloInvitationClaimHandler(identityKey, invitationFactory)
-  );
-}
+export const createHaloRecoveryPlugin = (identityKey: PublicKey, invitationFactory: InvitationFactory, peerId: PublicKey) => new GreetingCommandPlugin(
+  peerId.asBuffer(),
+  HaloRecoveryInitiator.createHaloInvitationClaimHandler(identityKey, invitationFactory)
+);

package/src/protocol/identity-credentials.ts

@@ -25,7 +25,7 @@ export interface IdentityCredentials {
 
 export type IdentityCredentialsProvider = () => IdentityCredentials | undefined
 
-export async function createTestIdentityCredentials (keyring: Keyring): Promise<IdentityCredentials> {
+export const createTestIdentityCredentials = async (keyring: Keyring): Promise<IdentityCredentials> => {
   const identityKey = await keyring.createKeyRecord({ type: KeyType.IDENTITY });
   const deviceKey = await keyring.createKeyRecord({ type: KeyType.DEVICE });
   const feedKey = await keyring.createKeyRecord({ type: KeyType.FEED });
@@ -53,9 +53,9 @@ export async function createTestIdentityCredentials (keyring: Keyring): Promise<
     preferences: undefined,
     contacts: undefined
   };
-}
+};
 
-export async function deriveTestDeviceCredentials (identity: IdentityCredentials): Promise<IdentityCredentials> {
+export const deriveTestDeviceCredentials = async (identity: IdentityCredentials): Promise<IdentityCredentials> => {
   const deviceKey = await identity.keyring.createKeyRecord({ type: KeyType.DEVICE });
   const keyAdmit = createKeyAdmitMessage(identity.keyring, identity.identityKey.publicKey, deviceKey, [identity.identityKey]);
 
@@ -75,4 +75,4 @@ export async function deriveTestDeviceCredentials (identity: IdentityCredentials
       deviceKeyChain
     )
   };
-}
+};

package/src/protocol/offline-invitation-plugin.ts

@@ -11,9 +11,7 @@ import { InvitationFactory, OfflineInvitationClaimer } from '../invitations';
  * Creates network protocol plugin that allows peers to claim offline invitations.
  * Plugin is intended to be used in data-party swarms.
  */
-export function createOfflineInvitationPlugin (invitationFactory: InvitationFactory, peerId: PublicKey) {
-  return new GreetingCommandPlugin(
-    peerId.asBuffer(),
-    OfflineInvitationClaimer.createOfflineInvitationClaimHandler(invitationFactory)
-  );
-}
+export const createOfflineInvitationPlugin = (invitationFactory: InvitationFactory, peerId: PublicKey) => new GreetingCommandPlugin(
+  peerId.asBuffer(),
+  OfflineInvitationClaimer.createOfflineInvitationClaimHandler(invitationFactory)
+);

package/src/protocol/replicator-plugin.ts

@@ -22,12 +22,10 @@ export const createReplicatorPlugin = (feedProvider: PartyFeedProvider) =>
       return feeds.map((feed) => ({ discoveryKey: feed.feed.discoveryKey }));
     },
 
-    subscribe: (addFeedToReplicatedSet: (feed: any) => void) => {
-      return feedProvider.feedOpened.on(async (feed) => {
-        log(`Adding feed: ${feed.key.toHex()}`);
-        addFeedToReplicatedSet({ discoveryKey: feed.feed.discoveryKey });
-      });
-    },
+    subscribe: (addFeedToReplicatedSet: (feed: any) => void) => feedProvider.feedOpened.on(async (feed) => {
+      log(`Adding feed: ${feed.key.toHex()}`);
+      addFeedToReplicatedSet({ discoveryKey: feed.feed.discoveryKey });
+    }),
 
     replicate: async (remoteFeeds, info) => {
       // We can ignore remoteFeeds entirely, since the set of feeds we want to replicate is dictated by the Party.

package/src/snapshots/snapshot-generator.ts

@@ -10,20 +10,16 @@ import { SnapshotStore } from './snapshot-store';
 
 const log = debug('dxos:snapshot-generator');
 
-export function createAutomaticSnapshots (
-  party: PartyCore, clock: TimeframeClock, store: SnapshotStore, interval: number
-) {
-  return clock.update.on(async timeframe => {
-    const totalMessages = timeframe.totalMessages();
-    if (totalMessages > 0 && totalMessages % interval === 0) {
-      log(`Saving snapshot of ${party.key.humanize()}...`);
-      try {
-        const snapshot = party.createSnapshot();
-        await store.save(snapshot);
-      } catch (err: any) {
-        console.error('Failed to save snapshot');
-        console.error(err);
-      }
+export const createAutomaticSnapshots = (party: PartyCore, clock: TimeframeClock, store: SnapshotStore, interval: number) => clock.update.on(async timeframe => {
+  const totalMessages = timeframe.totalMessages();
+  if (totalMessages > 0 && totalMessages % interval === 0) {
+    log(`Saving snapshot of ${party.key.humanize()}...`);
+    try {
+      const snapshot = party.createSnapshot();
+      await store.save(snapshot);
+    } catch (err: any) {
+      console.error('Failed to save snapshot');
+      console.error(err);
     }
-  });
-}
+  }
+});

package/src/snapshots/snapshot-store.test.ts

@@ -15,7 +15,7 @@ const createPublicKey = () => PublicKey.from(createKeyPair().publicKey);
 
 describe('SnapshotStore', () => {
   test('in-memory', async () => {
-    const store = new SnapshotStore(createStorage('snapshots', StorageType.RAM));
+    const store = new SnapshotStore(createStorage('', StorageType.RAM).directory('snapshots'));
 
     const key1 = createPublicKey();
     const key2 = createPublicKey();

package/src/snapshots/snapshot-store.ts

@@ -7,10 +7,9 @@ import debug from 'debug';
 
 import { keyToString } from '@dxos/crypto';
 import { schema, PartyKey, PartySnapshot } from '@dxos/echo-protocol';
-import { Storage } from '@dxos/random-access-multi-storage';
+import { Directory } from '@dxos/random-access-multi-storage';
 
 const log = debug('dxos:snapshot-store');
-
 /**
  * Stores party snapshots. Takes any `random-access-storage` compatible backend.
  *
@@ -18,11 +17,11 @@ const log = debug('dxos:snapshot-store');
  */
 export class SnapshotStore {
   constructor (
-    private readonly _storage: Storage
+    private readonly _directory: Directory
   ) {}
 
   async load (partyKey: PartyKey): Promise<PartySnapshot | undefined> {
-    const file = this._storage.createOrOpen(partyKey.toHex());
+    const file = this._directory.createOrOpen(partyKey.toHex());
 
     try {
       const { size } = await file.stat();
@@ -45,7 +44,7 @@ export class SnapshotStore {
 
   async save (snapshot: PartySnapshot) {
     assert(snapshot.partyKey);
-    const file = this._storage.createOrOpen(keyToString(snapshot.partyKey), { truncate: true, size: 0 });
+    const file = this._directory.createOrOpen(keyToString(snapshot.partyKey), { truncate: true, size: 0 });
 
     try {
       const data = schema.getCodecForType('dxos.echo.snapshot.PartySnapshot').encode(snapshot);
@@ -60,6 +59,6 @@ export class SnapshotStore {
    */
   async clear () {
     log('Clearing all snapshots..');
-    await this._storage.destroy();
+    await this._directory.destroy();
   }
 }

package/src/testing/testing-factories.ts

@@ -22,10 +22,10 @@ export type TestPeer = Awaited<ReturnType<typeof createTestInstance>>;
 
 export type WithTestMeta<T> = T & { testMeta: TestPeer }
 
-function addTestMeta<T> (obj: T, meta: TestPeer): WithTestMeta<T> {
+const addTestMeta = <T>(obj: T, meta: TestPeer): WithTestMeta<T> => {
   (obj as any).testMeta = meta;
   return obj as any;
-}
+};
 
 /**
  * Creates a number of test ECHO instances and a party that's shared between all of them.