Haskoin.Keys.Extended

BIP-32 extended keys.

Extended Keys

data XPubKey

Data type representing an extended BIP32 public key.

Constructors

XPubKey

Fields

• xPubDepth :: !Word8

  depth in the tree

• xPubParent :: !Fingerprint

  fingerprint of parent

• xPubIndex :: !KeyIndex

  derivation index

• xPubChain :: !ChainCode

  chain code

• xPubKey :: !PubKey

  public key of this node

Instances

Eq XPubKey

Defined in Haskoin.Keys.Extended

Methods

(==) :: XPubKey -> XPubKey -> Bool

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

Read XPubKey

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS XPubKey

readList :: ReadS [XPubKey]

readPrec :: ReadPrec XPubKey

readListPrec :: ReadPrec [XPubKey]

Show XPubKey

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> XPubKey -> ShowS

show :: XPubKey -> String

showList :: [XPubKey] -> ShowS

Generic XPubKey

Defined in Haskoin.Keys.Extended

Associated Types

type Rep XPubKey :: Type -> Type

Methods

from :: XPubKey -> Rep XPubKey x

to :: Rep XPubKey x -> XPubKey

Hashable XPubKey

Defined in Haskoin.Keys.Extended

Methods

hashWithSalt :: Int -> XPubKey -> Int

hash :: XPubKey -> Int

Serialize XPubKey

Defined in Haskoin.Keys.Extended

Methods

put :: Putter XPubKey

get :: Get XPubKey

NFData XPubKey

Defined in Haskoin.Keys.Extended

Methods

rnf :: XPubKey -> ()

type Rep XPubKey

Defined in Haskoin.Keys.Extended

