{"id":22705244,"url":"https://github.com/blockstack-packages/blockstack-keychains-js","last_synced_at":"2025-10-28T05:03:49.013Z","repository":{"id":44247497,"uuid":"50696788","full_name":"blockstack-packages/blockstack-keychains-js","owner":"blockstack-packages","description":"A keychain library for managing private + public keys","archived":false,"fork":false,"pushed_at":"2017-02-10T16:50:12.000Z","size":25,"stargazers_count":19,"open_issues_count":0,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-23T01:04:41.512Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blockstack-packages.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-29T22:50:46.000Z","updated_at":"2022-07-08T20:49:41.000Z","dependencies_parsed_at":"2022-09-07T17:50:29.575Z","dependency_job_id":null,"html_url":"https://github.com/blockstack-packages/blockstack-keychains-js","commit_stats":null,"previous_names":["blockstack/blockstack-keychain-js","blockstack/elliptic-keychain"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockstack-packages%2Fblockstack-keychains-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockstack-packages%2Fblockstack-keychains-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockstack-packages%2Fblockstack-keychains-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockstack-packages%2Fblockstack-keychains-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blockstack-packages","download_url":"https://codeload.github.com/blockstack-packages/blockstack-keychains-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248703120,"owners_count":21148116,"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","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":[],"created_at":"2024-12-10T09:09:48.078Z","updated_at":"2025-10-28T05:03:43.975Z","avatar_url":"https://github.com/blockstack-packages.png","language":"JavaScript","readme":"# Blockstack Keychains JS\n\n[![CircleCI](https://img.shields.io/circleci/project/blockstack/blockstack-keychains-js/master.svg)](https://circleci.com/gh/blockstack/blockstack-keychains-js/tree/master)\n[![npm](https://img.shields.io/npm/l/blockstack-keychains.svg)](https://www.npmjs.com/package/blockstack-keychains)\n[![npm](https://img.shields.io/npm/v/blockstack-keychains.svg)](https://www.npmjs.com/package/blockstack-keychains)\n[![npm](https://img.shields.io/npm/dm/blockstack-keychains.svg)](https://www.npmjs.com/package/blockstack-keychains)\n[![Slack](http://chat.blockstack.org/badge.svg)](http://chat.blockstack.org/)\n\nA library for effective private and public keychain management.\n\n### Installation\n\n```\n$ npm install blockstack-keychains\n```\n\n### Importing\n\n#### ES6\n\n```es6\nimport { PrivateKeychain, PublicKeychain, getChildKeypair, getEntropy } from 'blockstack-keychains'\n```\n\n#### Javascript (ES5)\n\n```es6\nvar blockstackKeychains = require('blockstack-keychains')\nvar PrivateKeychain = blockstackKeychains.PrivateKeychain,\n    PublicKeychain = blockstackKeychains.PublicKeychain,\n    getEntropy = blockstackKeychains.getEntropy,\n    getChildKeypair = blockstackKeychains.getChildKeypair\n```\n\n### Overview\n\nThis library provides a powerful key derivation interface that is based on the creation of private and public keychains.\n\nA private keychain contains a private key, and has a corresponding public keychain that can be derived from it.\n\nChild keychains can be derived in 6 different ways:\n\n1. use a private keychain and some supplied entropy to derive a private child keychain\n1. use a private keychain and a key number to derive a private child keychain\n1. use a private keychain and a label to derive a private child keychain\n1. use a public keychain and some supplied entropy to derive a public child keychain\n1. use a public keychain and a key number to derive a public child keychain\n1. use a public keychain and a label to derive a public child keychain\n\nMethod 1 can be used to create private subaccounts, as long as the creator keeps a recording of the entropy used to derive each subaccount.\n\nMethod 2 can be used to enumerate private subaccounts, without the requirement of recording any information beyond the information stored in the master keychain (this is the equivalent of BIP32 hardened keys).\n\nMethod 3 can be used to create private subaccounts that can be accessed/re-derived by name.\n\nMethod 4 can be used to create children that are not known to be linked to the parent until the entropy for each key is revealed.\n\nMethod 5 can be used to enumerate a bunch of children and be certain that everyone with the same public keychain is enumerating the same keys without having to share additional information (this is the equivalent of BIP32 unhardened keys).\n\nMethod 6 can be used to create a bunch of children that can be accessed/re-derived by name.\n\n### Private Keychains\n\n```es6\nlet privateKeychain = new PrivateKeychain()\n```\n\n### Private Keys\n\n```es6\nlet privateKey = privateKeychain.privateKey('hex')\n```\n\n### Public Keychains\n\n```es6\nlet publicKeychain = privateKeychain.publicKeychain()\nlet publicKeyString = '023db6b4e3cb22097a9b6b9c82ff6becb8cb01561fd46c3484abf22ff4dc30ee58',\n    publicKeychain2 = new PublicKeychain(publicKeyString)\n```\n\n### Public Keys\n\n```es6\nlet publicKey = publicKeychain.publicKey('hex')\n```\n\n### Mnemonics\n\n```es6\nlet mnemonic = privateKeychain.mnemonic()\nconsole.log(mnemonic)\n'aim elbow hungry involve ranch source car connect come wasp spread pet board welcome give garden virtual goose juice today over illness shove slam'\n```\n\n### Entropy-derived Child Keychains\n\n```es6\nlet entropy = getEntropy(32)\nlet privateChildKeychain = privateKeychain.child(entropy)\nlet publicChildKeychain = publicKeychain.child(entropy)\nlet publicChildKeychain2 = privateChildKeychain.publicKeychain()\n```\n\nNote that the independently derived public child keychains should be equal:\n\n```es6\nlet publicKey1 = publicChildKeychain.publicKey('hex')\nlet publicKey2 = publicChildKeychain2.publicKey('hex')\nconsole.log(publicKey1 === publicKey2)\ntrue\n```\n\n### Enumerated Child Keychains\n\n```es6\nlet firstPrivateChildKeychain = privateKeychain.privatelyEnumeratedChild(0)\nlet firstPublicChildKeychain = publicKeychain.publiclyEnumeratedChild(0)\n```\n\nNote that the privately-enumerated child should not correspond to the publicly-enumerated child\n\n```es6\nlet publicKey1 = firstPrivateChildKeychain.publicKeychain().publicKey('hex')\nlet publicKey2 = firstPublicChildKeychain.publicKey('hex')\nconsole.log(publicKey1 === publicKey2)\nfalse\n```\n\n### Named Child Keychains\n\n```es6\nlet namedPrivateChildKeychain = privateKeychain.privatelyNamedChild('home-laptop-1')\nlet namedPublicChildKeychain = publicKeychain.publiclyNamedChild('home-laptop-1')\n```\n\nNote that the privately-named child should not correspond to the publicly-named child\n\n```es6\nlet publicKey1 = namedPrivateChildKeychain.publicKeychain().publicKey('hex')\nlet publicKey2 = namedPublicChildKeychain.publicKey('hex')\nconsole.log(publicKey1 === publicKey2)\nfalse\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblockstack-packages%2Fblockstack-keychains-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblockstack-packages%2Fblockstack-keychains-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblockstack-packages%2Fblockstack-keychains-js/lists"}