cardano-api

Safe Haskell	None
Language	Haskell2010

Cardano.Api.UTxO

Contents

UTxO type
Operators
Query
Construction
- Insertion
- Delete/Update
Combine
Traversal
- Map
- Fold
Conversion
Filter
Find

Synopsis

newtype UTxO era = UTxO {
- unUTxO :: Map TxIn (TxOut CtxUTxO era)
}
(\\) :: UTxO era -> UTxO era -> UTxO era
lookup :: TxIn -> UTxO era -> Maybe (TxOut CtxUTxO era)
resolveTxIn :: TxIn -> UTxO era -> Maybe (TxOut CtxUTxO era)
empty :: UTxO era
singleton :: TxIn -> TxOut CtxUTxO era -> UTxO era
insert :: TxIn -> TxOut CtxUTxO era -> UTxO era -> UTxO era
delete :: TxIn -> UTxO era -> UTxO era
adjust :: (TxOut CtxUTxO era -> TxOut CtxUTxO era) -> TxIn -> UTxO era -> UTxO era
union :: UTxO era -> UTxO era -> UTxO era
unions :: [UTxO era] -> UTxO era
difference :: UTxO era -> UTxO era -> UTxO era
intersection :: UTxO era -> UTxO era -> UTxO era
map :: (TxOut CtxUTxO era -> TxOut CtxUTxO era) -> UTxO era -> UTxO era
mapWithKey :: (TxIn -> TxOut CtxUTxO era -> TxOut CtxUTxO era) -> UTxO era -> UTxO era
mapKeys :: (TxIn -> TxIn) -> UTxO era -> UTxO era
foldMap :: Monoid m => (TxOut CtxUTxO era -> m) -> UTxO era -> m
inputSet :: UTxO era -> Set TxIn
txOutputs :: UTxO era -> [TxOut CtxUTxO era]
fromList :: [(TxIn, TxOut CtxUTxO era)] -> UTxO era
toList :: UTxO era -> [(TxIn, TxOut CtxUTxO era)]
toMap :: UTxO era -> Map TxIn (TxOut CtxUTxO era)
fromMap :: Map TxIn (TxOut CtxUTxO era) -> UTxO era
fromShelleyUTxO :: ShelleyBasedEra era -> UTxO (ShelleyLedgerEra era) -> UTxO era
toShelleyUTxO :: ShelleyBasedEra era -> UTxO era -> UTxO (ShelleyLedgerEra era)
filter :: (TxOut CtxUTxO era -> Bool) -> UTxO era -> UTxO era
filterWithKey :: (TxIn -> TxOut CtxUTxO era -> Bool) -> UTxO era -> UTxO era
find :: (TxOut CtxUTxO era -> Bool) -> UTxO era -> Maybe (TxIn, TxOut CtxUTxO era)
findWithKey :: (TxIn -> TxOut CtxUTxO era -> Bool) -> UTxO era -> Maybe (TxIn, TxOut CtxUTxO era)

UTxO type

newtype UTxO era Source #

Constructors

UTxO
Fields unUTxO :: Map TxIn (TxOut CtxUTxO era)

Instances

Instances details

