feat: unify localstorage usage in misc-browser

Author: FedericoAmura

packages/auth/src/lib/authenticators/metamask/eth.ts

@@ -28,7 +28,11 @@ import {
   LIT_CHAINS_KEYS,
 } from '@lit-protocol/constants';
 import { validateSessionSig } from '@lit-protocol/lit-node-client';
-import { getStorageItem } from '@lit-protocol/misc-browser';
+import {
+  getStorageItem,
+  setStorageItem,
+  removeStorageItem,
+} from '@lit-protocol/misc-browser';
 import { AuthCallbackParams, AuthSig } from '@lit-protocol/types';
 
 import LitConnectModal from './connect-modal/modal';
@@ -350,7 +354,7 @@ export const connectWeb3 = async ({
 /**
  * @browserOnly
  * Delete any saved AuthSigs from local storage. Takes no params and returns
- * nothing. This will also clear out the WalletConnect cache in local storage.
+ * nothing. This will also clear out the WalletConnect cache in localstorage.
  * We often run this function as a result of the user pressing a "Logout" button.
  *
  * @return { void }
@@ -374,8 +378,8 @@ export const disconnectWeb3 = (): void => {
 
   const storage = LOCAL_STORAGE_KEYS;
 
-  localStorage.removeItem(storage.AUTH_SIGNATURE);
-  localStorage.removeItem(storage.WALLET_SIGNATURE);
+  removeStorageItem(storage.AUTH_SIGNATURE);
+  removeStorageItem(storage.WALLET_SIGNATURE);
 };
 
 /**
@@ -702,10 +706,7 @@ export const signAndSaveAuthMessage = async ({
 
   // -- 4. store auth and a keypair in localstorage for communication with sgx
   if (Environment.isBrowser) {
-    localStorage.setItem(
-      LOCAL_STORAGE_KEYS.AUTH_SIGNATURE,
-      JSON.stringify(authSig)
-    );
+    setStorageItem(LOCAL_STORAGE_KEYS.AUTH_SIGNATURE, JSON.stringify(authSig));
   }
 
   return authSig;

packages/contracts-sdk/src/lib/contracts-sdk.ts

@@ -27,6 +27,7 @@ import {
   TransactionError,
   WrongNetworkException,
 } from '@lit-protocol/constants';
+import { getStorageItem, setStorageItem } from '@lit-protocol/misc-browser';
 import {
   ContractName,
   EpochInfo,
@@ -248,7 +249,7 @@ export class LitContracts {
       let storagePrivateKey;
 
       try {
-        storagePrivateKey = localStorage.getItem(STORAGE_KEY);
+        storagePrivateKey = getStorageItem(STORAGE_KEY);
       } catch (e) {
         // swallow
         // this.#logger.info('Not a problem.');
@@ -286,7 +287,7 @@ export class LitContracts {
         this.#logger.info(
           "You've set the option to store your private key in local storage."
         );
-        localStorage.setItem(STORAGE_KEY, storagePrivateKey);
+        setStorageItem(STORAGE_KEY, storagePrivateKey);
       }
     } else {
       // ----------------------------------------

packages/contracts-sdk/src/lib/helpers/addresses.ts

@@ -13,6 +13,7 @@ import {
   ParamsMissingError,
 } from '@lit-protocol/constants';
 import { publicKeyCompress } from '@lit-protocol/crypto';
+import { getStorageItem, setStorageItem } from '@lit-protocol/misc-browser';
 import { DerivedAddresses } from '@lit-protocol/types';
 
 const logger = pino({ level: 'info', name: 'addresses' });
@@ -180,13 +181,16 @@ export const derivedAddresses = async (
     const CACHE_KEY = 'lit-cached-pkps';
     let cachedPkpJSON;
     try {
-      const cachedPkp = localStorage.getItem(CACHE_KEY);
+      const cachedPkp = getStorageItem(CACHE_KEY);
       if (cachedPkp) {
         cachedPkpJSON = JSON.parse(cachedPkp);
         publicKey = cachedPkpJSON[pkpTokenId];
       }
     } catch (e) {
-      logger.error(e);
+      logger.error({
+        msg: `Could not get ${CACHE_KEY} from storage. Continuing...`,
+        error: e,
+      });
     }
 
     if (!publicKey) {
@@ -222,18 +226,18 @@ export const derivedAddresses = async (
     if (options.cacheContractCall) {
       // trying to store key value pair in local storage
       try {
-        const cachedPkp = localStorage.getItem(CACHE_KEY);
-        if (cachedPkp) {
-          const cachedPkpJSON = JSON.parse(cachedPkp);
-          cachedPkpJSON[pkpTokenId] = publicKey;
-          localStorage.setItem(CACHE_KEY, JSON.stringify(cachedPkpJSON));
-        } else {
-          const cachedPkpJSON: Record<string, unknown> = {};
-          cachedPkpJSON[pkpTokenId] = publicKey;
-          localStorage.setItem(CACHE_KEY, JSON.stringify(cachedPkpJSON));
-        }
+        const cachedPkp = getStorageItem(CACHE_KEY);
+        const cachedPkpJSON: Record<string, unknown> = cachedPkp
+          ? JSON.parse(cachedPkp)
+          : {};
+
+        cachedPkpJSON[pkpTokenId] = publicKey;
+        setStorageItem(CACHE_KEY, JSON.stringify(cachedPkpJSON));
       } catch (e) {
-        logger.error(e);
+        logger.error({
+          msg: `Could not get ${CACHE_KEY} from storage. Continuing...`,
+          error: e,
+        });
       }
     }
   }

packages/crypto/src/lib/crypto.ts

@@ -11,6 +11,7 @@ import {
   UnknownError,
   UnknownSignatureError,
 } from '@lit-protocol/constants';
+import { getStorageItem, setStorageItem } from '@lit-protocol/misc-browser';
 import { NodeAttestation, SessionKeyPair, SigShare } from '@lit-protocol/types';
 import {
   blsCombine,
@@ -507,12 +508,12 @@ export const checkSevSnpAttestation = async (
   // use local storage if we have one available
   if (globalThis.localStorage) {
     logger.info('Using local storage for certificate caching');
-    vcekCert = localStorage.getItem(vcekUrl);
+    vcekCert = getStorageItem(vcekUrl);
     if (vcekCert) {
       vcekCert = Buffer.from(vcekCert, 'base64');
     } else {
       vcekCert = await getAmdCert(vcekUrl);
-      localStorage.setItem(vcekUrl, Buffer.from(vcekCert).toString('base64'));
+      setStorageItem(vcekUrl, Buffer.from(vcekCert).toString('base64'));
     }
   } else {
     const cache = ((

packages/lit-node-client/src/lib/lit-node-client.ts

@@ -256,7 +256,7 @@ export class LitNodeClient extends LitCore implements ILitNodeClient {
     const newSessionKey = generateSessionKeyPair();
 
     try {
-      localStorage.setItem(storageKey, JSON.stringify(newSessionKey));
+      setStorageItem(storageKey, JSON.stringify(newSessionKey));
     } catch (e) {
       this.#logger.info(
         `Localstorage not available. Not a problem. Continue...`
@@ -356,7 +356,6 @@ export class LitNodeClient extends LitCore implements ILitNodeClient {
       try {
         setStorageItem(storageKey, JSON.stringify(walletSig));
       } catch (e) {
-        this.#logger.info('getWalletSig - flow 1.4');
         this.#logger.warn({
           msg: `Unable to store walletSig in local storage. Not a problem. Continue...`,
           error: e,