Merge pull request #516 from LIT-Protocol/feature/release-private-key-after-use

manually release private key in tests

Author: Ansonhkg

.github/workflows/ci.yml

@@ -36,7 +36,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     env:
-      NETWORK: cayenne
+      NETWORK: datil-dev
       DEBUG: true
       MAX_ATTEMPTS: 3
     steps:

local-tests/setup/tinny-environment.ts

@@ -174,16 +174,6 @@ export class TinnyEnvironment {
         this.processEnvs.KEY_IN_USE[index] = true; // Mark the key as in use
         // console.log('[𐬺🧪 Tinny Environment𐬺] 🔑 Selected key at index', index); // Log a message indicating that we have selected a key
 
-        // Set a timer to automatically release the key after 10 seconds
-        setTimeout(() => {
-          this.releasePrivateKey(index);
-          // console.log(
-          //   '[𐬺🧪 Tinny Environment𐬺] 🔓 Automatically released key at index',
-          //   index,
-          //   `after ${this.processEnvs.TIME_TO_RELEASE_KEY / 10000} seconds`
-          // );
-        }, this.processEnvs.TIME_TO_RELEASE_KEY);
-
         return { privateKey: this.processEnvs.PRIVATE_KEYS[index], index }; // Return the key and its index
       } else {
         // console.log('[𐬺🧪 Tinny Environment𐬺] No available keys. Waiting...'); // Log a message indicating that we are waiting
@@ -195,6 +185,18 @@ export class TinnyEnvironment {
     }
   }
 
