README
¶
Go-BIP85
This is a Go library for deriving BIP-39 mnemonic seeds from a BIP-32 master root key, based on the BIP-85 specification.
Note: This library is an open-source project and is seeking community contributions and review to ensure it is production-ready. Your help in validating and improving the code is welcome!
Features
- Derivation of BIP-39 mnemonics (12, 18, and 24 words).
- Initialization from a master mnemonic phrase (English only).
- Initialization from a master extended private key (XPRV).
Usage
Here is a basic example of how to use the library:
package main
import (
"fmt"
"log"
"github.com/lescuer97/bip85"
)
func main() {
// Initialize from a mnemonic
mnemonic := "all all all all all all all all all all all all"
passphrase := ""
b, err := bip85.NewBip85FromMnemonic(mnemonic, passphrase)
if err != nil {
log.Fatal(err)
}
// Derive a new 12-word mnemonic
derivedMnemonic, err := b.DeriveMnemonic(12, 0)
if err != nil {
log.Fatal(err)
}
fmt.Println(derivedMnemonic)
}
Documentation
¶
Index ¶
Constants ¶
const English = 0
const Mnemonic = 39
const Xprv = 32
Variables ¶
var (
PrivateWalletVersion, _ = hex.DecodeString("0488ADE4")
)
Functions ¶
func CountWords ¶
CountWords counts the number of words in a mnemonic phrase, handling leading/trailing whitespace and multiple spaces between words. This implementation is optimized to avoid memory allocations.
Types ¶
type Bip85 ¶
type Bip85 struct {
// contains filtered or unexported fields
}
Bip85 wraps a BIP32 master key for BIP85 derivations.
func NewBip85FromMnemonic ¶
NewBip85FromMnemonic creates a new Bip85 instance from a BIP39 mnemonic. This implementation only supports the English wordlist.
func NewBip85FromXPRV ¶
NewBip85FromXPRV allows direct import of an existing BIP-32 root key.
func (*Bip85) DeriveToMnemonic ¶
type DerivationType ¶
type DerivationType uint
type MnemonicLanguage ¶
type MnemonicLanguage uint
Source Files