codex32

Documentation

Overview

package codex32 is an implementation of the codex32 scheme. BIP-93 describes the scheme in detail.

Index

• Constants
• type String
  • func Interpolate(shares []String, index rune) (String, error)
  • func New(s string) (String, error)
  • func NewSeed(hrp string, threshold int, id string, shareIdx rune, data []byte) (String, error)
  • func (s String) Seed() []byte
  • func (s String) Split() (id string, threshold int, idx rune)
  • func (s String) String() string

Constants

const Alphabet = "QPZRY9X8GF2TVDW0S3JN54KHCE6MUA7L"

Alphabet is the bech32 alphabet.

Types

type String

type String struct {
	// contains filtered or unexported fields
}

String is a codex32 string, containing a valid checksum.

func Interpolate

func Interpolate(shares []String, index rune) (String, error)

Interpolate a set of shares to derive a share at a specific index.

Using the index 'S' will recover the master seed.

func New

func New(s string) (String, error)

New constructs a codex32 string from a string.

func NewSeed

func NewSeed(hrp string, threshold int, id string, shareIdx rune, data []byte) (String, error)

NewSeed creates a share from secret data. The share index 'S' denotes an unshared secret.

func (String) Seed

func (s String) Seed() []byte

Seed extracts the seed.

func (String) Split

func (s String) Split() (id string, threshold int, idx rune)

func (String) String

func (s String) String() string