+  /**
+   * Marks a private key as available again after use.
+   * @param {number} index - The index of the key to mark as available.
+   */
+  releasePrivateKeyFromUser(user: TinnyPerson) {
+    const index = this.processEnvs.PRIVATE_KEYS.indexOf(user.privateKey);
+    this.processEnvs.KEY_IN_USE[index] = false;
+    // console.log(
+    //   `[𐬺🧪 Tinny Environment𐬺] 🪽 Released key at index ${index}. Thank you for your service!`
+    // );
+  }
+
   /**
    * Marks a private key as available again after use.
    * @param {number} index - The index of the key to mark as available.

local-tests/tests/test-example.ts

@@ -30,6 +30,8 @@ export const testExample = async (devEnv: TinnyEnvironment) => {
 
   console.log('aliceExecuteJsRes:', aliceExecuteJsRes);
 
+  devEnv.releasePrivateKeyFromUser(alice);
+
   // console.log('aliceEoaSessionSigs: ', aliceEoaSessionSigs);
 
   // const alicePkpSessionSigs = await getPkpSessionSigs(devEnv, alice);

local-tests/tests/testDelegatingCapacityCreditsNFTToAnotherPkpToExecuteJs.ts

@@ -85,6 +85,9 @@ export const testDelegatingCapacityCreditsNFTToAnotherPkpToExecuteJs = async (
 
   console.log('✅ res:', res);
 
+  devEnv.releasePrivateKeyFromUser(alice);
+  devEnv.releasePrivateKeyFromUser(bob);
+
   // -- Expected output:
   // {
   //   claims: {},

local-tests/tests/testDelegatingCapacityCreditsNFTToAnotherWalletToExecuteJs.ts

@@ -64,6 +64,9 @@ export const testDelegatingCapacityCreditsNFTToAnotherWalletToExecuteJs =
       },
     });
 
+    devEnv.releasePrivateKeyFromUser(alice);
+    devEnv.releasePrivateKeyFromUser(bob);
+
     // Expected output:
     // {
     //   claims: {},

local-tests/tests/testDelegatingCapacityCreditsNFTToAnotherWalletToPkpSign.ts

@@ -56,6 +56,9 @@ export const testDelegatingCapacityCreditsNFTToAnotherWalletToPkpSign = async (
     pubKey: bob.pkp.publicKey,
   });
 
+  devEnv.releasePrivateKeyFromUser(alice);
+  devEnv.releasePrivateKeyFromUser(bob);
+
   // -- Expected output:
   // {
   //   r: "25e04b2abdf220b1374b19228bc292bab71a3224a635726a46d4cbe3a62bb636",

local-tests/tests/testExecuteJsBroadcastAndCollect.ts

@@ -38,6 +38,7 @@ export const testExecuteJsBroadcastAndCollect = async (
       })();`,
     jsParams: {},
   });
+  devEnv.releasePrivateKeyFromUser(alice);
 
   const response = res.response;
   if (!response) {

local-tests/tests/testExecuteJsDecryptAndCombine.ts

@@ -78,6 +78,8 @@ export const testExecutJsDecryptAndCombine = async (
     },
   });
 
+  devEnv.releasePrivateKeyFromUser(alice);
+
   if (res.response !== 'Hello world') {
     throw new Error('content does not match what was expected');
   }

local-tests/tests/testExecuteJsSignAndCombineEcdsa.ts

@@ -72,6 +72,9 @@ export const testExecuteJsSignAndCombineEcdsa = async (
     },
   });
 
+  devEnv.releasePrivateKeyFromUser(alice);
+  devEnv.releasePrivateKeyFromUser(bob);
+
   /**
         Response format
        {

local-tests/tests/testPkpEthersWithEoaSessionSigsToEthSign.ts

@@ -56,5 +56,7 @@ export const testPkpEthersWithEoaSessionSigsToEthSign = async (
     console.log('✅ recoveredAddr:', recoveredAddr);
   } catch (e) {
     throw new Error('❌ Error: ' + e.message);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithEoaSessionSigsToEthSignTransaction.ts

@@ -103,5 +103,7 @@ export const testPkpEthersWithEoaSessionSigsToEthSignTransaction = async (
     } else {
       throw new Error(`❌ Error: ${e.toString()}`);
     }
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithEoaSessionSigsToEthSignTypedData.ts

@@ -91,5 +91,7 @@ export const testPkpEthersWithEoaSessionSigsToEthSignTypedData = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithEoaSessionSigsToEthSignTypedDataUtil.ts

@@ -88,5 +88,7 @@ export const testPkpEthersWithEoaSessionSigsToEthSignTypedDataUtil = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithEoaSessionSigsToEthSignTypedDataV1.ts

@@ -73,5 +73,7 @@ export const testPkpEthersWithEoaSessionSigsToEthSignTypedDataV1 = async (
     console.log('recoveredAddr: ', recoveredAddr);
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithEoaSessionSigsToEthSignTypedDataV3.ts

@@ -101,5 +101,7 @@ export const testPkpEthersWithEoaSessionSigsToEthSignTypedDataV3 = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithEoaSessionSigsToEthSignTypedDataV4.ts

@@ -101,5 +101,7 @@ export const testPkpEthersWithEoaSessionSigsToEthSignTypedDataV4 = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithEoaSessionSigsToPersonalSign.ts

@@ -57,5 +57,7 @@ export const testPkpEthersWithEoaSessionSigsToPersonalSign = async (
     console.log('✅ personal_sign recoveredAddr:', recoveredAddr);
   } catch (e) {
     throw new Error('❌ Error: ' + e.message);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithEoaSessionSigsToSendTx.ts

@@ -58,5 +58,7 @@ export const testPkpEthersWithEoaSessionSigsToSendTx = async (
     } else {
       throw new Error(`❌ Error: ${e.toString()}`);
     }
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithEoaSessionSigsToSignMessage.ts

@@ -29,5 +29,7 @@ export const testPkpEthersWithEoaSessionSigsToSignMessage = async (
     console.log('✅ signature:', signature);
   } catch (e) {
     throw new Error('❌ Error: ' + e.message);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithEoaSessionSigsToSignWithAuthContext.ts

@@ -66,5 +66,7 @@ export const testPkpEthersWithEoaSessionSigsToSignWithAuthContext = async (
     console.log('✅ signature:', signature);
   } catch (e) {
     throw new Error('❌ Error: ' + e.message);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithLitActionSessionSigsToEthSign.ts

@@ -56,5 +56,7 @@ export const testPkpEthersWithLitActionSessionSigsToEthSign = async (
     console.log('✅ recoveredAddr:', recoveredAddr);
   } catch (e) {
     throw new Error('❌ Error: ' + e.message);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithLitActionSessionSigsToEthSignTransaction.ts

@@ -103,5 +103,7 @@ export const testPkpEthersWithLitActionSessionSigsToEthSignTransaction = async (
     } else {
       throw new Error(`❌ Error: ${e.toString()}`);
     }
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithLitActionSessionSigsToEthSignTypedData.ts

@@ -91,5 +91,7 @@ export const testPkpEthersWithLitActionSessionSigsToEthSignTypedData = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithLitActionSessionSigsToEthSignTypedDataUtil.ts

@@ -83,5 +83,7 @@ export const testPkpEthersWithLitActionSessionSigsToEthSignTypedDataUtil =
       }
     } catch (e) {
       throw new Error(`❌ ${e.toString()}`);
+    } finally {
+      devEnv.releasePrivateKeyFromUser(alice);
     }
   };

local-tests/tests/testPkpEthersWithLitActionSessionSigsToEthSignTypedDataV1.ts

@@ -73,5 +73,7 @@ export const testPkpEthersWithLitActionSessionSigsToEthSignTypedDataV1 = async (
     console.log('recoveredAddr: ', recoveredAddr);
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithLitActionSessionSigsToEthSignTypedDataV3.ts

@@ -100,5 +100,7 @@ export const testPkpEthersWithLitActionSessionSigsToEthSignTypedDataV3 = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithLitActionSessionSigsToEthSignTypedDataV4.ts

@@ -101,5 +101,7 @@ export const testPkpEthersWithLitActionSessionSigsToEthSignTypedDataV4 = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithLitActionSessionSigsToPersonalSign.ts

@@ -57,5 +57,7 @@ export const testPkpEthersWithLitActionSessionSigsToPersonalSign = async (
     console.log('✅ personal_sign recoveredAddr:', recoveredAddr);
   } catch (e) {
     throw new Error('❌ Error: ' + e.message);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithLitActionSessionSigsToSendTx.ts

@@ -58,5 +58,7 @@ export const testPkpEthersWithLitActionSessionSigsToSendTx = async (
     } else {
       throw new Error(`❌ Error: ${e.toString()}`);
     }
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithLitActionSessionSigsToSignMessage.ts

@@ -28,5 +28,7 @@ export const testPkpEthersWithLitActionSessionSigsToSignMessage = async (
     console.log('✅ signature:', signature);
   } catch (e) {
     throw new Error('❌ Error: ' + e.message);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithPkpSessionSigsToEthSign.ts

@@ -56,5 +56,7 @@ export const testPkpEthersWithPkpSessionSigsToEthSign = async (
     console.log('✅ recoveredAddr:', recoveredAddr);
   } catch (e) {
     throw new Error('❌ Error: ' + e.message);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithPkpSessionSigsToEthSignTransaction.ts

@@ -103,5 +103,7 @@ export const testPkpEthersWithPkpSessionSigsToEthSignTransaction = async (
     } else {
       throw new Error(`❌ Error: ${e.toString()}`);
     }
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithPkpSessionSigsToEthSignTypedData.ts

@@ -91,5 +91,7 @@ export const testPkpEthersWithPkpSessionSigsToEthSignTypedData = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithPkpSessionSigsToEthSignTypedDataUtil.ts

@@ -84,5 +84,7 @@ export const testPkpEthersWithPkpSessionSigsToEthSignTypedDataUtil = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithPkpSessionSigsToEthSignTypedDataV1.ts

@@ -73,5 +73,7 @@ export const testPkpEthersWithPkpSessionSigsToEthSignTypedDataV1 = async (
     console.log('recoveredAddr: ', recoveredAddr);
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithPkpSessionSigsToEthSignTypedDataV3.ts

@@ -100,5 +100,7 @@ export const testPkpEthersWithPkpSessionSigsToEthSignTypedDataV3 = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithPkpSessionSigsToEthSignTypedDataV4.ts

@@ -101,5 +101,7 @@ export const testPkpEthersWithPkpSessionSigsToEthSignTypedDataV4 = async (
     }
   } catch (e) {
     throw new Error(`❌ ${e.toString()}`);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithPkpSessionSigsToPersonalSign.ts

@@ -57,5 +57,7 @@ export const testPkpEthersWithPkpSessionSigsToPersonalSign = async (
     console.log('✅ personal_sign recoveredAddr:', recoveredAddr);
   } catch (e) {
     throw new Error('❌ Error: ' + e.message);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithPkpSessionSigsToSendTx.ts

@@ -58,5 +58,7 @@ export const testPkpEthersWithPkpSessionSigsToSendTx = async (
     } else {
       throw new Error(`❌ Error: ${e.toString()}`);
     }
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testPkpEthersWithPkpSessionSigsToSignMessage.ts

@@ -28,5 +28,7 @@ export const testPkpEthersWithPkpSessionSigsToSignMessage = async (
     console.log('✅ signature:', signature);
   } catch (e) {
     throw new Error('❌ Error: ' + e.message);
+  } finally {
+    devEnv.releasePrivateKeyFromUser(alice);
   }
 };

local-tests/tests/testUseCapacityDelegationAuthSigWithUnspecifiedCapacityTokenIdToExecuteJs.ts

@@ -68,6 +68,9 @@ export const testUseCapacityDelegationAuthSigWithUnspecifiedCapacityTokenIdToExe
       },
     });
 
+    devEnv.releasePrivateKeyFromUser(alice);
+    devEnv.releasePrivateKeyFromUser(bob);
+
     // Expected output:
     // {
     //   claims: {},

local-tests/tests/testUseCapacityDelegationAuthSigWithUnspecifiedCapacityTokenIdToPkpSign.ts

@@ -58,6 +58,9 @@ export const testUseCapacityDelegationAuthSigWithUnspecifiedCapacityTokenIdToPkp
       pubKey: bob.pkp.publicKey,
     });
 
+    devEnv.releasePrivateKeyFromUser(alice);
+    devEnv.releasePrivateKeyFromUser(bob);
+
     // -- Expected output:
     // {
     //   r: "25e04b2abdf220b1374b19228bc292bab71a3224a635726a46d4cbe3a62bb636",

local-tests/tests/testUseCapacityDelegationAuthSigWithUnspecifiedDelegateesToExecuteJs.ts

@@ -66,6 +66,9 @@ export const testUseCapacityDelegationAuthSigWithUnspecifiedDelegateesToExecuteJ
       },
     });
 
+    devEnv.releasePrivateKeyFromUser(alice);
+    devEnv.releasePrivateKeyFromUser(bob);
+
     // Expected output:
     // {
     //   claims: {},

local-tests/tests/testUseCapacityDelegationAuthSigWithUnspecifiedDelegateesToPkpSign.ts

@@ -56,6 +56,9 @@ export const testUseCapacityDelegationAuthSigWithUnspecifiedDelegateesToPkpSign
       sessionSigs: bobsSessionSigs,
     });
 
+    devEnv.releasePrivateKeyFromUser(alice);
+    devEnv.releasePrivateKeyFromUser(bob);
+
     // -- Expected output:
     // {
     //   r: "36bd0039b4e4d1dae488a63437318790df86b8023ac4ffa842c8983245b7f629",