From 0e710fbd0a19f12c5a8c6494cffdc6339bd67f4e Mon Sep 17 00:00:00 2001 From: Liamsi Date: Mon, 11 Jun 2018 22:56:38 -0700 Subject: [PATCH] document more things --- keys/hd/hdpath.go | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/keys/hd/hdpath.go b/keys/hd/hdpath.go index 409f580..34550c8 100644 --- a/keys/hd/hdpath.go +++ b/keys/hd/hdpath.go @@ -1,6 +1,14 @@ -// Package hd provides bip44 / bip 32 functionality. -// - bip 32 paths work too -// TODO(ismail): proper documentation +// Package hd provides basic functionality Hierarchical Deterministic Wallets. +// +// The user must understand the overall concept of the BIP 32 and the BIP 44 specs: +// - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki +// - https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki +// +// In combination with the bip39 package in go-crypto this package provides the functionality for deriving keys using a +// BIP 44 HD path, or, more general, by passing a BIP 32 path. +// +// In particular, this package (together with bip39) provides all necessary functionality to derive keys from +// mnemonics generated during the cosmos fundraiser. package hd import (