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

Cardano.Wallet.DB.Layer

Contents

Directory of single-file wallet databases
Internal implementation
Unbracketed internal implementation
Interfaces
Migration Support

Description

An implementation of the DBLayer which uses Persistent and SQLite.

Synopsis

newDBFactory :: forall s k. ( PersistAddressBook s, PersistPrivateKey (k ' RootK ), WalletKey k) => Tracer IO DBFactoryLog -> DefaultFieldValues -> TimeInterpreter IO -> Maybe FilePath -> IO ( DBFactory IO s k)
findDatabases :: forall k. WalletKey k => Tracer IO DBFactoryLog -> FilePath -> IO [ WalletId ]
data DBFactoryLog
- = MsgFoundDatabase FilePath Text
- | MsgUnknownDBFile FilePath
- | MsgRemoving Text
- | MsgRemovingInUse Text Int
- | MsgRemovingDatabaseFile Text DeleteSqliteDatabaseLog
- | MsgWaitingForDatabase Text ( Maybe Int )
- | MsgWalletDB FilePath WalletDBLog
withDBLayer :: forall s k a. ( PersistAddressBook s, PersistPrivateKey (k ' RootK ), WalletKey k) => Tracer IO WalletDBLog -> DefaultFieldValues -> FilePath -> TimeInterpreter IO -> ( DBLayer IO s k -> IO a) -> IO a
withDBLayerInMemory :: forall s k a. ( PersistAddressBook s, PersistPrivateKey (k ' RootK )) => Tracer IO WalletDBLog -> TimeInterpreter IO -> ( DBLayer IO s k -> IO a) -> IO a
newtype WalletDBLog = MsgDB DBLog
data CacheBehavior
- = NoCache
- | CacheLatestCheckpoint
newDBLayerWith :: forall s k. ( PersistAddressBook s, PersistPrivateKey (k ' RootK )) => CacheBehavior -> Tracer IO WalletDBLog -> TimeInterpreter IO -> SqliteContext -> IO ( DBLayer IO s k)
newDBLayerInMemory :: forall s k. ( PersistAddressBook s, PersistPrivateKey (k ' RootK )) => Tracer IO WalletDBLog -> TimeInterpreter IO -> IO ( IO (), DBLayer IO s k)
class AddressBookIso s => PersistAddressBook s where
- insertPrologue :: WalletId -> Prologue s -> SqlPersistT IO ()
- insertDiscoveries :: WalletId -> SlotNo -> Discoveries s -> SqlPersistT IO ()
- loadPrologue :: WalletId -> SqlPersistT IO ( Maybe ( Prologue s))
- loadDiscoveries :: WalletId -> SlotNo -> SqlPersistT IO ( Discoveries s)
data DefaultFieldValues = DefaultFieldValues {
- defaultActiveSlotCoefficient :: ActiveSlotCoefficient
- defaultDesiredNumberOfPool :: Word16
- defaultMinimumUTxOValue :: Coin
- defaultHardforkEpoch :: Maybe EpochNo
- defaultKeyDeposit :: Coin
}

Directory of single-file wallet databases

newDBFactory Source #

Arguments

:: forall s k. ( PersistAddressBook s, PersistPrivateKey (k ' RootK ), WalletKey k)
=> Tracer IO DBFactoryLog	Logging object
-> DefaultFieldValues	Default database field values, used during migration.
-> TimeInterpreter IO	Time interpreter for slot to time conversions
-> Maybe FilePath	Path to database directory, or Nothing for in-memory database
-> IO ( DBFactory IO s k)

Instantiate a DBFactory from a given directory, or in-memory for testing.

findDatabases :: forall k. WalletKey k => Tracer IO DBFactoryLog -> FilePath -> IO [ WalletId ] Source #

Return all wallet databases that match the specified key type within the specified directory.

data DBFactoryLog Source #

Constructors

MsgFoundDatabase FilePath Text
MsgUnknownDBFile FilePath
MsgRemoving Text
MsgRemovingInUse Text Int
MsgRemovingDatabaseFile Text DeleteSqliteDatabaseLog
MsgWaitingForDatabase Text ( Maybe Int )
MsgWalletDB FilePath WalletDBLog

Instances

Instances details

Eq DBFactoryLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods (==) :: DBFactoryLog -> DBFactoryLog -> Bool Source # (/=) :: DBFactoryLog -> DBFactoryLog -> Bool Source #
Show DBFactoryLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods showsPrec :: Int -> DBFactoryLog -> ShowS Source # show :: DBFactoryLog -> String Source # showList :: [ DBFactoryLog ] -> ShowS Source #
Generic DBFactoryLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Associated Types type Rep DBFactoryLog :: Type -> Type Source # Methods from :: DBFactoryLog -> Rep DBFactoryLog x Source # to :: Rep DBFactoryLog x -> DBFactoryLog Source #
ToText DBFactoryLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods toText :: DBFactoryLog -> Text Source #
HasPrivacyAnnotation DBFactoryLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods getPrivacyAnnotation :: DBFactoryLog -> PrivacyAnnotation
HasSeverityAnnotation DBFactoryLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods getSeverityAnnotation :: DBFactoryLog -> Severity
type Rep DBFactoryLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer type Rep DBFactoryLog = D1 (' MetaData "DBFactoryLog" "Cardano.Wallet.DB.Layer" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) (( C1 (' MetaCons "MsgFoundDatabase" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 FilePath ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text )) :+: ( C1 (' MetaCons "MsgUnknownDBFile" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 FilePath )) :+: C1 (' MetaCons "MsgRemoving" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text )))) :+: (( C1 (' MetaCons "MsgRemovingInUse" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int )) :+: C1 (' MetaCons "MsgRemovingDatabaseFile" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 DeleteSqliteDatabaseLog ))) :+: ( C1 (' MetaCons "MsgWaitingForDatabase" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Int ))) :+: C1 (' MetaCons "MsgWalletDB" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 FilePath ) :*: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 WalletDBLog )))))

Internal implementation

withDBLayer Source #

Arguments

:: forall s k a. ( PersistAddressBook s, PersistPrivateKey (k ' RootK ), WalletKey k)
=> Tracer IO WalletDBLog	Logging object
-> DefaultFieldValues	Default database field values, used during migration.
-> FilePath	Path to database file
-> TimeInterpreter IO	Time interpreter for slot to time conversions
-> ( DBLayer IO s k -> IO a)	Action to run.
-> IO a

Runs an action with a connection to the SQLite database.

Database migrations are run to create tables if necessary.

If the given file path does not exist, it will be created by the sqlite library.

withDBLayerInMemory Source #

Arguments

:: forall s k a. ( PersistAddressBook s, PersistPrivateKey (k ' RootK ))
=> Tracer IO WalletDBLog	Logging object
-> TimeInterpreter IO	Time interpreter for slot to time conversions
-> ( DBLayer IO s k -> IO a)
-> IO a

Runs an IO action with a new DBLayer backed by a sqlite in-memory database.

newtype WalletDBLog Source #

Constructors

MsgDB DBLog

Instances

Instances details

Eq WalletDBLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods (==) :: WalletDBLog -> WalletDBLog -> Bool Source # (/=) :: WalletDBLog -> WalletDBLog -> Bool Source #
Show WalletDBLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods showsPrec :: Int -> WalletDBLog -> ShowS Source # show :: WalletDBLog -> String Source # showList :: [ WalletDBLog ] -> ShowS Source #
Generic WalletDBLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Associated Types type Rep WalletDBLog :: Type -> Type Source # Methods from :: WalletDBLog -> Rep WalletDBLog x Source # to :: Rep WalletDBLog x -> WalletDBLog Source #
ToText WalletDBLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods toText :: WalletDBLog -> Text Source #
HasPrivacyAnnotation WalletDBLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods getPrivacyAnnotation :: WalletDBLog -> PrivacyAnnotation
HasSeverityAnnotation WalletDBLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods getSeverityAnnotation :: WalletDBLog -> Severity
type Rep WalletDBLog Source #
Instance details Defined in Cardano.Wallet.DB.Layer type Rep WalletDBLog = D1 (' MetaData "WalletDBLog" "Cardano.Wallet.DB.Layer" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "MsgDB" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 DBLog )))

data CacheBehavior Source #

What to do with regards to caching. This is useful to disable caching in database benchmarks.

Constructors

NoCache
CacheLatestCheckpoint

Instances

Instances details

Eq CacheBehavior Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods (==) :: CacheBehavior -> CacheBehavior -> Bool Source # (/=) :: CacheBehavior -> CacheBehavior -> Bool Source #
Show CacheBehavior Source #
Instance details Defined in Cardano.Wallet.DB.Layer Methods showsPrec :: Int -> CacheBehavior -> ShowS Source # show :: CacheBehavior -> String Source # showList :: [ CacheBehavior ] -> ShowS Source #

Unbracketed internal implementation

newDBLayerWith Source #

Arguments

:: forall s k. ( PersistAddressBook s, PersistPrivateKey (k ' RootK ))
=> CacheBehavior	Option to disable caching.
-> Tracer IO WalletDBLog	Logging
-> TimeInterpreter IO	Time interpreter for slot to time conversions
-> SqliteContext	A (thread-)safe wrapper for query execution.
-> IO ( DBLayer IO s k)

Like newDBLayer , but allows to explicitly specify the caching behavior.

newDBLayerInMemory Source #

Arguments

:: forall s k. ( PersistAddressBook s, PersistPrivateKey (k ' RootK ))
=> Tracer IO WalletDBLog	Logging object
-> TimeInterpreter IO	Time interpreter for slot to time conversions
-> IO ( IO (), DBLayer IO s k)

Creates a DBLayer backed by a sqlite in-memory database.

Returns a cleanup function which you should always use exactly once when finished with the DBLayer .

Interfaces

class AddressBookIso s => PersistAddressBook s where Source #

Functions for saving loading the wallet's address book to from SQLite

Methods

insertPrologue :: WalletId -> Prologue s -> SqlPersistT IO () Source #

insertDiscoveries :: WalletId -> SlotNo -> Discoveries s -> SqlPersistT IO () Source #

loadPrologue :: WalletId -> SqlPersistT IO ( Maybe ( Prologue s)) Source #

loadDiscoveries :: WalletId -> SlotNo -> SqlPersistT IO ( Discoveries s) Source #

Instances

Instances details

PersistAddressBook ( RndState n) Source #	Persisting `RndState` requires that the wallet root key has already been added to the database with `putPrivateKey` . Unlike sequential AD, random address discovery requires a root key to recognize addresses.
Instance details Defined in Cardano.Wallet.DB.Store.Checkpoints Methods insertPrologue :: WalletId -> Prologue ( RndState n) -> SqlPersistT IO () Source # insertDiscoveries :: WalletId -> SlotNo -> Discoveries ( RndState n) -> SqlPersistT IO () Source # loadPrologue :: WalletId -> SqlPersistT IO ( Maybe ( Prologue ( RndState n))) Source # loadDiscoveries :: WalletId -> SlotNo -> SqlPersistT IO ( Discoveries ( RndState n)) Source #
PersistAddressBook ( RndAnyState n p) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Checkpoints Methods insertPrologue :: WalletId -> Prologue ( RndAnyState n p) -> SqlPersistT IO () Source # insertDiscoveries :: WalletId -> SlotNo -> Discoveries ( RndAnyState n p) -> SqlPersistT IO () Source # loadPrologue :: WalletId -> SqlPersistT IO ( Maybe ( Prologue ( RndAnyState n p))) Source # loadDiscoveries :: WalletId -> SlotNo -> SqlPersistT IO ( Discoveries ( RndAnyState n p)) Source #
( PersistPublicKey (key ' AccountK ), PersistPublicKey (key ' AddressK ), PersistPublicKey (key ' PolicyK ), MkKeyFingerprint key ( Proxy n, key ' AddressK XPub ), PaymentAddress n key, SoftDerivation key, Typeable n, (key == SharedKey ) ~ ' False , Eq ( SeqState n key)) => PersistAddressBook ( SeqState n key) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Checkpoints Methods insertPrologue :: WalletId -> Prologue ( SeqState n key) -> SqlPersistT IO () Source # insertDiscoveries :: WalletId -> SlotNo -> Discoveries ( SeqState n key) -> SqlPersistT IO () Source # loadPrologue :: WalletId -> SqlPersistT IO ( Maybe ( Prologue ( SeqState n key))) Source # loadDiscoveries :: WalletId -> SlotNo -> SqlPersistT IO ( Discoveries ( SeqState n key)) Source #
( PersistPublicKey (key ' AccountK ), SupportsDiscovery n key, WalletKey key, key ~ SharedKey ) => PersistAddressBook ( SharedState n key) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Checkpoints Methods insertPrologue :: WalletId -> Prologue ( SharedState n key) -> SqlPersistT IO () Source # insertDiscoveries :: WalletId -> SlotNo -> Discoveries ( SharedState n key) -> SqlPersistT IO () Source # loadPrologue :: WalletId -> SqlPersistT IO ( Maybe ( Prologue ( SharedState n key))) Source # loadDiscoveries :: WalletId -> SlotNo -> SqlPersistT IO ( Discoveries ( SharedState n key)) Source #
( Eq ( SeqState n k), (k == SharedKey ) ~ ' False , PersistAddressBook ( SeqState n k)) => PersistAddressBook ( SeqAnyState n k p) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Checkpoints Methods insertPrologue :: WalletId -> Prologue ( SeqAnyState n k p) -> SqlPersistT IO () Source # insertDiscoveries :: WalletId -> SlotNo -> Discoveries ( SeqAnyState n k p) -> SqlPersistT IO () Source # loadPrologue :: WalletId -> SqlPersistT IO ( Maybe ( Prologue ( SeqAnyState n k p))) Source # loadDiscoveries :: WalletId -> SlotNo -> SqlPersistT IO ( Discoveries ( SeqAnyState n k p)) Source #

Migration Support

data DefaultFieldValues Source #

A set of default field values that can be consulted when performing a database migration.

Constructors

DefaultFieldValues
Fields defaultActiveSlotCoefficient :: ActiveSlotCoefficient defaultDesiredNumberOfPool :: Word16 defaultMinimumUTxOValue :: Coin defaultHardforkEpoch :: Maybe EpochNo defaultKeyDeposit :: Coin