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

Cardano.Wallet.DB.Store.Transactions.Model

Description

Data type TxHistory for storing a set of transactions. Transactions are encoded "as" expressed in DB tables.

Synopsis

data DeltaTxHistory
- = Append TxHistory
- | DeleteTx TxId
type TxHistory = TxHistoryF ' Without
newtype TxHistoryF f = TxHistoryF ( Map TxId ( TxRelationF f))
data TxRelationF (f :: Decoration ) = TxRelationF {
- ins :: [DecorateWithTxOut f TxIn ]
- collateralIns :: [DecorateWithTxOut f TxCollateral ]
- outs :: [( TxOut , [ TxOutToken ])]
- collateralOuts :: Maybe ( TxCollateralOut , [ TxCollateralOutToken ])
- withdrawals :: [ TxWithdrawal ]
}
tokenCollateralOrd :: TxCollateralOutToken -> ( TokenPolicyId , TokenName )
tokenOutOrd :: TxOutToken -> ( TokenPolicyId , TokenName )
mkTxHistory :: [ Tx ] -> TxHistory
data Decoration
- = Without
- | With
data WithTxOut txin = WithTxOut {
- txIn :: txin
- context :: Maybe ( TxOut , [ TxOutToken ])
}
decorateWithTxOuts :: TxHistoryF ' Without -> TxHistoryF ' With
mkTxIn :: TxId -> ( Int , ( TxIn , Coin )) -> TxIn
mkTxCollateral :: TxId -> ( Int , ( TxIn , Coin )) -> TxCollateral
mkTxOut :: TxId -> ( Word32 , TxOut ) -> ( TxOut , [ TxOutToken ])
undecorateFromTxOuts :: TxHistoryF ' With -> TxHistoryF ' Without

Documentation

data DeltaTxHistory Source #

Verbs to change a TxHistory .

Constructors

Append TxHistory	Add new set of transactions. Overwrites transactions whose id is already present in the `TxHistory` .
DeleteTx TxId	Try to remove the transaction at the given transaction id.

Instances

Instances details

Eq DeltaTxHistory Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods (==) :: DeltaTxHistory -> DeltaTxHistory -> Bool Source # (/=) :: DeltaTxHistory -> DeltaTxHistory -> Bool Source #
Show DeltaTxHistory Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods showsPrec :: Int -> DeltaTxHistory -> ShowS Source # show :: DeltaTxHistory -> String Source # showList :: [ DeltaTxHistory ] -> ShowS Source #
Generic DeltaTxHistory Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Associated Types type Rep DeltaTxHistory :: Type -> Type Source # Methods from :: DeltaTxHistory -> Rep DeltaTxHistory x Source # to :: Rep DeltaTxHistory x -> DeltaTxHistory Source #
Buildable DeltaTxHistory Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods build :: DeltaTxHistory -> Builder Source #
Delta DeltaTxHistory Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Associated Types type Base DeltaTxHistory Source # Methods apply :: DeltaTxHistory -> Base DeltaTxHistory -> Base DeltaTxHistory Source #
type Rep DeltaTxHistory Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model type Rep DeltaTxHistory = D1 (' MetaData "DeltaTxHistory" "Cardano.Wallet.DB.Store.Transactions.Model" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "Append" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 TxHistory )) :+: C1 (' MetaCons "DeleteTx" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 TxId )))
type Base DeltaTxHistory Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model type Base DeltaTxHistory = TxHistory

type TxHistory = TxHistoryF ' Without Source #

Shortcut type for transaction history where inputs are not decorated with their corresponding TxOut .

newtype TxHistoryF f Source #

Transactions history is TxRelationF s indexed by TxId

Constructors

TxHistoryF ( Map TxId ( TxRelationF f))

Instances

Instances details

