-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | BIP-0032: Hierarchical Deterministic Wallets for Bitcoin and other cryptocurrencies
--   
--   BIP-0032: Hierarchical Deterministic Wallets for Bitcoin and other
--   cryptocurrencies
--   
--   This library builds in GHC and GHCJS.
@package bip32
@version 0.2


-- | <a>BIP-0032</a> Hierarchical Deterministic Wallets, for bitcoin and
--   other cryptocurrencies.
module BIP32

-- | Obtain the Base58 representation for an <a>XPrv</a>.
--   
--   It can be either 111 or 112 bytes in length, and when rendered as
--   ASCII it looks something like this:
--   
--   <pre>
--   xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi
--   </pre>
encodeXPrv :: XPrv -> ByteString

-- | Obtain the Base58 representation for an <a>XPub</a>.
--   
--   It can be either 111 or 112 bytes in length, and when rendered as
--   ASCII it looks something like this:
--   
--   <pre>
--   xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8
--   </pre>
encodeXPub :: XPub -> ByteString

-- | Decode the Base58-encoded <a>XPrv</a> representation. See
--   <a>encodeXPrv</a>.
decodeXPrv :: ByteString -> Maybe XPrv

-- | Decode the Base58-encoded <a>XPub</a> representation. See
--   <a>encodeXPub</a>.
decodeXPub :: ByteString -> Maybe XPub

-- | Decode the Base58-encoded representation of either and <a>XPub</a> or
--   an <a>XPub</a>.
decode :: ByteString -> Maybe (Either XPub XPrv)

-- | Encode the 78 raw <a>XPrv</a> bytes.
encodeXPrvRaw :: XPrv -> ByteString

-- | Encode the 78 raw <a>XPub</a> bytes.
encodeXPubRaw :: XPub -> ByteString

-- | Decode the 78 raw <a>XPrv</a> bytes.
decodeXPrvRaw :: ByteString -> Maybe XPrv

-- | Decode the 78 raw <a>XPub</a> bytes.
decodeXPubRaw :: ByteString -> Maybe XPub

-- | Encode the 78 raw <a>XPub</a> or <a>XPrv</a> bytes.
decodeRaw :: ByteString -> Maybe (Either XPub XPrv)

-- | Extended private key.
data XPrv
XPrv :: Version -> Depth -> Fingerprint -> Index -> Chain -> Prv -> XPrv
[xprv_version] :: XPrv -> Version
[xprv_depth] :: XPrv -> Depth
[xprv_fingerprint] :: XPrv -> Fingerprint
[xprv_index] :: XPrv -> Index
[xprv_chain] :: XPrv -> Chain
[xprv_prv] :: XPrv -> Prv

-- | Obtain the <a>XPub</a> corresponding to a particular <a>XPrv</a>, at a
--   particular <a>Version</a>.
xprvToXPub :: Version -> XPrv -> XPub

-- | Derive a <a>XPrv</a> subkey from a parent <a>XPrv</a> key.
--   
--   Returns <a>Nothing</a> if the given inputs result in an invalid key.
subXPrvXPrv :: XPrv -> Index -> Maybe XPrv

-- | Behaves exactly like <a>subXPrvXPrv</a>, but deals with <a>Chain</a>
--   and <a>Prv</a>, rather than an <a>XPrv</a>.
subPrvPrv :: Chain -> Prv -> Index -> Maybe (Chain, Prv)

-- | Lazily derive all the child <a>XPrv</a> subkeys from a parent's
--   <a>XPrv</a>.
--   
--   The first child returned is the one at the given <a>Index</a>, if any,
--   and the subsequent childs are those immediately after it (see
--   <a>indexNext</a>).
--   
--   The returned <a>Index</a>es are not necessarily consecutive, since not
--   all <a>XPrv</a> and <a>Index</a> combinations are able to derive valid
--   keys. However, the produced <a>Index</a>es do increase monotonically.
--   
--   If the given <a>Index</a> is hardened, then all produced children will
--   have hardened <a>Index</a>es too. If the given <a>Index</a> is normal,
--   then all children will have normal <a>Index</a>es too. That is, this
--   function will never produce children with <a>Index</a>es belonging to
--   another group (normal vs. hardened).
subsXPrvXPrv :: XPrv -> Index -> [XPrv]

