refactor(wrapped-keys-lit-actions): LIT-3920 - Extract encryption of keys to common encryptPrivateKey method and rename signMessage... and signTransaction... methods to clarify that they use _already decrypted_ keys

Author: MaximusHaximus

packages/wrapped-keys-lit-actions/src/lib/ethereum/internal/generateEncryptedPrivateKey.js renamed to packages/wrapped-keys-lit-actions/src/lib/common/internal/encryptKey.js

@@ -1,21 +1,16 @@
-import { generateEthereumPrivateKey } from './generatePrivateKey';
 import { LIT_PREFIX } from '../../constants';
 
 /* global Lit */
 
 /**
- * Generates a random Ethers private key that only allows the provided PKP to decrypt it
- * This should be executed using `runOnce` to avoid generating `n` new private keys where we only want 1.
- *
  * @private
  * @returns { Promise<{ciphertext: string, dataToEncryptHash: string, publicKey: string}> } - The ciphertext & dataToEncryptHash which are the result of the encryption, and the publicKey of the newly generated Ethers Wrapped Key.
  */
-
-export async function generateEncryptedEthereumPrivateKey({
+export async function encryptPrivateKey({
   accessControlConditions,
+  privateKey,
+  publicKey,
 }) {
-  const { privateKey, publicKey } = generateEthereumPrivateKey();
-
   const { ciphertext, dataToEncryptHash } = await Lit.Actions.encrypt({
     accessControlConditions,
     to_encrypt: new TextEncoder().encode(LIT_PREFIX + privateKey),

packages/wrapped-keys-lit-actions/src/lib/ethereum/generateEncryptedEthereumPrivateKey.js

@@ -9,18 +9,25 @@
  *
  * @returns { Promise<string> } - Returns a stringified JSON object with ciphertext & dataToEncryptHash which are the result of the encryption. Also returns the publicKey of the newly generated Ethers Wrapped Key.
  */
-import { generateEncryptedEthereumPrivateKey } from './internal/generateEncryptedPrivateKey';
+import { generateEthereumPrivateKey } from './internal/generatePrivateKey';
+import { encryptPrivateKey } from '../common/internal/encryptKey';
 
 (async () => {
-  const generatedKeyResultStr = await Lit.Actions.runOnce(
-    { waitForResponse: true, name: 'generateEthereumPrivateKey' },
+  const { privateKey, publicKey } = generateEthereumPrivateKey();
+
+  const encryptedKeyResultStr = await Lit.Actions.runOnce(
+    { waitForResponse: true, name: 'encryptEthereumPrivateKey' },
     async () =>
       JSON.stringify(
-        generateEncryptedEthereumPrivateKey({ accessControlConditions })
+        encryptPrivateKey({
+          accessControlConditions,
+          privateKey,
+          publicKey,
+        })
       )
   );
 
   Lit.Actions.setResponse({
-    response: generatedKeyResultStr,
+    response: encryptedKeyResultStr,
   });
 })();

packages/wrapped-keys-lit-actions/src/lib/ethereum/internal/signMessageWithEncryptedKey.js renamed to packages/wrapped-keys-lit-actions/src/lib/ethereum/internal/signMessage.js

@@ -19,10 +19,7 @@ function verifyMessageSignature(messageToSign, signature) {
   }
 }
 
-export async function signMessageWithEncryptedEthereumKey({
-  privateKey,
-  messageToSign,
-}) {
+export async function signMessageEthereumKey({ privateKey, messageToSign }) {
   const { signature, walletAddress } = await signMessage({
     privateKey,
     messageToSign,

packages/wrapped-keys-lit-actions/src/lib/ethereum/internal/signTransactionWithEncryptedKey.js renamed to packages/wrapped-keys-lit-actions/src/lib/ethereum/internal/signTransaction.js

@@ -99,7 +99,7 @@ async function broadcastTransaction({ provider, signedTx }) {
   }
 }
 
-export async function signTransactionWithEncryptedKey({
+export async function signTransactionEthereumKey({
   broadcast,
   privateKey,
   unsignedTransaction,

packages/wrapped-keys-lit-actions/src/lib/ethereum/signMessageWithEncryptedEthereumKey.js

@@ -1,6 +1,4 @@
-const {
-  signMessageWithEncryptedEthereumKey,
-} = require('./internal/signMessageWithEncryptedKey');
+const { signMessageEthereumKey } = require('./internal/signMessage');
 const { getDecryptedKey } = require('../common/internal/getDecryptedKey');
 const { removeSaltFromDecryptedKey } = require('../utils');
 
@@ -33,7 +31,7 @@ const { removeSaltFromDecryptedKey } = require('../utils');
 
     const privateKey = removeSaltFromDecryptedKey(decryptedPrivateKey);
 
-    const signature = await signMessageWithEncryptedEthereumKey({
+    const signature = await signMessageEthereumKey({
       privateKey,
       messageToSign,
     });

packages/wrapped-keys-lit-actions/src/lib/ethereum/signTransactionWithEncryptedEthereumKey.js

@@ -1,6 +1,4 @@
-const {
-  signTransactionWithEncryptedKey,
-} = require('./internal/signTransactionWithEncryptedKey');
+const { signTransactionEthereumKey } = require('./internal/signTransaction');
 const { getDecryptedKey } = require('../common/internal/getDecryptedKey');
 const { removeSaltFromDecryptedKey } = require('../utils');
 
@@ -34,7 +32,7 @@ const { removeSaltFromDecryptedKey } = require('../utils');
 
     const privateKey = removeSaltFromDecryptedKey(decryptedPrivateKey);
 
-    const txResult = await signTransactionWithEncryptedKey({
+    const txResult = await signTransactionEthereumKey({
       broadcast,
       privateKey,
       unsignedTransaction,

packages/wrapped-keys-lit-actions/src/lib/solana/generateEncryptedSolanaPrivateKey.js

@@ -1,11 +1,9 @@
-const {
-  generateEncryptedSolanaPrivateKey,
-} = require('./internal/generateEncryptedPrivateKey');
+const { generateSolanaPrivateKey } = require('./internal/generatePrivateKey');
+const { encryptPrivateKey } = require('../common/internal/encryptKey');
 
 /* global accessControlConditions, Lit */
 
 /**
- *
  * Bundles solana/web3.js package as it's required to generate a random Solana key and only allows the provided PKP to decrypt it
  *
  * @jsParam pkpAddress - The Eth address of the PKP which is associated with the Wrapped Key
@@ -14,15 +12,21 @@ const {
  * @returns { Promise<string> } - Returns a stringified JSON object with ciphertext & dataToEncryptHash which are the result of the encryption. Also returns the publicKey of the newly generated Solana Wrapped Key.
  */
 (async () => {
-  const generatedKeyResultStr = await Lit.Actions.runOnce(
-    { waitForResponse: true, name: 'generateSolanaPrivateKey' },
+  const { privateKey, publicKey } = generateSolanaPrivateKey();
+
+  const encryptedKeyResultStr = await Lit.Actions.runOnce(
+    { waitForResponse: true, name: 'encryptSolanaPrivateKey' },
     () =>
       JSON.stringify(
-        generateEncryptedSolanaPrivateKey({ accessControlConditions })
+        encryptPrivateKey({
+          accessControlConditions,
+          publicKey,
+          privateKey,
+        })
       )
   );
 
   Lit.Actions.setResponse({
-    response: generatedKeyResultStr,
+    response: encryptedKeyResultStr,
   });
 })();

packages/wrapped-keys-lit-actions/src/lib/solana/internal/generateEncryptedPrivateKey.js

@@ -2,9 +2,6 @@ import { Keypair } from '@solana/web3.js';
 import bs58 from 'bs58';
 import nacl from 'tweetnacl';
 
-import { getDecryptedKey } from '../../common/internal/getDecryptedKey';
-import { removeSaltFromDecryptedKey } from '../../utils';
-
 async function signMessage({ messageToSign, solanaKeyPair }) {
   try {
     const signature = nacl.sign.detached(
@@ -32,10 +29,7 @@ function verifyMessageSignature({ signature, solanaKeyPair, messageToSign }) {
   }
 }
 
-export async function signMessageWithEncryptedSolanaKey({
-  messageToSign,
-  privateKey,
-}) {
+export async function signMessageSolanaKey({ messageToSign, privateKey }) {
   const solanaKeyPair = Keypair.fromSecretKey(Buffer.from(privateKey, 'hex'));
 
   const { signature } = await signMessage({

packages/wrapped-keys-lit-actions/src/lib/solana/internal/signMessageWithEncryptedKey.js renamed to packages/wrapped-keys-lit-actions/src/lib/solana/internal/signMessage.js

@@ -46,7 +46,7 @@ async function sendTransaction({ chain, transaction }) {
   }
 }
 
-export async function signTransactionWithEncryptedSolanaKey({
+export async function signTransactionSolanaKey({
   broadcast,
   privateKey,
   unsignedTransaction,