Safe Haskell	None
Language	Haskell2010

Bitcoin.BIP32.Types

Contents

Key types
Child key operations
Util
Re-exports

Synopsis

Key types

data RootPrv Source #

Source of all other key types

Instances

Generic RootPrv Source #
Associated Types type Rep RootPrv :: * -> * # Methods from :: RootPrv -> Rep RootPrv x # to :: Rep RootPrv x -> RootPrv #
ToJSON RootPrv Source #
Methods toJSON :: RootPrv -> Value # toEncoding :: RootPrv -> Encoding # toJSONList :: [RootPrv] -> Value # toEncodingList :: [RootPrv] -> Encoding #
FromJSON RootPrv Source #
Methods parseJSON :: Value -> Parser RootPrv # parseJSONList :: Value -> Parser [RootPrv] #
Serialize RootPrv Source #
Methods put :: Putter RootPrv # get :: Get RootPrv #
NFData RootPrv Source #
Methods rnf :: RootPrv -> () #
DerivationSeed r => HasSigningKey RootPrv r Source #
Methods getSignKey :: InputG t r oldSigData -> RootPrv -> PrvKeyC
IsChildKey RootPrv Internal ChildPair HardPath Source #
Methods mkChild :: RootPrv -> HardPath -> Internal ChildPair Source #
IsChildKey RootPrv External ChildPub SoftPath Source #
Methods mkChild :: RootPrv -> SoftPath -> External ChildPub Source #
IsChildKey RootPrv External ChildPair SoftPath Source #
Methods mkChild :: RootPrv -> SoftPath -> External ChildPair Source #
DerivationSeed r => DeriveChangeOut (SigSinglePair t r sd) (TxFee, DustPolicy) RootPrv r Source #
Methods createChangeOut :: SigSinglePair t r sd -> RootPrv -> (TxFee, DustPolicy) -> ChangeOut Source #
type Rep RootPrv Source #
type Rep RootPrv = D1 (MetaData "RootPrv" "Bitcoin.BIP32.Types" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" True) (C1 (MetaCons "RootPrv" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 XPrvKey)))

data RootPub Source #

The public counterpart of a RootPrv

Instances

Eq RootPub Source #
Methods (==) :: RootPub -> RootPub -> Bool # (/=) :: RootPub -> RootPub -> Bool #
Show RootPub Source #
Methods showsPrec :: Int -> RootPub -> ShowS # show :: RootPub -> String # showList :: [RootPub] -> ShowS #
Generic RootPub Source #
Associated Types type Rep RootPub :: * -> * # Methods from :: RootPub -> Rep RootPub x # to :: Rep RootPub x -> RootPub #
ToJSON RootPub Source #
Methods toJSON :: RootPub -> Value # toEncoding :: RootPub -> Encoding # toJSONList :: [RootPub] -> Value # toEncodingList :: [RootPub] -> Encoding #
FromJSON RootPub Source #
Methods parseJSON :: Value -> Parser RootPub # parseJSONList :: Value -> Parser [RootPub] #
Serialize RootPub Source #
Methods put :: Putter RootPub # get :: Get RootPub #
NFData RootPub Source #
Methods rnf :: RootPub -> () #
IsChildKey RootPub External ChildPub SoftPath Source #
Methods mkChild :: RootPub -> SoftPath -> External ChildPub Source #
type Rep RootPub Source #
type Rep RootPub = D1 (MetaData "RootPub" "Bitcoin.BIP32.Types" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" True) (C1 (MetaCons "RootPub" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 XPubKey)))

data RootKeyId Source #

Unique ID for a 'RootPrv'/'RootPub' pair

Instances

Eq RootKeyId Source #
Methods (==) :: RootKeyId -> RootKeyId -> Bool # (/=) :: RootKeyId -> RootKeyId -> Bool #
Show RootKeyId Source #
Methods showsPrec :: Int -> RootKeyId -> ShowS # show :: RootKeyId -> String # showList :: [RootKeyId] -> ShowS #
Generic RootKeyId Source #
Associated Types type Rep RootKeyId :: * -> * # Methods from :: RootKeyId -> Rep RootKeyId x # to :: Rep RootKeyId x -> RootKeyId #
ToJSON RootKeyId Source #
Methods toJSON :: RootKeyId -> Value # toEncoding :: RootKeyId -> Encoding # toJSONList :: [RootKeyId] -> Value # toEncodingList :: [RootKeyId] -> Encoding #
FromJSON RootKeyId Source #
Methods parseJSON :: Value -> Parser RootKeyId # parseJSONList :: Value -> Parser [RootKeyId] #
Serialize RootKeyId Source #
Methods put :: Putter RootKeyId # get :: Get RootKeyId #
NFData RootKeyId Source #
Methods rnf :: RootKeyId -> () #
type Rep RootKeyId Source #
type Rep RootKeyId = D1 (MetaData "RootKeyId" "Bitcoin.BIP32.Types" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" True) (C1 (MetaCons "RootKeyId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Hash256)))

