Deprecate Argon2id (#1945)

Author: webmaster128

CHANGELOG.md

@@ -17,6 +17,9 @@ and this project adheres to
   wallet serialization/deserialization which is not needed anymore after
   [#1938].
 - Bring back main/types fields for bundlephobia support
+- @cosmjs/crypto: Deprecate `Argon2id`/`Argon2idOptions`/`isArgon2idOptions`
+  because it will likely be removed when wallet serialization/deserialization is
+  removed.
 
 [#1935]: https://github.com/cosmos/cosmjs/pull/1935
 [#1938]: https://github.com/cosmos/cosmjs/issues/1938

packages/crypto/src/argon2.ts

@@ -1,6 +1,10 @@
 import { isNonNullObject } from "@cosmjs/utils";
 import { argon2id, ArgonOpts } from "@noble/hashes/argon2.js";
 
+/**
+ * @deprecated This is just a thin wrapper around argon2id from @noble/hashes and will likely be removed.
+ * @see https://github.com/cosmos/cosmjs/issues/1796
+ */
 export interface Argon2idOptions {
   /** Output length in bytes */
   readonly outputLength: number;
@@ -20,6 +24,10 @@ export interface Argon2idOptions {
   readonly memLimitKib: number;
 }
 
+/**
+ * @deprecated This is just a thin wrapper around argon2id from @noble/hashes and will likely be removed.
+ * @see https://github.com/cosmos/cosmjs/issues/1796
+ */
 export function isArgon2idOptions(thing: unknown): thing is Argon2idOptions {
   if (!isNonNullObject(thing)) return false;
   if (typeof (thing as Argon2idOptions).outputLength !== "number") return false;
@@ -28,6 +36,10 @@ export function isArgon2idOptions(thing: unknown): thing is Argon2idOptions {
   return true;
 }
 
+/**
+ * @deprecated This is just a thin wrapper around argon2id from @noble/hashes and will likely be removed.
+ * @see https://github.com/cosmos/cosmjs/issues/1796
+ */
 export class Argon2id {
   // This is async for historic reasons. If we switch to a Wasm implementation or get argon2 in WebCrypto,
   // this is needed again.