Copyright	© 2018-2020 IOHK
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Cardano.Wallet.DB.Pure.Implementation

Contents

Model Types
Model Operation Types
Model database functions

Description

An implementation of the wallet database using only pure functions.

These functions and types model the behaviour of the SQLite database backend, and are used for QuickCheck state machine testing, and the MVar database backend.

Synopsis

data Database wid s xprv = Database {
- wallets :: !( Map wid ( WalletDatabase s xprv))
- txs :: !( Map ( Hash "Tx") Tx )
}
data WalletDatabase s xprv = WalletDatabase {
- checkpoints :: !( Map SlotNo ( Wallet s))
- certificates :: !( Map SlotNo ( Maybe PoolId ))
- stakeKeys :: !( Map SlotNo StakeKeyCertificate )
- metadata :: ! WalletMetadata
- txHistory :: !( Map ( Hash "Tx") TxMeta )
- xprv :: !( Maybe xprv)
- genesisParameters :: ! GenesisParameters
- rewardAccountBalance :: ! Coin
- submittedTxs :: !( Map ( Hash "Tx") ( SealedTx , SlotNo ))
}
emptyDatabase :: Ord wid => Database wid s xprv
type TxHistory = [( Tx , TxMeta )]
type TxHistoryMap = Map ( Hash "Tx") ( Tx , TxMeta )
filterTxHistory :: Maybe Coin -> SortOrder -> Range SlotNo -> TxHistory -> TxHistory
type ModelOp wid s xprv a = Database wid s xprv -> ( Either ( Err wid) a, Database wid s xprv)
data Err wid
- = NoSuchWallet wid
- | WalletAlreadyExists wid
- | NoSuchTx wid ( Hash "Tx")
- | CantRemoveTxInLedger wid ( Hash "Tx")
mCleanDB :: Ord wid => ModelOp wid s xprv ()
mInitializeWallet :: forall wid s xprv. Ord wid => wid -> Wallet s -> WalletMetadata -> TxHistory -> GenesisParameters -> ModelOp wid s xprv ()
mRemoveWallet :: Ord wid => wid -> ModelOp wid s xprv ()
mListWallets :: Ord wid => ModelOp wid s xprv [wid]
mPutCheckpoint :: Ord wid => wid -> Wallet s -> ModelOp wid s xprv ()
mReadCheckpoint :: Ord wid => wid -> ModelOp wid s xprv ( Maybe ( Wallet s))
mListCheckpoints :: Ord wid => wid -> ModelOp wid s xprv [ ChainPoint ]
mRollbackTo :: Ord wid => wid -> Slot -> ModelOp wid s xprv ChainPoint
mPutWalletMeta :: Ord wid => wid -> WalletMetadata -> ModelOp wid s xprv ()
mReadWalletMeta :: Ord wid => TimeInterpreter Identity -> wid -> ModelOp wid s xprv ( Maybe WalletMetadata )
mPutDelegationCertificate :: Ord wid => wid -> DelegationCertificate -> SlotNo -> ModelOp wid s xprv ()
mIsStakeKeyRegistered :: Ord wid => wid -> ModelOp wid s xprv Bool
mPutTxHistory :: forall wid s xprv. Ord wid => wid -> TxHistory -> ModelOp wid s xprv ()
mReadTxHistory :: forall wid s xprv. Ord wid => TimeInterpreter Identity -> wid -> Maybe Coin -> SortOrder -> Range SlotNo -> Maybe TxStatus -> ModelOp wid s xprv [ TransactionInfo ]
mPutLocalTxSubmission :: Ord wid => wid -> Hash "Tx" -> SealedTx -> SlotNo -> ModelOp wid s xprv ()
mReadLocalTxSubmissionPending :: Ord wid => wid -> ModelOp wid s xprv [ LocalTxSubmissionStatus SealedTx ]
mUpdatePendingTxForExpiry :: Ord wid => wid -> SlotNo -> ModelOp wid s xprv ()
mRemovePendingOrExpiredTx :: Ord wid => wid -> Hash "Tx" -> ModelOp wid s xprv ()
mPutPrivateKey :: Ord wid => wid -> xprv -> ModelOp wid s xprv ()
mReadPrivateKey :: Ord wid => wid -> ModelOp wid s xprv ( Maybe xprv)
mReadGenesisParameters :: Ord wid => wid -> ModelOp wid s xprv ( Maybe GenesisParameters )
mPutDelegationRewardBalance :: Ord wid => wid -> Coin -> ModelOp wid s xprv ()
mReadDelegationRewardBalance :: Ord wid => wid -> ModelOp wid s xprv Coin
mCheckWallet :: Ord wid => wid -> ModelOp wid s xprv ()

Model Types

data Database wid s xprv Source #

Model database, parameterised by the wallet ID type, the wallet AD state type, the target backend, and the private key type.

Tne type parameters exist so that simpler mock types can be used in place of actual wallet types.

Constructors

Database
Fields wallets :: !( Map wid ( WalletDatabase s xprv)) Wallet-related information. txs :: !( Map ( Hash "Tx") Tx ) In the database, transactions are global and not associated with any particular wallet.

