@midnight-ntwrk/wallet-sdk-hd 3.1.0-beta.2 → 3.1.0-beta.3

package/dist/HDWallet.d.ts

@@ -40,8 +40,11 @@ export declare class HDWallet {
     static fromSeed(seed: Uint8Array): HDWalletResult;
     selectAccount(account: number): AccountKey;
     /**
-     * Once all keys are derived - clear internals from private data, so that they do not reside in memory longer than
-     * needed.
+     * Wipes the root key's private-key buffer, narrowing the window in which the seed is reachable.
+     *
+     * It does not reach the intermediate keys BIP32 allocates at each level of a derivation path, nor the derived keys
+     * already handed to callers — neither is reachable from here, so both are left to the garbage collector. Call this
+     * once all keys are derived, but do not read it as a guarantee that the seed is gone from the process.
      */
     clear(): void;
 }

package/dist/HDWallet.js

@@ -61,8 +61,11 @@ export class HDWallet {
         return new AccountKey(this.rootKey, account);
     }
     /**
-     * Once all keys are derived - clear internals from private data, so that they do not reside in memory longer than
-     * needed.
+     * Wipes the root key's private-key buffer, narrowing the window in which the seed is reachable.
+     *
+     * It does not reach the intermediate keys BIP32 allocates at each level of a derivation path, nor the derived keys
+     * already handed to callers — neither is reachable from here, so both are left to the garbage collector. Call this
+     * once all keys are derived, but do not read it as a guarantee that the seed is gone from the process.
      */
     clear() {
         this.rootKey.wipePrivateData();

package/dist/WalletSeeds.js

@@ -67,7 +67,7 @@ export const WalletSeeds = {
             .selectAccount(account)
             .selectRoles([Roles.Zswap, unshieldedRole, Roles.Dust])
             .deriveKeysAt(addressIndex);
-        // Wiped whether or not the derivation succeeded: a failed walk is no reason to leave the tree open.
+        // Wiped whether or not the derivation succeeded: a failed walk is no reason to leave the root key live.
         opened.hdWallet.clear();
         if (derived.type !== 'keysDerived') {
             throw new SeedDerivationError(`No key exists at account ${account}, address index ${addressIndex} for ${derived.roles.length === 1 ? 'role' : 'roles'} ` +

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midnight-ntwrk/wallet-sdk-hd",
-  "version": "3.1.0-beta.2",
+  "version": "3.1.0-beta.3",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",