@midnight-ntwrk/wallet-sdk-hd 3.0.0-beta.6 → 3.0.0-beta.8

package/README.md

@@ -2,30 +2,34 @@
 
 This package provides support for Hierarchical Deterministic (HD) Wallet.
 
-To allow deterministic derivation of keys for different features, Midnight follows algorithms and structure being a mix of [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki), [BIP-44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) and [CIP-1852](https://github.com/cardano-foundation/CIPs/blob/master/CIP-1852/README.md). Specifically, derivation follows BIP-32, and following path for a key pair is used:
+To allow deterministic derivation of keys for different features, Midnight follows algorithms and structure being a mix
+of [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki),
+[BIP-44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) and
+[CIP-1852](https://github.com/cardano-foundation/CIPs/blob/master/CIP-1852/README.md). Specifically, derivation follows
+BIP-32, and following path for a key pair is used:
 
 ```
 m / purpose' / coin_type' / account' / role / index
 ```
 
 Where:
+
 - `purpose` is integer `44` (`0x8000002c`) - despite extensions, Night part of the hierarchy follows BIP-44
 - `coin_type` is integer `2400` (`0x80000960`)
 - `account` follows BIP-44 recommendations
 - `role` follows table below
 - `index` follows BIP-44 recommendations
 
-
 | Role name            | Value | Description                                             |
-|----------------------|-------|---------------------------------------------------------|
+| -------------------- | ----- | ------------------------------------------------------- |
 | Night External chain | 0     | Night is Midnight's main token of value, Follows BIP-44 |
 | Night Internal chain | 1     | as above                                                |
 | Dust                 | 2     | Dust is needed to pay fees on Midnight                  |
 | Zswap                | 3     | Zswap is a sub-protocol for shielded native tokens      |
 | Metadata             | 4     | Keys for signing metadata                               |
 
-
 ## How to derive the keys?
+
 Below you can find an example on how to derive keys from a random seed:
 
 ```typescript

package/dist/HDWallet.d.ts

@@ -9,35 +9,60 @@ export declare const Roles: {
 };
 export type Role = ValueOf<typeof Roles>;
 type DerivationResult = {
-    type: 'keyDerived';
-    key: Uint8Array;
+    readonly type: 'keyDerived';
+    readonly key: Uint8Array;
 } | {
-    type: 'keyOutOfBounds';
+    readonly type: 'keyOutOfBounds';
+};
+type CompositeDerivationResult<T extends readonly Role[]> = {
+    readonly type: 'keysDerived';
+    readonly keys: Record<T[number], Uint8Array>;
+} | {
+    readonly type: 'keyOutOfBounds';
+    readonly roles: readonly Role[];
 };
 type HDWalletResult = {
-    type: 'seedOk';
-    hdWallet: HDWallet;
+    readonly type: 'seedOk';
+    readonly hdWallet: HDWallet;
 } | {
-    type: 'seedError';
-    error: unknown;
+    readonly type: 'seedError';
+    readonly error: unknown;
+};
+declare const CompositeDerivationResult: {
+    fromResults: <T extends readonly Role[]>(results: {
+        role: T[number];
+        result: DerivationResult;
+    }[]) => CompositeDerivationResult<T>;
 };
 export declare class HDWallet {
     private readonly rootKey;
     private constructor();
     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.
+     */
+    clear(): void;
 }
 export declare class AccountKey {
-    private rootKey;
-    private account;
+    private readonly rootKey;
+    private readonly account;
     constructor(rootKey: HDKey, account: number);
     selectRole(role: Role): RoleKey;
+    selectRoles<T extends readonly Role[]>(roles: T): CompositeRoleKey<T>;
 }
 export declare class RoleKey {
-    private rootKey;
-    private account;
-    private role;
+    private readonly rootKey;
+    private readonly account;
+    private readonly role;
     constructor(rootKey: HDKey, account: number, role: Role);
     deriveKeyAt(index: number): DerivationResult;
 }
+export declare class CompositeRoleKey<T extends readonly Role[]> {
+    private readonly rootKey;
+    private readonly account;
+    private readonly roles;
+    constructor(rootKey: HDKey, account: number, roles: T);
+    deriveKeysAt(index: number): CompositeDerivationResult<T>;
+}
 export {};

package/dist/HDWallet.js

@@ -1,3 +1,15 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 import { HDKey } from '@scure/bip32';
 export const Roles = {
     NightExternal: 0,
@@ -8,6 +20,25 @@ export const Roles = {
 };
 const PURPOSE = 44;
 const COIN_TYPE = 2400;
+const CompositeDerivationResult = {
+    fromResults: (results) => {
+        const { succeededKeys, failedRoles } = results.reduce((acc, result) => {
+            if (result.result.type === 'keyDerived') {
+                acc.succeededKeys[result.role] = result.result.key;
+            }
+            else {
+                acc.failedRoles.push(result.role);
+            }
+            return acc;
+        }, { succeededKeys: {}, failedRoles: [] });
+        if (failedRoles.length > 0) {
+            return { type: 'keyOutOfBounds', roles: failedRoles };
+        }
+        else {
+            return { type: 'keysDerived', keys: succeededKeys };
+        }
+    },
+};
 export class HDWallet {
     rootKey;
     constructor(key) {
@@ -26,6 +57,12 @@ export class HDWallet {
     selectAccount(account) {
         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.
+     */
+    clear() {
+        this.rootKey.wipePrivateData();
+    }
 }
 export class AccountKey {
     rootKey;
@@ -38,6 +75,9 @@ export class AccountKey {
     selectRole(role) {
         return new RoleKey(this.rootKey, this.account, role);
     }
+    selectRoles(roles) {
+        return new CompositeRoleKey(this.rootKey, this.account, roles);
+    }
 }
 export class RoleKey {
     rootKey;
@@ -55,3 +95,20 @@ export class RoleKey {
         return derivedKey.privateKey ? { type: 'keyDerived', key: derivedKey.privateKey } : { type: 'keyOutOfBounds' };
     }
 }
+export class CompositeRoleKey {
+    rootKey;
+    account;
+    roles;
+    constructor(rootKey, account, roles) {
+        this.roles = roles;
+        this.rootKey = rootKey;
+        this.account = account;
+    }
+    deriveKeysAt(index) {
+        const results = this.roles.map((role) => ({
+            role,
+            result: new RoleKey(this.rootKey, this.account, role).deriveKeyAt(index),
+        }));
+        return CompositeDerivationResult.fromResults(results);
+    }
+}

package/dist/MnemonicUtils.js

@@ -1,3 +1,15 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 import * as bip39 from '@scure/bip39';
 import { wordlist as english } from '@scure/bip39/wordlists/english';
 export const mnemonicToWords = (mnemonic) => mnemonic.split(' ');

package/dist/index.js

@@ -1,2 +1,14 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 export * from './HDWallet.js';
 export * from './MnemonicUtils.js';

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@midnight-ntwrk/wallet-sdk-hd",
-  "version": "3.0.0-beta.6",
+  "version": "3.0.0-beta.8",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "author": "IOHK",
+  "author": "Midnight Foundation",
   "license": "Apache-2.0",
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"
@@ -32,16 +32,18 @@
     "@ethereumjs/wallet": "^3.0.0-alpha.1",
     "eslint": "^9.37.0",
     "fast-check": "^4.2.0",
+    "prettier": "^3.7.0",
     "publint": "~0.3.14",
     "rimraf": "^6.0.1",
     "typescript": "^5.9.3",
-    "vitest": "^3.2.4"
+    "vitest": "^4.0.16"
   },
   "scripts": {
     "typecheck": "tsc -b ./tsconfig.json --noEmit",
     "test": "vitest run",
     "lint": "eslint --max-warnings 0",
-    "format": "prettier --write \"**/*.{ts,js,json,yaml,yml}\"",
+    "format": "prettier --write \"**/*.{ts,js,json,yaml,yml,md}\"",
+    "format:check": "prettier --check \"**/*.{ts,js,json,yaml,yml,md}\"",
     "dist": "tsc -b ./tsconfig.build.json",
     "dist:publish": "tsc -b ./tsconfig.publish.json",
     "clean": "rimraf --glob dist 'tsconfig.*.tsbuildinfo' && date +%s > .clean-timestamp",