{-# LANGUAGE DeriveAnyClass #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE LambdaCase #-} {-# LANGUAGE OverloadedStrings #-} module Haskoin.Store.Common ( Limit , Offset , StoreRead(..) , StoreWrite(..) , StoreEvent(..) , PubExcept(..) , xPubBalsTxs , xPubBalsUnspents , getTransaction , blockAtOrBefore , applyOffset , applyLimit , applyOffsetLimit , applyOffsetC , applyLimitC , applyOffsetLimitC , sortTxs , nub' ) where import Conduit (ConduitT, dropC, mapC, takeC) import Control.DeepSeq (NFData) import Control.Exception (Exception) import Control.Monad (mzero) import Control.Monad.Trans (lift) import Control.Monad.Trans.Maybe (MaybeT (..), runMaybeT) import Data.ByteString (ByteString) import Data.Function (on) import Data.Hashable (Hashable) import qualified Data.HashSet as H import Data.IntMap.Strict (IntMap) import Data.List (sortBy) import Data.Maybe (listToMaybe) import Data.Serialize (Serialize (..)) import Data.Word (Word32, Word64) import GHC.Generics (Generic) import Haskoin (Address, BlockHash, BlockHeader (..), BlockHeight, KeyIndex, Network (..), OutPoint (..), RejectCode (..), Tx (..), TxHash (..), TxIn (..), XPubKey (..), deriveAddr, deriveCompatWitnessAddr, deriveWitnessAddr, pubSubKey, txHash) import Haskoin.Node (Peer) import Haskoin.Store.Data (Balance (..), BlockData (..), BlockRef, BlockTx (..), DeriveType (..), Spender, Transaction, TxData, UnixTime, Unspent, XPubBal (..), XPubSpec (..), XPubSummary (..), XPubUnspent (..), nullBalance, toTransaction) import Network.Socket (SockAddr) type DeriveAddr = XPubKey -> KeyIndex -> Address type Offset = Word32 type Limit = Word32 class Monad m => StoreRead m where getNetwork :: m Network getBestBlock :: m (Maybe BlockHash) getBlocksAtHeight :: BlockHeight -> m [BlockHash] getBlock :: BlockHash -> m (Maybe BlockData) getTxData :: TxHash -> m (Maybe TxData) getSpenders :: TxHash -> m (IntMap Spender) getSpender :: OutPoint -> m (Maybe Spender) getBalance :: Address -> m Balance getBalance a = head <$> getBalances [a] getBalances :: [Address] -> m [Balance] getBalances as = mapM getBalance as getAddressesTxs :: [Address] -> Maybe BlockRef -> Maybe Limit -> m [BlockTx] getAddressTxs :: Address -> Maybe BlockRef -> Maybe Limit -> m [BlockTx] getAddressTxs a = getAddressesTxs [a] getUnspent :: OutPoint -> m (Maybe Unspent) getAddressUnspents :: Address -> Maybe BlockRef -> Maybe Limit -> m [Unspent] getAddressUnspents a = getAddressesUnspents [a] getAddressesUnspents :: [Address] -> Maybe BlockRef -> Maybe Limit -> m [Unspent] getMempool :: m [BlockTx] xPubBals :: XPubSpec -> m [XPubBal] xPubBals xpub = do igap <- getInitialGap gap <- getMaxGap ext1 <- derive_until_gap gap 0 (take (fromIntegral igap) (aderiv 0 0)) if all (nullBalance . xPubBal) ext1 then return [] else do ext2 <- derive_until_gap gap 0 (aderiv 0 igap) chg <- derive_until_gap gap 1 (aderiv 1 0) return (ext1 <> ext2 <> chg) where aderiv m n = deriveAddresses (deriveFunction (xPubDeriveType xpub)) (pubSubKey (xPubSpecKey xpub) m) n xbalance m b n = XPubBal {xPubBalPath = [m, n], xPubBal = b} derive_until_gap _ _ [] = return [] derive_until_gap gap m as = do let (as1, as2) = splitAt (fromIntegral gap) as bs <- getBalances (map snd as1) let xbs = zipWith (xbalance m) bs (map fst as1) if all nullBalance bs then return xbs else (xbs <>) <$> derive_until_gap gap m as2 xPubSummary :: XPubSpec -> m XPubSummary xPubSummary xpub = do bs <- filter (not . nullBalance . xPubBal) <$> xPubBals xpub let ex = foldl max 0 [i | XPubBal {xPubBalPath = [0, i]} <- bs] ch = foldl max 0 [i | XPubBal {xPubBalPath = [1, i]} <- bs] uc = sum [ c | XPubBal {xPubBal = Balance {balanceUnspentCount = c}} <- bs ] xt = [b | b@XPubBal {xPubBalPath = [0, _]} <- bs] rx = sum [ r | XPubBal {xPubBal = Balance {balanceTotalReceived = r}} <- xt ] return XPubSummary { xPubSummaryConfirmed = sum (map (balanceAmount . xPubBal) bs) , xPubSummaryZero = sum (map (balanceZero . xPubBal) bs) , xPubSummaryReceived = rx , xPubUnspentCount = uc , xPubChangeIndex = ch , xPubExternalIndex = ex } xPubUnspents :: XPubSpec -> Maybe BlockRef -> Offset -> Maybe Limit -> m [XPubUnspent] xPubUnspents xpub start offset limit = do xs <- filter positive <$> xPubBals xpub applyOffsetLimit offset limit <$> go xs where positive XPubBal {xPubBal = Balance {balanceUnspentCount = c}} = c > 0 go [] = return [] go (XPubBal {xPubBalPath = p, xPubBal = Balance {balanceAddress = a}}:xs) = do uns <- getAddressUnspents a start limit let xuns = map (\t -> XPubUnspent {xPubUnspentPath = p, xPubUnspent = t}) uns (xuns <>) <$> go xs xPubTxs :: XPubSpec -> Maybe BlockRef -> Offset -> Maybe Limit -> m [BlockTx] xPubTxs xpub start offset limit = do bs <- xPubBals xpub let as = map (balanceAddress . xPubBal) bs ts <- concat <$> mapM (\a -> getAddressTxs a start limit) as let ts' = sortBy (flip compare `on` blockTxBlock) (nub' ts) return $ applyOffsetLimit offset limit ts' getMaxGap :: m Word32 getInitialGap :: m Word32 class StoreWrite m where setBest :: BlockHash -> m () insertBlock :: BlockData -> m () setBlocksAtHeight :: [BlockHash] -> BlockHeight -> m () insertTx :: TxData -> m () insertSpender :: OutPoint -> Spender -> m () deleteSpender :: OutPoint -> m () insertAddrTx :: Address -> BlockTx -> m () deleteAddrTx :: Address -> BlockTx -> m () insertAddrUnspent :: Address -> Unspent -> m () deleteAddrUnspent :: Address -> Unspent -> m () setMempool :: [BlockTx] -> m () setBalance :: Balance -> m () insertUnspent :: Unspent -> m () deleteUnspent :: OutPoint -> m () deriveAddresses :: DeriveAddr -> XPubKey -> Word32 -> [(Word32, Address)] deriveAddresses derive xpub start = map (\i -> (i, derive xpub i)) [start ..] deriveFunction :: DeriveType -> DeriveAddr deriveFunction DeriveNormal i = fst . deriveAddr i deriveFunction DeriveP2SH i = fst . deriveCompatWitnessAddr i deriveFunction DeriveP2WPKH i = fst . deriveWitnessAddr i xPubBalsUnspents :: StoreRead m => [XPubBal] -> Maybe BlockRef -> Offset -> Maybe Limit -> m [XPubUnspent] xPubBalsUnspents bals start offset limit = do let xs = filter positive bals applyOffsetLimit offset limit <$> go xs where positive XPubBal {xPubBal = Balance {balanceUnspentCount = c}} = c > 0 go [] = return [] go (XPubBal {xPubBalPath = p, xPubBal = Balance {balanceAddress = a}}:xs) = do uns <- getAddressUnspents a start limit let xuns = map (\t -> XPubUnspent {xPubUnspentPath = p, xPubUnspent = t}) uns (xuns <>) <$> go xs xPubBalsTxs :: StoreRead m => [XPubBal] -> Maybe BlockRef -> Offset -> Maybe Limit -> m [BlockTx] xPubBalsTxs bals start offset limit = do let as = map balanceAddress . filter (not . nullBalance) $ map xPubBal bals ts <- concat <$> mapM (\a -> getAddressTxs a start limit) as let ts' = sortBy (flip compare `on` blockTxBlock) (nub' ts) return $ applyOffsetLimit offset limit ts' getTransaction :: (Monad m, StoreRead m) => TxHash -> m (Maybe Transaction) getTransaction h = runMaybeT $ do d <- MaybeT $ getTxData h sm <- lift $ getSpenders h return $ toTransaction d sm blockAtOrBefore :: (Monad m, StoreRead m) => UnixTime -> m (Maybe BlockData) blockAtOrBefore q = runMaybeT $ do a <- g 0 b <- MaybeT getBestBlock >>= MaybeT . getBlock f a b where f a b | t b <= q = return b | t a > q = mzero | h b - h a == 1 = return a | otherwise = do let x = h a + (h b - h a) `div` 2 m <- g x if t m > q then f a m else f m b g x = MaybeT (listToMaybe <$> getBlocksAtHeight x) >>= MaybeT . getBlock h = blockDataHeight t = fromIntegral . blockTimestamp . blockDataHeader -- | Events that the store can generate. data StoreEvent = StoreBestBlock !BlockHash -- ^ new best block | StoreMempoolNew !TxHash -- ^ new mempool transaction | StorePeerConnected !Peer !SockAddr -- ^ new peer connected | StorePeerDisconnected !Peer !SockAddr -- ^ peer has disconnected | StorePeerPong !Peer !Word64 -- ^ peer responded 'Ping' | StoreTxAvailable !Peer ![TxHash] -- ^ peer inv transactions | StoreTxReject !Peer !TxHash !RejectCode !ByteString -- ^ peer rejected transaction | StoreTxDeleted !TxHash -- ^ transaction deleted from store | StoreBlockReverted !BlockHash -- ^ block no longer head of main chain data PubExcept = PubNoPeers | PubReject RejectCode | PubTimeout | PubPeerDisconnected deriving (Eq, NFData, Generic, Serialize) instance Show PubExcept where show PubNoPeers = "no peers" show (PubReject c) = "rejected: " <> case c of RejectMalformed -> "malformed" RejectInvalid -> "invalid" RejectObsolete -> "obsolete" RejectDuplicate -> "duplicate" RejectNonStandard -> "not standard" RejectDust -> "dust" RejectInsufficientFee -> "insufficient fee" RejectCheckpoint -> "checkpoint" show PubTimeout = "peer timeout or silent rejection" show PubPeerDisconnected = "peer disconnected" instance Exception PubExcept applyOffsetLimit :: Offset -> Maybe Limit -> [a] -> [a] applyOffsetLimit offset limit = applyLimit limit . applyOffset offset applyOffset :: Offset -> [a] -> [a] applyOffset = drop . fromIntegral applyLimit :: Maybe Limit -> [a] -> [a] applyLimit Nothing = id applyLimit (Just l) = take (fromIntegral l) applyOffsetLimitC :: Monad m => Offset -> Maybe Limit -> ConduitT i i m () applyOffsetLimitC offset limit = applyOffsetC offset >> applyLimitC limit applyOffsetC :: Monad m => Offset -> ConduitT i i m () applyOffsetC = dropC . fromIntegral applyLimitC :: Monad m => Maybe Limit -> ConduitT i i m () applyLimitC Nothing = mapC id applyLimitC (Just l) = takeC (fromIntegral l) sortTxs :: [Tx] -> [(Word32, Tx)] sortTxs txs = go [] thset $ zip [0 ..] txs where thset = H.fromList (map txHash txs) go [] _ [] = [] go orphans ths [] = go [] ths orphans go orphans ths ((i, tx):xs) = let ops = map (outPointHash . prevOutput) (txIn tx) orp = any (`H.member` ths) ops in if orp then go ((i, tx) : orphans) ths xs else (i, tx) : go orphans (txHash tx `H.delete` ths) xs nub' :: (Eq a, Hashable a) => [a] -> [a] nub' = H.toList . H.fromList