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

Cardano.Wallet.DB.WalletState

Contents

Wallet state
WalletCheckpoint (internal use mostly)
Delta types
Multiple wallets

Description

Pure data type which represents the entire wallet state, including all checkpoints.

FIXME during ADP-1043: Actually include everything, e.g. TxHistory, Pending transactions, …

Synopsis

data WalletState s = WalletState {
- prologue :: !( Prologue s)
- checkpoints :: !( Checkpoints ( WalletCheckpoint s))
}
fromGenesis :: AddressBookIso s => Wallet s -> Maybe ( WalletState s)
getLatest :: AddressBookIso s => WalletState s -> Wallet s
findNearestPoint :: WalletState s -> Slot -> Maybe Slot
data WalletCheckpoint s = WalletCheckpoint {
- currentTip :: ! BlockHeader
- utxo :: ! UTxO
- discoveries :: !( Discoveries s)
}
toWallet :: AddressBookIso s => Prologue s -> WalletCheckpoint s -> Wallet s
fromWallet :: AddressBookIso s => Wallet s -> ( Prologue s, WalletCheckpoint s)
getBlockHeight :: WalletCheckpoint s -> Word32
getSlot :: WalletCheckpoint s -> Slot
data DeltaWalletState1 s
- = ReplacePrologue ( Prologue s)
- | UpdateCheckpoints ( DeltasCheckpoints ( WalletCheckpoint s))
type DeltaWalletState s = [ DeltaWalletState1 s]
data DeltaMap key da
- = Insert key ( Base da)
- | Delete key
- | Adjust key da
newtype ErrNoSuchWallet = ErrNoSuchWallet WalletId
adjustNoSuchWallet :: WalletId -> ( ErrNoSuchWallet -> e) -> (w -> Either e (dw, b)) -> Map WalletId w -> ( Maybe ( DeltaMap WalletId dw), Either e b)

Wallet state

data WalletState s Source #

Wallet state. Currently includes:

Prologue of the address discovery state
Checkpoints of UTxO and of discoveries of the address discovery state.

FIXME during ADP-1043: Include also TxHistory, pending transactions, …, everything.

Constructors

WalletState
Fields prologue :: !( Prologue s) checkpoints :: !( Checkpoints ( WalletCheckpoint s))

Instances

Instances details

