SLIP32

SLIP-0032 is an extended serialization format for BIP-0032 wallets

Implementation based on the draft SLIP-0032 spec.

Parsing

parse :: ByteString -> Maybe (Either XPub XPrv)

Parse either an XPub or an XPrv from its SLIP-0032 representation.

parseXPub :: ByteString -> Maybe XPub

Parse an XPub from its SLIP-0032 representation.

parseXPrv :: ByteString -> Maybe XPrv

Parse an XPrv from its SLIP-0032 representation.

Text

parseText :: Text -> Maybe (Either XPub XPrv)

Parse either an XPub or an XPrv from its SLIP-0032 representation.

Like parse, but takes Text.

parseXPubText :: Text -> Maybe XPub

Parse an XPub from its SLIP-0032 representation.

Like parseXPub, but takes Text.

parseXPrvText :: Text -> Maybe XPrv

Parse an XPrv from its SLIP-0032 representation.

Like parseXPrv, but takes Text.

Rendering

renderXPub :: XPub -> ByteString

Render an XPub using the SLIP-0032 encoding.

renderXPrv :: XPrv -> ByteString

Render an XPub using the SLIP-0032 encoding.

Text

renderXPubText :: XPub -> Text

Render an XPub using the SLIP-0032 encoding.

The rendered Text is ASCII compatible.

renderXPrvText :: XPrv -> Text

Render an XPub using the SLIP-0032 encoding.

The rendered Text is ASCII compatible.

Public key

data XPub

Extended public key.

Constructors

XPub !Path !Chain !Pub

Instances

Eq XPub

Defined in SLIP32

Methods

(==) :: XPub -> XPub -> Bool

(/=) :: XPub -> XPub -> Bool

Show XPub

Defined in SLIP32

Methods

showsPrec :: Int -> XPub -> ShowS

show :: XPub -> String

showList :: [XPub] -> ShowS

data Pub

Public key.

Construct with pub.

Instances

Eq Pub

Defined in SLIP32

Methods

(==) :: Pub -> Pub -> Bool

(/=) :: Pub -> Pub -> Bool

Show Pub

Defined in SLIP32

Methods

showsPrec :: Int -> Pub -> ShowS

show :: Pub -> String

showList :: [Pub] -> ShowS

pub :: ByteString -> Maybe Pub

Construct a Pub key from its raw bytes.

• 33 bytes in total, containing \(ser_{P}(P)\).
• The leftmost byte is either 0x02 or 0x03, depending on the parity of the omitted y coordinate.
• The remaining 32 bytes are \(ser_{256}(x)\).

See Bitcoin's BIP-0032 for details.

Nothing if something is not satisfied.

unPub :: Pub -> ByteString

Obtain the 33 raw bytes inside a Pub. See pub.

Private key

data XPrv

Extended private key.

Constructors

XPrv !Path !Chain !Prv

Instances

Eq XPrv

Defined in SLIP32

Methods

(==) :: XPrv -> XPrv -> Bool

(/=) :: XPrv -> XPrv -> Bool

Show XPrv

Defined in SLIP32

Methods

showsPrec :: Int -> XPrv -> ShowS

show :: XPrv -> String

showList :: [XPrv] -> ShowS

data Prv

Private key.

Construct with prv.

Instances

Eq Prv

Defined in SLIP32

Methods

(==) :: Prv -> Prv -> Bool

(/=) :: Prv -> Prv -> Bool

Show Prv

Defined in SLIP32

Methods

showsPrec :: Int -> Prv -> ShowS

show :: Prv -> String

showList :: [Prv] -> ShowS

prv :: ByteString -> Maybe Prv

Construct a Prv key from its raw bytes.

• 33 bytes in total.
• The leftmost byte is 0x00.
• The remaining 32 bytes are \(ser_{256}(k)\).

See Bitcoin's BIP-0032 for details.

Nothing if something is not satisfied.

unPrv :: Prv -> ByteString

Obtain the 33 raw bytes inside a Prv. See prv.

Path

data Path

Derivation path.

Construct with path.

Instances

Eq Path

Defined in SLIP32

Methods

(==) :: Path -> Path -> Bool

(/=) :: Path -> Path -> Bool

Show Path

Defined in SLIP32

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

path :: [Word32] -> Maybe Path

Construct a derivation Path.

Hardened keys start from \(2^{31}\).

m           = path []
m/0         = path [0]
m/0'        = path [0 + 2^31]
m/1         = path [1]
m/1'        = path [1 + 2^31]
m/0'/1/2'/2 = path [0 + 2^31, 1, 2 + 2^31, 2]

See Bitcoin's BIP-0032 for details.

Returns Nothing if the list length is more than 255.

unPath :: Path -> [Word32]

Obtains the derivation path as a list of up to 255 elements.

Chain

data Chain

Chain code.

Construct with chain.

Instances

Eq Chain

Defined in SLIP32

Methods

(==) :: Chain -> Chain -> Bool

(/=) :: Chain -> Chain -> Bool

Show Chain

Defined in SLIP32

Methods

showsPrec :: Int -> Chain -> ShowS

show :: Chain -> String

showList :: [Chain] -> ShowS

chain :: ByteString -> Maybe Chain

Construct a Chain code.

See Bitcoin's BIP-0032 for details.

Nothing if the ByteString length is not 32.

unChain :: Chain -> ByteString

Obtain the 32 raw bytes inside a Chain.