feature: add bl command to output bip39 labelled words

Author: gavincarr

main.go

@@ -43,6 +43,7 @@ var cli struct {
 	BipVal       BipValCmd       `cmd name:"bv" help:"Validate a BIP39 mnemonic seed phrase"`
 	BipSlip      BipSlipCmd      `cmd name:"bs" help:"Convert a BIP39 mnemonic seed to a set of SLIP39 shares"`
 	BipEntropy   BipEntropyCmd   `cmd name:"be" help:"Convert a BIP39 mnemonic seed to a hex-encoded entropy string"`
+	BipLabel     BipLabelCmd     `cmd name:"bl" help:"Convert a full set of BIP39 mnemonic shares to labelled word format"`
 	SlipVal      SlipValCmd      `cmd name:"sv" help:"Validate a full set of SLIP39 mnemonic shares"`
 	SlipBip      SlipBipCmd      `cmd name:"sb" help:"Convert a minimal set of SLIP39 mnemonic shares to a BIP39 mnemonic seed"`
 	SlipLabel    SlipLabelCmd    `cmd name:"sl" help:"Convert a full set of SLIP39 mnemonic shares to labelled word format"`
@@ -81,6 +82,12 @@ type BipSlipCmd struct {
 	Seed []string `arg help:"BIP39 mnemonic seed phrase" optional`
 }
 
+type BipLabelCmd struct {
+	Upper bool `flag short:"u" help:"output words in uppercase"`
+
+	Seed []string `arg help:"BIP39 mnemonic seed phrase" optional`
+}
+
 type SlipValCmd struct {
 	Passphrase string `flag short:"p" help:"passphrase used with the SLIP39 shares"`
 	CheckFile  string `flag short:"c" aliases:"cf" help:"check file with the source BIP39 mnemonic seed"`
@@ -242,6 +249,29 @@ func (cmd BipSlipCmd) Run(ctx *Context) error {
 	return nil
 }
 
+func (cmd BipLabelCmd) Run(ctx *Context) error {
+	mnemonic, err := readSeedMnemonic(ctx, cmd.Seed)
+	if err != nil {
+		return err
+	}
+
+	words := strings.Fields(mnemonic)
+	if len(words) < 12 || len(words) > 24 || len(words)%3 != 0 {
+		return fmt.Errorf("invalid BIP39 mnemonic seed length %d (must be 12-24 words, multiple of 3)",
+			len(words))
+	}
+
+	for i := range len(words) {
+		word := words[i]
+		if cmd.Upper {
+			word = strings.ToUpper(word)
+		}
+		fmt.Fprintf(ctx.writer, "%02d %s\n", i+1, word)
+	}
+
+	return nil
+}
+
 func (cmd SlipValCmd) Run(ctx *Context) error {
 	mnemonics, err := readShareMnemonics(ctx, cmd.Shares)
 	if err != nil {

main_test.go

@@ -295,6 +295,57 @@ func TestBipSlip(t *testing.T) {
 	}
 }
 
+// Test converting BIP-39 seeds to labelled words
+func TestBipLabel_Success(t *testing.T) {
+	t.Parallel()
+
+	// Load all testdata `bipMs.txt` files (good seeds)
+	tests := make(map[string]string)
+	testfiles, err := filepath.Glob("testdata/bip?s.txt")
+	if err != nil {
+		t.Fatal(err)
+	}
+	for _, tf := range testfiles {
+		data, err := ioutil.ReadFile(tf)
+		if err != nil {
+			t.Fatal(err)
+		}
+		tests[tf] = string(data)
+	}
+
+	reTestfile := regexp.MustCompile(`^testdata/bip`)
+	for tf, seeds := range tests {
+		lf := reTestfile.ReplaceAllString(tf, "testdata/blabels")
+		ldata, err := ioutil.ReadFile(lf)
+		if err != nil {
+			t.Fatal(err)
+		}
+		//t.Logf("checking tf %q vs lf %q", tf, lf)
+
+		// Convert bip seeds to labelled words
+		buf1 := bytes.NewBufferString(seeds)
+		var buf2 bytes.Buffer
+		// Test with uppercase flag on
+		cmd := BipLabelCmd{Upper: true}
+		ctx := Context{
+			reader: buf1,
+			writer: &buf2,
+		}
+
+		err = cmd.Run(&ctx)
+		if err != nil {
+			t.Errorf("BipLabel error on %q: %s", tf, err.Error())
+			continue
+		}
+
+		words := buf2.String()
+		if words != string(ldata) {
+			t.Errorf("test file %q mismatch - got:\n%sexpected:\n%s",
+				tf, words, string(ldata))
+		}
+	}
+}
+
 // Test validation of good SLIP-39 shares
 func TestSlipVal_Success(t *testing.T) {
 	t.Parallel()

testdata/blabels1s.txt

@@ -0,0 +1,24 @@
+01 ALL
+02 HOUR
+03 MAKE
+04 FIRST
+05 LEADER
+06 EXTEND
+07 HOLE
+08 ALIEN
+09 BEHIND
+10 GUARD
+11 GOSPEL
+12 LAVA
+13 PATH
+14 OUTPUT
+15 CENSUS
+16 MUSEUM
+17 JUNIOR
+18 MASS
+19 REOPEN
+20 FAMOUS
+21 SING
+22 ADVANCE
+23 SALT
+24 REFORM

testdata/blabels2s.txt

@@ -0,0 +1,12 @@
+01 ABANDON
+02 ABANDON
+03 ABANDON
+04 ABANDON
+05 ABANDON
+06 ABANDON
+07 ABANDON
+08 ABANDON
+09 ABANDON
+10 ABANDON
+11 ABANDON
+12 ABOUT

testdata/blabels3s.txt

@@ -0,0 +1,12 @@
+01 LEGAL
+02 WINNER
+03 THANK
+04 YEAR
+05 WAVE
+06 SAUSAGE
+07 WORTH
+08 USEFUL
+09 LEGAL
+10 WINNER
+11 THANK
+12 YELLOW