data External a Source #

A key pair where the public part can be derived without knowledge of the private part (not safe if a single derived private key is exposed)

Instances

Functor External Source #
Methods fmap :: (a -> b) -> External a -> External b # (<$) :: a -> External b -> External a #
HasKey External ChildPub XPubKey SoftPath Source #
Methods getKey :: External ChildPub -> XPubKey Source #
HasKey External ChildPub PubKeyC SoftPath Source #
Methods getKey :: External ChildPub -> PubKeyC Source #
HasKey External ChildPub Address SoftPath Source #
Methods getKey :: External ChildPub -> Address Source #
HasKey External ChildPair XPubKey SoftPath Source #
Methods getKey :: External ChildPair -> XPubKey Source #
HasKey External ChildPair PubKeyC SoftPath Source #
Methods getKey :: External ChildPair -> PubKeyC Source #
HasKey External ChildPair PrvKeyC SoftPath Source #
Methods getKey :: External ChildPair -> PrvKeyC Source #
HasKey External ChildPair Address SoftPath Source #
Methods getKey :: External ChildPair -> Address Source #
IsChildKey RootPub External ChildPub SoftPath Source #
Methods mkChild :: RootPub -> SoftPath -> External ChildPub Source #
IsChildKey RootPrv External ChildPub SoftPath Source #
Methods mkChild :: RootPrv -> SoftPath -> External ChildPub Source #
IsChildKey RootPrv External ChildPair SoftPath Source #
Methods mkChild :: RootPrv -> SoftPath -> External ChildPair Source #
HasKey External ChildPair (PrvKeyC, XPubKey) SoftPath Source #
Methods getKey :: External ChildPair -> (PrvKeyC, XPubKey) Source #
Eq a => Eq (External a) Source #
Methods (==) :: External a -> External a -> Bool # (/=) :: External a -> External a -> Bool #
Show a => Show (External a) Source #
Methods showsPrec :: Int -> External a -> ShowS # show :: External a -> String # showList :: [External a] -> ShowS #
Generic (External a) Source #
Associated Types type Rep (External a) :: * -> * # Methods from :: External a -> Rep (External a) x # to :: Rep (External a) x -> External a #
ToJSON a => ToJSON (External a) Source #
Methods toJSON :: External a -> Value # toEncoding :: External a -> Encoding # toJSONList :: [External a] -> Value # toEncodingList :: [External a] -> Encoding #
FromJSON a => FromJSON (External a) Source #
Methods parseJSON :: Value -> Parser (External a) # parseJSONList :: Value -> Parser [External a] #
Serialize a => Serialize (External a) Source #
Methods put :: Putter (External a) # get :: Get (External a) #
NFData a => NFData (External a) Source #
Methods rnf :: External a -> () #
type Rep (External a) Source #
type Rep (External a)

data Internal a Source #

A key pair where the public part cannot be derived without knowledge of the private part (safe if a single derived private key is exposed)

Instances

Functor Internal Source #
Methods fmap :: (a -> b) -> Internal a -> Internal b # (<$) :: a -> Internal b -> Internal a #
HasKey Internal ChildPair XPubKey HardPath Source #
Methods getKey :: Internal ChildPair -> XPubKey Source #
HasKey Internal ChildPair PubKeyC HardPath Source #
Methods getKey :: Internal ChildPair -> PubKeyC Source #
HasKey Internal ChildPair PrvKeyC HardPath Source #
Methods getKey :: Internal ChildPair -> PrvKeyC Source #
HasKey Internal ChildPair Address HardPath Source #
Methods getKey :: Internal ChildPair -> Address Source #
IsChildKey RootPrv Internal ChildPair HardPath Source #
Methods mkChild :: RootPrv -> HardPath -> Internal ChildPair Source #
HasKey Internal ChildPair (PrvKeyC, XPubKey) HardPath Source #
Methods getKey :: Internal ChildPair -> (PrvKeyC, XPubKey) Source #
Eq a => Eq (Internal a) Source #
Methods (==) :: Internal a -> Internal a -> Bool # (/=) :: Internal a -> Internal a -> Bool #
Show a => Show (Internal a) Source #
Methods showsPrec :: Int -> Internal a -> ShowS # show :: Internal a -> String # showList :: [Internal a] -> ShowS #
Generic (Internal a) Source #
Associated Types type Rep (Internal a) :: * -> * # Methods from :: Internal a -> Rep (Internal a) x # to :: Rep (Internal a) x -> Internal a #
Serialize a => Serialize (Internal a) Source #
Methods put :: Putter (Internal a) # get :: Get (Internal a) #
NFData a => NFData (Internal a) Source #
Methods rnf :: Internal a -> () #
type Rep (Internal a) Source #
type Rep (Internal a)