Instances

Instances details

( Eq wid, Eq xprv, Eq s) => Eq ( Database wid s xprv) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods (==) :: Database wid s xprv -> Database wid s xprv -> Bool Source # (/=) :: Database wid s xprv -> Database wid s xprv -> Bool Source #
( Show wid, Show s, Show xprv) => Show ( Database wid s xprv) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods showsPrec :: Int -> Database wid s xprv -> ShowS Source # show :: Database wid s xprv -> String Source # showList :: [ Database wid s xprv] -> ShowS Source #
Generic ( Database wid s xprv) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Associated Types type Rep ( Database wid s xprv) :: Type -> Type Source # Methods from :: Database wid s xprv -> Rep ( Database wid s xprv) x Source # to :: Rep ( Database wid s xprv) x -> Database wid s xprv Source #
( NFData wid, NFData s, NFData xprv) => NFData ( Database wid s xprv) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods rnf :: Database wid s xprv -> () Source #
type Rep ( Database wid s xprv) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation type Rep ( Database wid s xprv) = D1 (' MetaData "Database" "Cardano.Wallet.DB.Pure.Implementation" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "Database" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "wallets") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map wid ( WalletDatabase s xprv))) :*: S1 (' MetaSel (' Just "txs") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map ( Hash "Tx") Tx ))))

data WalletDatabase s xprv Source #

Model database record for a single wallet.

Constructors

WalletDatabase
Fields checkpoints :: !( Map SlotNo ( Wallet s)) certificates :: !( Map SlotNo ( Maybe PoolId )) stakeKeys :: !( Map SlotNo StakeKeyCertificate ) metadata :: ! WalletMetadata txHistory :: !( Map ( Hash "Tx") TxMeta ) xprv :: !( Maybe xprv) genesisParameters :: ! GenesisParameters rewardAccountBalance :: ! Coin submittedTxs :: !( Map ( Hash "Tx") ( SealedTx , SlotNo ))

Instances

Instances details

( Eq s, Eq xprv) => Eq ( WalletDatabase s xprv) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods (==) :: WalletDatabase s xprv -> WalletDatabase s xprv -> Bool Source # (/=) :: WalletDatabase s xprv -> WalletDatabase s xprv -> Bool Source #
( Show s, Show xprv) => Show ( WalletDatabase s xprv) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods showsPrec :: Int -> WalletDatabase s xprv -> ShowS Source # show :: WalletDatabase s xprv -> String Source # showList :: [ WalletDatabase s xprv] -> ShowS Source #
Generic ( WalletDatabase s xprv) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Associated Types type Rep ( WalletDatabase s xprv) :: Type -> Type Source # Methods from :: WalletDatabase s xprv -> Rep ( WalletDatabase s xprv) x Source # to :: Rep ( WalletDatabase s xprv) x -> WalletDatabase s xprv Source #
( NFData s, NFData xprv) => NFData ( WalletDatabase s xprv) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods rnf :: WalletDatabase s xprv -> () Source #
type Rep ( WalletDatabase s xprv) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation type Rep ( WalletDatabase s xprv) = D1 (' MetaData "WalletDatabase" "Cardano.Wallet.DB.Pure.Implementation" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "WalletDatabase" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "checkpoints") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map SlotNo ( Wallet s))) :: S1 (' MetaSel (' Just "certificates") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map SlotNo ( Maybe PoolId )))) :: ( S1 (' MetaSel (' Just "stakeKeys") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map SlotNo StakeKeyCertificate )) :: S1 (' MetaSel (' Just "metadata") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 WalletMetadata ))) :: (( S1 (' MetaSel (' Just "txHistory") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map ( Hash "Tx") TxMeta )) :: S1 (' MetaSel (' Just "xprv") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Maybe xprv))) :: ( S1 (' MetaSel (' Just "genesisParameters") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 GenesisParameters ) :: ( S1 (' MetaSel (' Just "rewardAccountBalance") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ) :: S1 (' MetaSel (' Just "submittedTxs") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map ( Hash "Tx") ( SealedTx , SlotNo ))))))))

emptyDatabase :: Ord wid => Database wid s xprv Source #

Produces an empty model database.

type TxHistory = [( Tx , TxMeta )] Source #

Shorthand for the readTxHistory result type.

type TxHistoryMap = Map ( Hash "Tx") ( Tx , TxMeta ) Source #

Shorthand for the putTxHistory argument type.

filterTxHistory :: Maybe Coin -> SortOrder -> Range SlotNo -> TxHistory -> TxHistory Source #

Apply optional filters on slotNo and sort using the default sort order (first time/slotNo, then by TxId) to a TxHistory .

Model Operation Types

type ModelOp wid s xprv a = Database wid s xprv -> ( Either ( Err wid) a, Database wid s xprv) Source #

A database model operation, which is a function that takes a database and returns: * a value, which is a query of the database, or an error; and * a (possibly) modified database.

data Err wid Source #

All of the possible errors that any of the model database functions might return.

Constructors

NoSuchWallet wid
WalletAlreadyExists wid
NoSuchTx wid ( Hash "Tx")
CantRemoveTxInLedger wid ( Hash "Tx")

Instances

Instances details

Functor Err Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods fmap :: (a -> b) -> Err a -> Err b Source # (<$) :: a -> Err b -> Err a Source #
Foldable Err Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods fold :: Monoid m => Err m -> m Source # foldMap :: Monoid m => (a -> m) -> Err a -> m Source # foldMap' :: Monoid m => (a -> m) -> Err a -> m Source # foldr :: (a -> b -> b) -> b -> Err a -> b Source # foldr' :: (a -> b -> b) -> b -> Err a -> b Source # foldl :: (b -> a -> b) -> b -> Err a -> b Source # foldl' :: (b -> a -> b) -> b -> Err a -> b Source # foldr1 :: (a -> a -> a) -> Err a -> a Source # foldl1 :: (a -> a -> a) -> Err a -> a Source # toList :: Err a -> [a] Source # null :: Err a -> Bool Source # length :: Err a -> Int Source # elem :: Eq a => a -> Err a -> Bool Source # maximum :: Ord a => Err a -> a Source # minimum :: Ord a => Err a -> a Source # sum :: Num a => Err a -> a Source # product :: Num a => Err a -> a Source #
Traversable Err Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods traverse :: Applicative f => (a -> f b) -> Err a -> f ( Err b) Source # sequenceA :: Applicative f => Err (f a) -> f ( Err a) Source # mapM :: Monad m => (a -> m b) -> Err a -> m ( Err b) Source # sequence :: Monad m => Err (m a) -> m ( Err a) Source #
Eq wid => Eq ( Err wid) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods (==) :: Err wid -> Err wid -> Bool Source # (/=) :: Err wid -> Err wid -> Bool Source #
Show wid => Show ( Err wid) Source #
Instance details Defined in Cardano.Wallet.DB.Pure.Implementation Methods showsPrec :: Int -> Err wid -> ShowS Source # show :: Err wid -> String Source # showList :: [ Err wid] -> ShowS Source #

Model database functions

mCleanDB :: Ord wid => ModelOp wid s xprv () Source #

mInitializeWallet :: forall wid s xprv. Ord wid => wid -> Wallet s -> WalletMetadata -> TxHistory -> GenesisParameters -> ModelOp wid s xprv () Source #

mRemoveWallet :: Ord wid => wid -> ModelOp wid s xprv () Source #

mListWallets :: Ord wid => ModelOp wid s xprv [wid] Source #

mPutCheckpoint :: Ord wid => wid -> Wallet s -> ModelOp wid s xprv () Source #

mReadCheckpoint :: Ord wid => wid -> ModelOp wid s xprv ( Maybe ( Wallet s)) Source #

mListCheckpoints :: Ord wid => wid -> ModelOp wid s xprv [ ChainPoint ] Source #

mRollbackTo :: Ord wid => wid -> Slot -> ModelOp wid s xprv ChainPoint Source #

mPutWalletMeta :: Ord wid => wid -> WalletMetadata -> ModelOp wid s xprv () Source #

mReadWalletMeta :: Ord wid => TimeInterpreter Identity -> wid -> ModelOp wid s xprv ( Maybe WalletMetadata ) Source #

mPutDelegationCertificate :: Ord wid => wid -> DelegationCertificate -> SlotNo -> ModelOp wid s xprv () Source #

mIsStakeKeyRegistered :: Ord wid => wid -> ModelOp wid s xprv Bool Source #

mPutTxHistory :: forall wid s xprv. Ord wid => wid -> TxHistory -> ModelOp wid s xprv () Source #

mReadTxHistory :: forall wid s xprv. Ord wid => TimeInterpreter Identity -> wid -> Maybe Coin -> SortOrder -> Range SlotNo -> Maybe TxStatus -> ModelOp wid s xprv [ TransactionInfo ] Source #

mPutLocalTxSubmission :: Ord wid => wid -> Hash "Tx" -> SealedTx -> SlotNo -> ModelOp wid s xprv () Source #

mReadLocalTxSubmissionPending :: Ord wid => wid -> ModelOp wid s xprv [ LocalTxSubmissionStatus SealedTx ] Source #

mUpdatePendingTxForExpiry :: Ord wid => wid -> SlotNo -> ModelOp wid s xprv () Source #

mRemovePendingOrExpiredTx :: Ord wid => wid -> Hash "Tx" -> ModelOp wid s xprv () Source #

mPutPrivateKey :: Ord wid => wid -> xprv -> ModelOp wid s xprv () Source #

mReadPrivateKey :: Ord wid => wid -> ModelOp wid s xprv ( Maybe xprv) Source #

mReadGenesisParameters :: Ord wid => wid -> ModelOp wid s xprv ( Maybe GenesisParameters ) Source #

mPutDelegationRewardBalance :: Ord wid => wid -> Coin -> ModelOp wid s xprv () Source #

mReadDelegationRewardBalance :: Ord wid => wid -> ModelOp wid s xprv Coin Source #

mCheckWallet :: Ord wid => wid -> ModelOp wid s xprv () Source #