chore: remove duplicate types, small code refactor

packages/connector/src/snap.ts

@@ -360,12 +360,12 @@ export async function sendOIDCAuthorizationResponse(
 
 export async function setCeramicSession(
   this: Masca,
-  sessionKey: string
+  serializedSession: string
 ): Promise<Result<boolean>> {
   return sendSnapMethod(
     {
       method: 'setCeramicSession',
-      params: { sessionKey },
+      params: { serializedSession },
     },
     this.snapId
   );

packages/snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/blockchain-lab-um/masca.git"
   },
   "source": {
-    "shasum": "4oWrs9nhRESibCc76Oi02stINN/l0p64gyFaeB2D+ps=",
+    "shasum": "O1UXSOxy+oi/+u0TyrzxY8rHpZ+9hrK+QfSdATkhV60=",
     "location": {
       "npm": {
         "filePath": "dist/snap.js",

packages/snap/src/index.ts

@@ -192,7 +192,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({
         // TODO (andy) validate request params
         res = await setCeramicSession(
           apiParams,
-          (request.params as any).sessionKey as string
+          (request.params as any).serializedSession as string
         );
         return ResultObject.success(res);
       case 'validateStoredCeramicSession':

packages/snap/src/interfaces.ts

@@ -1,67 +1,7 @@
-import type {
-  MascaAccountConfig,
-  MascaConfig,
-} from '@blockchain-lab-um/masca-types';
+import { MascaState } from '@blockchain-lab-um/masca-types';
 import { BIP44CoinTypeNode } from '@metamask/key-tree';
 import { MetaMaskInpageProvider } from '@metamask/providers';
 import type { SnapsGlobalObject } from '@metamask/snaps-types';
-import type { IIdentifier, IKey, W3CVerifiableCredential } from '@veramo/core';
-import type { ManagedPrivateKey } from '@veramo/key-manager';
-
-export type MascaState = {
-  /**
-   * Account specific storage
-   */
-  accountState: Record<string, MascaAccountState>;
-  /**
-   * Current account
-   */
-  currentAccount: string;
-  /**
-   * Configuration for Masca
-   */
-  snapConfig: MascaConfig;
-};
-
-export type ExtendedVerifiableCredential = W3CVerifiableCredential & {
-  /**
-   * key for dictionary
-   */
-  key: string;
-};
-
-/**
- * Ceramic Network storedVCs
- */
-export type StoredCredentials = {
-  storedCredentials: ExtendedVerifiableCredential[];
-};
-
-/**
- * Masca State for a MetaMask address
- */
-export type MascaAccountState = {
-  /**
-   * Store for {@link SnapPrivateKeyStore}
-   */
-  snapPrivateKeyStore: Record<string, ManagedPrivateKey>;
-  /**
-   * Store for {@link SnapKeyStore}
-   */
-  snapKeyStore: Record<string, IKey>;
-  /**
-   * Store for {@link SnapDIDStore}
-   */
-  identifiers: Record<string, IIdentifier>;
-  /**
-   * Store for {@link SnapVCStore}
-   */
-  vcs: Record<string, W3CVerifiableCredential>;
-
-  publicKey: string;
-  index?: number;
-  accountConfig: MascaAccountConfig;
-};
 
 export type SnapConfirmParams = {
   prompt: string;

packages/snap/src/rpc/setCeramicSession.ts

@@ -1,10 +1,12 @@
 import { ApiParams } from '../interfaces';
-import { setSession } from '../utils/ceramicUtils';
+import { updateSnapState } from '../utils/stateUtils';
 
 export async function setCeramicSession(
   params: ApiParams,
-  sessionKey: string
+  serializedSession: string
 ): Promise<boolean> {
-  const res = await setSession(params.snap, params.state, sessionKey);
-  return res;
+  const { state } = params;
+  state.accountState[state.currentAccount].ceramicSession = serializedSession;
+  await updateSnapState(snap, state);
+  return true;
 }

packages/snap/src/rpc/validateStoredCeramicSession.ts

@@ -1,9 +1,12 @@
 import { ApiParams } from '../interfaces';
-import { validateStoredSession } from '../utils/ceramicUtils';
+import { validateSession } from '../utils/ceramicUtils';
 
 export async function validateStoredCeramicSession(
   params: ApiParams
 ): Promise<string> {
-  const sessionKey = validateStoredSession(params.state);
-  return sessionKey;
+  const { state } = params;
+  const serializedSession = await validateSession(
+    state.accountState[state.currentAccount].ceramicSession
+  );
+  return serializedSession;
 }

packages/snap/src/utils/ceramicUtils.ts

@@ -1,17 +1,8 @@
 import type { MascaState } from '@blockchain-lab-um/masca-types';
 import { CeramicClient } from '@ceramicnetwork/http-client';
-import { EthereumNodeAuth, getAccountId } from '@didtools/pkh-ethereum';
 import { MetaMaskInpageProvider } from '@metamask/providers';
 import type { SnapsGlobalObject } from '@metamask/snaps-types';
 import { DIDSession } from 'did-session';
-import { DID } from 'dids';
-import { Wallet } from 'ethers';
-
-import { getAddressKeyDeriver, snapGetKeysFromAddress } from './keyPair';
-import { getCurrentAccount } from './snapUtils';
-import { updateSnapState } from './stateUtils';
-
-const ceramicDID = { did: undefined } as { did: DID | undefined };
 
 export const aliases = {
   definitions: {
@@ -25,119 +16,32 @@ export const aliases = {
   tiles: {},
 };
 
-class CustomProvider {
-  constructor(
-    private readonly wallet: Wallet,
-    private readonly metamask: MetaMaskInpageProvider
-  ) {
-    this.wallet = wallet;
-    this.metamask = metamask;
+// Should return serialized session or throw an error
+export async function validateSession(
+  serializedSession?: string
+): Promise<string> {
+  if (!serializedSession) {
+    throw new Error('No session found');
   }
 
-  async request(args: { method: string; params: Array<string> }) {
-    const { method, params } = args;
-
-    if (method === 'personal_sign') {
-      // First parameter is the message to sign, second parameter is the address
-      const [message] = params;
-      return this.wallet.signMessage(message);
-    }
+  const session = await DIDSession.fromSession(serializedSession);
 
-    if (method === 'eth_chainId') {
-      return this.metamask.request(args);
-    }
-
-    throw new Error('Unsupported method');
-  }
-}
-
-// Should return key or throw an error
-async function validateSession(sessionKey: string): Promise<string> {
-  const session = await DIDSession.fromSession(sessionKey);
   if (session.isExpired) {
     throw new Error('Session expired');
   }
 
   if (session.expireInSecs < 3600) {
     throw new Error('Session will expire soon');
   }
-  return sessionKey;
-}
 
-// Returns session key if session is valid and throws an error if something goes wrong
-export async function validateStoredSession(
-  state: MascaState
-): Promise<string> {
-  const sessionKey = state.accountState[state.currentAccount].ceramicSession;
-
-  if (!sessionKey) {
-    throw new Error('No session found');
-  }
-  return validateSession(sessionKey);
-}
-
-export async function setSession(
-  snap: SnapsGlobalObject,
-  state: MascaState,
-  sessionKey: string
-): Promise<boolean> {
-  state.accountState[state.currentAccount].ceramicSession = sessionKey;
-  await updateSnapState(snap, state);
-  return true;
-}
-
-async function authenticateWithEthers(params: {
-  ethereum: MetaMaskInpageProvider;
-  snap: SnapsGlobalObject;
-  state: MascaState;
-}) {
-  if (ceramicDID.did) return ceramicDID.did;
-
-  const { ethereum, snap, state } = params;
-
-  const account = getCurrentAccount(state);
-
-  const bip44CoinTypeNode = await getAddressKeyDeriver({
-    state,
-    snap,
-    account,
-  });
-
-  const res = await snapGetKeysFromAddress(
-    bip44CoinTypeNode,
-    state,
-    account,
-    snap
-  );
-
-  if (res === null) throw new Error('Could not get keys from address');
-
-  const { privateKey } = res;
-
-  // Ethers is required to sign the DID auth message
-  const wallet = new Wallet(privateKey);
-
-  const customProvider = new CustomProvider(wallet, ethereum);
-
-  const accountId = await getAccountId(customProvider, wallet.address);
-
-  const authMethod = await EthereumNodeAuth.getAuthMethod(
-    customProvider,
-    accountId,
-    'masca'
-  );
-
-  const session = await DIDSession.authorize(authMethod, {
-    resources: [`ceramic://*`],
-  });
-
-  ceramicDID.did = session.did;
-  return session.did;
+  return serializedSession;
 }
 
 async function authenticateWithSessionKey(state: MascaState) {
-  const sessionKey = await validateStoredSession(state);
-  const session = await DIDSession.fromSession(sessionKey);
+  const serializedSession = await validateSession(
+    state.accountState[state.currentAccount].ceramicSession
+  );
+  const session = await DIDSession.fromSession(serializedSession);
   return session.did;
 }
 
@@ -147,8 +51,6 @@ export async function getCeramic(
   state: MascaState
 ): Promise<CeramicClient> {
   const ceramic = new CeramicClient('https://ceramic-clay.3boxlabs.com');
-
-  // const did = await authenticateWithEthers({ ethereum, snap, state });
   const did = await authenticateWithSessionKey(state);
 
   await ceramic.setDID(did);

packages/snap/src/utils/didUtils.ts

@@ -1,6 +1,7 @@
 import type {
   AvailableMethods,
   AvailableVCStores,
+  MascaState,
 } from '@blockchain-lab-um/masca-types';
 import { BIP44CoinTypeNode } from '@metamask/key-tree';
 import { MetaMaskInpageProvider } from '@metamask/providers';
@@ -9,7 +10,6 @@ import type { IIdentifier } from '@veramo/core';
 import type { DIDResolutionResult } from 'did-resolver';
 import elliptic from 'elliptic';
 
-import type { MascaState } from '../interfaces';
 import { getAgent } from '../veramo/setup';
 import { snapGetKeysFromAddress } from './keyPair';
 import { getCurrentNetwork } from './snapUtils';

packages/snap/src/utils/ebsiUtils.ts

@@ -1,8 +1,8 @@
+import type { MascaState } from '@blockchain-lab-um/masca-types';
 import type { SnapsGlobalObject } from '@metamask/snaps-types';
 import type { IDIDManagerCreateArgs } from '@veramo/core';
 import { keccak256 } from 'ethers';
 
-import type { MascaState } from '../interfaces';
 import { getAgent } from '../veramo/setup';
 import { getAddressKeyDeriver, snapGetKeysFromAddress } from './keyPair';
 

packages/snap/src/utils/init.ts

@@ -1,6 +1,6 @@
+import type { MascaState } from '@blockchain-lab-um/masca-types';
 import type { SnapsGlobalObject } from '@metamask/snaps-types';
 
-import type { MascaState } from '../interfaces';
 import { initSnapState } from './stateUtils';
 
 export async function init(snap: SnapsGlobalObject): Promise<MascaState> {

packages/snap/src/utils/keyPair.ts

@@ -1,12 +1,14 @@
-import { didCoinTypeMappping } from '@blockchain-lab-um/masca-types';
+import {
+  didCoinTypeMappping,
+  type MascaState,
+} from '@blockchain-lab-um/masca-types';
 import {
   BIP44CoinTypeNode,
   getBIP44AddressKeyDeriver,
 } from '@metamask/key-tree';
 import type { SnapsGlobalObject } from '@metamask/snaps-types';
 import { Wallet } from 'ethers';
 
-import type { MascaState } from '../interfaces';
 import { updateSnapState } from './stateUtils';
 
 export async function setAccountIndex(

packages/snap/src/utils/params.ts

@@ -6,6 +6,7 @@ import {
   type CreateVCRequestParams,
   type CreateVPRequestParams,
   type DeleteVCsRequestParams,
+  type MascaState,
   type QueryVCsRequestParams,
   type ResolveDIDRequestParams,
   type SaveVCRequestParams,
@@ -15,7 +16,6 @@ import {
   type VerifyDataRequestParams,
 } from '@blockchain-lab-um/masca-types';
 
-import type { MascaState } from '../interfaces';
 import { isEnabledVCStore } from './snapUtils';
 
 function isStringArray(input: unknown): input is string[] {

packages/snap/src/utils/snapUtils.ts

@@ -1,10 +1,13 @@
-import type { AvailableVCStores } from '@blockchain-lab-um/masca-types';
+import type {
+  AvailableVCStores,
+  MascaState,
+} from '@blockchain-lab-um/masca-types';
 import { BIP44CoinTypeNode } from '@metamask/key-tree';
 import { MetaMaskInpageProvider } from '@metamask/providers';
 import type { SnapsGlobalObject } from '@metamask/snaps-types';
 import type { Component } from '@metamask/snaps-ui';
 
-import type { ApiParams, MascaState } from '../interfaces';
+import type { ApiParams } from '../interfaces';
 import { snapGetKeysFromAddress } from './keyPair';
 import { updateSnapState } from './stateUtils';
 

packages/snap/src/utils/stateUtils.ts

@@ -1,6 +1,7 @@
+import type { MascaState } from '@blockchain-lab-um/masca-types';
 import type { Json, SnapsGlobalObject } from '@metamask/snaps-types';
 
-import type { ApiParams, MascaState } from '../interfaces';
+import type { ApiParams } from '../interfaces';
 import { getEmptyAccountState, getInitialSnapState } from './config';
 
 /**