Skip to content

Commit 9b37759

Browse files
committed
proto-signing: mark encryption functions as @deprecated
1 parent fc318d1 commit 9b37759

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

packages/proto-signing/src/directsecp256k1hdwallet.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,8 @@ export class DirectSecp256k1HdWallet implements OfflineDirectSigner {
170170
*
171171
* @param password The user provided password used to generate an encryption key via a KDF.
172172
* This is not normalized internally (see "Unicode normalization" to learn more).
173+
*
174+
* @deprecated Encryption support may be removed from CosmJS in a future version. If you actually use this, comment at https://github.com/cosmos/cosmjs/issues/1796
173175
*/
174176
public static async deserialize(serialization: string, password: string): Promise<DirectSecp256k1HdWallet> {
175177
const root = JSON.parse(serialization);
@@ -189,6 +191,8 @@ export class DirectSecp256k1HdWallet implements OfflineDirectSigner {
189191
*
190192
* The caller is responsible for ensuring the key was derived with the given KDF configuration. This can be
191193
* done using `extractKdfConfiguration(serialization)` and `executeKdf(password, kdfConfiguration)` from this package.
194+
*
195+
* @deprecated Encryption support may be removed from CosmJS in a future version. If you actually use this, comment at https://github.com/cosmos/cosmjs/issues/1796
192196
*/
193197
public static async deserializeWithEncryptionKey(
194198
serialization: string,
@@ -290,6 +294,8 @@ export class DirectSecp256k1HdWallet implements OfflineDirectSigner {
290294
*
291295
* @param password The user provided password used to generate an encryption key via a KDF.
292296
* This is not normalized internally (see "Unicode normalization" to learn more).
297+
*
298+
* @deprecated Encryption support may be removed from CosmJS in a future version. If you actually use this, comment at https://github.com/cosmos/cosmjs/issues/1796
293299
*/
294300
public async serialize(password: string): Promise<string> {
295301
const kdfConfiguration = basicPasswordHashingOptions;
@@ -305,6 +311,8 @@ export class DirectSecp256k1HdWallet implements OfflineDirectSigner {
305311
*
306312
* The caller is responsible for ensuring the key was derived with the given KDF options. If this
307313
* is not the case, the wallet cannot be restored with the original password.
314+
*
315+
* @deprecated Encryption support may be removed from CosmJS in a future version. If you actually use this, comment at https://github.com/cosmos/cosmjs/issues/1796
308316
*/
309317
public async serializeWithEncryptionKey(
310318
encryptionKey: Uint8Array,

0 commit comments

Comments
 (0)