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

Cardano.Wallet.Primitive.Types.UTxO

Contents

UTxO
UTxO delta encoding
Queries
Transformations
UTxO Statistics

Description

This module provides the main UTxO data type used by the wallet.

Synopsis

newtype UTxO = UTxO {
- unUTxO :: Map TxIn TxOut
}
dom :: UTxO -> Set TxIn
null :: UTxO -> Bool
size :: UTxO -> Int
balance :: UTxO -> TokenBundle
isSubsetOf :: UTxO -> UTxO -> Bool
empty :: UTxO
disjoint :: UTxO -> UTxO -> Bool
excluding :: UTxO -> Set TxIn -> UTxO
restrictedBy :: UTxO -> Set TxIn -> UTxO
restrictedTo :: UTxO -> Set TxOut -> UTxO
difference :: UTxO -> UTxO -> UTxO
partition :: ( TxIn -> Bool ) -> UTxO -> ( UTxO , UTxO )
lookup :: TxIn -> UTxO -> Maybe TxOut
filter :: ( TxIn -> Bool ) -> UTxO -> UTxO
filterByAddressM :: forall f. Monad f => ( Address -> f Bool ) -> UTxO -> f UTxO
filterByAddress :: ( Address -> Bool ) -> UTxO -> UTxO
toList :: UTxO -> [( TxIn , TxOut )]
data DeltaUTxO
excluded :: DeltaUTxO -> Set TxIn
received :: DeltaUTxO -> UTxO
excludingD :: UTxO -> Set TxIn -> ( DeltaUTxO , UTxO )
receiveD :: UTxO -> UTxO -> ( DeltaUTxO , UTxO )
assetIds :: UTxO -> Set AssetId
txIds :: UTxO -> Set ( Hash "Tx")
mapAssetIds :: ( AssetId -> AssetId ) -> UTxO -> UTxO
mapTxIds :: ( Hash "Tx" -> Hash "Tx") -> UTxO -> UTxO
removeAssetId :: UTxO -> AssetId -> UTxO
data UTxOStatistics = UTxOStatistics {
- histogram :: ![ HistogramBar ]
- allStakes :: ! Word64
- boundType :: BoundType
}
data BoundType
data HistogramBar = HistogramBar {
- bucketUpperBound :: ! Word64
- bucketCount :: ! Word64
}
computeStatistics :: (a -> [ Word64 ]) -> BoundType -> [a] -> UTxOStatistics
computeUtxoStatistics :: BoundType -> UTxO -> UTxOStatistics
log10 :: BoundType

UTxO

newtype UTxO Source #

Constructors

UTxO
Fields unUTxO :: Map TxIn TxOut

Instances

Instances details