type Rep XPubKey = D1 ('MetaData "XPubKey" "Haskoin.Keys.Extended" "haskoin-core-0.19.0-inplace" 'False) (C1 ('MetaCons "XPubKey" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xPubDepth") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8) :*: S1 ('MetaSel ('Just "xPubParent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Fingerprint)) :*: (S1 ('MetaSel ('Just "xPubIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KeyIndex) :*: (S1 ('MetaSel ('Just "xPubChain") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChainCode) :*: S1 ('MetaSel ('Just "xPubKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PubKey)))))

data XPrvKey

Data type representing an extended BIP32 private key. An extended key is a node in a tree of key derivations. It has a depth in the tree, a parent node and an index to differentiate it from other siblings.

Constructors

XPrvKey

Fields

• xPrvDepth :: !Word8

  depth in the tree

• xPrvParent :: !Fingerprint

  fingerprint of parent

• xPrvIndex :: !KeyIndex

  derivation index

• xPrvChain :: !ChainCode

  chain code

• xPrvKey :: !SecKey

  private key of this node

Instances

Eq XPrvKey

Defined in Haskoin.Keys.Extended

Methods

(==) :: XPrvKey -> XPrvKey -> Bool

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

Read XPrvKey

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS XPrvKey

readList :: ReadS [XPrvKey]

readPrec :: ReadPrec XPrvKey

readListPrec :: ReadPrec [XPrvKey]

Show XPrvKey

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> XPrvKey -> ShowS

show :: XPrvKey -> String

showList :: [XPrvKey] -> ShowS

Generic XPrvKey

Defined in Haskoin.Keys.Extended

Associated Types

type Rep XPrvKey :: Type -> Type

Methods

from :: XPrvKey -> Rep XPrvKey x

to :: Rep XPrvKey x -> XPrvKey

Hashable XPrvKey

Defined in Haskoin.Keys.Extended

Methods

hashWithSalt :: Int -> XPrvKey -> Int

hash :: XPrvKey -> Int

Serialize XPrvKey

Defined in Haskoin.Keys.Extended

Methods

put :: Putter XPrvKey

get :: Get XPrvKey

NFData XPrvKey

Defined in Haskoin.Keys.Extended

Methods

rnf :: XPrvKey -> ()

type Rep XPrvKey

Defined in Haskoin.Keys.Extended

type Rep XPrvKey = D1 ('MetaData "XPrvKey" "Haskoin.Keys.Extended" "haskoin-core-0.19.0-inplace" 'False) (C1 ('MetaCons "XPrvKey" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xPrvDepth") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8) :*: S1 ('MetaSel ('Just "xPrvParent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Fingerprint)) :*: (S1 ('MetaSel ('Just "xPrvIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KeyIndex) :*: (S1 ('MetaSel ('Just "xPrvChain") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChainCode) :*: S1 ('MetaSel ('Just "xPrvKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecKey)))))

type ChainCode = Hash256

Chain code as specified in BIP-32.

type KeyIndex = Word32

Index of key as specified in BIP-32.

type Fingerprint = Word32

Fingerprint of parent

newtype DerivationException

A derivation exception is thrown in the very unlikely event that a derivation is invalid.

Constructors

DerivationException String

Instances

Eq DerivationException

Defined in Haskoin.Keys.Extended

Methods

(==) :: DerivationException -> DerivationException -> Bool

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

Read DerivationException

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS DerivationException

readList :: ReadS [DerivationException]

readPrec :: ReadPrec DerivationException

readListPrec :: ReadPrec [DerivationException]

Show DerivationException

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> DerivationException -> ShowS

show :: DerivationException -> String

showList :: [DerivationException] -> ShowS

Generic DerivationException

Defined in Haskoin.Keys.Extended

Associated Types

type Rep DerivationException :: Type -> Type

Methods

from :: DerivationException -> Rep DerivationException x

to :: Rep DerivationException x -> DerivationException

Exception DerivationException

Defined in Haskoin.Keys.Extended

Methods

toException :: DerivationException -> SomeException

fromException :: SomeException -> Maybe DerivationException

displayException :: DerivationException -> String

NFData DerivationException

Defined in Haskoin.Keys.Extended

Methods

rnf :: DerivationException -> ()

type Rep DerivationException

Defined in Haskoin.Keys.Extended

type Rep DerivationException = D1 ('MetaData "DerivationException" "Haskoin.Keys.Extended" "haskoin-core-0.19.0-inplace" 'True) (C1 ('MetaCons "DerivationException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

makeXPrvKey :: ByteString -> XPrvKey

Build a BIP32 compatible extended private key from a bytestring. This will produce a root node (depth=0 and parent=0).

deriveXPubKey :: XPrvKey -> XPubKey

Derive an extended public key from an extended private key. This function will preserve the depth, parent, index and chaincode fields of the extended private keys.

prvSubKey

Arguments

:: XPrvKey

extended parent private key

-> KeyIndex

child derivation index

-> XPrvKey

extended child private key

Compute a private, soft child key derivation. A private soft derivation will allow the equivalent extended public key to derive the public key for this child. Given a parent key m and a derivation index i, this function will compute m/i.

Soft derivations allow for more flexibility such as read-only wallets. However, care must be taken not the leak both the parent extended public key and one of the extended child private keys as this would compromise the extended parent private key.

pubSubKey

Arguments

:: XPubKey

extended parent public key

-> KeyIndex

child derivation index

-> XPubKey

extended child public key

Compute a public, soft child key derivation. Given a parent key M and a derivation index i, this function will compute M/i.

hardSubKey

Arguments

:: XPrvKey

extended parent private key

-> KeyIndex

child derivation index

-> XPrvKey

extended child private key

Compute a hard child key derivation. Hard derivations can only be computed for private keys. Hard derivations do not allow the parent public key to derive the child public keys. However, they are safer as a breach of the parent public key and child private keys does not lead to a breach of the parent private key. Given a parent key m and a derivation index i, this function will compute m/i'.

xPrvIsHard :: XPrvKey -> Bool

Returns true if the extended private key was derived through a hard derivation.

xPubIsHard :: XPubKey -> Bool

Returns true if the extended public key was derived through a hard derivation.

xPrvChild :: XPrvKey -> KeyIndex

Returns the derivation index of this extended private key without the hard bit set.

xPubChild :: XPubKey -> KeyIndex

Returns the derivation index of this extended public key without the hard bit set.

xPubID :: XPubKey -> Hash160

Computes the key identifier of an extended public key.

xPrvID :: XPrvKey -> Hash160

Computes the key identifier of an extended private key.

xPubFP :: XPubKey -> Fingerprint

Computes the key fingerprint of an extended public key.

xPrvFP :: XPrvKey -> Fingerprint

Computes the key fingerprint of an extended private key.

xPubAddr :: XPubKey -> Address

Compute a standard P2PKH address for an extended public key.

xPubWitnessAddr :: XPubKey -> Address

Compute a SegWit P2WPKH address for an extended public key.

xPubCompatWitnessAddr :: XPubKey -> Address

Compute a backwards-compatible SegWit P2SH-P2WPKH address for an extended public key.

xPubExport :: Network -> XPubKey -> Base58

Exports an extended public key to the BIP32 key export format (Base58).

xPubToJSON :: Network -> XPubKey -> Value

Get JSON Value from XPubKey.

xPubToEncoding :: Network -> XPubKey -> Encoding

xPubFromJSON :: Network -> Value -> Parser XPubKey

Decode an extended public key from a JSON string

xPrvExport :: Network -> XPrvKey -> Base58

Exports an extended private key to the BIP32 key export format (Base58).

xPrvToJSON :: Network -> XPrvKey -> Value

xPrvToEncoding :: Network -> XPrvKey -> Encoding

xPrvFromJSON :: Network -> Value -> Parser XPrvKey

Decode an extended private key from a JSON string

xPubImport :: Network -> Base58 -> Maybe XPubKey

Decodes a BIP32 encoded extended public key. This function will fail if invalid base 58 characters are detected or if the checksum fails.

xPrvImport :: Network -> Base58 -> Maybe XPrvKey

Decodes a BIP32 encoded extended private key. This function will fail if invalid base 58 characters are detected or if the checksum fails.

xPrvWif :: Network -> XPrvKey -> Base58

Export an extended private key to WIF (Wallet Import Format).

putXPrvKey :: Network -> Putter XPrvKey

Serialize an extended private key.

putXPubKey :: Network -> Putter XPubKey

Serialize an extended public key.

getXPrvKey :: Network -> Get XPrvKey

Parse a binary extended private key.

getXPubKey :: Network -> Get XPubKey

Parse a binary extended public key.

Helper Functions

prvSubKeys :: XPrvKey -> KeyIndex -> [(XPrvKey, KeyIndex)]

Cyclic list of all private soft child key derivations of a parent key starting from an offset index.

pubSubKeys :: XPubKey -> KeyIndex -> [(XPubKey, KeyIndex)]

Cyclic list of all public soft child key derivations of a parent key starting from an offset index.

hardSubKeys :: XPrvKey -> KeyIndex -> [(XPrvKey, KeyIndex)]

Cyclic list of all hard child key derivations of a parent key starting from an offset index.

deriveAddr :: XPubKey -> KeyIndex -> (Address, PubKey)

Derive a standard address from an extended public key and an index.

deriveWitnessAddr :: XPubKey -> KeyIndex -> (Address, PubKey)

Derive a SegWit P2WPKH address from an extended public key and an index.

deriveCompatWitnessAddr :: XPubKey -> KeyIndex -> (Address, PubKey)

Derive a backwards-compatible SegWit P2SH-P2WPKH address from an extended public key and an index.

deriveAddrs :: XPubKey -> KeyIndex -> [(Address, PubKey, KeyIndex)]

Cyclic list of all addresses derived from a public key starting from an offset index.

deriveWitnessAddrs :: XPubKey -> KeyIndex -> [(Address, PubKey, KeyIndex)]

Cyclic list of all SegWit P2WPKH addresses derived from a public key starting from an offset index.

deriveCompatWitnessAddrs :: XPubKey -> KeyIndex -> [(Address, PubKey, KeyIndex)]

Cyclic list of all backwards-compatible SegWit P2SH-P2WPKH addresses derived from a public key starting from an offset index.

deriveMSAddr :: [XPubKey] -> Int -> KeyIndex -> (Address, RedeemScript)

Derive a multisig address from a list of public keys, the number of required signatures m and a derivation index. The derivation type is a public, soft derivation.

deriveMSAddrs :: [XPubKey] -> Int -> KeyIndex -> [(Address, RedeemScript, KeyIndex)]

Cyclic list of all multisig addresses derived from a list of public keys, a number of required signatures m and starting from an offset index. The derivation type is a public, soft derivation.

cycleIndex :: KeyIndex -> [KeyIndex]

Helper function to go through derivation indices.

Derivation Paths

data DerivPathI t where

Data type representing a derivation path. Two constructors are provided for specifying soft or hard derivations. The path /0/1'/2 for example can be expressed as Deriv :/ 0 :| 1 :/ 2. The HardOrAny and AnyOrSoft type classes are used to constrain the valid values for the phantom type t. If you mix hard (:|) and soft (:\/) paths, the only valid type for t is AnyDeriv. Otherwise, t can be HardDeriv if you only have hard derivation or SoftDeriv if you only have soft derivations.

Using this type is as easy as writing the required derivation like in these example:

Deriv :/ 0 :/ 1 :/ 2 :: SoftPath
Deriv :| 0 :| 1 :| 2 :: HardPath
Deriv :| 0 :/ 1 :/ 2 :: DerivPath

Constructors

(:|) :: HardOrAny t => !(DerivPathI t) -> !KeyIndex -> DerivPathI t

(:/) :: AnyOrSoft t => !(DerivPathI t) -> !KeyIndex -> DerivPathI t

Deriv :: DerivPathI t

Instances

Read SoftPath

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS SoftPath

readList :: ReadS [SoftPath]

readPrec :: ReadPrec SoftPath

readListPrec :: ReadPrec [SoftPath]

Read DerivPath

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS DerivPath

readList :: ReadS [DerivPath]

readPrec :: ReadPrec DerivPath

readListPrec :: ReadPrec [DerivPath]

Read HardPath

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS HardPath

readList :: ReadS [HardPath]

readPrec :: ReadPrec HardPath

readListPrec :: ReadPrec [HardPath]

Show SoftPath

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> SoftPath -> ShowS

show :: SoftPath -> String

showList :: [SoftPath] -> ShowS

Show DerivPath

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> DerivPath -> ShowS

show :: DerivPath -> String

showList :: [DerivPath] -> ShowS

Show HardPath

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> HardPath -> ShowS

show :: HardPath -> String

showList :: [HardPath] -> ShowS

IsString SoftPath

Defined in Haskoin.Keys.Extended

Methods

fromString :: String -> SoftPath

IsString DerivPath

Defined in Haskoin.Keys.Extended

Methods

fromString :: String -> DerivPath

IsString HardPath

Defined in Haskoin.Keys.Extended

Methods

fromString :: String -> HardPath

FromJSON SoftPath

Defined in Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser SoftPath

parseJSONList :: Value -> Parser [SoftPath]

FromJSON DerivPath

Defined in Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser DerivPath

parseJSONList :: Value -> Parser [DerivPath]

FromJSON HardPath

Defined in Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser HardPath

parseJSONList :: Value -> Parser [HardPath]

Serialize SoftPath

Defined in Haskoin.Keys.Extended

Methods

put :: Putter SoftPath

get :: Get SoftPath

Serialize DerivPath

Defined in Haskoin.Keys.Extended

Methods

put :: Putter DerivPath

get :: Get DerivPath

Serialize HardPath

Defined in Haskoin.Keys.Extended

Methods

put :: Putter HardPath

get :: Get HardPath

Eq (DerivPathI t)

Defined in Haskoin.Keys.Extended

Methods

(==) :: DerivPathI t -> DerivPathI t -> Bool

(/=) :: DerivPathI t -> DerivPathI t -> Bool

Ord (DerivPathI t)

Defined in Haskoin.Keys.Extended

Methods

compare :: DerivPathI t -> DerivPathI t -> Ordering

(<) :: DerivPathI t -> DerivPathI t -> Bool

(<=) :: DerivPathI t -> DerivPathI t -> Bool

(>) :: DerivPathI t -> DerivPathI t -> Bool

(>=) :: DerivPathI t -> DerivPathI t -> Bool

max :: DerivPathI t -> DerivPathI t -> DerivPathI t

min :: DerivPathI t -> DerivPathI t -> DerivPathI t

ToJSON (DerivPathI t)

Defined in Haskoin.Keys.Extended

Methods

toJSON :: DerivPathI t -> Value

toEncoding :: DerivPathI t -> Encoding

toJSONList :: [DerivPathI t] -> Value

toEncodingList :: [DerivPathI t] -> Encoding

NFData (DerivPathI t)

Defined in Haskoin.Keys.Extended

Methods

rnf :: DerivPathI t -> ()

data AnyDeriv

Phantom type signaling no knowledge about derivation path: can be hardened or not.

Instances

Read DerivPath

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS DerivPath

readList :: ReadS [DerivPath]

readPrec :: ReadPrec DerivPath

readListPrec :: ReadPrec [DerivPath]

Show DerivPath

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> DerivPath -> ShowS

show :: DerivPath -> String

showList :: [DerivPath] -> ShowS

IsString DerivPath

Defined in Haskoin.Keys.Extended

Methods

fromString :: String -> DerivPath

Generic AnyDeriv

Defined in Haskoin.Keys.Extended

Associated Types

type Rep AnyDeriv :: Type -> Type

Methods

from :: AnyDeriv -> Rep AnyDeriv x

to :: Rep AnyDeriv x -> AnyDeriv

FromJSON DerivPath

Defined in Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser DerivPath

parseJSONList :: Value -> Parser [DerivPath]

Serialize DerivPath

Defined in Haskoin.Keys.Extended

Methods

put :: Putter DerivPath

get :: Get DerivPath

NFData AnyDeriv

Defined in Haskoin.Keys.Extended

Methods

rnf :: AnyDeriv -> ()

AnyOrSoft AnyDeriv

Defined in Haskoin.Keys.Extended

HardOrAny AnyDeriv

Defined in Haskoin.Keys.Extended

type Rep AnyDeriv

Defined in Haskoin.Keys.Extended

type Rep AnyDeriv = D1 ('MetaData "AnyDeriv" "Haskoin.Keys.Extended" "haskoin-core-0.19.0-inplace" 'False) (V1 :: Type -> Type)

data HardDeriv

Phantom type signaling a hardened derivation path that can only be computed from private extended key.

Instances

Read HardPath

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS HardPath

readList :: ReadS [HardPath]

readPrec :: ReadPrec HardPath

readListPrec :: ReadPrec [HardPath]

Show HardPath

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> HardPath -> ShowS

show :: HardPath -> String

showList :: [HardPath] -> ShowS

IsString HardPath

Defined in Haskoin.Keys.Extended

Methods

fromString :: String -> HardPath

Generic HardDeriv

Defined in Haskoin.Keys.Extended

Associated Types

type Rep HardDeriv :: Type -> Type

Methods

from :: HardDeriv -> Rep HardDeriv x

to :: Rep HardDeriv x -> HardDeriv

FromJSON HardPath

Defined in Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser HardPath

parseJSONList :: Value -> Parser [HardPath]

Serialize HardPath

Defined in Haskoin.Keys.Extended

Methods

put :: Putter HardPath

get :: Get HardPath

NFData HardDeriv

Defined in Haskoin.Keys.Extended

Methods

rnf :: HardDeriv -> ()

HardOrAny HardDeriv

Defined in Haskoin.Keys.Extended

type Rep HardDeriv

Defined in Haskoin.Keys.Extended

type Rep HardDeriv = D1 ('MetaData "HardDeriv" "Haskoin.Keys.Extended" "haskoin-core-0.19.0-inplace" 'False) (V1 :: Type -> Type)

data SoftDeriv

Phantom type signaling derivation path including only non-hardened paths that can be computed from an extended public key.

Instances

Read SoftPath

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS SoftPath

readList :: ReadS [SoftPath]

readPrec :: ReadPrec SoftPath

readListPrec :: ReadPrec [SoftPath]

Show SoftPath

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> SoftPath -> ShowS

show :: SoftPath -> String

showList :: [SoftPath] -> ShowS

IsString SoftPath

Defined in Haskoin.Keys.Extended

Methods

fromString :: String -> SoftPath

Generic SoftDeriv

Defined in Haskoin.Keys.Extended

Associated Types

type Rep SoftDeriv :: Type -> Type

Methods

from :: SoftDeriv -> Rep SoftDeriv x

to :: Rep SoftDeriv x -> SoftDeriv

FromJSON SoftPath

Defined in Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser SoftPath

parseJSONList :: Value -> Parser [SoftPath]

Serialize SoftPath

Defined in Haskoin.Keys.Extended

Methods

put :: Putter SoftPath

get :: Get SoftPath

NFData SoftDeriv

Defined in Haskoin.Keys.Extended

Methods

rnf :: SoftDeriv -> ()

AnyOrSoft SoftDeriv

Defined in Haskoin.Keys.Extended

type Rep SoftDeriv

Defined in Haskoin.Keys.Extended

type Rep SoftDeriv = D1 ('MetaData "SoftDeriv" "Haskoin.Keys.Extended" "haskoin-core-0.19.0-inplace" 'False) (V1 :: Type -> Type)

class HardOrAny a

Helper class to perform validations on a hardened derivation path.

Instances

HardOrAny AnyDeriv

Defined in Haskoin.Keys.Extended

HardOrAny HardDeriv

Defined in Haskoin.Keys.Extended

class AnyOrSoft a

Helper class to perform validations on a non-hardened derivation path.

Instances

AnyOrSoft SoftDeriv

Defined in Haskoin.Keys.Extended

AnyOrSoft AnyDeriv

Defined in Haskoin.Keys.Extended

type DerivPath = DerivPathI AnyDeriv

Any derivation path.

type HardPath = DerivPathI HardDeriv

Hardened derivation path. Can be computed from extended private key only.

type SoftPath = DerivPathI SoftDeriv

Non-hardened derivation path can be computed from extended public key.

data Bip32PathIndex

Type for BIP32 path index element.

Constructors

Bip32HardIndex KeyIndex

Bip32SoftIndex KeyIndex

Instances

Eq Bip32PathIndex

Defined in Haskoin.Keys.Extended

Methods

(==) :: Bip32PathIndex -> Bip32PathIndex -> Bool

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

Read Bip32PathIndex

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS Bip32PathIndex

readList :: ReadS [Bip32PathIndex]

readPrec :: ReadPrec Bip32PathIndex

readListPrec :: ReadPrec [Bip32PathIndex]

Show Bip32PathIndex

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> Bip32PathIndex -> ShowS

show :: Bip32PathIndex -> String

showList :: [Bip32PathIndex] -> ShowS

Generic Bip32PathIndex

Defined in Haskoin.Keys.Extended

Associated Types

type Rep Bip32PathIndex :: Type -> Type

Methods

from :: Bip32PathIndex -> Rep Bip32PathIndex x

to :: Rep Bip32PathIndex x -> Bip32PathIndex

NFData Bip32PathIndex

Defined in Haskoin.Keys.Extended

Methods

rnf :: Bip32PathIndex -> ()

type Rep Bip32PathIndex

Defined in Haskoin.Keys.Extended

type Rep Bip32PathIndex = D1 ('MetaData "Bip32PathIndex" "Haskoin.Keys.Extended" "haskoin-core-0.19.0-inplace" 'False) (C1 ('MetaCons "Bip32HardIndex" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KeyIndex)) :+: C1 ('MetaCons "Bip32SoftIndex" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KeyIndex)))

derivePath :: DerivPathI t -> XPrvKey -> XPrvKey

Derive a private key from a derivation path

derivePubPath :: SoftPath -> XPubKey -> XPubKey

Derive a public key from a soft derivation path

toHard :: DerivPathI t -> Maybe HardPath

Turn a derivation path into a hard derivation path. Will fail if the path contains soft derivations.

toSoft :: DerivPathI t -> Maybe SoftPath

Turn a derivation path into a soft derivation path. Will fail if the path has hard derivations.

toGeneric :: DerivPathI t -> DerivPath

Make a derivation path generic.

(++/) :: DerivPathI t1 -> DerivPathI t2 -> DerivPath

Append two derivation paths together. The result will be a mixed derivation path.

pathToStr :: DerivPathI t -> String

Convert a derivation path to a human-readable string.

listToPath :: [KeyIndex] -> DerivPath

Convert a list of derivation indices to a derivation path.

pathToList :: DerivPathI t -> [KeyIndex]

Get a list of derivation indices from a derivation path.

Derivation Path Parser

data XKey

Data type representing a private or public key with its respective network.

Constructors

XPrv

Fields

• getXKeyPrv :: !XPrvKey
• getXKeyNet :: !Network

XPub

Fields

• getXKeyPub :: !XPubKey
• getXKeyNet :: !Network

Instances

Eq XKey

Defined in Haskoin.Keys.Extended

Methods

(==) :: XKey -> XKey -> Bool

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

Show XKey

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> XKey -> ShowS

show :: XKey -> String

showList :: [XKey] -> ShowS

Generic XKey

Defined in Haskoin.Keys.Extended

Associated Types

type Rep XKey :: Type -> Type

Methods

from :: XKey -> Rep XKey x

to :: Rep XKey x -> XKey

NFData XKey

Defined in Haskoin.Keys.Extended

Methods

rnf :: XKey -> ()

type Rep XKey

Defined in Haskoin.Keys.Extended

type Rep XKey = D1 ('MetaData "XKey" "Haskoin.Keys.Extended" "haskoin-core-0.19.0-inplace" 'False) (C1 ('MetaCons "XPrv" 'PrefixI 'True) (S1 ('MetaSel ('Just "getXKeyPrv") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 XPrvKey) :*: S1 ('MetaSel ('Just "getXKeyNet") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Network)) :+: C1 ('MetaCons "XPub" 'PrefixI 'True) (S1 ('MetaSel ('Just "getXKeyPub") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 XPubKey) :*: S1 ('MetaSel ('Just "getXKeyNet") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Network)))

data ParsedPath

Type for parsing derivation paths of the form m/1/2'/3 or M/1/2'/3.

Constructors

ParsedPrv

Fields

• getParsedPath :: !DerivPath

ParsedPub

Fields

• getParsedPath :: !DerivPath

ParsedEmpty

Fields

• getParsedPath :: !DerivPath

Instances

Eq ParsedPath

Defined in Haskoin.Keys.Extended

Methods

(==) :: ParsedPath -> ParsedPath -> Bool

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

Read ParsedPath

Defined in Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS ParsedPath

readList :: ReadS [ParsedPath]

readPrec :: ReadPrec ParsedPath

readListPrec :: ReadPrec [ParsedPath]

Show ParsedPath

Defined in Haskoin.Keys.Extended

Methods

showsPrec :: Int -> ParsedPath -> ShowS

show :: ParsedPath -> String

showList :: [ParsedPath] -> ShowS

IsString ParsedPath

Defined in Haskoin.Keys.Extended

Methods

fromString :: String -> ParsedPath

Generic ParsedPath

Defined in Haskoin.Keys.Extended

Associated Types

type Rep ParsedPath :: Type -> Type

Methods

from :: ParsedPath -> Rep ParsedPath x

to :: Rep ParsedPath x -> ParsedPath

ToJSON ParsedPath

Defined in Haskoin.Keys.Extended

Methods

toJSON :: ParsedPath -> Value

toEncoding :: ParsedPath -> Encoding

toJSONList :: [ParsedPath] -> Value

toEncodingList :: [ParsedPath] -> Encoding

FromJSON ParsedPath

Defined in Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser ParsedPath

parseJSONList :: Value -> Parser [ParsedPath]

NFData ParsedPath

Defined in Haskoin.Keys.Extended

Methods

rnf :: ParsedPath -> ()

type Rep ParsedPath

Defined in Haskoin.Keys.Extended

type Rep ParsedPath = D1 ('MetaData "ParsedPath" "Haskoin.Keys.Extended" "haskoin-core-0.19.0-inplace" 'False) (C1 ('MetaCons "ParsedPrv" 'PrefixI 'True) (S1 ('MetaSel ('Just "getParsedPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DerivPath)) :+: (C1 ('MetaCons "ParsedPub" 'PrefixI 'True) (S1 ('MetaSel ('Just "getParsedPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DerivPath)) :+: C1 ('MetaCons "ParsedEmpty" 'PrefixI 'True) (S1 ('MetaSel ('Just "getParsedPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DerivPath))))

parsePath :: String -> Maybe ParsedPath

Parse derivation path string for extended key. Forms: m/0'/2, M/2/3/4.

parseHard :: String -> Maybe HardPath

Helper function to parse a hard path.

parseSoft :: String -> Maybe SoftPath

Helper function to parse a soft path.

applyPath :: ParsedPath -> XKey -> Either String XKey

Apply a parsed path to an extended key to derive the new key defined in the path. If the path starts with m, a private key will be returned and if the path starts with M, a public key will be returned. Private derivations on a public key, and public derivations with a hard segment, return an error value.

derivePathAddr :: XPubKey -> SoftPath -> KeyIndex -> (Address, PubKey)

Derive an address from a given parent path.

derivePathAddrs :: XPubKey -> SoftPath -> KeyIndex -> [(Address, PubKey, KeyIndex)]

Cyclic list of all addresses derived from a given parent path and starting from the given offset index.

derivePathMSAddr :: [XPubKey] -> SoftPath -> Int -> KeyIndex -> (Address, RedeemScript)

Derive a multisig address from a given parent path. The number of required signatures (m in m of n) is also needed.

derivePathMSAddrs :: [XPubKey] -> SoftPath -> Int -> KeyIndex -> [(Address, RedeemScript, KeyIndex)]

Cyclic list of all multisig addresses derived from a given parent path and starting from the given offset index. The number of required signatures (m in m of n) is also needed.

concatBip32Segments :: [Bip32PathIndex] -> DerivPath

Concatenate derivation path indices into a derivation path.