refactor: Rename make methods

hirosystems · Oct 22, 2024 · 5172bce · 5172bce
1 parent e78cc74
commit 5172bce
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 7 deletions.
diff --git a/.github/MIGRATION.md b/.github/MIGRATION.md
@@ -327,6 +327,8 @@ This likely was a misunderstood and unused feature.
 - `generateSecretKey` was renamed to `randomSeedPhrase`.
 - `nextYear`, `nextMonth`, `nextHour`, `makeUUID4`, `updateQueryStringParameter`, `getAesCbcOutputLength`, `getAPIUsageErrorMessage`, `isSameOriginAbsoluteUrl`, `isLaterVersion`, `getBase64OutputLength`, were marked as deprecated.
 - `encrypt` and `decrypt` in `@stacks/wallet-sdk` (aliases of `encryptMnemonic` and `decryptMnemonic` in the `@stacks/encryption` package respectively) were removed.
+- `makeECPrivateKey` in `@stacks/encryption` was deprecated, use `randomPrivateKey` instead.
+- `makeSigHashPreSign` was renamed to `sigHashPreSign` and marked as internal.
 
 ## Stacks.js (&lt;=4.x.x) → (5.x.x)
 

diff --git a/packages/encryption/src/keys.ts b/packages/encryption/src/keys.ts
@@ -30,11 +30,17 @@ utils.hmacSha256Sync = (key: Uint8Array, ...msgs: Uint8Array[]) => {
 
 /**
  * @ignore
+ * @deprecated Use `randomPrivateKey` instead.
  */
 export function makeECPrivateKey() {
   return bytesToHex(utils.randomPrivateKey());
 }
 
+/** Generate a random elliptic-curve private key */
+export function randomPrivateKey() {
+  return bytesToHex(utils.randomPrivateKey());
+}
+
 /**
  * Based on bitcoinjs-lib MIT https://github.com/bitcoinjs/bs58check/blob/12b3e700f355c5c49d0be3f8fc29be6c66e753e9/base.js
  * @ignore

diff --git a/packages/transactions/src/authorization.ts b/packages/transactions/src/authorization.ts
@@ -339,7 +339,8 @@ export function deserializeSpendingCondition(bytesReader: BytesReader): Spending
   }
 }
 
-export function makeSigHashPreSign(
+/** @ignore */
+export function sigHashPreSign(
   curSigHash: string,
   authType: AuthType,
   fee: IntegerType,
@@ -398,11 +399,11 @@ export function nextSignature(
   nextSig: string;
   nextSigHash: string;
 } {
-  const sigHashPreSign = makeSigHashPreSign(curSigHash, authType, fee, nonce);
+  const sigHashPre = sigHashPreSign(curSigHash, authType, fee, nonce);
 
-  const signature = signWithKey(privateKey, sigHashPreSign);
+  const signature = signWithKey(privateKey, sigHashPre);
   const publicKey = createStacksPublicKey(privateKeyToPublic(privateKey));
-  const nextSigHash = makeSigHashPostSign(sigHashPreSign, publicKey, signature);
+  const nextSigHash = makeSigHashPostSign(sigHashPre, publicKey, signature);
 
   return {
     nextSig: signature,
@@ -418,13 +419,13 @@ export function nextVerification(
   pubKeyEncoding: PubKeyEncoding,
   signature: string
 ) {
-  const sigHashPreSign = makeSigHashPreSign(initialSigHash, authType, fee, nonce);
+  const sigHashPre = sigHashPreSign(initialSigHash, authType, fee, nonce);
 
   const publicKey = createStacksPublicKey(
-    publicKeyFromSignatureVrs(sigHashPreSign, signature, pubKeyEncoding)
+    publicKeyFromSignatureVrs(sigHashPre, signature, pubKeyEncoding)
   );
 
-  const nextSigHash = makeSigHashPostSign(sigHashPreSign, publicKey, signature);
+  const nextSigHash = makeSigHashPostSign(sigHashPre, publicKey, signature);
 
   return {
     pubKey: publicKey,