{-# LANGUAGE DeriveTraversable #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE PolyKinds #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}

-- | Intended for qualified import
--
-- > import Ouroboros.Consensus.Fragment.Validated (ValidatedFragment)
-- > import qualified Ouroboros.Consensus.Fragment.Validated as VF
module Ouroboros.Consensus.Fragment.Validated (
    ValidatedFragment (ValidatedFragment)
  , validatedFragment
  , validatedLedger
  , validatedTip
    -- * Monadic
  , newM
  ) where

import           GHC.Stack
import           Ouroboros.Consensus.Block
import           Ouroboros.Consensus.Ledger.Abstract
import           Ouroboros.Consensus.Util.Assert
import           Ouroboros.Consensus.Util.IOLike hiding (invariant)
import           Ouroboros.Network.AnchoredFragment (AnchoredFragment)
import qualified Ouroboros.Network.AnchoredFragment as AF

-- | Validated chain fragment along with the ledger state after validation
--
-- INVARIANT:
--
-- > AF.headPoint validatedFragment == ledgerTipPoint validatedLedger
--
-- The invariant is only checked on construction, maintaining it afterwards is
-- up to the user.
data ValidatedFragment b l = UnsafeValidatedFragment {
      -- | Chain fragment
      forall b l. ValidatedFragment b l -> AnchoredFragment b
validatedFragment :: !(AnchoredFragment b)

      -- | Ledger after validation
    , forall b l. ValidatedFragment b l -> l
validatedLedger   :: !l
    }
  deriving ((forall a b.
 (a -> b) -> ValidatedFragment b a -> ValidatedFragment b b)
-> (forall a b.
    a -> ValidatedFragment b b -> ValidatedFragment b a)
-> Functor (ValidatedFragment b)
forall a b. a -> ValidatedFragment b b -> ValidatedFragment b a
forall a b.
(a -> b) -> ValidatedFragment b a -> ValidatedFragment b b
forall b a b. a -> ValidatedFragment b b -> ValidatedFragment b a
forall b a b.
(a -> b) -> ValidatedFragment b a -> ValidatedFragment b b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall b a b.
(a -> b) -> ValidatedFragment b a -> ValidatedFragment b b
fmap :: forall a b.
(a -> b) -> ValidatedFragment b a -> ValidatedFragment b b
$c<$ :: forall b a b. a -> ValidatedFragment b b -> ValidatedFragment b a
<$ :: forall a b. a -> ValidatedFragment b b -> ValidatedFragment b a
Functor, (forall m. Monoid m => ValidatedFragment b m -> m)
-> (forall m a. Monoid m => (a -> m) -> ValidatedFragment b a -> m)
-> (forall m a. Monoid m => (a -> m) -> ValidatedFragment b a -> m)
-> (forall a b. (a -> b -> b) -> b -> ValidatedFragment b a -> b)
-> (forall a b. (a -> b -> b) -> b -> ValidatedFragment b a -> b)
-> (forall b a. (b -> a -> b) -> b -> ValidatedFragment b a -> b)
-> (forall b a. (b -> a -> b) -> b -> ValidatedFragment b a -> b)
-> (forall a. (a -> a -> a) -> ValidatedFragment b a -> a)
-> (forall a. (a -> a -> a) -> ValidatedFragment b a -> a)
-> (forall a. ValidatedFragment b a -> [a])
-> (forall a. ValidatedFragment b a -> Bool)
-> (forall a. ValidatedFragment b a -> Int)
-> (forall a. Eq a => a -> ValidatedFragment b a -> Bool)
-> (forall a. Ord a => ValidatedFragment b a -> a)
-> (forall a. Ord a => ValidatedFragment b a -> a)
-> (forall a. Num a => ValidatedFragment b a -> a)
-> (forall a. Num a => ValidatedFragment b a -> a)
-> Foldable (ValidatedFragment b)
forall a. Eq a => a -> ValidatedFragment b a -> Bool
forall a. Num a => ValidatedFragment b a -> a
forall a. Ord a => ValidatedFragment b a -> a
forall m. Monoid m => ValidatedFragment b m -> m
forall a. ValidatedFragment b a -> Bool
forall a. ValidatedFragment b a -> Int
forall a. ValidatedFragment b a -> [a]
forall a. (a -> a -> a) -> ValidatedFragment b a -> a
forall b a. Eq a => a -> ValidatedFragment b a -> Bool
forall b a. Num a => ValidatedFragment b a -> a
forall b a. Ord a => ValidatedFragment b a -> a
forall m a. Monoid m => (a -> m) -> ValidatedFragment b a -> m
forall b m. Monoid m => ValidatedFragment b m -> m
forall b a. ValidatedFragment b a -> Bool
forall b a. ValidatedFragment b a -> Int
forall b a. ValidatedFragment b a -> [a]
forall b a. (b -> a -> b) -> b -> ValidatedFragment b a -> b
forall a b. (a -> b -> b) -> b -> ValidatedFragment b a -> b
forall b a. (a -> a -> a) -> ValidatedFragment b a -> a
forall b m a. Monoid m => (a -> m) -> ValidatedFragment b a -> m
forall b b a. (b -> a -> b) -> b -> ValidatedFragment b a -> b
forall b a b. (a -> b -> b) -> b -> ValidatedFragment b a -> b
forall (t :: * -> *).
(forall m. Monoid m => t m -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. t a -> [a])
-> (forall a. t a -> Bool)
-> (forall a. t a -> Int)
-> (forall a. Eq a => a -> t a -> Bool)
-> (forall a. Ord a => t a -> a)
-> (forall a. Ord a => t a -> a)
-> (forall a. Num a => t a -> a)
-> (forall a. Num a => t a -> a)
-> Foldable t
$cfold :: forall b m. Monoid m => ValidatedFragment b m -> m
fold :: forall m. Monoid m => ValidatedFragment b m -> m
$cfoldMap :: forall b m a. Monoid m => (a -> m) -> ValidatedFragment b a -> m
foldMap :: forall m a. Monoid m => (a -> m) -> ValidatedFragment b a -> m
$cfoldMap' :: forall b m a. Monoid m => (a -> m) -> ValidatedFragment b a -> m
foldMap' :: forall m a. Monoid m => (a -> m) -> ValidatedFragment b a -> m
$cfoldr :: forall b a b. (a -> b -> b) -> b -> ValidatedFragment b a -> b
foldr :: forall a b. (a -> b -> b) -> b -> ValidatedFragment b a -> b
$cfoldr' :: forall b a b. (a -> b -> b) -> b -> ValidatedFragment b a -> b
foldr' :: forall a b. (a -> b -> b) -> b -> ValidatedFragment b a -> b
$cfoldl :: forall b b a. (b -> a -> b) -> b -> ValidatedFragment b a -> b
foldl :: forall b a. (b -> a -> b) -> b -> ValidatedFragment b a -> b
$cfoldl' :: forall b b a. (b -> a -> b) -> b -> ValidatedFragment b a -> b
foldl' :: forall b a. (b -> a -> b) -> b -> ValidatedFragment b a -> b
$cfoldr1 :: forall b a. (a -> a -> a) -> ValidatedFragment b a -> a
foldr1 :: forall a. (a -> a -> a) -> ValidatedFragment b a -> a
$cfoldl1 :: forall b a. (a -> a -> a) -> ValidatedFragment b a -> a
foldl1 :: forall a. (a -> a -> a) -> ValidatedFragment b a -> a
$ctoList :: forall b a. ValidatedFragment b a -> [a]
toList :: forall a. ValidatedFragment b a -> [a]
$cnull :: forall b a. ValidatedFragment b a -> Bool
null :: forall a. ValidatedFragment b a -> Bool
$clength :: forall b a. ValidatedFragment b a -> Int
length :: forall a. ValidatedFragment b a -> Int
$celem :: forall b a. Eq a => a -> ValidatedFragment b a -> Bool
elem :: forall a. Eq a => a -> ValidatedFragment b a -> Bool
$cmaximum :: forall b a. Ord a => ValidatedFragment b a -> a
maximum :: forall a. Ord a => ValidatedFragment b a -> a
$cminimum :: forall b a. Ord a => ValidatedFragment b a -> a
minimum :: forall a. Ord a => ValidatedFragment b a -> a
$csum :: forall b a. Num a => ValidatedFragment b a -> a
sum :: forall a. Num a => ValidatedFragment b a -> a
$cproduct :: forall b a. Num a => ValidatedFragment b a -> a
product :: forall a. Num a => ValidatedFragment b a -> a
Foldable, Functor (ValidatedFragment b)
Foldable (ValidatedFragment b)
(Functor (ValidatedFragment b), Foldable (ValidatedFragment b)) =>
(forall (f :: * -> *) a b.
 Applicative f =>
 (a -> f b) -> ValidatedFragment b a -> f (ValidatedFragment b b))
-> (forall (f :: * -> *) a.
    Applicative f =>
    ValidatedFragment b (f a) -> f (ValidatedFragment b a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> ValidatedFragment b a -> m (ValidatedFragment b b))
-> (forall (m :: * -> *) a.
    Monad m =>
    ValidatedFragment b (m a) -> m (ValidatedFragment b a))
-> Traversable (ValidatedFragment b)
forall b. Functor (ValidatedFragment b)
forall b. Foldable (ValidatedFragment b)
forall b (m :: * -> *) a.
Monad m =>
ValidatedFragment b (m a) -> m (ValidatedFragment b a)
forall b (f :: * -> *) a.
Applicative f =>
ValidatedFragment b (f a) -> f (ValidatedFragment b a)
forall b (m :: * -> *) a b.
Monad m =>
(a -> m b) -> ValidatedFragment b a -> m (ValidatedFragment b b)
forall b (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> ValidatedFragment b a -> f (ValidatedFragment b b)
forall (t :: * -> *).
(Functor t, Foldable t) =>
(forall (f :: * -> *) a b.
 Applicative f =>
 (a -> f b) -> t a -> f (t b))
-> (forall (f :: * -> *) a. Applicative f => t (f a) -> f (t a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> t a -> m (t b))
-> (forall (m :: * -> *) a. Monad m => t (m a) -> m (t a))
-> Traversable t
forall (m :: * -> *) a.
Monad m =>
ValidatedFragment b (m a) -> m (ValidatedFragment b a)
forall (f :: * -> *) a.
Applicative f =>
ValidatedFragment b (f a) -> f (ValidatedFragment b a)
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> ValidatedFragment b a -> m (ValidatedFragment b b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> ValidatedFragment b a -> f (ValidatedFragment b b)
$ctraverse :: forall b (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> ValidatedFragment b a -> f (ValidatedFragment b b)
traverse :: forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> ValidatedFragment b a -> f (ValidatedFragment b b)
$csequenceA :: forall b (f :: * -> *) a.
Applicative f =>
ValidatedFragment b (f a) -> f (ValidatedFragment b a)
sequenceA :: forall (f :: * -> *) a.
Applicative f =>
ValidatedFragment b (f a) -> f (ValidatedFragment b a)
$cmapM :: forall b (m :: * -> *) a b.
Monad m =>
(a -> m b) -> ValidatedFragment b a -> m (ValidatedFragment b b)
mapM :: forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> ValidatedFragment b a -> m (ValidatedFragment b b)
$csequence :: forall b (m :: * -> *) a.
Monad m =>
ValidatedFragment b (m a) -> m (ValidatedFragment b a)
sequence :: forall (m :: * -> *) a.
Monad m =>
ValidatedFragment b (m a) -> m (ValidatedFragment b a)
Traversable)

{-# COMPLETE ValidatedFragment #-}

pattern ValidatedFragment ::
     (GetTip l, HasHeader b, HeaderHash b ~ HeaderHash l, HasCallStack)
  => AnchoredFragment b -> l mk -> ValidatedFragment b (l mk)
pattern $mValidatedFragment :: forall {r} {l :: LedgerStateKind} {b} {mk :: MapKind}.
(GetTip l, HasHeader b, HeaderHash b ~ HeaderHash l,
 HasCallStack) =>
ValidatedFragment b (l mk)
-> (AnchoredFragment b -> l mk -> r) -> ((# #) -> r) -> r
$bValidatedFragment :: forall (l :: LedgerStateKind) b (mk :: MapKind).
(GetTip l, HasHeader b, HeaderHash b ~ HeaderHash l,
 HasCallStack) =>
AnchoredFragment b -> l mk -> ValidatedFragment b (l mk)
ValidatedFragment f l <- UnsafeValidatedFragment f l
  where
    ValidatedFragment AnchoredFragment b
f l mk
l = AnchoredFragment b -> l mk -> ValidatedFragment b (l mk)
forall (l :: LedgerStateKind) (mk :: MapKind) b.
(GetTip l, HasHeader b, HeaderHash b ~ HeaderHash l,
 HasCallStack) =>
AnchoredFragment b -> l mk -> ValidatedFragment b (l mk)
new AnchoredFragment b
f l mk
l

validatedTip :: HasHeader b => ValidatedFragment b l -> Point b
validatedTip :: forall b l. HasHeader b => ValidatedFragment b l -> Point b
validatedTip = AnchoredFragment b -> Point b
forall block.
HasHeader block =>
AnchoredFragment block -> Point block
AF.headPoint (AnchoredFragment b -> Point b)
-> (ValidatedFragment b l -> AnchoredFragment b)
-> ValidatedFragment b l
-> Point b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ValidatedFragment b l -> AnchoredFragment b
forall b l. ValidatedFragment b l -> AnchoredFragment b
validatedFragment

invariant ::
     forall l mk b.
     (GetTip l , HasHeader b, HeaderHash b ~ HeaderHash l)
  => ValidatedFragment b (l mk)
  -> Either String ()
invariant :: forall (l :: LedgerStateKind) (mk :: MapKind) b.
(GetTip l, HasHeader b, HeaderHash b ~ HeaderHash l) =>
ValidatedFragment b (l mk) -> Either String ()
invariant (ValidatedFragment AnchoredFragment b
fragment l mk
ledger) =
  Point l -> AnchoredFragment b -> Either String ()
forall {k} (l :: k) b.
(HeaderHash b ~ HeaderHash l, HasHeader b) =>
Point l -> AnchoredFragment b -> Either String ()
pointInvariant (l mk -> Point l
forall (mk :: MapKind). l mk -> Point l
forall (l :: LedgerStateKind) (mk :: MapKind).
GetTip l =>
l mk -> Point l
getTip l mk
ledger :: Point l) AnchoredFragment b
fragment

pointInvariant ::
     forall l b. (HeaderHash b ~ HeaderHash l, HasHeader b)
  => Point l
  -> AnchoredFragment b
  -> Either String ()
pointInvariant :: forall {k} (l :: k) b.
(HeaderHash b ~ HeaderHash l, HasHeader b) =>
Point l -> AnchoredFragment b -> Either String ()
pointInvariant Point l
ledgerTip0 AnchoredFragment b
fragment
    | Point b
ledgerTip Point b -> Point b -> Bool
forall a. Eq a => a -> a -> Bool
/= Point b
headPoint
    = String -> Either String ()
forall a b. a -> Either a b
Left (String -> Either String ()) -> String -> Either String ()
forall a b. (a -> b) -> a -> b
$ [String] -> String
forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat [
          String
"ledger tip "
        , Point b -> String
forall a. Show a => a -> String
show Point b
ledgerTip
        , String
" /= head point "
        , Point b -> String
forall a. Show a => a -> String
show Point b
headPoint
        ]
    | Bool
otherwise
    = () -> Either String ()
forall a b. b -> Either a b
Right ()
  where
   ledgerTip, headPoint :: Point b
   ledgerTip :: Point b
ledgerTip = Point l -> Point b
forall {k1} {k2} (b :: k1) (b' :: k2).
Coercible (HeaderHash b) (HeaderHash b') =>
Point b -> Point b'
castPoint Point l
ledgerTip0
   headPoint :: Point b
headPoint = Point b -> Point b
forall {k1} {k2} (b :: k1) (b' :: k2).
Coercible (HeaderHash b) (HeaderHash b') =>
Point b -> Point b'
castPoint (Point b -> Point b) -> Point b -> Point b
forall a b. (a -> b) -> a -> b
$ AnchoredFragment b -> Point b
forall block.
HasHeader block =>
AnchoredFragment block -> Point block
AF.headPoint AnchoredFragment b
fragment

-- | Constructor for 'ValidatedFragment' that checks the invariant
new ::
     forall l mk b.
     (GetTip l, HasHeader b, HeaderHash b ~ HeaderHash l, HasCallStack)
  => AnchoredFragment b
  -> l mk
  -> ValidatedFragment b (l mk)
new :: forall (l :: LedgerStateKind) (mk :: MapKind) b.
(GetTip l, HasHeader b, HeaderHash b ~ HeaderHash l,
 HasCallStack) =>
AnchoredFragment b -> l mk -> ValidatedFragment b (l mk)
new AnchoredFragment b
fragment l mk
ledger =
    Either String ()
-> ValidatedFragment b (l mk) -> ValidatedFragment b (l mk)
forall a. HasCallStack => Either String () -> a -> a
assertWithMsg (ValidatedFragment b (l mk) -> Either String ()
forall (l :: LedgerStateKind) (mk :: MapKind) b.
(GetTip l, HasHeader b, HeaderHash b ~ HeaderHash l) =>
ValidatedFragment b (l mk) -> Either String ()
invariant ValidatedFragment b (l mk)
validated) (ValidatedFragment b (l mk) -> ValidatedFragment b (l mk))
-> ValidatedFragment b (l mk) -> ValidatedFragment b (l mk)
forall a b. (a -> b) -> a -> b
$
      ValidatedFragment b (l mk)
validated
  where
    validated :: ValidatedFragment b (l mk)
    validated :: ValidatedFragment b (l mk)
validated = UnsafeValidatedFragment {
          validatedFragment :: AnchoredFragment b
validatedFragment = AnchoredFragment b
fragment
        , validatedLedger :: l mk
validatedLedger   = l mk
ledger
        }

{-------------------------------------------------------------------------------
  Monadic
-------------------------------------------------------------------------------}

invariantM ::
     forall m l b.
     (MonadSTM m, GetTipSTM m l, HasHeader b, HeaderHash b ~ HeaderHash l)
  => ValidatedFragment b l
  -> m (Either String ())
invariantM :: forall (m :: * -> *) l b.
(MonadSTM m, GetTipSTM m l, HasHeader b,
 HeaderHash b ~ HeaderHash l) =>
ValidatedFragment b l -> m (Either String ())
invariantM (UnsafeValidatedFragment AnchoredFragment b
fragment l
ledger) = do
    ledgerTip <- l -> m (Point l)
forall (m :: * -> *) l.
(GetTipSTM m l, MonadSTM m) =>
l -> m (Point l)
getTipM l
ledger
    pure $ pointInvariant ledgerTip fragment

-- | Constructor for 'ValidatedFragment' that checks the invariant
newM ::
     forall m l b.
     (MonadSTM m, GetTipSTM m l, HasHeader b, HeaderHash b ~ HeaderHash l, HasCallStack)
  => AnchoredFragment b
  -> l
  -> m (ValidatedFragment b l)
newM :: forall (m :: * -> *) l b.
(MonadSTM m, GetTipSTM m l, HasHeader b,
 HeaderHash b ~ HeaderHash l, HasCallStack) =>
AnchoredFragment b -> l -> m (ValidatedFragment b l)
newM AnchoredFragment b
fragment l
ledger = do
    msg <- ValidatedFragment b l -> m (Either String ())
forall (m :: * -> *) l b.
(MonadSTM m, GetTipSTM m l, HasHeader b,
 HeaderHash b ~ HeaderHash l) =>
ValidatedFragment b l -> m (Either String ())
invariantM ValidatedFragment b l
validated
    pure $ assertWithMsg msg validated
  where
    validated :: ValidatedFragment b l
    validated :: ValidatedFragment b l
validated = UnsafeValidatedFragment {
          validatedFragment :: AnchoredFragment b
validatedFragment = AnchoredFragment b
fragment
        , validatedLedger :: l
validatedLedger   = l
ledger
        }