data ChildPair Source #

Key pair, containing both private and public extended keys. Derive subkeys using getKey

Instances

Eq ChildPair Source #
Methods (==) :: ChildPair -> ChildPair -> Bool # (/=) :: ChildPair -> ChildPair -> Bool #
Show ChildPair Source #
Methods showsPrec :: Int -> ChildPair -> ShowS # show :: ChildPair -> String # showList :: [ChildPair] -> ShowS #
Generic ChildPair Source #
Associated Types type Rep ChildPair :: * -> * # Methods from :: ChildPair -> Rep ChildPair x # to :: Rep ChildPair x -> ChildPair #
NFData ChildPair Source #
Methods rnf :: ChildPair -> () #
HasKey Internal ChildPair XPubKey HardPath Source #
Methods getKey :: Internal ChildPair -> XPubKey Source #
HasKey Internal ChildPair PubKeyC HardPath Source #
Methods getKey :: Internal ChildPair -> PubKeyC Source #
HasKey Internal ChildPair PrvKeyC HardPath Source #
Methods getKey :: Internal ChildPair -> PrvKeyC Source #
HasKey Internal ChildPair Address HardPath Source #
Methods getKey :: Internal ChildPair -> Address Source #
HasKey External ChildPair XPubKey SoftPath Source #
Methods getKey :: External ChildPair -> XPubKey Source #
HasKey External ChildPair PubKeyC SoftPath Source #
Methods getKey :: External ChildPair -> PubKeyC Source #
HasKey External ChildPair PrvKeyC SoftPath Source #
Methods getKey :: External ChildPair -> PrvKeyC Source #
HasKey External ChildPair Address SoftPath Source #
Methods getKey :: External ChildPair -> Address Source #
IsChildKey RootPrv Internal ChildPair HardPath Source #
Methods mkChild :: RootPrv -> HardPath -> Internal ChildPair Source #
IsChildKey RootPrv External ChildPair SoftPath Source #
Methods mkChild :: RootPrv -> SoftPath -> External ChildPair Source #
HasKey Internal ChildPair (PrvKeyC, XPubKey) HardPath Source #
Methods getKey :: Internal ChildPair -> (PrvKeyC, XPubKey) Source #
HasKey External ChildPair (PrvKeyC, XPubKey) SoftPath Source #
Methods getKey :: External ChildPair -> (PrvKeyC, XPubKey) Source #
type Rep ChildPair Source #
type Rep ChildPair = D1 (MetaData "ChildPair" "Bitcoin.BIP32.Types" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" False) (C1 (MetaCons "ChildPair" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "pairPriv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 XPrvKey)) (S1 (MetaSel (Just Symbol "pairPub'") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 XPubKey))))

data ChildPub Source #

Public part only of a ChildPair

Instances