-- | Behaves exactly like <a>subsXPrvXPrv</a>, but deals with <a>Chain</a>
--   and <a>Prv</a>, rather than an <a>XPrv</a>.
subsPrvPrv :: Chain -> Prv -> Index -> [(Index, Chain, Prv)]

-- | Derive <a>XPub</a> subkey from a parent <a>XPrv</a> key.
--   
--   Notice that while <tt><a>subXPubXPub</a> (<a>xprvToXPub</a> v) xprv
--   i</tt> will fail with a hardened <a>Index</a>, <tt><a>subXPrvXPub</a>
--   v xprv i</tt> may succeed.
--   
--   Returns <a>Nothing</a> if the given inputs result in an invalid key.
subXPrvXPub :: Version -> XPrv -> Index -> Maybe XPub

-- | Behaves exactly like <a>subXPrvXPub</a>, but deals with <a>Chain</a>,
--   <a>Prv</a> and <a>Pub</a>, rather than an <a>XPrv</a> and <a>XPub</a>.
subPrvPub :: Chain -> Prv -> Index -> Maybe (Chain, Pub)

-- | Lazily derive all the <a>XPub</a> subkeys from a parent <a>XPrv</a>
--   key.
--   
--   The first child returned is the one at the given <a>Index</a>, if any,
--   and the subsequent childs are those immediately after it (see
--   <a>indexNext</a>).
--   
--   The returned <a>Index</a>es are not necessarily consecutive, since not
--   all <a>XPrv</a> and <a>Index</a> combinations are able to derive valid
--   keys. However, the produced <a>Index</a>es do increase monotonically.
--   
--   If the given <a>Index</a> is hardened, then all produced children will
--   have hardened <a>Index</a>es too. If the given <a>Index</a> is normal,
--   then all children will have normal <a>Index</a>es too. That is, this
--   function will never produce children with <a>Index</a>es belonging to
--   another group (normal vs. hardened).
--   
--   <i>Notice</i> that while <tt><a>subsXPubXPub</a> (<a>xprvToXPub</a> v)
--   xprv i</tt> will fail with a hardened <a>Index</a>,
--   <tt><a>subsXPrvXPub</a> v xprv i</tt> may succeed.
subsXPrvXPub :: Version -> XPrv -> Index -> [XPub]

-- | Behaves exactly like <a>subsXPrvXPub</a>, but deals with <a>Chain</a>,
--   <a>Prv</a> and <a>Pub</a>, rather than an <a>XPrv</a> and <a>XPub</a>.
subsPrvPub :: Chain -> Prv -> Index -> [(Index, Chain, Pub)]

-- | Extended private key.
data XPub
XPub :: Version -> Depth -> Fingerprint -> Index -> Chain -> Pub -> XPub
[xpub_version] :: XPub -> Version
[xpub_depth] :: XPub -> Depth
[xpub_fingerprint] :: XPub -> Fingerprint
[xpub_index] :: XPub -> Index
[xpub_chain] :: XPub -> Chain
[xpub_pub] :: XPub -> Pub

-- | Derive a <a>XPub</a> subkey from a parent <a>XPub</a> key.
--   
--   The given <a>Index</a> is expected to <i>not</i> be hardened.
--   
--   Returns <a>Nothing</a> if the given inputs result in an invalid key.
subXPubXPub :: XPub -> Index -> Maybe XPub

-- | Behaves exactly like <a>subXPubXPub</a>, but deals with <a>Chain</a>
--   and <a>Pub</a>, rather than an <a>XPub</a>.
subPubPub :: Chain -> Pub -> Index -> Maybe (Chain, Pub)

-- | Lazily derive all the <a>XPub</a> subkeys from a parent's <a>XPub</a>.
--   
--   The first child returned is the one at the given <a>Index</a>, if any,
--   and the subsequent childs are those immediately after it (see
--   <a>indexNext</a>).
--   
--   The returned <a>Index</a>es are not necessarily consecutive, since not
--   all <a>XPub</a> and <a>Index</a> combinations are able to derive valid
--   keys. However, the produced <a>Index</a>es do increase monotonically.
--   
--   The produced list will never include a hardened <a>Index</a>. If a
--   hardened <a>Index</a> is provided as input, the produced list will be
--   empty.
subsXPubXPub :: XPub -> Index -> [XPub]

