chatch / stellar-hd-wallet

🔐 Key derivation for Stellar (SEP-0005) 🚀

stellar-hd-wallet

Key derivation for Stellar (SEP-0005)

Usage

import StellarHDWallet from 'stellar-hd-wallet'

const mnemonic = StellarHDWallet.generateMnemonic()
const wallet = StellarHDWallet.fromMnemonic(mnemonic)

wallet.getPublicKey(0) // => GDKYMXOAJ5MK4EVIHHNWRGAAOUZMNZYAETMHFCD6JCVBPZ77TUAZFPKT
wallet.getSecret(0) // => SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED
wallet.getKeypair(0) // => StellarBase.Keypair for account 0
wallet.derive(`m/44'/148'/0'`) // => raw key for account 0 as a Buffer

// wallet instance from seeds
const seedHex =
  '794fc27373add3ac7676358e868a787bcbf1edfac83edcecdb34d7f1068c645dbadba563f3f3a4287d273ac4f052d2fc650ba953e7af1a016d7b91f4d273378f'
const seedBuffer = Buffer.from(seedHex)
StellarHDWallet.fromSeed(seedHex)
StellarHDWallet.fromSeed(seedBuffer)

// mnemonics with different lengths
StellarHDWallet.generateMnemonic() // 24 words
StellarHDWallet.generateMnemonic({entropyBits: 224}) // 21 words
StellarHDWallet.generateMnemonic({entropyBits: 160}) // 18 words
StellarHDWallet.generateMnemonic({entropyBits: 128}) // 12 words

// validate a mnemonic
StellarHDWallet.validateMnemonic('too short and non wordlist words') // false

Mnemonic Language

Mnemonics can be generated in any language supported by the underlying bip39 npm module.

The full list of language keys are under exports 'wordlists' here.

Usage

import StellarHDWallet from 'stellar-hd-wallet'

// traditional chinese - 24 words
StellarHDWallet.generateMnemonic({
  language: 'chinese_traditional',
})
// => '省 从 唯 芽 激 顿 埋 愤 碳 它 炸 如 青 领 涨 骤 度 牲 朱 师 即 姓 讲 蒋'

// french - 12 words
StellarHDWallet.generateMnemonic({language: 'french', entropyBits: 128})
// => 'directif terrible légume dérober science vision venimeux exulter abrasif vague mutuel innocent'

Randomness

• NodeJs: crypto.randomBytes
• Browser: window.crypto.getRandomValues

(using randombytes npm module)

Tests

All SEP-0005 test cases are exercised here against these.

stellar-hd-wallet's Issues

Aarry length and seceret key length i different

When i use
var secret_key=wallet.getSecret(0);
console.log("secret_key",secret_key);

"SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED"
its generating 28 byte of hash value.

but when the get the keypair value
var keyPair=wallet.getKeypair(0);

i ll get secret_key 32 bytes,

why hash and key-pair array is different..?

Library throws insecure errors in browser with strict CSP

Please see here: tonyg/js-nacl#52

I am not sure what the implications are of the errors thrown. How can we fix?

Thanks.

How do you create/add additional keypairs?

Since you can select the index of the keypair, how would you create/add new ones?

Signing issue using nacl

I am generating new key pair its working,But when i try to use signing function its throws the error Uncaught Error: bad secret key size

//Generate new keyPair
function generateNewKeyPair(menomic)
{
var Password=""
const wallet = HDWallet.fromMnemonic(menomic);
var publickey=wallet.getPublicKey(0)
var seceretkey=wallet.getSecret(0)
var keyPair=wallet.getKeypair(0);
signTransaction(keyPair.rawSecretKey(),publickey);
}

//signTransaction
function signTransaction(seceretkey,publicKey)
{
var data = 'data to sign';
var signature = steller.sign(data,seceretkey);
if (steller.verify(data, signature,publicKey)) {
console.log('OK!');
} else {
console.log('Bad signature!');
}
}
generateNewKeyPair();

lodash is a dependency, but not mentioned as such

update stellar-base dependency

Tried to use the wallet for an angular 6 project and could not build it because the angular cli started complaining about the crypto library. I then found out that wallet is currently using the stellar-base 0.11. The guys from stellar have removed the crypto library in version 0.13 of the stellar-base sdk which should have fixed the issue. More details can be found here