IsShelleyBasedEra era => FromJSON (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

Methods

parseJSON :: Value -> Parser (UTxO era) #

parseJSONList :: Value -> Parser [UTxO era] #

omittedField :: Maybe (UTxO era) #

IsCardanoEra era => ToJSON (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

Methods

toJSON :: UTxO era -> Value #

toEncoding :: UTxO era -> Encoding #

toJSONList :: [UTxO era] -> Value #

toEncodingList :: [UTxO era] -> Encoding #

omitField :: UTxO era -> Bool #

Monoid (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

Methods

mempty :: UTxO era Source #

mappend :: UTxO era -> UTxO era -> UTxO era Source #

mconcat :: [UTxO era] -> UTxO era Source #

Semigroup (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

Methods

(<>) :: UTxO era -> UTxO era -> UTxO era Source #

sconcat :: NonEmpty (UTxO era) -> UTxO era Source #

stimes :: Integral b => b -> UTxO era -> UTxO era Source #

IsList (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

Associated Types

type Item (UTxO era)
Instance details Defined in Cardano.Api.UTxO type Item (UTxO era) = (TxIn, TxOut CtxUTxO era)

Methods

fromList :: [Item (UTxO era)] -> UTxO era Source #

fromListN :: Int -> [Item (UTxO era)] -> UTxO era Source #

toList :: UTxO era -> [Item (UTxO era)] Source #

Show (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

Methods

showsPrec :: Int -> UTxO era -> ShowS Source #

show :: UTxO era -> String Source #

showList :: [UTxO era] -> ShowS Source #

Eq (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

Methods

(==) :: UTxO era -> UTxO era -> Bool Source #

(/=) :: UTxO era -> UTxO era -> Bool Source #

MonoFoldable (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

Methods

ofoldMap :: Monoid m => (Element (UTxO era) -> m) -> UTxO era -> m

ofoldr :: (Element (UTxO era) -> b -> b) -> b -> UTxO era -> b

ofoldl' :: (a -> Element (UTxO era) -> a) -> a -> UTxO era -> a

otoList :: UTxO era -> [Element (UTxO era)]

oall :: (Element (UTxO era) -> Bool) -> UTxO era -> Bool

oany :: (Element (UTxO era) -> Bool) -> UTxO era -> Bool

onull :: UTxO era -> Bool

olength :: UTxO era -> Int

olength64 :: UTxO era -> Int64

ocompareLength :: Integral i => UTxO era -> i -> Ordering

otraverse_ :: Applicative f => (Element (UTxO era) -> f b) -> UTxO era -> f ()

ofor_ :: Applicative f => UTxO era -> (Element (UTxO era) -> f b) -> f ()

omapM_ :: Applicative m => (Element (UTxO era) -> m ()) -> UTxO era -> m ()

oforM_ :: Applicative m => UTxO era -> (Element (UTxO era) -> m ()) -> m ()

ofoldlM :: Monad m => (a -> Element (UTxO era) -> m a) -> a -> UTxO era -> m a

ofoldMap1Ex :: Semigroup m => (Element (UTxO era) -> m) -> UTxO era -> m

ofoldr1Ex :: (Element (UTxO era) -> Element (UTxO era) -> Element (UTxO era)) -> UTxO era -> Element (UTxO era)

ofoldl1Ex' :: (Element (UTxO era) -> Element (UTxO era) -> Element (UTxO era)) -> UTxO era -> Element (UTxO era)

headEx :: UTxO era -> Element (UTxO era)

lastEx :: UTxO era -> Element (UTxO era)

unsafeHead :: UTxO era -> Element (UTxO era)

unsafeLast :: UTxO era -> Element (UTxO era)

maximumByEx :: (Element (UTxO era) -> Element (UTxO era) -> Ordering) -> UTxO era -> Element (UTxO era)

minimumByEx :: (Element (UTxO era) -> Element (UTxO era) -> Ordering) -> UTxO era -> Element (UTxO era)

oelem :: Element (UTxO era) -> UTxO era -> Bool

onotElem :: Element (UTxO era) -> UTxO era -> Bool

MonoFunctor (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

Methods

omap :: (Element (UTxO era) -> Element (UTxO era)) -> UTxO era -> UTxO era

MonoTraversable (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

Methods

otraverse :: Applicative f => (Element (UTxO era) -> f (Element (UTxO era))) -> UTxO era -> f (UTxO era)

omapM :: Applicative m => (Element (UTxO era) -> m (Element (UTxO era))) -> UTxO era -> m (UTxO era)

type Item (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

type Item (UTxO era) = (TxIn, TxOut CtxUTxO era)

type Element (UTxO era) Source #

Instance details

Defined in Cardano.Api.UTxO

type Element (UTxO era) = TxOut CtxUTxO era

Operators

(\\) :: UTxO era -> UTxO era -> UTxO era Source #

Infix version of difference.

Query

lookup :: TxIn -> UTxO era -> Maybe (TxOut CtxUTxO era) Source #

Find a TxOut for a given TxIn.

resolveTxIn :: TxIn -> UTxO era -> Maybe (TxOut CtxUTxO era) Source #

Synonym for lookup.

Construction

empty :: UTxO era Source #

Create an empty UTxO.

singleton :: TxIn -> TxOut CtxUTxO era -> UTxO era Source #

Create a UTxO from a single unspent transaction output.

Insertion

insert :: TxIn -> TxOut CtxUTxO era -> UTxO era -> UTxO era Source #

Insert a new TxIn and TxOut into the UTxO. If the TxIn is already present in the UTxO, the associated TxOut is replaced with the supplied TxOut.

Delete/Update

delete :: TxIn -> UTxO era -> UTxO era Source #

Delete a TxIn and TxOut from the UTxO if it exists. When the TxIn is not a member of the UTxO, the original UTxO is returned.

adjust :: (TxOut CtxUTxO era -> TxOut CtxUTxO era) -> TxIn -> UTxO era -> UTxO era Source #

Update a TxOut corresponding to a specific TxIn with the result of the provided function. When the TxIn is not a member of the UTxO, the original UTxO is returned.

Combine

Union

union :: UTxO era -> UTxO era -> UTxO era Source #

Left-biased union of two UTxO.

unions :: [UTxO era] -> UTxO era Source #

The union of a list of UTxO.

Difference

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

Difference of two UTxO. Returns elements of the first UTxO not existing in the second UTxO.

Intersection

intersection :: UTxO era -> UTxO era -> UTxO era Source #

Traversal

Map

map :: (TxOut CtxUTxO era -> TxOut CtxUTxO era) -> UTxO era -> UTxO era Source #

Map a function over all TxOut in the UTxO.

mapWithKey :: (TxIn -> TxOut CtxUTxO era -> TxOut CtxUTxO era) -> UTxO era -> UTxO era Source #

Map a function over all TxIn/TxOut in the UTxO.

mapKeys :: (TxIn -> TxIn) -> UTxO era -> UTxO era Source #

Map a function over the TxIn keys in the UTxO.

Fold

foldMap :: Monoid m => (TxOut CtxUTxO era -> m) -> UTxO era -> m Source #

Fold the TxOuts to a monoid and combine the results.

Conversion

inputSet :: UTxO era -> Set TxIn Source #

Get the UTxO's TxIn Set.

txOutputs :: UTxO era -> [TxOut CtxUTxO era] Source #

Get the UTxO's TxOut Set.

Lists

fromList :: [(TxIn, TxOut CtxUTxO era)] -> UTxO era Source #

Convert to a List of TxIn/TxOut pairs.

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

Convert from a List of TxIn/TxOut pairs.

Maps

toMap :: UTxO era -> Map TxIn (TxOut CtxUTxO era) Source #

Convert to a Map of TxIn/TxOut.

fromMap :: Map TxIn (TxOut CtxUTxO era) -> UTxO era Source #

Convert from a Map of TxIn/TxOut.

Shelley

fromShelleyUTxO :: ShelleyBasedEra era -> UTxO (ShelleyLedgerEra era) -> UTxO era Source #

Convert from a `cardano-ledger` UTxO to a `cardano-api` UTxO.

toShelleyUTxO :: ShelleyBasedEra era -> UTxO era -> UTxO (ShelleyLedgerEra era) Source #

Convert from a `cardano-api` UTxO to a `cardano-ledger` UTxO.

Filter

filter :: (TxOut CtxUTxO era -> Bool) -> UTxO era -> UTxO era Source #

Filter all TxOut that satisfy the predicate.

filterWithKey :: (TxIn -> TxOut CtxUTxO era -> Bool) -> UTxO era -> UTxO era Source #

Filter all UTxO to only include outs satisfying given predicate.

Find

find :: (TxOut CtxUTxO era -> Bool) -> UTxO era -> Maybe (TxIn, TxOut CtxUTxO era) Source #

Find the first TxIn/TxOut pair in UTxO using the predicate.

findWithKey :: (TxIn -> TxOut CtxUTxO era -> Bool) -> UTxO era -> Maybe (TxIn, TxOut CtxUTxO era) Source #

Find the first TxIn/TxOut pair in UTxO using the predicate.