Eq ChildPub Source #
Methods (==) :: ChildPub -> ChildPub -> Bool # (/=) :: ChildPub -> ChildPub -> Bool #
Show ChildPub Source #
Methods showsPrec :: Int -> ChildPub -> ShowS # show :: ChildPub -> String # showList :: [ChildPub] -> ShowS #
Generic ChildPub Source #
Associated Types type Rep ChildPub :: * -> * # Methods from :: ChildPub -> Rep ChildPub x # to :: Rep ChildPub x -> ChildPub #
ToJSON ChildPub Source #
Methods toJSON :: ChildPub -> Value # toEncoding :: ChildPub -> Encoding # toJSONList :: [ChildPub] -> Value # toEncodingList :: [ChildPub] -> Encoding #
FromJSON ChildPub Source #
Methods parseJSON :: Value -> Parser ChildPub # parseJSONList :: Value -> Parser [ChildPub] #
Serialize ChildPub Source #
Methods put :: Putter ChildPub # get :: Get ChildPub #
NFData ChildPub Source #
Methods rnf :: ChildPub -> () #
HasKey External ChildPub XPubKey SoftPath Source #
Methods getKey :: External ChildPub -> XPubKey Source #
HasKey External ChildPub PubKeyC SoftPath Source #
Methods getKey :: External ChildPub -> PubKeyC Source #
HasKey External ChildPub Address SoftPath Source #
Methods getKey :: External ChildPub -> Address Source #
IsChildKey RootPub External ChildPub SoftPath Source #
Methods mkChild :: RootPub -> SoftPath -> External ChildPub Source #
IsChildKey RootPrv External ChildPub SoftPath Source #
Methods mkChild :: RootPrv -> SoftPath -> External ChildPub Source #
type Rep ChildPub Source #
type Rep ChildPub = D1 (MetaData "ChildPub" "Bitcoin.BIP32.Types" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" True) (C1 (MetaCons "ChildPub" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 XPubKey)))

type ExtPub = External ChildPub Source #

type ExtPrv = External ChildPair Source #

createRootPrv :: ByteString -> RootPrv Source #

fromRootPrv :: RootPrv -> RootPub Source #

Child key operations

class IsChildKey sourceKey t k derivPath | t -> derivPath where Source #

Minimal complete definition

mkChild

Methods

mkChild :: sourceKey -> derivPath -> t k Source #

Instances

IsChildKey RootPub External ChildPub SoftPath Source #
Methods mkChild :: RootPub -> SoftPath -> External ChildPub Source #
IsChildKey RootPrv Internal ChildPair HardPath Source #
Methods mkChild :: RootPrv -> HardPath -> Internal ChildPair Source #
IsChildKey RootPrv External ChildPub SoftPath Source #
Methods mkChild :: RootPrv -> SoftPath -> External ChildPub Source #
IsChildKey RootPrv External ChildPair SoftPath Source #
Methods mkChild :: RootPrv -> SoftPath -> External ChildPair Source #

class HasKey t k key derivPath | t -> derivPath where Source #

Get a key of type key from an 'Internal'/'External' 'ChildPub'/'ChildPair'

Minimal complete definition

getKey

Methods

getKey :: t k -> key Source #

Instances

HasKey Internal ChildPair XPubKey HardPath Source #
Methods getKey :: Internal ChildPair -> XPubKey Source #
HasKey Internal ChildPair PubKeyC HardPath Source #
Methods getKey :: Internal ChildPair -> PubKeyC Source #
HasKey Internal ChildPair PrvKeyC HardPath Source #
Methods getKey :: Internal ChildPair -> PrvKeyC Source #
HasKey Internal ChildPair Address HardPath Source #
Methods getKey :: Internal ChildPair -> Address Source #
HasKey External ChildPub XPubKey SoftPath Source #
Methods getKey :: External ChildPub -> XPubKey Source #
HasKey External ChildPub PubKeyC SoftPath Source #
Methods getKey :: External ChildPub -> PubKeyC Source #
HasKey External ChildPub Address SoftPath Source #
Methods getKey :: External ChildPub -> Address Source #
HasKey External ChildPair XPubKey SoftPath Source #
Methods getKey :: External ChildPair -> XPubKey Source #
HasKey External ChildPair PubKeyC SoftPath Source #
Methods getKey :: External ChildPair -> PubKeyC Source #
HasKey External ChildPair PrvKeyC SoftPath Source #
Methods getKey :: External ChildPair -> PrvKeyC Source #
HasKey External ChildPair Address SoftPath Source #
Methods getKey :: External ChildPair -> Address Source #
HasKey Internal ChildPair (PrvKeyC, XPubKey) HardPath Source #
Methods getKey :: Internal ChildPair -> (PrvKeyC, XPubKey) Source #
HasKey External ChildPair (PrvKeyC, XPubKey) SoftPath Source #
Methods getKey :: External ChildPair -> (PrvKeyC, XPubKey) Source #

data KeyDeriveIndex Source #

Key index for a BIP32 child key

Instances

Enum KeyDeriveIndex Source #
Methods succ :: KeyDeriveIndex -> KeyDeriveIndex # pred :: KeyDeriveIndex -> KeyDeriveIndex # toEnum :: Int -> KeyDeriveIndex # fromEnum :: KeyDeriveIndex -> Int # enumFrom :: KeyDeriveIndex -> [KeyDeriveIndex] # enumFromThen :: KeyDeriveIndex -> KeyDeriveIndex -> [KeyDeriveIndex] # enumFromTo :: KeyDeriveIndex -> KeyDeriveIndex -> [KeyDeriveIndex] # enumFromThenTo :: KeyDeriveIndex -> KeyDeriveIndex -> KeyDeriveIndex -> [KeyDeriveIndex] #
Eq KeyDeriveIndex Source #
Methods (==) :: KeyDeriveIndex -> KeyDeriveIndex -> Bool # (/=) :: KeyDeriveIndex -> KeyDeriveIndex -> Bool #
Integral KeyDeriveIndex Source #
Methods quot :: KeyDeriveIndex -> KeyDeriveIndex -> KeyDeriveIndex # rem :: KeyDeriveIndex -> KeyDeriveIndex -> KeyDeriveIndex # div :: KeyDeriveIndex -> KeyDeriveIndex -> KeyDeriveIndex # mod :: KeyDeriveIndex -> KeyDeriveIndex -> KeyDeriveIndex # quotRem :: KeyDeriveIndex -> KeyDeriveIndex -> (KeyDeriveIndex, KeyDeriveIndex) # divMod :: KeyDeriveIndex -> KeyDeriveIndex -> (KeyDeriveIndex, KeyDeriveIndex) # toInteger :: KeyDeriveIndex -> Integer #
Num KeyDeriveIndex Source #
Methods (+) :: KeyDeriveIndex -> KeyDeriveIndex -> KeyDeriveIndex # (-) :: KeyDeriveIndex -> KeyDeriveIndex -> KeyDeriveIndex # (*) :: KeyDeriveIndex -> KeyDeriveIndex -> KeyDeriveIndex # negate :: KeyDeriveIndex -> KeyDeriveIndex # abs :: KeyDeriveIndex -> KeyDeriveIndex # signum :: KeyDeriveIndex -> KeyDeriveIndex # fromInteger :: Integer -> KeyDeriveIndex #
Ord KeyDeriveIndex Source #
Methods compare :: KeyDeriveIndex -> KeyDeriveIndex -> Ordering # (<) :: KeyDeriveIndex -> KeyDeriveIndex -> Bool # (<=) :: KeyDeriveIndex -> KeyDeriveIndex -> Bool # (>) :: KeyDeriveIndex -> KeyDeriveIndex -> Bool # (>=) :: KeyDeriveIndex -> KeyDeriveIndex -> Bool # max :: KeyDeriveIndex -> KeyDeriveIndex -> KeyDeriveIndex # min :: KeyDeriveIndex -> KeyDeriveIndex -> KeyDeriveIndex #
Real KeyDeriveIndex Source #
Methods toRational :: KeyDeriveIndex -> Rational #
Show KeyDeriveIndex Source #
Methods showsPrec :: Int -> KeyDeriveIndex -> ShowS # show :: KeyDeriveIndex -> String # showList :: [KeyDeriveIndex] -> ShowS #
ToJSON KeyDeriveIndex Source #
Methods toJSON :: KeyDeriveIndex -> Value # toEncoding :: KeyDeriveIndex -> Encoding # toJSONList :: [KeyDeriveIndex] -> Value # toEncodingList :: [KeyDeriveIndex] -> Encoding #
FromJSON KeyDeriveIndex Source #
Methods parseJSON :: Value -> Parser KeyDeriveIndex # parseJSONList :: Value -> Parser [KeyDeriveIndex] #
Serialize KeyDeriveIndex Source #
Methods put :: Putter KeyDeriveIndex # get :: Get KeyDeriveIndex #
NFData KeyDeriveIndex Source #
Methods rnf :: KeyDeriveIndex -> () #

class HasKeyIndex a where Source #

Minimal complete definition

getKeyIndex

Methods

getKeyIndex :: a -> KeyDeriveIndex Source #

Instances

HasKeyIndex XPubKey Source #
Methods getKeyIndex :: XPubKey -> KeyDeriveIndex Source #

Util

keyId :: HasKeyId rk => rk -> RootKeyId Source #

fromExternalPair :: External ChildPair -> External ChildPub Source #

Re-exports

type SoftPath = DerivPathI Soft #

type HardPath = DerivPathI Hard #