AddressBookIso s => Eq ( WalletState s) Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Methods (==) :: WalletState s -> WalletState s -> Bool Source # (/=) :: WalletState s -> WalletState s -> Bool Source #
Generic ( WalletState s) Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Associated Types type Rep ( WalletState s) :: Type -> Type Source # Methods from :: WalletState s -> Rep ( WalletState s) x Source # to :: Rep ( WalletState s) x -> WalletState s Source #
type Rep ( WalletState s) Source #
Instance details Defined in Cardano.Wallet.DB.WalletState type Rep ( WalletState s) = D1 (' MetaData "WalletState" "Cardano.Wallet.DB.WalletState" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "WalletState" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "prologue") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Prologue s)) :*: S1 (' MetaSel (' Just "checkpoints") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Checkpoints ( WalletCheckpoint s)))))

fromGenesis :: AddressBookIso s => Wallet s -> Maybe ( WalletState s) Source #

Create a wallet from the genesis block.

getLatest :: AddressBookIso s => WalletState s -> Wallet s Source #

Get the wallet checkpoint with the largest slot number

findNearestPoint :: WalletState s -> Slot -> Maybe Slot Source #

Find the nearest Checkpoint that is either at the given point or before.

WalletCheckpoint (internal use mostly)

data WalletCheckpoint s Source #

Data stored in a single checkpoint. Only includes the UTxO and the Discoveries , but not the Prologue .

Constructors

WalletCheckpoint
Fields currentTip :: ! BlockHeader utxo :: ! UTxO discoveries :: !( Discoveries s)

Instances

Instances details

AddressBookIso s => Eq ( WalletCheckpoint s) Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Methods (==) :: WalletCheckpoint s -> WalletCheckpoint s -> Bool Source # (/=) :: WalletCheckpoint s -> WalletCheckpoint s -> Bool Source #
Generic ( WalletCheckpoint s) Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Associated Types type Rep ( WalletCheckpoint s) :: Type -> Type Source # Methods from :: WalletCheckpoint s -> Rep ( WalletCheckpoint s) x Source # to :: Rep ( WalletCheckpoint s) x -> WalletCheckpoint s Source #
type Rep ( WalletCheckpoint s) Source #
Instance details Defined in Cardano.Wallet.DB.WalletState type Rep ( WalletCheckpoint s) = D1 (' MetaData "WalletCheckpoint" "Cardano.Wallet.DB.WalletState" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "WalletCheckpoint" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "currentTip") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 BlockHeader ) :: ( S1 (' MetaSel (' Just "utxo") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 UTxO ) :: S1 (' MetaSel (' Just "discoveries") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Discoveries s)))))

toWallet :: AddressBookIso s => Prologue s -> WalletCheckpoint s -> Wallet s Source #

Convert a stored WalletCheckpoint to the legacy Wallet state.

fromWallet :: AddressBookIso s => Wallet s -> ( Prologue s, WalletCheckpoint s) Source #

Convert a legacy Wallet state to a Prologue and a WalletCheckpoint

getBlockHeight :: WalletCheckpoint s -> Word32 Source #

Helper function: Get the block height of a wallet checkpoint.

getSlot :: WalletCheckpoint s -> Slot Source #

Helper function: Get the Slot of a wallet checkpoint.

Delta types

data DeltaWalletState1 s Source #

Constructors

ReplacePrologue ( Prologue s)	Replace the prologue of the address discovery state
UpdateCheckpoints ( DeltasCheckpoints ( WalletCheckpoint s))	Update the wallet checkpoints.

Instances

Instances details

Show ( DeltaWalletState1 s) Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Methods showsPrec :: Int -> DeltaWalletState1 s -> ShowS Source # show :: DeltaWalletState1 s -> String Source # showList :: [ DeltaWalletState1 s] -> ShowS Source #
Buildable ( DeltaWalletState1 s) Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Methods build :: DeltaWalletState1 s -> Builder Source #
Delta ( DeltaWalletState1 s) Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Associated Types type Base ( DeltaWalletState1 s) Source # Methods apply :: DeltaWalletState1 s -> Base ( DeltaWalletState1 s) -> Base ( DeltaWalletState1 s) Source #
type Base ( DeltaWalletState1 s) Source #
Instance details Defined in Cardano.Wallet.DB.WalletState type Base ( DeltaWalletState1 s) = WalletState s

type DeltaWalletState s = [ DeltaWalletState1 s] Source #

Multiple wallets

data DeltaMap key da Source #

Delta type for Map .

Constructors

Insert key ( Base da)
Delete key
Adjust key da

Instances

Instances details

( Show key, Show da, Show ( Base da)) => Show ( DeltaMap key da)
Instance details Defined in Data.DeltaMap Methods showsPrec :: Int -> DeltaMap key da -> ShowS Source # show :: DeltaMap key da -> String Source # showList :: [ DeltaMap key da] -> ShowS Source #
( Show key, Show da, Show ( Base da)) => Buildable ( DeltaMap key da)
Instance details Defined in Data.DeltaMap Methods build :: DeltaMap key da -> Builder Source #
( Ord key, Delta da) => Delta ( DeltaMap key da)
Instance details Defined in Data.DeltaMap Associated Types type Base ( DeltaMap key da) Source # Methods apply :: DeltaMap key da -> Base ( DeltaMap key da) -> Base ( DeltaMap key da) Source #
type Base ( DeltaMap key da)
Instance details Defined in Data.DeltaMap type Base ( DeltaMap key da) = Map key ( Base da)

newtype ErrNoSuchWallet Source #

Can't perform given operation because there's no wallet

Constructors

ErrNoSuchWallet WalletId

Instances

Instances details

Eq ErrNoSuchWallet Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Methods (==) :: ErrNoSuchWallet -> ErrNoSuchWallet -> Bool Source # (/=) :: ErrNoSuchWallet -> ErrNoSuchWallet -> Bool Source #
Show ErrNoSuchWallet Source #
Instance details Defined in Cardano.Wallet.DB.WalletState Methods showsPrec :: Int -> ErrNoSuchWallet -> ShowS Source # show :: ErrNoSuchWallet -> String Source # showList :: [ ErrNoSuchWallet ] -> ShowS Source #
IsServerError ErrNoSuchWallet Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrNoSuchWallet -> ServerError Source #

adjustNoSuchWallet :: WalletId -> ( ErrNoSuchWallet -> e) -> (w -> Either e (dw, b)) -> Map WalletId w -> ( Maybe ( DeltaMap WalletId dw), Either e b) Source #

Adjust a specific wallet if it exists or return ErrNoSuchWallet .