{"id":22344380,"url":"https://github.com/symbol/symbol-hd-wallets","last_synced_at":"2025-07-30T03:30:53.500Z","repository":{"id":40713749,"uuid":"180003888","full_name":"symbol/symbol-hd-wallets","owner":"symbol","description":"Hierarchical-deterministic wallets library for Symbol","archived":false,"fork":false,"pushed_at":"2024-01-31T00:51:53.000Z","size":1199,"stargazers_count":11,"open_issues_count":14,"forks_count":17,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-07-02T12:17:12.675Z","etag":null,"topics":["catapult","derivation","ed25519","hd-wallet","javascript","nem","symbol","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/symbol.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-07T18:07:23.000Z","updated_at":"2025-03-30T00:45:34.000Z","dependencies_parsed_at":"2024-06-18T22:46:34.593Z","dependency_job_id":"dff37bf8-52c2-4cd7-9d47-c8a9971e6f4a","html_url":"https://github.com/symbol/symbol-hd-wallets","commit_stats":null,"previous_names":["evias/nem2-hd-wallets","nemtech/symbol-hd-wallets"],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/symbol/symbol-hd-wallets","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symbol%2Fsymbol-hd-wallets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symbol%2Fsymbol-hd-wallets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symbol%2Fsymbol-hd-wallets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symbol%2Fsymbol-hd-wallets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/symbol","download_url":"https://codeload.github.com/symbol/symbol-hd-wallets/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symbol%2Fsymbol-hd-wallets/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267803963,"owners_count":24146527,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["catapult","derivation","ed25519","hd-wallet","javascript","nem","symbol","typescript"],"created_at":"2024-12-04T09:10:11.621Z","updated_at":"2025-07-30T03:30:53.228Z","avatar_url":"https://github.com/symbol.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Symbol HD Wallets\n\n[![npm version](https://badge.fury.io/js/symbol-hd-wallets.svg)](https://badge.fury.io/js/symbol-hd-wallets)\n[![Build Status](https://travis-ci.com/nemtech/symbol-hd-wallets.svg?branch=master)](https://travis-ci.com/nemtech/symbol-hd-wallets)\n[![Slack](https://img.shields.io/badge/chat-on%20slack-green.svg)](https://nem2.slack.com/messages/CB0UU89GS//)\n\nHierarchical-deterministic (HD) wallets generator library for Symbol.\n\nThis is a PoC to validate the proposed [NIP6 Multi-Account Hierarchy for Deterministic Wallets](https://github.com/nemtech/NIP/issues/12). When stable, the repository will be moved to the [nemtech](https://github.com/nemtech) organization.\n\n**NOTE**: The author of this package cannot be held responsible for any loss of money or any malintentioned usage forms of this package. Please use this package with caution.\n\n## Requirements\n\n- Node.js 12 LTS\n\n## Installation\n\n`npm install symbol-hd-wallets`\n\n## Usage\n\n### Generating a mnemonic pass phrase\n\n```ts\n// examples/GeneratingAMnemonicPassPhrase.ts\n\nimport {MnemonicPassPhrase} from \"../src/MnemonicPassPhrase\";\n\n// random 24-words mnemonic\nMnemonicPassPhrase.createRandom();\n\n// random 12-words mnemonic\nMnemonicPassPhrase.createRandom('english', 128);\n\n// random 24-words mnemonic with french wordlist\nMnemonicPassPhrase.createRandom('french');\n\n// random 24-words mnemonic with japanese wordlist\nMnemonicPassPhrase.createRandom('japanese');\n\n```\n\n### Generating a password-protected mnemonic pass phrase seed (for storage)\n\n```ts\n// examples/GeneratePasswordProtectedSeedForRandomPassPhrase.ts\n\nimport {MnemonicPassPhrase} from \"../src/MnemonicPassPhrase\";\n\nconst mnemonic = MnemonicPassPhrase.createRandom();\nconst secureSeedHex = mnemonic.toSeed('your-password');\n\n```\n\n```ts\n// examples/GeneratePasswordProtectedSeedForRandomPassPhraseEmptyPassword.ts\n\nimport {MnemonicPassPhrase} from \"../src/MnemonicPassPhrase\";\n\n// Example 2: empty password for password-protected seed\nconst mnemonic = MnemonicPassPhrase.createRandom();\nconst secureSeedHex = mnemonic.toSeed(); // omit password means empty password: ''\n\n```\n\n### Generating a root (master) extended key\n\n```ts\n// examples/GeneratingARootMasterExtendedKeyForKnownPassPhrase.ts\n\nimport {MnemonicPassPhrase} from \"../src/MnemonicPassPhrase\";\n\n// Example 2: generate BIP32 master seed for known pass phrase\nconst words = 'alpha pattern real admit vacuum wall ready code '\n    + 'correct program depend valid focus basket whisper firm '\n    + 'tray fit rally day dance demise engine mango';\nconst mnemonic = new MnemonicPassPhrase(words);\n\n// the following seed can be used with `ExtendedKey.createFromSeed()`\nconst bip32Seed = mnemonic.toSeed(); // using empty password\n\n```\n\n```ts\n// examples/GeneratingARootMasterExtendedKeyForRandomPassPhrase.ts\n\nimport {MnemonicPassPhrase} from \"../src/MnemonicPassPhrase\";\n\n// Example 1: generate BIP32 master seed for random pass phrase\nconst mnemonic = MnemonicPassPhrase.createRandom();\nconst bip32Seed = mnemonic.toSeed();\n\n```\n\n### Generating a HD wallet (SYMBOL **mijin** and **mijinTest** compatible)\n\n```ts\n// examples/GeneratingAHDWalletPrivateNetworkCompatible.ts\n\nimport {NetworkType} from 'symbol-sdk';\nimport {ExtendedKey} from \"../src/ExtendedKey\";\nimport {Wallet} from \"../src/Wallet\";\nimport {Network} from \"../src/Network\";\n\nconst xkey = ExtendedKey.createFromSeed('000102030405060708090a0b0c0d0e0f', Network.SYMBOL);\nconst wallet = new Wallet(xkey);\n\n// get master account\nconst masterAccount = wallet.getAccount();\n\n// get DEFAULT ACCOUNT\nconst defaultAccount = wallet.getChildAccount();\n\n// derive specific child path\nconst childAccount = wallet.getChildAccount('m/44\\'/4343\\'/0\\'/0\\'/0\\'', NetworkType.MIJIN_TEST);\n\n// get read-only wallet\nconst readOnlyWallet = new Wallet(xkey.getPublicNode());\nconst readOnlyAccount = readOnlyWallet.getPublicAccount(NetworkType.MIJIN_TEST);\n\n// get read-only DEFAULT ACCOUNT\nconst readOnlyDefaultAccount = readOnlyWallet.getChildPublicAccount();\n\n```\n\n### Generating a HD wallet (SYMBOL **public** and **publicTest** compatible)\n\n```ts\n// examples/GeneratingAHDWalletPublicNetworkCompatible.ts\n\nimport {Network} from \"../src/Network\";\nimport {NetworkType} from \"symbol-sdk\";\nimport {Wallet} from \"../src/Wallet\";\nimport {ExtendedKey} from \"../src/ExtendedKey\";\n\nconst xkey = ExtendedKey.createFromSeed('000102030405060708090a0b0c0d0e0f', Network.SYMBOL);\nconst wallet = new Wallet(xkey);\n\n// get master account\nconst masterAccount = wallet.getAccount();\n\n// get DEFAULT ACCOUNT\nconst defaultAccount = wallet.getChildAccount();\n\n// derive specific child path\nconst childAccount = wallet.getChildAccount('m/44\\'/4343\\'/0\\'/0\\'/0\\'', NetworkType.TEST_NET);\n\n// get read-only wallet\nconst readOnlyWallet = new Wallet(xkey.getPublicNode());\nconst readOnlyAccount = readOnlyWallet.getPublicAccount(NetworkType.TEST_NET);\n\n// get read-only DEFAULT ACCOUNT\nconst readOnlyDefaultAccount = readOnlyWallet.getChildPublicAccount();\n\n```\n\n### Signing with a HD wallet (SYMBOL compatible)\n\n```ts\n// examples/SigningWithAHDWalletPrivateNetworkCompatible.ts\n\nimport {Account, Deadline, EmptyMessage, NetworkType, TransferTransaction} from \"symbol-sdk\";\nimport {Wallet} from \"../src/Wallet\";\nimport {ExtendedKey} from \"../src/ExtendedKey\";\nimport {Network} from \"../src/Network\";\n\nconst xkey = ExtendedKey.createFromSeed('000102030405060708090a0b0c0d0e0f', Network.SYMBOL);\nconst wallet = new Wallet(xkey);\n\n// derive specific child path\nconst childAccount = wallet.getChildAccount('m/44\\'/4343\\'/0\\'/0\\'/0\\'', NetworkType.TEST_NET);\n\n// create a transfer object\nconst transfer = TransferTransaction.create(\n    Deadline.create(),\n    Account.generateNewAccount(NetworkType.TEST_NET).address,\n    [],\n    EmptyMessage,\n    NetworkType.TEST_NET);\n\n// sign the transaction with derived account\nconst generationHash = ''; // replace with network generation hash\nconst signedTx = childAccount.sign(transfer, generationHash);\n\n```\n## Getting help\n\nUse the following available resources to get help:\n\n- [Symbol Documentation][docs]\n- Join the community [slack group (#sig-client)][slack] \n- If you found a bug, [open a new issue][issues]\n\n## Contributing\n\nContributions are welcome and appreciated. \nCheck [CONTRIBUTING](CONTRIBUTING.md) for information on how to contribute.\n\n## License\n\nCopyright (c) 2019, Grégory Saive\n\nLicensed under the [BSD-2 License](LICENSE).\n\n[self]: https://github.com/nemtech/symbol-hd-wallets\n[docs]: https://nemtech.github.io\n[issues]: https://github.com/nemtech/symbol-hd-wallets/issues\n[slack]: https://join.slack.com/t/nem2/shared_invite/enQtMzY4MDc2NTg0ODgyLWZmZWRiMjViYTVhZjEzOTA0MzUyMTA1NTA5OWQ0MWUzNTA4NjM5OTJhOGViOTBhNjkxYWVhMWRiZDRkOTE0YmU\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsymbol%2Fsymbol-hd-wallets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsymbol%2Fsymbol-hd-wallets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsymbol%2Fsymbol-hd-wallets/lists"}