Network.Haskoin.Keys

ECDSA private and public keys, extended keys (BIP-32) and mnemonic sentences (BIP-39).

Mnemonic Sentences

type Entropy = ByteString

Random data used to create a mnemonic sentence. Use a good entropy source. You will get your coins stolen if you don't. You have been warned.

type Mnemonic = Text

Human-readable mnemonic sentence.

type Passphrase = ByteString

Optional passphrase for mnemnoic sentence.

type Seed = ByteString

Seed for a private key from a mnemonic sentence.

toMnemonic :: Entropy -> Either String Mnemonic

Provide intial Entropy as a ByteString of length multiple of 4 bytes. Output a Mnemonic sentence.

fromMnemonic :: Mnemonic -> Either String Entropy

Revert toMnemonic. Do not use this to generate a Seed. Instead use mnemonicToSeed. This outputs the original Entropy used to generate a Mnemonic sentence.

mnemonicToSeed :: Passphrase -> Mnemonic -> Either String Seed

Get a 512-bit Seed from a Mnemonic sentence. Will validate checksum. Passphrase can be used to protect the Mnemonic. Use an empty string as Passphrase if none is required.

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 Network.Haskoin.Keys.Extended

Methods

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

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

Read XPubKey

Defined in Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS XPubKey

readList :: ReadS [XPubKey]

readPrec :: ReadPrec XPubKey

readListPrec :: ReadPrec [XPubKey]

Show XPubKey

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> XPubKey -> ShowS

show :: XPubKey -> String

showList :: [XPubKey] -> ShowS

Generic XPubKey

Defined in Network.Haskoin.Keys.Extended

Associated Types

type Rep XPubKey :: * -> *

Methods

from :: XPubKey -> Rep XPubKey x

to :: Rep XPubKey x -> XPubKey

type Rep XPubKey

Defined in Network.Haskoin.Keys.Extended