-- | Behaves exactly like <a>subsXPubXPub</a>, but deals with <a>Chain</a>
--   and <a>Pub</a>, rather than an <a>XPub</a>.
subsPubPub :: Chain -> Pub -> Index -> [(Index, Chain, Pub)]

-- | Chain code.
--   
--   Construct with <a>chain</a>.
data Chain

-- | Construct a <a>Chain</a> code.
--   
--   See Bitcoin's <a>BIP-0032</a> for details.
--   
--   <a>Nothing</a> if the <a>ByteString</a> length is not 32.
chain :: ByteString -> Maybe Chain

-- | Obtain the 32 raw bytes inside a <a>Chain</a>.
unChain :: Chain -> ByteString

-- | A derivation path <a>Index</a>.
newtype Index
Index :: Word32 -> Index
[unIndex] :: Index -> Word32

-- | Whether a derivation path <a>Index</a> is hardened. That is,
--   &lt;math&gt; or larger.
indexIsHardened :: Index -> Bool

-- | Increment the given <a>Index</a> by one, but only if doing so would
--   result in a new <a>Index</a> in the same index group (normal vs.
--   hardened). Otherwise, returns <a>Nothing</a>.
indexNext :: Index -> Maybe Index

-- | Derivation path depth.
--   
--   <ul>
--   <li><tt>0</tt> for master nodes — <tt>m</tt></li>
--   <li><tt>1</tt> for level-1 derived keys — <tt>m/0'</tt>, or
--   <tt>m/13</tt>, or …</li>
--   <li><tt>2</tt> for level-2 derived keys — <tt>m/0'/28</tt>, or
--   <tt>m/44'/0'</tt>, or …</li>
--   <li>… up to <tt>255</tt>.</li>
--   </ul>
newtype Depth
Depth :: Word8 -> Depth
[unDepth] :: Depth -> Word8

-- | 4-byte fingerprint of a <a>Pub</a> key.
newtype Fingerprint
Fingerprint :: Word32 -> Fingerprint
[unFingerprint] :: Fingerprint -> Word32
fingerprint :: Pub -> Fingerprint

-- | Version bytes.
newtype Version
Version :: Word32 -> Version
[unVersion] :: Version -> Word32

-- | <tt>0x0488ade4</tt>, “xprv”, Bitcoin mainnet private.
version_xprv :: Version

-- | <tt>0x0488b21e</tt>, “xpub”, Bitcoin mainnet public.
version_xpub :: Version

-- | <tt>0x04358394</tt>, “tprv”, Bitcoin testnet private.
version_tprv :: Version

-- | <tt>0x043587cf</tt>, “tpub”, Bitcoin testnet public.
version_tpub :: Version

-- | <tt>0x019d9cfe</tt>, “Ltpv”, Litecoin mainnet private.
version_Ltpv :: Version

-- | <tt>0x019da462</tt>, “Ltub”, Litecoin mainnet public.
version_Ltub :: Version

-- | <tt>0x0436ef7d</tt>, “ttpv”, Litecoin testnet private.
version_ttpv :: Version

-- | <tt>0x0436f6e1</tt>, “ttub”, Litecoin testnet public.
version_ttub :: Version
instance GHC.Show.Show BIP32.XPrv
instance GHC.Classes.Eq BIP32.XPrv
instance GHC.Show.Show BIP32.XPub
instance GHC.Classes.Eq BIP32.XPub
instance GHC.Show.Show BIP32.Index
instance GHC.Classes.Ord BIP32.Index
instance GHC.Classes.Eq BIP32.Index
instance GHC.Classes.Eq BIP32.Chain
instance GHC.Show.Show BIP32.Fingerprint
instance GHC.Classes.Eq BIP32.Fingerprint
instance GHC.Show.Show BIP32.Depth
instance GHC.Classes.Eq BIP32.Depth
instance GHC.Show.Show BIP32.Version
instance GHC.Classes.Eq BIP32.Version
instance GHC.Show.Show BIP32.Chain