add skeleton functions for space events and identity

Author: nikgraf

docs/technology-stack.md

@@ -0,0 +1,18 @@
+# Technology Stack
+
+- Frontend
+  - React
+  - Shadcn
+  - Vite
+  - TypeScript
+- Testing
+  - Vitest
+- Backend
+  - Database: Postgres + Prisma (explore Neo4j as well)
+  - API: Websocket
+  - Effect
+- Other
+  - CRDT: Automerge
+  - Cryptography: Nobel
+  - Auth: Privy
+  - ESM

packages/graph-framework/src/generateId.ts

@@ -0,0 +1,5 @@
+import { v4 as uuidv4 } from "uuid";
+
+export const generateId = () => {
+  return uuidv4();
+};

packages/graph-framework/src/identity/create-identity.ts

@@ -0,0 +1,8 @@
+export const createIdentity = () => {
+  return {
+    signaturePublicKey: "",
+    signaturePrivateKey: "",
+    encryptionPublicKey: "",
+    encryptionPrivateKey: "",
+  };
+};

packages/graph-framework/src/identity/restore-identity.ts

@@ -0,0 +1,12 @@
+type Params = {
+  preKey: string;
+};
+
+export const restoreIdentity = ({ preKey }: Params) => {
+  return {
+    signaturePublicKey: "",
+    signaturePrivateKey: "",
+    encryptionPublicKey: "",
+    encryptionPrivateKey: "",
+  };
+};

packages/graph-framework/src/space-events/apply-event.ts

@@ -0,0 +1,61 @@
+import {
+  SpaceEvent,
+  SpaceInvitation,
+  SpaceMember,
+  SpaceState,
+} from "./types.js";
+
+type Params = {
+  state?: SpaceState;
+  event: SpaceEvent;
+};
+
+export const applyEvent = ({ state, event: rawEvent }: Params): SpaceState => {
+  // TODO parse the event
+  const event = rawEvent;
+
+  // TODO verify the event
+  // - verify the signature
+  // - verify that this event is based on the previous one
+  // - verify versioning
+
+  let id = "";
+  let members: { [signaturePublicKey: string]: SpaceMember } = {};
+  let removedMembers: { [signaturePublicKey: string]: SpaceMember } = {};
+  let invitations: { [id: string]: SpaceInvitation } = {};
+
+  if (event.transaction.type === "create-space") {
+    id = event.transaction.id;
+    members[event.transaction.creatorSignaturePublicKey] = {
+      signaturePublicKey: event.transaction.creatorSignaturePublicKey,
+      encryptionPublicKey: event.transaction.creatorEncryptionPublicKey,
+      role: "admin",
+    };
+  } else if (state !== undefined) {
+    id = state.id;
+    members = { ...state.members };
+    removedMembers = { ...state.removedMembers };
+    invitations = { ...state.invitations };
+
+    if (event.transaction.type === "delete-space") {
+      removedMembers = { ...members };
+      members = {};
+      invitations = {};
+    } else if (event.transaction.type === "create-invitation") {
+      invitations[event.transaction.id] = {
+        signaturePublicKey: event.transaction.signaturePublicKey,
+        encryptionPublicKey: event.transaction.encryptionPublicKey,
+      };
+    }
+  } else {
+    throw new Error("State is required for all events except create-space");
+  }
+
+  return {
+    id,
+    members,
+    removedMembers,
+    invitations,
+    transactionHash: "", // TODO
+  };
+};

packages/graph-framework/src/space-events/create-invitation.test.ts

