feat(wrapped-keys): LIT-3956 - Initial implementation of new storeEncryptedKeyBatch() client API method and associated types

Author: MaximusHaximus

packages/wrapped-keys/src/index.ts

@@ -8,6 +8,7 @@ import {
   storeEncryptedKey,
   listEncryptedKeyMetadata,
   batchGeneratePrivateKeys,
+  storeEncryptedKeyBatch,
 } from './lib/api';
 import {
   CHAIN_ETHEREUM,
@@ -45,11 +46,13 @@ import type {
   SignTransactionParamsSupportedEvm,
   SignTransactionParamsSupportedSolana,
   StoreEncryptedKeyParams,
+  StoreEncryptedKeyBatchParams,
   StoredKeyData,
   StoredKeyMetadata,
   ListEncryptedKeyMetadataParams,
   StoreEncryptedKeyResult,
   ImportPrivateKeyResult,
+  StoreEncryptedKeyBatchResult,
 } from './lib/types';
 
 export const constants = {
@@ -70,6 +73,7 @@ export const api = {
   signMessageWithEncryptedKey,
   signTransactionWithEncryptedKey,
   storeEncryptedKey,
+  storeEncryptedKeyBatch,
   batchGeneratePrivateKeys,
 };
 
@@ -101,6 +105,8 @@ export {
   SignTransactionWithEncryptedKeyParams,
   StoreEncryptedKeyParams,
   StoreEncryptedKeyResult,
+  StoreEncryptedKeyBatchParams,
+  StoreEncryptedKeyBatchResult,
   StoredKeyData,
   StoredKeyMetadata,
   SupportedNetworks,

packages/wrapped-keys/src/lib/api/index.ts

@@ -7,6 +7,7 @@ import { listEncryptedKeyMetadata } from './list-encrypted-key-metadata';
 import { signMessageWithEncryptedKey } from './sign-message-with-encrypted-key';
 import { signTransactionWithEncryptedKey } from './sign-transaction-with-encrypted-key';
 import { storeEncryptedKey } from './store-encrypted-key';
+import { storeEncryptedKeyBatch } from './store-encrypted-key-batch';
 
 export {
   listEncryptedKeyMetadata,
@@ -16,6 +17,7 @@ export {
   exportPrivateKey,
   signMessageWithEncryptedKey,
   storeEncryptedKey,
+  storeEncryptedKeyBatch,
   getEncryptedKey,
   batchGeneratePrivateKeys,
 };

packages/wrapped-keys/src/lib/api/store-encrypted-key-batch.ts

@@ -0,0 +1,53 @@
+import { storePrivateKeyBatch } from '../service-client';
+import { StoreKeyBatchParams } from '../service-client/types';
+import {
+  StoredKeyData,
+  StoreEncryptedKeyBatchParams,
+  StoreEncryptedKeyBatchResult,
+} from '../types';
+import { getFirstSessionSig, getPkpAddressFromSessionSig } from '../utils';
+
+/** Stores a batch of encrypted private keys and their metadata to the wrapped keys backend service
+ *
+ * @param { StoreEncryptedKeyParams } params Parameters required to fetch the encrypted private key metadata
+ * @returns { Promise<StoreEncryptedKeyResult> } The encrypted private key and its associated metadata
+ */
+export async function storeEncryptedKeyBatch(
+  params: StoreEncryptedKeyBatchParams
+): Promise<StoreEncryptedKeyBatchResult> {
+  const { pkpSessionSigs, litNodeClient, keyBatch } = params;
+  const sessionSig = getFirstSessionSig(pkpSessionSigs);
+  const pkpAddress = getPkpAddressFromSessionSig(sessionSig);
+
+  const storedKeyMetadataBatch: StoreKeyBatchParams['storedKeyMetadataBatch'] =
+    keyBatch.map(
+      ({
+        keyType,
+        publicKey,
+        memo,
+        dataToEncryptHash,
+        ciphertext,
+      }): Pick<
+        StoredKeyData,
+        | 'pkpAddress'
+        | 'publicKey'
+        | 'keyType'
+        | 'dataToEncryptHash'
+        | 'ciphertext'
+        | 'memo'
+      > => ({
+        pkpAddress,
+        publicKey,
+        memo,
+        dataToEncryptHash,
+        ciphertext,
+        keyType,
+      })
+    );
+
+  return storePrivateKeyBatch({
+    storedKeyMetadataBatch,
+    sessionSig: getFirstSessionSig(pkpSessionSigs),
+    litNetwork: litNodeClient.config.litNetwork,
+  });
+}

packages/wrapped-keys/src/lib/service-client/client.ts

@@ -1,8 +1,14 @@
-import { FetchKeyParams, ListKeysParams, StoreKeyParams } from './types';
+import {
+  FetchKeyParams,
+  ListKeysParams,
+  StoreKeyBatchParams,
+  StoreKeyParams,
+} from './types';
 import { generateRequestId, getBaseRequestParams, makeRequest } from './utils';
 import {
   StoredKeyData,
   StoredKeyMetadata,
+  StoreEncryptedKeyBatchResult,
   StoreEncryptedKeyResult,
 } from '../types';
 import { getPkpAddressFromSessionSig } from '../utils';
@@ -92,3 +98,33 @@ export async function storePrivateKey(
 
   return { pkpAddress, id };
 }
+
+/** Stores a batch of up to 25 private key metadata into the wrapped keys service backend
+ *
+ * @param { StoreKeyParams } params Parameters required to store the private key metadata
+ * @returns { Promise<StoreEncryptedKeyResult> } `true` on successful write to the service. Otherwise, this method throws an error.
+ */
+export async function storePrivateKeyBatch(
+  params: StoreKeyBatchParams
+): Promise<StoreEncryptedKeyBatchResult> {
+  const { litNetwork, sessionSig, storedKeyMetadataBatch } = params;
+
+  const requestId = generateRequestId();
+  const { baseUrl, initParams } = getBaseRequestParams({
+    litNetwork,
+    sessionSig,
+    method: 'POST',
+    requestId,
+  });
+
+  const { pkpAddress, ids } = await makeRequest<StoreEncryptedKeyBatchResult>({
+    url: baseUrl,
+    init: {
+      ...initParams,
+      body: JSON.stringify({ keyParamsBatch: storedKeyMetadataBatch }),
+    },
+    requestId,
+  });
+
+  return { pkpAddress, ids };
+}

packages/wrapped-keys/src/lib/service-client/index.ts

@@ -1,7 +1,13 @@
 import {
   fetchPrivateKey,
   storePrivateKey,
+  storePrivateKeyBatch,
   listPrivateKeyMetadata,
 } from './client';
 
-export { fetchPrivateKey, storePrivateKey, listPrivateKeyMetadata };
+export {
+  fetchPrivateKey,
+  storePrivateKey,
+  storePrivateKeyBatch,
+  listPrivateKeyMetadata,
+};

packages/wrapped-keys/src/lib/service-client/types.ts

@@ -30,6 +30,18 @@ export interface StoreKeyParams extends BaseApiParams {
   >;
 }
 
+export interface StoreKeyBatchParams extends BaseApiParams {
+  storedKeyMetadataBatch: Pick<
+    StoredKeyData,
+    | 'pkpAddress'
+    | 'publicKey'
+    | 'keyType'
+    | 'dataToEncryptHash'
+    | 'ciphertext'
+    | 'memo'
+  >[];
+}
+
 export interface BaseRequestParams {
   sessionSig: AuthSig;
   method: 'GET' | 'POST';

packages/wrapped-keys/src/lib/types.ts

@@ -77,7 +77,7 @@ export interface StoredKeyData extends StoredKeyMetadata {
   dataToEncryptHash: string;
 }
 
-/** Fetching a previously persisted key's metadata only requires valid pkpSessionSigs and a LIT Node Client instance configured for the appropriate network.
+/** Properties required to persist an encrypted key into the wrapped-keys backend storage service
  *
  * @typedef StoreEncryptedKeyParams
  * @extends BaseApiParams
@@ -101,6 +101,31 @@ export interface StoreEncryptedKeyResult {
   pkpAddress: string;
 }
 
+/** Properties required to persist a batch of encrypted keys into the wrapped-keys backend storage service
+ *
+ * @typedef StoreEncryptedKeyBatchParams
+ * @extends BaseApiParams
+ *
+ */
+export type StoreEncryptedKeyBatchParams = BaseApiParams & {
+  keyBatch: Pick<
+    StoredKeyData,
+    'publicKey' | 'keyType' | 'dataToEncryptHash' | 'ciphertext' | 'memo'
+  >[];
+};
+
+/** Result of storing a batch of private keys in the wrapped keys backend service
+ * Includes an array of unique identifiers, which are necessary to get the encrypted ciphertext and dataToEncryptHash in the future
+ *
+ * @typedef StoreEncryptedKeyBatchResult
+ * @property { string } pkpAddress The LIT PKP Address that the key was linked to; this is derived from the provided pkpSessionSigs
+ * @property { string[] } ids Array of the unique identifiers (UUID V4) of the encrypted private keys in the same order provided
+ */
+export interface StoreEncryptedKeyBatchResult {
+  ids: string[];
+  pkpAddress: string;
+}
+
 /** Exporting a previously persisted key only requires valid pkpSessionSigs and a LIT Node Client instance configured for the appropriate network.
  *
  * @typedef ExportPrivateKeyParams