fromMnemonic should validate the mnemonic parameter

So currently invalid (words not in wordlist, too short, etc.) and empty mnemonics work perfectly fine.

Change this to call validateMnemonic on the mnemonic parameter before continuing. Throw an error if mnemonic is not valid.

Restore private key from mnemonic

How could one go about restoring your secret from a mnemonic?

Steller account does not address hex

I was checking "stellar-hd-wallet" ,It generate only secret Key and public key, I cant find the address hex. Does the public keys is receive address.?

how to get secret key by 12 recovery phrase in stellar lobstr vault account ? easy word explanation

hi
I create a stellar account in lobstr vault application and I got public key and 12 recovery phrase .
now I want to transfer the crypto from lobstr wallet , but it is needed the secret key which is not received from lobstr vault.
I checked the several third party application , but not useful <
would you please explain me in easy word how to get secret key
thanks

HD path on > 10000000000 not working, keeps hanging

Deriving path on index greater than 10000000000, package get stuck

Question about the stellar-hd-wallet

Hi @chatch: Are there specific requirements to use the stellar-hd-wallet in an ionic-angular project?

I have tried a copule of things but none of them seems to work.

Error when including both stellar-hd-wallet and stellar-sdk in my project

When I include both stellar-hd-wallet and stellar-sdk in my project I get errors when requiring them both as stellar-base is included twice, not sure if stellar-base should instead be a peerDependency or how to solve this...

Any suggestions?

Error: XDR Error:Value is already defined
    at TypeBuilder.define (/code/blockchain-client/node_modules/js-xdr/lib/config.js:341:17)
    at TypeBuilder.typedef (/code/blockchain-client/node_modules/js-xdr/lib/config.js:247:14)
    at /code/blockchain-client/node_modules/stellar-hd-wallet/node_modules/stellar-base/lib/generated/stellar-xdr_generated.js:1:259
    at Object.config (/code/blockchain-client/node_modules/js-xdr/lib/config.js:38:5)
    at Object.<anonymous> (//code/blockchain-client/node_modules/stellar-hd-wallet/node_modules/stellar-base/lib/generated/stellar-xdr_generated.js:1:234)

These are the related deps in my package.json:

"stellar-hd-wallet": "0.0.6",
"stellar-sdk": "^0.9.2"

Add korean langauge mnemonics

Pull in the latest bip39 release -> bitcoinjs/bip39#63

Cannot retrieve secret key from mneumonic

`const StellarHDWallet = require("stellar-hd-wallet");
const { Keypair } = require("stellar-sdk");

function privateKeyToMnemonic(privateKey) {
const mnemonic = StellarHDWallet.generateMnemonic(privateKey);
return mnemonic;
}

const privateKey = "SBT4B2Y4VN33OCHVPRSD6JXXNPZ2UDXQFLRS7B5C4MLRMLOTEZS4UDY5";
console.log("Private key before: ", privateKey);

const mneumonic = privateKeyToMnemonic(privateKey);
console.log("Mneumonic is ", mneumonic);

const wallet = StellarHDWallet.fromMnemonic(mneumonic);
console.log(wallet.getSecret(0));
`
The key keeps changing

Private key before: SBT4B2Y4VN33OCHVPRSD6JXXNPZ2UDXQFLRS7B5C4MLRMLOTEZS4UDY5 Mneumonic is decline come potato citizen visual awkward owner illness pigeon save apple snake ordinary salmon twenty uphold toss must put primary oak hollow people ivory SBCNTVPPHD2GDWQTKA7CNCMLI53QDZK7JWKHTDZGTVCV4OIHTSGR5GQI

Private key before: SBT4B2Y4VN33OCHVPRSD6JXXNPZ2UDXQFLRS7B5C4MLRMLOTEZS4UDY5 Mneumonic is dance scatter cry recycle rookie day wage culture fly expect wolf mirror market approve soon before test sleep heavy connect unknown lawsuit lake idle SDZGV6NYGR7BNCWMJV2EUPXSGGGUEZ3C47Y2RPCFF7J7RHC6XZIUEVPU

no types!

Please either rebuild with TypeScript (highly recommend! it's so great!) or add a types file. Thanks"