Documentation fix for generatePrivateKey

mr-zwets · web-flow · commit 78fad8ec511d · 2022-02-07T15:39:38.000+01:00
generatePrivateKey() only takes one argument, not ```secp256k1``` as first parameter so I removed it.
diff --git a/src/lib/key/key-utils.ts b/src/lib/key/key-utils.ts
@@ -51,14 +51,14 @@ export const validateSecp256k1PrivateKey = (privateKey: Uint8Array) => {
  * import { randomBytes } from 'crypto';
  * import { generatePrivateKey } from '@bitauth/libauth';
  *
- * const key = generatePrivateKey(secp256k1, () => randomBytes(32));
+ * const key = generatePrivateKey(() => randomBytes(32));
  * ```
  *
  * **Browser Usage**
  * ```ts
  * import { generatePrivateKey } from '@bitauth/libauth';
  *
- * const key = generatePrivateKey(secp256k1, () =>
+ * const key = generatePrivateKey(() =>
  *   window.crypto.getRandomValues(new Uint8Array(32))
  * );
  * ```

Original file line number	Diff line number	Diff line change
`@@ -51,14 +51,14 @@ export const validateSecp256k1PrivateKey = (privateKey: Uint8Array) => {`
`51`	`51`	`* import { randomBytes } from 'crypto';`
`52`	`52`	`* import { generatePrivateKey } from '@bitauth/libauth';`
`53`	`53`	`*`
`54`		`- * const key = generatePrivateKey(secp256k1, () => randomBytes(32));`
	`54`	`+ * const key = generatePrivateKey(() => randomBytes(32));`
`55`	`55`	* ```
`56`	`56`	`*`
`57`	`57`	`* Browser Usage`
`58`	`58`	* ```ts
`59`	`59`	`* import { generatePrivateKey } from '@bitauth/libauth';`
`60`	`60`	`*`
`61`		`- * const key = generatePrivateKey(secp256k1, () =>`
	`61`	`+ * const key = generatePrivateKey(() =>`
`62`	`62`	`* window.crypto.getRandomValues(new Uint8Array(32))`
`63`	`63`	`* );`
`64`	`64`	* ```