feat: export setSignEntropy

wevm · Nov 21, 2024 · a22c5b1 · a22c5b1
1 parent ce1b8af
commit a22c5b1
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 11 deletions.
diff --git a/.changeset/ninety-suits-invite.md b/.changeset/ninety-suits-invite.md
@@ -1,5 +1,5 @@
 ---
-"viem": minor
+"viem": patch
 ---
 
-Improved security of signature generation. Resolves #3028.
+Added `setSignEntropy` export to improve security of signature generation.
diff --git a/src/accounts/index.test.ts b/src/accounts/index.test.ts
@@ -22,6 +22,7 @@ test('exports utils', () => {
       "mnemonicToAccount",
       "privateKeyToAccount",
       "toAccount",
+      "setSignEntropy",
       "sign",
       "signatureToHex",
       "serializeSignature",

diff --git a/src/accounts/index.ts b/src/accounts/index.ts
@@ -55,6 +55,7 @@ export {
   type SignErrorType,
   type SignParameters,
   type SignReturnType,
+  setSignEntropy,
   sign,
 } from './utils/sign.js'
 export {

diff --git a/src/accounts/utils/sign.ts b/src/accounts/utils/sign.ts
@@ -25,10 +25,13 @@ export type SignReturnType<to extends To = 'object'> =
 
 export type SignErrorType = NumberToHexErrorType | ErrorType
 
-let extraEntropy: Hex | boolean = true
+let extraEntropy: Hex | boolean = false
 
-/** @internal */
-export function setSignEntropy(entropy: Hex | boolean) {
+/**
+ * Sets extra entropy for signing functions.
+ */
+export function setSignEntropy(entropy: true | Hex) {
+  if (!entropy) throw new Error('must be a `true` or a hex value.')
   extraEntropy = entropy
 }
 

diff --git a/test/setup.ts b/test/setup.ts
@@ -5,14 +5,11 @@ import { cleanupCache, listenersCache } from '~viem/utils/observe.js'
 import { promiseCache, responseCache } from '~viem/utils/promise/withCache.js'
 import { socketClientCache } from '~viem/utils/rpc/socket.js'
 
-import { setSignEntropy } from '../src/accounts/utils/sign.js'
 import { setErrorConfig } from '../src/errors/base.js'
 import * as instances from './src/anvil.js'
 
 const client = instances.anvilMainnet.getClient()
 
-setSignEntropy(false)
-
 beforeAll(() => {
   setErrorConfig({
     getDocsUrl({ docsBaseUrl, docsPath }) {

diff --git a/vectors/src/transaction.vectors.test.ts b/vectors/src/transaction.vectors.test.ts
@@ -7,9 +7,6 @@ import { signTransaction } from '../../src/accounts/utils/signTransaction.js'
 import { parseTransaction } from '../../src/index.js'
 import { serializeTransaction } from '../../src/utils/transaction/serializeTransaction.js'
 import { readGzippedJson } from '../utils.js'
-import { setSignEntropy } from '../../src/accounts/utils/sign.js'
-
-setSignEntropy(false)
 
 const transactions_ = await readGzippedJson(
   join(import.meta.dir, './transaction.json.gz'),