{"_id":"minterjs-wallet","_rev":"32-999dd8fce5f036cb5f5130b52d07a3f6","name":"minterjs-wallet","dist-tags":{"latest":"6.2.0"},"versions":{"1.0.0":{"name":"minterjs-wallet","version":"1.0.0","description":"Utilities for handling Minter keys","main":"dist/index.js","files":["dist"],"scripts":{"coverage":"istanbul cover _mocha","coveralls":"npm run coverage && coveralls \n\n```\n\n## Wallet API\n\n### Construction methods:\nMnemonic wallets are generated by a [BIP-0044 ](https://en.bitcoin.it/wiki/BIP_0044) path, Ethereum path is used by default \"m/44'/60'/0'/0/0\"\n\n#### `generateWallet(path)`\nGenerates wallet from a random BIP39 mnemonic phrase (uses `bip39.generateMnemonic()` under the hood).\n```js\nimport {generateWallet} from 'minterjs-wallet';\nconst wallet = generateWallet();\n```\n\n#### `walletFromMnemonic(mnemonic, path)`\nCreate a wallet instance based on BIP39 12 words mnemonic phrase\n```js\nimport {walletFromMnemonic} from 'minterjs-wallet';\nconst wallet = walletFromMnemonic('surround tape away million into program organ tonight write prefer inform cool');\n```\n\n#### `walletFromMnemonicAsync(mnemonic, path)`\nSame as `walletFromMnemonic` but async and has better performance in browser, because it uses `window.crypto.subtle` under hood\n```js\nimport {walletFromMnemonicAsync} from 'minterjs-wallet';\nconst wallet = await walletFromMnemonicAsync('surround tape away million into program organ tonight write prefer inform cool');\n```\n\n#### `walletFromPrivateKey(privateKey)`\nCreate a wallet instance based on a raw private key\n```js\nimport {walletFromPrivateKey} from 'minterjs-wallet';\nconst privateKeyBuffer = Buffer.from('ef2af2385681c490bc473c2f7e6097fc1a38e6f67b44b81a3350a6583aadd144', 'hex')\nconst wallet = walletFromPrivateKey(privateKeyBuffer);\n```\n\n\n### Wallet instance methods:\n\n#### `.getAddress()`\nReturn the address: 20 bytes length Buffer or Uint8Array\n```js\nwallet.getAddress();\n// [88,108,62,182,16,84,7,36,101,31,244,29,32,158,20,41,238,62,68,154]\n```\n\n#### `.getAddressString()`\nReturn the Minter-style address\n```js\nwallet.getAddress();\n// 'Mx586c3eb610540724651ff41d209e1429ee3e449a'\n```\n\n#### `.getMnemonic()`\nReturn the mnemonic phrase: 12 words string.\n**Note:** Only works with instance created/generated from mnemonic, otherwise it will throw an error.\n```js\nwallet.getMnemonic();\n// 'surround tape away million into program organ tonight write prefer inform cool'\n```\n\n#### `.getPrivateKey()`\nReturn the private key: 32 bytes length Buffer or Uint8Array\n```js\nwallet.getPrivateKey();\n// [239,42,242,56,86,129,196,144,188,71,60,47,126,96,151,252,26,56,230,246,123,68,184,26,51,80,166,88,58,173,209,68]\n```\n\n#### `.getPrivateKeyString()`\nReturn the private key string of 64 hex characters\n```js\nwallet.getPrivateKeyString();\n// 'ef2af2385681c490bc473c2f7e6097fc1a38e6f67b44b81a3350a6583aadd144'\n```\n\n#### `.getPublicKey()`\nReturn the uncompressed Ethereum-style public key: 64 bytes length Buffer or Uint8Array\n```js\nwallet.getPublicKey();\n// [251,82,201,189,133,251,174,27,6,6,18,34,12,222,116,254,99,169,65,249,135,81,170,13,35,99,50,6,231,95,48,69,41,47,96,75,240,242,9,77,23,168,173,59,137,223,128,80,144,69,34,91,145,21,255,133,112,189,68,8,42,245,210,116]\n```\n\n#### `.getPublicKeyString()`\nReturn the Minter-style public key string\n```js\nwallet.getPublicKeyString();\n// 'Mpfb52c9bd85fbae1b060612220cde74fe63a941f98751aa0d23633206e75f3045'\n```\n\n### Mnemonic\n\n#### `generateMnemonic()`\nGenerate random 12 words mnemonic phrase. Exposed `bip39.generateMnemonic()`.\n```js\nimport {generateMnemonic} from 'minterjs-wallet';\nconst mnemonic = generateMnemonic();\n// 'surround tape away million into program organ tonight write prefer inform cool'\n```\n\n#### `isValidMnemonic(mnemonic)`\nCheck that given mnemonic is valid, returns `boolean`, uses `bip39.validateMnemonic()` under the hood.\n```js\nimport {isValidMnemonic} from 'minterjs-wallet';\nconst isValid = isValidMnemonic('surround tape away million into program organ tonight write prefer inform cool');\n// true\n```\n\n## License\n\nMIT License\n","readmeFilename":"README.md"}