type Rep XPubKey = D1 (MetaData "XPubKey" "Network.Haskoin.Keys.Extended" "haskoin-core-0.8.2-DBbfowLuwQJDnYGV2ClFSV" 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 Network.Haskoin.Keys.Extended

Methods

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

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

Read XPrvKey

Defined in Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS XPrvKey

readList :: ReadS [XPrvKey]

readPrec :: ReadPrec XPrvKey

readListPrec :: ReadPrec [XPrvKey]

Show XPrvKey

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> XPrvKey -> ShowS

show :: XPrvKey -> String

showList :: [XPrvKey] -> ShowS

Generic XPrvKey

Defined in Network.Haskoin.Keys.Extended

Associated Types

type Rep XPrvKey :: * -> *

Methods

from :: XPrvKey -> Rep XPrvKey x

to :: Rep XPrvKey x -> XPrvKey

type Rep XPrvKey

Defined in Network.Haskoin.Keys.Extended

type Rep XPrvKey = D1 (MetaData "XPrvKey" "Network.Haskoin.Keys.Extended" "haskoin-core-0.8.2-DBbfowLuwQJDnYGV2ClFSV" 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 Network.Haskoin.Keys.Extended

Methods

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

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

Read DerivationException

Defined in Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS DerivationException

readList :: ReadS [DerivationException]

readPrec :: ReadPrec DerivationException

readListPrec :: ReadPrec [DerivationException]

Show DerivationException

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> DerivationException -> ShowS

show :: DerivationException -> String

showList :: [DerivationException] -> ShowS

Exception DerivationException

Defined in Network.Haskoin.Keys.Extended

Methods

toException :: DerivationException -> SomeException

fromException :: SomeException -> Maybe DerivationException

displayException :: DerivationException -> 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

Computer the Address of 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.

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

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 an address from a public key and an index. The derivation type is a public, soft derivation.

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

Cyclic list of all addresses derived from a public key starting from an offset index. The derivation types are public, soft derivations.

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 Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS SoftPath

readList :: ReadS [SoftPath]

readPrec :: ReadPrec SoftPath

readListPrec :: ReadPrec [SoftPath]

Read DerivPath

Defined in Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS DerivPath

readList :: ReadS [DerivPath]

readPrec :: ReadPrec DerivPath

readListPrec :: ReadPrec [DerivPath]

Read HardPath

Defined in Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS HardPath

readList :: ReadS [HardPath]

readPrec :: ReadPrec HardPath

readListPrec :: ReadPrec [HardPath]

Show SoftPath

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> SoftPath -> ShowS

show :: SoftPath -> String

showList :: [SoftPath] -> ShowS

Show DerivPath

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> DerivPath -> ShowS

show :: DerivPath -> String

showList :: [DerivPath] -> ShowS

Show HardPath

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> HardPath -> ShowS

show :: HardPath -> String

showList :: [HardPath] -> ShowS

IsString SoftPath

Defined in Network.Haskoin.Keys.Extended

Methods

fromString :: String -> SoftPath

IsString DerivPath

Defined in Network.Haskoin.Keys.Extended

Methods

fromString :: String -> DerivPath

IsString HardPath

Defined in Network.Haskoin.Keys.Extended

Methods

fromString :: String -> HardPath

FromJSON SoftPath

Defined in Network.Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser SoftPath

parseJSONList :: Value -> Parser [SoftPath]

FromJSON DerivPath

Defined in Network.Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser DerivPath

parseJSONList :: Value -> Parser [DerivPath]

FromJSON HardPath

Defined in Network.Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser HardPath

parseJSONList :: Value -> Parser [HardPath]

Serialize DerivPath

Defined in Network.Haskoin.Keys.Extended

Methods

put :: Putter DerivPath

get :: Get DerivPath

Eq (DerivPathI t)

Defined in Network.Haskoin.Keys.Extended

Methods

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

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

ToJSON (DerivPathI t)

Defined in Network.Haskoin.Keys.Extended

Methods

toJSON :: DerivPathI t -> Value

toEncoding :: DerivPathI t -> Encoding

toJSONList :: [DerivPathI t] -> Value

toEncodingList :: [DerivPathI t] -> Encoding

data AnyDeriv

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

Instances

Read DerivPath

Defined in Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS DerivPath

readList :: ReadS [DerivPath]

readPrec :: ReadPrec DerivPath

readListPrec :: ReadPrec [DerivPath]

Show DerivPath

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> DerivPath -> ShowS

show :: DerivPath -> String

showList :: [DerivPath] -> ShowS

IsString DerivPath

Defined in Network.Haskoin.Keys.Extended

Methods

fromString :: String -> DerivPath

FromJSON DerivPath

Defined in Network.Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser DerivPath

parseJSONList :: Value -> Parser [DerivPath]

Serialize DerivPath

Defined in Network.Haskoin.Keys.Extended

Methods

put :: Putter DerivPath

get :: Get DerivPath

AnyOrSoft AnyDeriv

Defined in Network.Haskoin.Keys.Extended

HardOrAny AnyDeriv

Defined in Network.Haskoin.Keys.Extended

data HardDeriv

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

Instances

Read HardPath

Defined in Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS HardPath

readList :: ReadS [HardPath]

readPrec :: ReadPrec HardPath

readListPrec :: ReadPrec [HardPath]

Show HardPath

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> HardPath -> ShowS

show :: HardPath -> String

showList :: [HardPath] -> ShowS

IsString HardPath

Defined in Network.Haskoin.Keys.Extended

Methods

fromString :: String -> HardPath

FromJSON HardPath

Defined in Network.Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser HardPath

parseJSONList :: Value -> Parser [HardPath]

HardOrAny HardDeriv

Defined in Network.Haskoin.Keys.Extended

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 Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS SoftPath

readList :: ReadS [SoftPath]

readPrec :: ReadPrec SoftPath

readListPrec :: ReadPrec [SoftPath]

Show SoftPath

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> SoftPath -> ShowS

show :: SoftPath -> String

showList :: [SoftPath] -> ShowS

IsString SoftPath

Defined in Network.Haskoin.Keys.Extended

Methods

fromString :: String -> SoftPath

FromJSON SoftPath

Defined in Network.Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser SoftPath

parseJSONList :: Value -> Parser [SoftPath]

AnyOrSoft SoftDeriv

Defined in Network.Haskoin.Keys.Extended

class HardOrAny a

Helper class to perform validations on a hardened derivation path.

Instances

HardOrAny AnyDeriv

Defined in Network.Haskoin.Keys.Extended

HardOrAny HardDeriv

Defined in Network.Haskoin.Keys.Extended

class AnyOrSoft a

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

Instances

AnyOrSoft SoftDeriv

Defined in Network.Haskoin.Keys.Extended

AnyOrSoft AnyDeriv

Defined in Network.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 Network.Haskoin.Keys.Extended

Methods

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

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

Read Bip32PathIndex

Defined in Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS Bip32PathIndex

readList :: ReadS [Bip32PathIndex]

readPrec :: ReadPrec Bip32PathIndex

readListPrec :: ReadPrec [Bip32PathIndex]

Show Bip32PathIndex

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> Bip32PathIndex -> ShowS

show :: Bip32PathIndex -> String

showList :: [Bip32PathIndex] -> ShowS

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 derivatino 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 Network.Haskoin.Keys.Extended

Methods

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

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

Show XKey

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> XKey -> ShowS

show :: XKey -> String

showList :: [XKey] -> ShowS

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 Network.Haskoin.Keys.Extended

Methods

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

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

Read ParsedPath

Defined in Network.Haskoin.Keys.Extended

Methods

readsPrec :: Int -> ReadS ParsedPath

readList :: ReadS [ParsedPath]

readPrec :: ReadPrec ParsedPath

readListPrec :: ReadPrec [ParsedPath]

Show ParsedPath

Defined in Network.Haskoin.Keys.Extended

Methods

showsPrec :: Int -> ParsedPath -> ShowS

show :: ParsedPath -> String

showList :: [ParsedPath] -> ShowS

IsString ParsedPath

Defined in Network.Haskoin.Keys.Extended

Methods

fromString :: String -> ParsedPath

ToJSON ParsedPath

Defined in Network.Haskoin.Keys.Extended

Methods

toJSON :: ParsedPath -> Value

toEncoding :: ParsedPath -> Encoding

toJSONList :: [ParsedPath] -> Value

toEncodingList :: [ParsedPath] -> Encoding

FromJSON ParsedPath

Defined in Network.Haskoin.Keys.Extended

Methods

parseJSON :: Value -> Parser ParsedPath

parseJSONList :: Value -> Parser [ParsedPath]

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.

Public & Private Keys

data PubKeyI

Elliptic curve public key type with expected serialized compression flag.

Constructors

PubKeyI

Fields

• pubKeyPoint :: !PubKey
• pubKeyCompressed :: !Bool

Instances

Eq PubKeyI

Defined in Network.Haskoin.Keys.Common

Methods

(==) :: PubKeyI -> PubKeyI -> Bool

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

Read PubKeyI

Defined in Network.Haskoin.Keys.Common

Methods

readsPrec :: Int -> ReadS PubKeyI

readList :: ReadS [PubKeyI]

readPrec :: ReadPrec PubKeyI

readListPrec :: ReadPrec [PubKeyI]

Show PubKeyI

Defined in Network.Haskoin.Keys.Common

Methods

showsPrec :: Int -> PubKeyI -> ShowS

show :: PubKeyI -> String

showList :: [PubKeyI] -> ShowS

IsString PubKeyI

Defined in Network.Haskoin.Keys.Common

Methods

fromString :: String -> PubKeyI

Generic PubKeyI

Defined in Network.Haskoin.Keys.Common

Associated Types

type Rep PubKeyI :: * -> *

Methods

from :: PubKeyI -> Rep PubKeyI x

to :: Rep PubKeyI x -> PubKeyI

Hashable PubKeyI

Defined in Network.Haskoin.Keys.Common

Methods

hashWithSalt :: Int -> PubKeyI -> Int

hash :: PubKeyI -> Int

ToJSON PubKeyI

Defined in Network.Haskoin.Keys.Common

Methods

toJSON :: PubKeyI -> Value

toEncoding :: PubKeyI -> Encoding

toJSONList :: [PubKeyI] -> Value

toEncodingList :: [PubKeyI] -> Encoding

FromJSON PubKeyI

Defined in Network.Haskoin.Keys.Common

Methods

parseJSON :: Value -> Parser PubKeyI

parseJSONList :: Value -> Parser [PubKeyI]

Serialize PubKeyI

Defined in Network.Haskoin.Keys.Common

Methods

put :: Putter PubKeyI

get :: Get PubKeyI

type Rep PubKeyI

Defined in Network.Haskoin.Keys.Common

type Rep PubKeyI = D1 (MetaData "PubKeyI" "Network.Haskoin.Keys.Common" "haskoin-core-0.8.2-DBbfowLuwQJDnYGV2ClFSV" False) (C1 (MetaCons "PubKeyI" PrefixI True) (S1 (MetaSel (Just "pubKeyPoint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PubKey) :*: S1 (MetaSel (Just "pubKeyCompressed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))

data SecKeyI

Elliptic curve private key type with expected public key compression information. Compression information is stored in private key WIF formats and needs to be preserved to generate the correct address from the corresponding public key.

Constructors

SecKeyI

Fields

• secKeyData :: !SecKey
• secKeyCompressed :: !Bool

Instances

Eq SecKeyI

Defined in Network.Haskoin.Keys.Common

Methods

(==) :: SecKeyI -> SecKeyI -> Bool

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

Read SecKeyI

Defined in Network.Haskoin.Keys.Common

Methods

readsPrec :: Int -> ReadS SecKeyI

readList :: ReadS [SecKeyI]

readPrec :: ReadPrec SecKeyI

readListPrec :: ReadPrec [SecKeyI]

Show SecKeyI

Defined in Network.Haskoin.Keys.Common

Methods

showsPrec :: Int -> SecKeyI -> ShowS

show :: SecKeyI -> String

showList :: [SecKeyI] -> ShowS

exportPubKey :: Bool -> PubKey -> ByteString

Encode public key as DER. First argument True for compressed output.

importPubKey :: ByteString -> Maybe PubKey

Import DER-encoded public key.

wrapPubKey :: Bool -> PubKey -> PubKeyI

Wrap a public key from secp256k1 library adding information about compression.

derivePubKeyI :: SecKeyI -> PubKeyI

Derives a public key from a private key. This function will preserve compression flag.

wrapSecKey :: Bool -> SecKey -> SecKeyI

Wrap private key with corresponding public key compression flag.

fromMiniKey :: ByteString -> Maybe SecKeyI

Decode Casascius mini private keys (22 or 30 characters).

tweakPubKey :: PubKey -> Hash256 -> Maybe PubKey

Tweak a public key.

tweakSecKey :: SecKey -> Hash256 -> Maybe SecKey

Tweak a private key.

secKeyPut :: Putter SecKey

Serialize SecKey.

secKeyGet :: Get SecKey

Deserialize SecKey.

getSecKey :: SecKey -> ByteString

Get 32-byte secret key.

secKey :: ByteString -> Maybe SecKey

Import 32-byte ByteString as SecKey.