refactor: add registry profile entry interface and add public keys to it

Author: hai-ko

.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "[javascript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSave": true
+    },
+    "[typescript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSave": true
+    },
+    "[typescriptreact]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSave": true
+    }
+}

src/lib/README.md

@@ -7,7 +7,7 @@ sequenceDiagram
     EnsMailLib->>EnsMailLib: createKeys()
     EnsMailLib->>+MetaMask: personal_sign
     MetaMask-->>-EnsMailLib: signature
-    EnsMailLib->>+ DeliveryService: POST submitPublicKeys()
+    EnsMailLib->>+ DeliveryService: POST submitProfileRegistryEntry()
     DeliveryService->> DeliveryService: checkSignature()
     DeliveryService-->>- EnsMailLib: token
     EnsMailLib-->>-UI: Messages

src/lib/account/Account.ts

@@ -19,6 +19,10 @@ export interface Keys {
     storageEncryptionKey: string;
 }
 
+export interface ProfileRegistryEntry {
+    publicKeys: PublicKeys;
+}
+
 export interface PublicKeys {
     publicKey: string;
     publicMessagingKey: string;
@@ -39,9 +43,12 @@ export interface Account {
 export async function getContacts(
     connection: Connection,
     deliveryServiceToken: string,
-    getPublicKeys: (
+    getProfileRegistryEntry: (
         contact: string,
-    ) => Promise<{ publicKeys: PublicKeys | undefined; signature: string }>,
+    ) => Promise<
+        | { profileRegistryEntry: ProfileRegistryEntry; signature: string }
+        | undefined
+    >,
     getPendingConversations: (
         connection: Connection,
         userDb: UserDB,
@@ -87,7 +94,9 @@ export async function getContacts(
             )
             .map(async (address) => ({
                 address,
-                publicKeys: (await getPublicKeys(address)).publicKeys,
+                publicKeys: (
+                    await getProfileRegistryEntry(address)
+                )?.profileRegistryEntry.publicKeys,
             })),
     );
 }

src/lib/delivery/Keys.ts

@@ -4,11 +4,12 @@ import { formatAddress } from '../external-apis/InjectedWeb3API';
 import { log } from '../shared/log';
 import { Session } from './Session';
 import { v4 as uuidv4 } from 'uuid';
+import { ProfileRegistryEntry } from '../account/Account';
 
-export function submitPublicKeys(
+export function submitProfileRegistryEntry(
     sessions: Map<string, Session>,
     accountAddress: string,
-    publicKeys: PublicKeys,
+    profileRegistryEntry: ProfileRegistryEntry,
     signature: string,
     pendingConversations: Map<string, Set<string>>,
     send: (socketId: string) => void,
@@ -17,21 +18,19 @@ export function submitPublicKeys(
     const account = formatAddress(accountAddress);
 
     const recoveredAddress = ethers.utils.recoverAddress(
-        ethers.utils.hashMessage(
-            publicKeys.publicKey +
-                publicKeys.publicMessagingKey +
-                publicKeys.publicSigningKey,
-        ),
+        ethers.utils.hashMessage(JSON.stringify(profileRegistryEntry)),
         signature,
     );
 
     if (formatAddress(recoveredAddress) === account) {
-        const session = sessions.has(account)
-            ? (sessions.get(account) as Session)
-            : { account };
-        session.keys = publicKeys;
-        session.token = uuidv4();
-        session.pubKeySignature = signature;
+        const session: Session = {
+            ...(sessions.has(account) ? sessions.get(account)! : {}),
+            account,
+            profileRegistryEntry: profileRegistryEntry,
+            token: uuidv4(),
+            profileRegistryEntrySignature: signature,
+        };
+
         sessions.set(account, session);
         const pending = pendingConversations.get(account);
         if (pending) {
@@ -46,29 +45,26 @@ export function submitPublicKeys(
         }
         return session.token;
     } else {
+        log(`- Invalid signature`);
         throw Error('Signature invalid.');
     }
 }
 
-export function getPublicKeys(
+export function getProfileRegistryEntry(
     sessions: Map<string, Session>,
     accountAddress: string,
-): Partial<{ publicKeys: PublicKeys | undefined; signature: string }> {
-    log(`[getPublicKeys] for account ${accountAddress}`);
+):
+    | { profileRegistryEntry: ProfileRegistryEntry; signature: string }
+    | undefined {
+    log(`[getProfileRegistryEntry] for account ${accountAddress}`);
     const account = formatAddress(accountAddress);
-
-    if (sessions.get(account)?.keys) {
+    const session = sessions.get(account);
+    if (session) {
         return {
-            publicKeys: {
-                publicMessagingKey:
-                    sessions.get(account)?.keys!.publicMessagingKey!,
-                publicSigningKey:
-                    sessions.get(account)?.keys!.publicSigningKey!,
-                publicKey: sessions.get(account)?.keys!.publicKey!,
-            },
-            signature: sessions.get(account)?.pubKeySignature,
+            profileRegistryEntry: session.profileRegistryEntry,
+            signature: session.profileRegistryEntrySignature,
         };
     } else {
-        return {};
+        return;
     }
 }

src/lib/delivery/Session.ts

@@ -1,14 +1,14 @@
-import { PublicKeys } from '../account/Account';
+import { ProfileRegistryEntry } from '../account/Account';
 import { formatAddress } from '../external-apis/InjectedWeb3API';
 import { log } from '../shared/log';
 
 export interface Session {
     account: string;
-    pubKeySignature?: string;
-    token?: string;
+    profileRegistryEntrySignature: string;
+    token: string;
     ttl?: undefined;
     socketId?: string;
-    keys?: PublicKeys;
+    profileRegistryEntry: ProfileRegistryEntry;
 }
 
 export function checkToken(

src/lib/delivery/index.ts

@@ -6,4 +6,4 @@ export {
     createPendingEntry,
 } from './Messages';
 export type { Session } from './Session';
-export { submitPublicKeys, getPublicKeys } from './Keys';
+export { submitProfileRegistryEntry, getProfileRegistryEntry } from './Keys';

src/lib/external-apis/BackendAPI.ts

@@ -2,8 +2,9 @@ import axios from 'axios';
 import { log } from '../shared/log';
 import { EncryptionEnvelop, Envelop } from '../messaging/Messaging';
 import { Connection } from '../web3-provider/Web3Provider';
-import { PublicKeys } from '../account/Account';
+import { PublicKeys, ProfileRegistryEntry } from '../account/Account';
 import { UserDB } from '..';
+import { datacatalog } from 'googleapis/build/src/apis/datacatalog';
 
 const DELIVERY_SERVICE =
     (process.env.REACT_APP_BACKEND as string) + '/deliveryService';
@@ -17,21 +18,26 @@ function createJsonRpcRequest(method: string, params: any, id = 1) {
     };
 }
 
-export async function submitPublicKeys(
+export async function submitProfileRegistryEntry(
     accountAddress: string,
-    publicKeys: PublicKeys,
+    profileRegistryEntry: ProfileRegistryEntry,
     signature: string,
 ): Promise<string> {
-    return (
+    const request = (
         await axios.post(
             DELIVERY_SERVICE,
-            createJsonRpcRequest('submitPublicKeys', {
+            createJsonRpcRequest('submitProfileRegistryEntry', {
                 accountAddress: accountAddress,
-                publicKeys,
+                profileRegistryEntry,
                 signature,
             }),
         )
-    ).data.result;
+    ).data;
+    if (request.error) {
+        throw Error('submitProfileRegistryEntry failed.');
+    }
+
+    return request.result;
 }
 
 export async function submitMessage(
@@ -82,7 +88,7 @@ export async function getNewMessages(
     userDb: UserDB,
     contactAddress: string,
 ): Promise<EncryptionEnvelop[]> {
-    return (
+    const request = (
         await axios.post(
             DELIVERY_SERVICE,
             createJsonRpcRequest('getMessages', {
@@ -91,33 +97,54 @@ export async function getNewMessages(
                 token: userDb.deliveryServiceToken,
             }),
         )
-    ).data.result.messages;
+    ).data;
+
+    if (request.error) {
+        throw Error('getNewMessages failed.');
+    }
+
+    return request.result.messages;
 }
 
 export async function getPendingConversations(
     connection: Connection,
     userDb: UserDB,
 ): Promise<string[]> {
-    return (
+    const request = (
         await axios.post(
             DELIVERY_SERVICE,
             createJsonRpcRequest('getPendingConversations', {
                 accountAddress: connection.account!.address,
                 token: userDb.deliveryServiceToken,
             }),
         )
-    ).data.result.pendingConversations;
+    ).data;
+
+    if (request.error) {
+        throw Error('getPendingConversations failed.');
+    }
+
+    return request.result.pendingConversations;
 }
 
-export async function getPublicKeys(
+export async function getProfileRegistryEntry(
     contact: string,
-): Promise<{ publicKeys: PublicKeys | undefined; signature: string }> {
-    return (
+): Promise<
+    | { profileRegistryEntry: ProfileRegistryEntry; signature: string }
+    | undefined
+> {
+    const request = (
         await axios.post(
             DELIVERY_SERVICE,
-            createJsonRpcRequest('getPublicKeys', {
+            createJsonRpcRequest('getProfileRegistryEntry', {
                 accountAddress: contact,
             }),
         )
-    ).data.result;
+    ).data;
+
+    if (request.error) {
+        throw Error('getProfileRegistryEntry failed.');
+    }
+
+    return request.result;
 }

src/lib/index.ts

@@ -10,7 +10,12 @@ import * as Storage from './storage';
 import { StorageEnvelopContainer, UserDB } from './storage';
 
 export type { Connection } from './web3-provider/Web3Provider';
-export type { Account, PublicKeys, Keys } from './account/Account';
+export type {
+    Account,
+    PublicKeys,
+    Keys,
+    ProfileRegistryEntry,
+} from './account/Account';
 export type {
     Message,
     EncryptionEnvelop,
@@ -47,7 +52,7 @@ export function connectAccount(provider: ethers.providers.JsonRpcProvider) {
     return SignIn.connectAccount(
         provider,
         Web3Api.requestAccounts,
-        BackendAPI.getPublicKeys,
+        BackendAPI.getProfileRegistryEntry,
     );
 }
 
@@ -89,7 +94,7 @@ export async function signIn(
     return SignIn.signIn(
         connection,
         Web3Api.prersonalSign,
-        BackendAPI.submitPublicKeys,
+        BackendAPI.submitProfileRegistryEntry,
         Account.createKeys,
         Web3Api.getPublicKey,
         dataFile,
@@ -144,7 +149,7 @@ export async function getContacts(
     return Account.getContacts(
         connection,
         deliveryServiceToken,
-        BackendAPI.getPublicKeys,
+        BackendAPI.getProfileRegistryEntry,
         BackendAPI.getPendingConversations,
         Web3Api.resolveName,
         userDb,

src/lib/signin/Connect.ts

@@ -1,26 +1,29 @@
 import { ethers } from 'ethers';
-import { PublicKeys } from '../account/Account';
+import { ProfileRegistryEntry } from '../account/Account';
 import { ConnectionState } from '../web3-provider/Web3Provider';
 
 export async function connectAccount(
     provider: ethers.providers.JsonRpcProvider,
     requestAccounts: (
         provider: ethers.providers.JsonRpcProvider,
     ) => Promise<string>,
-    getPublicKeys: (
+    getProfileRegistryEntry: (
         contact: string,
-    ) => Promise<{ publicKeys: PublicKeys | undefined; signature: string }>,
+    ) => Promise<
+        | { profileRegistryEntry: ProfileRegistryEntry; signature: string }
+        | undefined
+    >,
 ): Promise<{
     account?: string;
     connectionState: ConnectionState;
     existingAccount: boolean;
 }> {
     try {
         const account = await requestAccounts(provider);
-
         return {
             account,
-            existingAccount: (await getPublicKeys(account))?.publicKeys
+            existingAccount: (await getProfileRegistryEntry(account))
+                ?.profileRegistryEntry.publicKeys
                 ? true
                 : false,
             connectionState: ConnectionState.CollectingSignInData,