@@ -0,0 +1,33 @@
+import { expect, it } from "vitest";
+import { applyEvent } from "./apply-event.js";
+import { createInvitation } from "./create-invitation.js";
+import { createSpace } from "./create-space.js";
+
+it("should create an invitation", () => {
+  const author = {
+    signaturePublicKey: "signature",
+    encryptionPublicKey: "encryption",
+  };
+  const spaceEvent = createSpace({ author });
+  const state = applyEvent({ event: spaceEvent });
+  const spaceEvent2 = createInvitation({ author, id: state.id });
+  const state2 = applyEvent({ state, event: spaceEvent2 });
+  expect(state2).toEqual({
+    id: state.id,
+    members: {
+      [author.signaturePublicKey]: {
+        signaturePublicKey: author.signaturePublicKey,
+        encryptionPublicKey: author.encryptionPublicKey,
+        role: "admin",
+      },
+    },
+    removedMembers: {},
+    invitations: {
+      [spaceEvent2.transaction.id]: {
+        signaturePublicKey: "",
+        encryptionPublicKey: "",
+      },
+    },
+    transactionHash: "",
+  });
+});

packages/graph-framework/src/space-events/create-invitation.ts

@@ -0,0 +1,27 @@
+import { Author, SpaceEvent } from "./types.js";
+
+type Params = {
+  author: Author;
+  id: string;
+};
+
+export const createInvitation = ({ author, id }: Params): SpaceEvent => {
+  const transaction = {
+    type: "create-invitation" as const,
+    id,
+    ciphertext: "",
+    nonce: "",
+    signaturePublicKey: "",
+    encryptionPublicKey: "",
+  };
+  // TODO canonicalize, hash and sign the transaction
+  const signature = "";
+
+  return {
+    transaction,
+    author: {
+      publicKey: author.signaturePublicKey,
+      signature,
+    },
+  };
+};

packages/graph-framework/src/space-events/create-space.test.ts

@@ -0,0 +1,25 @@
+import { expect, it } from "vitest";
+import { applyEvent } from "./apply-event.js";
+import { createSpace } from "./create-space.js";
+
+it("should create a space state", () => {
+  const author = {
+    signaturePublicKey: "signature",
+    encryptionPublicKey: "encryption",
+  };
+  const spaceEvent = createSpace({ author });
+  const state = applyEvent({ event: spaceEvent });
+  expect(state).toEqual({
+    id: spaceEvent.transaction.id,
+    invitations: {},
+    members: {
+      [author.signaturePublicKey]: {
+        signaturePublicKey: author.signaturePublicKey,
+        encryptionPublicKey: author.encryptionPublicKey,
+        role: "admin",
+      },
+    },
+    removedMembers: {},
+    transactionHash: "",
+  });
+});

packages/graph-framework/src/space-events/create-space.ts

@@ -0,0 +1,25 @@
+import { generateId } from "../generateId.js";
+import { Author, SpaceEvent } from "./types.js";
+
+type Params = {
+  author: Author;
+};
+
+export const createSpace = ({ author }: Params): SpaceEvent => {
+  const transaction = {
+    type: "create-space" as const,
+    id: generateId(),
+    creatorSignaturePublicKey: author.signaturePublicKey,
+    creatorEncryptionPublicKey: author.encryptionPublicKey,
+  };
+  // TODO canonicalize, hash and sign the transaction
+  const signature = "";
+
+  return {
+    transaction,
+    author: {
+      publicKey: author.signaturePublicKey,
+      signature,
+    },
+  };
+};

packages/graph-framework/src/space-events/delete-space.test.ts

@@ -0,0 +1,28 @@
+import { expect, it } from "vitest";
+import { applyEvent } from "./apply-event.js";
+import { createSpace } from "./create-space.js";
+import { deleteSpace } from "./delete-space.js";
+
+it("should delete a space", () => {
+  const author = {
+    signaturePublicKey: "signature",
+    encryptionPublicKey: "encryption",
+  };
+  const spaceEvent = createSpace({ author });
+  const state = applyEvent({ event: spaceEvent });
+  const spaceEvent2 = deleteSpace({ author, id: state.id });
+  const state2 = applyEvent({ state, event: spaceEvent2 });
+  expect(state2).toEqual({
+    id: state.id,
+    members: {},
+    invitations: {},
+    removedMembers: {
+      [author.signaturePublicKey]: {
+        signaturePublicKey: author.signaturePublicKey,
+        encryptionPublicKey: author.encryptionPublicKey,
+        role: "admin",
+      },
+    },
+    transactionHash: "",
+  });
+});