( Eq (DecorateWithTxOut f TxIn ), Eq (DecorateWithTxOut f TxCollateral )) => Eq ( TxHistoryF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods (==) :: TxHistoryF f -> TxHistoryF f -> Bool Source # (/=) :: TxHistoryF f -> TxHistoryF f -> Bool Source #
( Show (DecorateWithTxOut f TxIn ), Show (DecorateWithTxOut f TxCollateral )) => Show ( TxHistoryF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods showsPrec :: Int -> TxHistoryF f -> ShowS Source # show :: TxHistoryF f -> String Source # showList :: [ TxHistoryF f] -> ShowS Source #
Generic ( TxHistoryF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Associated Types type Rep ( TxHistoryF f) :: Type -> Type Source # Methods from :: TxHistoryF f -> Rep ( TxHistoryF f) x Source # to :: Rep ( TxHistoryF f) x -> TxHistoryF f Source #
Semigroup ( TxHistoryF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods (<>) :: TxHistoryF f -> TxHistoryF f -> TxHistoryF f Source # sconcat :: NonEmpty ( TxHistoryF f) -> TxHistoryF f Source # stimes :: Integral b => b -> TxHistoryF f -> TxHistoryF f Source #
Monoid ( TxHistoryF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods mempty :: TxHistoryF f Source # mappend :: TxHistoryF f -> TxHistoryF f -> TxHistoryF f Source # mconcat :: [ TxHistoryF f] -> TxHistoryF f Source #
( Show (DecorateWithTxOut f TxIn ), Show (DecorateWithTxOut f TxCollateral )) => Buildable ( TxHistoryF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods build :: TxHistoryF f -> Builder Source #
type Rep ( TxHistoryF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model type Rep ( TxHistoryF f) = D1 (' MetaData "TxHistoryF" "Cardano.Wallet.DB.Store.Transactions.Model" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "TxHistoryF" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "relations") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Map TxId ( TxRelationF f)))))

data TxRelationF (f :: Decoration ) Source #

A low level definition of a transaction covering all transaction content by collecting all related-to-index database rows. Normalization is performed anyway after the first relation level. All values used here are records in the database. Foreign keys are used to group data correctly, but they are not removed from the data.

Constructors

TxRelationF
Fields ins :: [DecorateWithTxOut f TxIn ] collateralIns :: [DecorateWithTxOut f TxCollateral ] outs :: [( TxOut , [ TxOutToken ])] collateralOuts :: Maybe ( TxCollateralOut , [ TxCollateralOutToken ]) withdrawals :: [ TxWithdrawal ]

Instances

Instances details

( Eq (DecorateWithTxOut f TxIn ), Eq (DecorateWithTxOut f TxCollateral )) => Eq ( TxRelationF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods (==) :: TxRelationF f -> TxRelationF f -> Bool Source # (/=) :: TxRelationF f -> TxRelationF f -> Bool Source #
( Show (DecorateWithTxOut f TxIn ), Show (DecorateWithTxOut f TxCollateral )) => Show ( TxRelationF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods showsPrec :: Int -> TxRelationF f -> ShowS Source # show :: TxRelationF f -> String Source # showList :: [ TxRelationF f] -> ShowS Source #
Generic ( TxRelationF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Associated Types type Rep ( TxRelationF f) :: Type -> Type Source # Methods from :: TxRelationF f -> Rep ( TxRelationF f) x Source # to :: Rep ( TxRelationF f) x -> TxRelationF f Source #
type Rep ( TxRelationF f) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model type Rep ( TxRelationF f)

tokenCollateralOrd :: TxCollateralOutToken -> ( TokenPolicyId , TokenName ) Source #

tokenOutOrd :: TxOutToken -> ( TokenPolicyId , TokenName ) Source #

mkTxHistory :: [ Tx ] -> TxHistory Source #

Convert high level transactions definition in low level DB history

data Decoration Source #

A kind to index the 2 flavours of a TxRelationF , with or without TxOuts

Constructors

Without
With

data WithTxOut txin Source #

A context that carries a TxOut together with its tokens (this will be needed in the future for the DB Layer to reconstruct TransactionInfo ).

Constructors

WithTxOut
Fields txIn :: txin context :: Maybe ( TxOut , [ TxOutToken ])

Instances

Instances details

Functor WithTxOut Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods fmap :: (a -> b) -> WithTxOut a -> WithTxOut b Source # (<$) :: a -> WithTxOut b -> WithTxOut a Source #
Eq txin => Eq ( WithTxOut txin) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods (==) :: WithTxOut txin -> WithTxOut txin -> Bool Source # (/=) :: WithTxOut txin -> WithTxOut txin -> Bool Source #
Show txin => Show ( WithTxOut txin) Source #
Instance details Defined in Cardano.Wallet.DB.Store.Transactions.Model Methods showsPrec :: Int -> WithTxOut txin -> ShowS Source # show :: WithTxOut txin -> String Source # showList :: [ WithTxOut txin] -> ShowS Source #

decorateWithTxOuts :: TxHistoryF ' Without -> TxHistoryF ' With Source #

mkTxIn :: TxId -> ( Int , ( TxIn , Coin )) -> TxIn Source #

mkTxCollateral :: TxId -> ( Int , ( TxIn , Coin )) -> TxCollateral Source #

mkTxOut Source #

Arguments

:: TxId
-> ( Word32 , TxOut )	(index, txout)
-> ( TxOut , [ TxOutToken ])

undecorateFromTxOuts :: TxHistoryF ' With -> TxHistoryF ' Without Source #