foldClient with ledger state #135
Conversation
There was a problem hiding this comment.
I think we need two variants of foldClient' - one that keeps track of the ledger state, and one that doesn't. It should be possible for users of the library to opt out of keeping k versions of the entire ledger state in memory.
Maybe we could add some parameters like this
-- | Whether to keep track of the full ledger state on the client
data LedgerStateMode = FullLedgerState | NoLedgerState
data LedgerStateArgs mode where
NoLedgerStateArgs :: LedgerStateArgs 'NoLedgerState
LedgerStateArgs :: LedgerState -> LedgerStateArgs 'FullLedgerState
data LedgerStateUpdate mode where
NoLedgerStateUpdate :: LedgerStateUpdate 'NoLedgerState
LedgerStateUpdate :: LedgerState -> [LedgerEvent] -> LedgerStateUpdate 'FullLedgerState
foldClient' ::
forall s w mode.
Monoid w =>
s -- ^ Initial state
-> LedgerStateArgs mode -- ^ Initial ledger state arguments
-> Env -- ^ Node connection data
-> (ChainPoint -> w -> s -> IO (w, s)) -- ^ Rollback
-> (CatchingUp -> s -> LedgerStateUpdate mode -> BlockInMode CardanoMode -> IO (Maybe (w, s))) -- ^ Fold
-> PipelinedLedgerStateClientWhat do you think?
We could even add a field for the validation mode in LedgerStateArgs (to resolve the TODO in l. 181)
| newState <- accumulate | ||
| cu | ||
| currentState | ||
| currentLedgerState |
There was a problem hiding this comment.
Here we're passing the old ledger state to accumulate, but in foldBlocks the accumulator gets the new ledger state, with the block applied. Is this intentional? (same for currentLedgerEvents)
There was a problem hiding this comment.
You are right!
| env | ||
| (\_ _ !s -> pure ((), s)) | ||
| (\c !s -> fmap (fmap pure) . applyBlock c s) | ||
| (\c !s ls le -> fmap (fmap pure) . accumulate c s ls le) |
There was a problem hiding this comment.
I believe there should be a ! on ls
| @@ -65,6 +74,20 @@ data CatchingUp = | |||
| deriving stock (Eq, Show, Generic) | |||
| deriving anyclass (FromJSON, ToJSON) | |||
|
|
|||
| data LedgerStateMode = FullLedgerState | NoLedgerState | |||
There was a problem hiding this comment.
Some haddocks explaining what this does (switching between ledger state / no ledger state) would be nice
|
Thanks for the review! |
|
@the-headless-ghost do you feel up to porting this to the |
No description provided.