Eq UTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods (==) :: UTxO -> UTxO -> Bool Source # (/=) :: UTxO -> UTxO -> Bool Source #
Ord UTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods compare :: UTxO -> UTxO -> Ordering Source # (<) :: UTxO -> UTxO -> Bool Source # (<=) :: UTxO -> UTxO -> Bool Source # (>) :: UTxO -> UTxO -> Bool Source # (>=) :: UTxO -> UTxO -> Bool Source # max :: UTxO -> UTxO -> UTxO Source # min :: UTxO -> UTxO -> UTxO Source #
Show UTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods showsPrec :: Int -> UTxO -> ShowS Source # show :: UTxO -> String Source # showList :: [ UTxO ] -> ShowS Source #
Generic UTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Associated Types type Rep UTxO :: Type -> Type Source # Methods from :: UTxO -> Rep UTxO x Source # to :: Rep UTxO x -> UTxO Source #
Semigroup UTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods (<>) :: UTxO -> UTxO -> UTxO Source # sconcat :: NonEmpty UTxO -> UTxO Source # stimes :: Integral b => b -> UTxO -> UTxO Source #
Monoid UTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods mempty :: UTxO Source # mappend :: UTxO -> UTxO -> UTxO Source # mconcat :: [ UTxO ] -> UTxO Source #
NFData UTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods rnf :: UTxO -> () Source #
Buildable UTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods build :: UTxO -> Builder Source #
type Rep UTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO type Rep UTxO = D1 (' MetaData "UTxO" "Cardano.Wallet.Primitive.Types.UTxO" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "UTxO" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unUTxO") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Map TxIn TxOut ))))

dom :: UTxO -> Set TxIn Source #

Domain of a UTxO = the set of inputs of the utxo .

null :: UTxO -> Bool Source #

size :: UTxO -> Int Source #

balance :: UTxO -> TokenBundle Source #

Compute the balance of a UTxO

isSubsetOf :: UTxO -> UTxO -> Bool Source #

a ⊆ b

empty :: UTxO Source #

disjoint :: UTxO -> UTxO -> Bool Source #

Indicates whether a pair of UTxO sets are disjoint.

excluding :: UTxO -> Set TxIn -> UTxO Source #

ins⋪ u

restrictedBy :: UTxO -> Set TxIn -> UTxO Source #

ins⊲ u

restrictedTo :: UTxO -> Set TxOut -> UTxO Source #

u ⊳ outs

difference :: UTxO -> UTxO -> UTxO Source #

partition :: ( TxIn -> Bool ) -> UTxO -> ( UTxO , UTxO ) Source #

Partitions a UTxO set according to a condition.

filter p a == a && filter (not . p) b == b
  where (a,b) = partition p utxo

lookup :: TxIn -> UTxO -> Maybe TxOut Source #

Lookup an input in the UTXO

filter :: ( TxIn -> Bool ) -> UTxO -> UTxO Source #

Filters a UTxO set according to a condition.

filterByAddressM :: forall f. Monad f => ( Address -> f Bool ) -> UTxO -> f UTxO Source #

Filters a UTxO set with an indicator function on Address values.

Returns the subset of UTxO entries that have addresses for which the given indicator function returns True .

filterByAddress :: ( Address -> Bool ) -> UTxO -> UTxO Source #

Filters a UTxO set with an indicator function on Address values.

Returns the subset of UTxO entries that have addresses for which the given indicator function returns True .

filterByAddress f u = runIdentity $ filterByAddressM (pure . f) u filterByAddress (const True) u = u filterByAddress (const False) u = mempty filterByAddress f mempty = mempty filterByAddress f u isSubsetOf u

toList :: UTxO -> [( TxIn , TxOut )] Source #

Converts a UTxO set into a list of UTxO elements.

UTxO delta encoding

data DeltaUTxO Source #

Efficient delta encoding for UTxO .

Instances

Instances details

Eq DeltaUTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods (==) :: DeltaUTxO -> DeltaUTxO -> Bool Source # (/=) :: DeltaUTxO -> DeltaUTxO -> Bool Source #
Show DeltaUTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods showsPrec :: Int -> DeltaUTxO -> ShowS Source # show :: DeltaUTxO -> String Source # showList :: [ DeltaUTxO ] -> ShowS Source #
Generic DeltaUTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Associated Types type Rep DeltaUTxO :: Type -> Type Source # Methods from :: DeltaUTxO -> Rep DeltaUTxO x Source # to :: Rep DeltaUTxO x -> DeltaUTxO Source #
Semigroup DeltaUTxO Source #	Left argument is applied after right argument.
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods (<>) :: DeltaUTxO -> DeltaUTxO -> DeltaUTxO Source # sconcat :: NonEmpty DeltaUTxO -> DeltaUTxO Source # stimes :: Integral b => b -> DeltaUTxO -> DeltaUTxO Source #
Monoid DeltaUTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods mempty :: DeltaUTxO Source # mappend :: DeltaUTxO -> DeltaUTxO -> DeltaUTxO Source # mconcat :: [ DeltaUTxO ] -> DeltaUTxO Source #
Delta DeltaUTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Associated Types type Base DeltaUTxO Source # Methods apply :: DeltaUTxO -> Base DeltaUTxO -> Base DeltaUTxO Source #
type Rep DeltaUTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO type Rep DeltaUTxO = D1 (' MetaData "DeltaUTxO" "Cardano.Wallet.Primitive.Types.UTxO" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "DeltaUTxO" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "excluded") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Set TxIn )) :*: S1 (' MetaSel (' Just "received") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 UTxO )))
type Base DeltaUTxO Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO type Base DeltaUTxO = UTxO

excluded :: DeltaUTxO -> Set TxIn Source #

First exclude these inputs

received :: DeltaUTxO -> UTxO Source #

Then receive these additional outputs.

excludingD :: UTxO -> Set TxIn -> ( DeltaUTxO , UTxO ) Source #

Exclude a set of transaction inputs, typically because we spend them.

receiveD :: UTxO -> UTxO -> ( DeltaUTxO , UTxO ) Source #

Receive additional UTxO / union.

Queries

assetIds :: UTxO -> Set AssetId Source #

txIds :: UTxO -> Set ( Hash "Tx") Source #

Transformations

mapAssetIds :: ( AssetId -> AssetId ) -> UTxO -> UTxO Source #

mapTxIds :: ( Hash "Tx" -> Hash "Tx") -> UTxO -> UTxO Source #

Applies a mapping on transaction identifiers to a UTxO set.

If the provided mapping gives rise to a collision within the TxIn key set, then only the smallest TxOut is retained, according to the Ord instance for TxOut .

removeAssetId :: UTxO -> AssetId -> UTxO Source #

UTxO Statistics

data UTxOStatistics Source #

Constructors

UTxOStatistics
Fields histogram :: ![ HistogramBar ] allStakes :: ! Word64 boundType :: BoundType

Instances

Instances details

Eq UTxOStatistics Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods (==) :: UTxOStatistics -> UTxOStatistics -> Bool Source # (/=) :: UTxOStatistics -> UTxOStatistics -> Bool Source #
Ord UTxOStatistics Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods compare :: UTxOStatistics -> UTxOStatistics -> Ordering Source # (<) :: UTxOStatistics -> UTxOStatistics -> Bool Source # (<=) :: UTxOStatistics -> UTxOStatistics -> Bool Source # (>) :: UTxOStatistics -> UTxOStatistics -> Bool Source # (>=) :: UTxOStatistics -> UTxOStatistics -> Bool Source # max :: UTxOStatistics -> UTxOStatistics -> UTxOStatistics Source # min :: UTxOStatistics -> UTxOStatistics -> UTxOStatistics Source #
Show UTxOStatistics Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods showsPrec :: Int -> UTxOStatistics -> ShowS Source # show :: UTxOStatistics -> String Source # showList :: [ UTxOStatistics ] -> ShowS Source #
Generic UTxOStatistics Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Associated Types type Rep UTxOStatistics :: Type -> Type Source # Methods from :: UTxOStatistics -> Rep UTxOStatistics x Source # to :: Rep UTxOStatistics x -> UTxOStatistics Source #
NFData UTxOStatistics Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods rnf :: UTxOStatistics -> () Source #
Buildable UTxOStatistics Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods build :: UTxOStatistics -> Builder Source #
type Rep UTxOStatistics Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO type Rep UTxOStatistics = D1 (' MetaData "UTxOStatistics" "Cardano.Wallet.Primitive.Types.UTxO" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "UTxOStatistics" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "histogram") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 [ HistogramBar ]) :: ( S1 (' MetaSel (' Just "allStakes") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word64 ) :: S1 (' MetaSel (' Just "boundType") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BoundType ))))

data BoundType Source #

Instances

Instances details

Eq BoundType Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods (==) :: BoundType -> BoundType -> Bool Source # (/=) :: BoundType -> BoundType -> Bool Source #
Ord BoundType Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods compare :: BoundType -> BoundType -> Ordering Source # (<) :: BoundType -> BoundType -> Bool Source # (<=) :: BoundType -> BoundType -> Bool Source # (>) :: BoundType -> BoundType -> Bool Source # (>=) :: BoundType -> BoundType -> Bool Source # max :: BoundType -> BoundType -> BoundType Source # min :: BoundType -> BoundType -> BoundType Source #
Show BoundType Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods showsPrec :: Int -> BoundType -> ShowS Source # show :: BoundType -> String Source # showList :: [ BoundType ] -> ShowS Source #
Generic BoundType Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Associated Types type Rep BoundType :: Type -> Type Source # Methods from :: BoundType -> Rep BoundType x Source # to :: Rep BoundType x -> BoundType Source #
NFData BoundType Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods rnf :: BoundType -> () Source #
ToJSON ( ApiT BoundType ) Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods toJSON :: ApiT BoundType -> Value Source # toEncoding :: ApiT BoundType -> Encoding Source # toJSONList :: [ ApiT BoundType ] -> Value Source # toEncodingList :: [ ApiT BoundType ] -> Encoding Source #
FromJSON ( ApiT BoundType ) Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods parseJSON :: Value -> Parser ( ApiT BoundType ) Source # parseJSONList :: Value -> Parser [ ApiT BoundType ] Source #
type Rep BoundType Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO type Rep BoundType = D1 (' MetaData "BoundType" "Cardano.Wallet.Primitive.Types.UTxO" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "Log10" ' PrefixI ' False ) ( U1 :: Type -> Type ))

data HistogramBar Source #

Constructors

HistogramBar
Fields bucketUpperBound :: ! Word64 bucketCount :: ! Word64

Instances

Instances details

Eq HistogramBar Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods (==) :: HistogramBar -> HistogramBar -> Bool Source # (/=) :: HistogramBar -> HistogramBar -> Bool Source #
Ord HistogramBar Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods compare :: HistogramBar -> HistogramBar -> Ordering Source # (<) :: HistogramBar -> HistogramBar -> Bool Source # (<=) :: HistogramBar -> HistogramBar -> Bool Source # (>) :: HistogramBar -> HistogramBar -> Bool Source # (>=) :: HistogramBar -> HistogramBar -> Bool Source # max :: HistogramBar -> HistogramBar -> HistogramBar Source # min :: HistogramBar -> HistogramBar -> HistogramBar Source #
Show HistogramBar Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods showsPrec :: Int -> HistogramBar -> ShowS Source # show :: HistogramBar -> String Source # showList :: [ HistogramBar ] -> ShowS Source #
Generic HistogramBar Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Associated Types type Rep HistogramBar :: Type -> Type Source # Methods from :: HistogramBar -> Rep HistogramBar x Source # to :: Rep HistogramBar x -> HistogramBar Source #
NFData HistogramBar Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods rnf :: HistogramBar -> () Source #
Buildable HistogramBar Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO Methods build :: HistogramBar -> Builder Source #
type Rep HistogramBar Source #
Instance details Defined in Cardano.Wallet.Primitive.Types.UTxO type Rep HistogramBar = D1 (' MetaData "HistogramBar" "Cardano.Wallet.Primitive.Types.UTxO" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "HistogramBar" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "bucketUpperBound") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word64 ) :*: S1 (' MetaSel (' Just "bucketCount") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word64 )))

computeStatistics :: (a -> [ Word64 ]) -> BoundType -> [a] -> UTxOStatistics Source #

A more generic function for computing UTxO statistics on some other type of data that maps to UTxO's values.

computeUtxoStatistics :: BoundType -> UTxO -> UTxOStatistics Source #

Compute UtxoStatistics from UTxOs

log10 :: BoundType Source #

Smart-constructor to create bounds using a log-10 scale