cardano-wallet-core-2022.7.1: The Wallet Backend for a Cardano node.
Safe Haskell None
Language Haskell2010

Cardano.Wallet.Primitive.Types.TokenMap

Description

Provides the TokenMap type, which represents a map of named non-ada token quantities scoped by token policy.

The TokenMap type does not provide a way to store ada quantities. If you also need to store ada quantities, use the TokenBundle type.

This module is meant to be imported qualified. For example: 

>>> import qualified Cardano.Wallet.Primitive.Types.TokenMap as TM
Synopsis

Types

data TokenMap Source #

A map of named token quantities, grouped by token policy.

The token map data structure has an important invariant: all token quantities held within a map are non-zero.

This means that:

  • using the setQuantity function to add a zero-valued quantity to a map is equivalent to applying the identity operation to that map.
  • using the setQuantity function to change an existing quantity to zero is equivalent to removing that quantity from the map.

As a consequence of this invariant, the token map data structure is always in its canonical form: we can perform an equality check without needing any extra canonicalization steps.

Instances

Instances details
Eq TokenMap Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

(==) :: TokenMap -> TokenMap -> Bool Source #

(/=) :: TokenMap -> TokenMap -> Bool Source #

( TypeError (' Text "Ord not supported for token maps") :: Constraint ) => Ord TokenMap Source #

Token maps can be partially ordered, but there is no total ordering of token maps that's consistent with their arithmetic properties.

In the event that someone attempts to define an Ord instance for the TokenMap type, we generate a type error.

If some arbitrary ordering is needed (for example, so that token maps can be included in an ordered set), the recommended course of action is to define a newtype with its own dedicated Ord instance.

Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

compare :: TokenMap -> TokenMap -> Ordering Source #

(<) :: TokenMap -> TokenMap -> Bool Source #

(<=) :: TokenMap -> TokenMap -> Bool Source #

(>) :: TokenMap -> TokenMap -> Bool Source #

(>=) :: TokenMap -> TokenMap -> Bool Source #

max :: TokenMap -> TokenMap -> TokenMap Source #

min :: TokenMap -> TokenMap -> TokenMap Source #

Read TokenMap Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

readsPrec :: Int -> ReadS TokenMap Source #

readList :: ReadS [ TokenMap ] Source #

readPrec :: ReadPrec TokenMap Source #

readListPrec :: ReadPrec [ TokenMap ] Source #

Show TokenMap Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

showsPrec :: Int -> TokenMap -> ShowS Source #

show :: TokenMap -> String Source #

showList :: [ TokenMap ] -> ShowS Source #

Generic TokenMap Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Associated Types

type Rep TokenMap :: Type -> Type Source #

Methods

from :: TokenMap -> Rep TokenMap x Source #

to :: Rep TokenMap x -> TokenMap Source #

Semigroup TokenMap Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

(<>) :: TokenMap -> TokenMap -> TokenMap Source #

sconcat :: NonEmpty TokenMap -> TokenMap Source #

stimes :: Integral b => b -> TokenMap -> TokenMap Source #

Monoid TokenMap Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

mempty :: TokenMap Source #

mappend :: TokenMap -> TokenMap -> TokenMap Source #

mconcat :: [ TokenMap ] -> TokenMap Source #

NFData TokenMap Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

rnf :: TokenMap -> () Source #

Hashable TokenMap Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

hashWithSalt :: Int -> TokenMap -> Int Source #

hash :: TokenMap -> Int Source #

PartialOrd TokenMap Source #

Partial ordering for token maps.

There is no total ordering of token maps that's consistent with their arithmetic properties.

To see why this is true, consider how we might order the following maps: 

>>> p = fromFlatList [(assetA, 2), (assetB, 1)]
>>> q = fromFlatList [(assetA, 1), (assetB, 2)]

One possibility would be to use a lexicographic ordering, but this is not arithmetically useful.

Instead, we define a partial order, where map x is less than or equal to map y if (and only if):

  • all the quantities in map x are less than or equal to their corresponding quantities in map y ;
  • all the quantities in map y are greater than or equal to their corresponding quantities in map x .

For example, consider the following pair of maps: 

>>> x = fromFlatList [(assetA, 1)]
>>> y = fromFlatList [(assetA, 2), (assetB, 1)]

In the above example, map x is strictly less than map y .

Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

leq :: TokenMap -> TokenMap -> Bool Source #

comparable :: TokenMap -> TokenMap -> Bool Source #

Ord ( Lexicographic TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

compare :: Lexicographic TokenMap -> Lexicographic TokenMap -> Ordering Source #

(<) :: Lexicographic TokenMap -> Lexicographic TokenMap -> Bool Source #

(<=) :: Lexicographic TokenMap -> Lexicographic TokenMap -> Bool Source #

(>) :: Lexicographic TokenMap -> Lexicographic TokenMap -> Bool Source #

(>=) :: Lexicographic TokenMap -> Lexicographic TokenMap -> Bool Source #

max :: Lexicographic TokenMap -> Lexicographic TokenMap -> Lexicographic TokenMap Source #

min :: Lexicographic TokenMap -> Lexicographic TokenMap -> Lexicographic TokenMap Source #

Ord ( AssetCount TokenMap ) Source #

A total ordering on token maps based on the number of assets in each map.

If two maps have the same number of assets, then we fall back to ordinary lexicographic ordering as a tie-breaker.

Instance details

Defined in Cardano.Wallet.CoinSelection.Internal.Balance

Methods

compare :: AssetCount TokenMap -> AssetCount TokenMap -> Ordering Source #

(<) :: AssetCount TokenMap -> AssetCount TokenMap -> Bool Source #

(<=) :: AssetCount TokenMap -> AssetCount TokenMap -> Bool Source #

(>) :: AssetCount TokenMap -> AssetCount TokenMap -> Bool Source #

(>=) :: AssetCount TokenMap -> AssetCount TokenMap -> Bool Source #

max :: AssetCount TokenMap -> AssetCount TokenMap -> AssetCount TokenMap Source #

min :: AssetCount TokenMap -> AssetCount TokenMap -> AssetCount TokenMap Source #

ToJSON ( Nested TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

toJSON :: Nested TokenMap -> Value Source #

toEncoding :: Nested TokenMap -> Encoding Source #

toJSONList :: [ Nested TokenMap ] -> Value Source #

toEncodingList :: [ Nested TokenMap ] -> Encoding Source #

ToJSON ( Flat TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

toJSON :: Flat TokenMap -> Value Source #

toEncoding :: Flat TokenMap -> Encoding Source #

toJSONList :: [ Flat TokenMap ] -> Value Source #

toEncodingList :: [ Flat TokenMap ] -> Encoding Source #

ToJSON ( ApiT TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Api.Types

Methods

toJSON :: ApiT TokenMap -> Value Source #

toEncoding :: ApiT TokenMap -> Encoding Source #

toJSONList :: [ ApiT TokenMap ] -> Value Source #

toEncodingList :: [ ApiT TokenMap ] -> Encoding Source #

FromJSON ( Nested TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

parseJSON :: Value -> Parser ( Nested TokenMap ) Source #

parseJSONList :: Value -> Parser [ Nested TokenMap ] Source #

FromJSON ( Flat TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

parseJSON :: Value -> Parser ( Flat TokenMap ) Source #

parseJSONList :: Value -> Parser [ Flat TokenMap ] Source #

FromJSON ( ApiT TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Api.Types

Methods

parseJSON :: Value -> Parser ( ApiT TokenMap ) Source #

parseJSONList :: Value -> Parser [ ApiT TokenMap ] Source #

Buildable ( Nested TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

build :: Nested TokenMap -> Builder Source #

Buildable ( Flat TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

build :: Flat TokenMap -> Builder Source #

type Rep TokenMap Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

type Rep TokenMap = D1 (' MetaData "TokenMap" "Cardano.Wallet.Primitive.Types.TokenMap" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "TokenMap" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unTokenMap") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Map TokenPolicyId ( NonEmptyMap TokenName TokenQuantity )))))

data AssetId Source #

A combination of a token policy identifier and a token name that can be used as a compound identifier.

Constructors

AssetId

Fields

Instances

Instances details
Eq AssetId Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

(==) :: AssetId -> AssetId -> Bool Source #

(/=) :: AssetId -> AssetId -> Bool Source #

Ord AssetId Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

compare :: AssetId -> AssetId -> Ordering Source #

(<) :: AssetId -> AssetId -> Bool Source #

(<=) :: AssetId -> AssetId -> Bool Source #

(>) :: AssetId -> AssetId -> Bool Source #

(>=) :: AssetId -> AssetId -> Bool Source #

max :: AssetId -> AssetId -> AssetId Source #

min :: AssetId -> AssetId -> AssetId Source #

Read AssetId Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

readsPrec :: Int -> ReadS AssetId Source #

readList :: ReadS [ AssetId ] Source #

readPrec :: ReadPrec AssetId Source #

readListPrec :: ReadPrec [ AssetId ] Source #

Show AssetId Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

showsPrec :: Int -> AssetId -> ShowS Source #

show :: AssetId -> String Source #

showList :: [ AssetId ] -> ShowS Source #

Generic AssetId Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Associated Types

type Rep AssetId :: Type -> Type Source #

Methods

from :: AssetId -> Rep AssetId x Source #

to :: Rep AssetId x -> AssetId Source #

NFData AssetId Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

rnf :: AssetId -> () Source #

type Rep AssetId Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

type Rep AssetId = D1 (' MetaData "AssetId" "Cardano.Wallet.Primitive.Types.TokenMap" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "AssetId" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "tokenPolicyId") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 TokenPolicyId ) :*: S1 (' MetaSel (' Just "tokenName") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 TokenName )))

Construction

empty :: TokenMap Source #

The empty token map.

singleton :: AssetId -> TokenQuantity -> TokenMap Source #

Creates a singleton token map with just one token quantity.

If the specified token quantity is zero, then the resultant map will be equal to the empty map.

fromFlatList :: [( AssetId , TokenQuantity )] -> TokenMap Source #

Creates a token map from a flat list.

If a token name appears more than once in the list under the same policy, its associated quantities will be added together in the resultant map.

fromNestedList :: [( TokenPolicyId , NonEmpty ( TokenName , TokenQuantity ))] -> TokenMap Source #

Creates a token map from a nested list.

If a token name appears more than once in the list under the same policy, its associated quantities will be added together in the resultant map.

fromNestedMap :: Map TokenPolicyId ( NonEmptyMap TokenName TokenQuantity ) -> TokenMap Source #

Creates a token map from a nested map.

Deconstruction

toFlatList :: TokenMap -> [( AssetId , TokenQuantity )] Source #

Converts a token map to a flat list.

toNestedList :: TokenMap -> [( TokenPolicyId , NonEmpty ( TokenName , TokenQuantity ))] Source #

Converts a token map to a nested list.

toNestedMap :: TokenMap -> Map TokenPolicyId ( NonEmptyMap TokenName TokenQuantity ) Source #

Converts a token map to a nested map.

Filtering

filter :: ( AssetId -> Bool ) -> TokenMap -> TokenMap Source #

Arithmetic

add :: TokenMap -> TokenMap -> TokenMap Source #

Adds one token map to another.

subtract :: TokenMap -> TokenMap -> Maybe TokenMap Source #

Subtracts the second token map from the first.

Returns Nothing if the second map is not less than or equal to the first map when compared with the leq function.

difference :: TokenMap -> TokenMap -> TokenMap Source #

Analogous to Set.difference , return the difference between two token maps.

The following property holds: prop> x leq (x difference y) add y

Note that there's a leq rather than equality, which we'd expect if this was subtraction of integers. I.e. 

>>> (0 - 1) + 1
0

whereas 

>>> let oneToken = singleton aid (TokenQuantity 1)
>>> (mempty `difference` oneToken) `add` oneToken
oneToken

intersection :: TokenMap -> TokenMap -> TokenMap Source #

Computes the intersection of two token maps.

Analogous to Set.intersection .

Example: 

>>> m1 = [("a", 1), ("b", 2), ("c", 3)          ]
>>> m2 = [          ("b", 3), ("c", 2), ("d", 1)]
>>> intersection m1 m2
         [          ("b", 2), ("c", 2)          ]

Queries

size :: TokenMap -> Int Source #

Returns the number of unique assets in a token map.

Tests

isEmpty :: TokenMap -> Bool Source #

Returns true if and only if the given map is empty.

isNotEmpty :: TokenMap -> Bool Source #

Returns true if and only if the given map is not empty.

Quantities

getQuantity :: TokenMap -> AssetId -> TokenQuantity Source #

Gets the quantity associated with a given asset.

If the given map does not have an entry for the specified asset, this function returns a value of zero.

setQuantity :: TokenMap -> AssetId -> TokenQuantity -> TokenMap Source #

Updates the quantity associated with a given asset.

If the given quantity is zero, the resultant map will not have an entry for the given asset.

hasQuantity :: TokenMap -> AssetId -> Bool Source #

Returns true if and only if the given map has a non-zero quantity for the given asset.

adjustQuantity :: TokenMap -> AssetId -> ( TokenQuantity -> TokenQuantity ) -> TokenMap Source #

Uses the specified function to adjust the quantity associated with a given asset.

If the result of adjusting the quantity is equal to zero, the resultant map will not have an entry for the given asset.

removeQuantity :: TokenMap -> AssetId -> TokenMap Source #

Removes the quantity associated with the given asset.

This is equivalent to calling setQuantity with a value of zero.

maximumQuantity :: TokenMap -> TokenQuantity Source #

Get the largest quantity from this map.

Partitioning

equipartitionAssets Source #

Arguments

:: TokenMap

The token map to be partitioned.

-> NonEmpty a

Represents the number of portions in which to partition the token map.

-> NonEmpty TokenMap

The partitioned maps.

Partitions a token map into n smaller maps, where the asset sets of the resultant maps are disjoint.

In the resultant maps, the smallest asset set size and largest asset set size will differ by no more than 1.

The quantities of each asset are unchanged.

equipartitionQuantities Source #

Arguments

:: TokenMap

The map to be partitioned.

-> NonEmpty a

Represents the number of portions in which to partition the map.

-> NonEmpty TokenMap

The partitioned maps.

Partitions a token map into n smaller maps, where the quantity of each token is equipartitioned across the resultant maps.

In the resultant maps, the smallest quantity and largest quantity of a given token will differ by no more than 1.

The resultant list is sorted into ascending order when maps are compared with the leq function.

equipartitionQuantitiesWithUpperBound Source #

Arguments

:: TokenMap
-> TokenQuantity

Maximum allowable token quantity.

-> NonEmpty TokenMap

The partitioned maps.

Partitions a token map into n smaller maps, where the quantity of each token is equipartitioned across the resultant maps, with the goal that no token quantity in any of the resultant maps exceeds the given upper bound.

The value n is computed automatically, and is the minimum value required to achieve the goal that no token quantity in any of the resulting maps exceeds the maximum allowable token quantity.

Ordering

newtype Lexicographic a Source #

Defines a lexicographic ordering.

Constructors

Lexicographic

Fields

Instances

Instances details
Eq a => Eq ( Lexicographic a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

(==) :: Lexicographic a -> Lexicographic a -> Bool Source #

(/=) :: Lexicographic a -> Lexicographic a -> Bool Source #

Ord ( Lexicographic TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

compare :: Lexicographic TokenMap -> Lexicographic TokenMap -> Ordering Source #

(<) :: Lexicographic TokenMap -> Lexicographic TokenMap -> Bool Source #

(<=) :: Lexicographic TokenMap -> Lexicographic TokenMap -> Bool Source #

(>) :: Lexicographic TokenMap -> Lexicographic TokenMap -> Bool Source #

(>=) :: Lexicographic TokenMap -> Lexicographic TokenMap -> Bool Source #

max :: Lexicographic TokenMap -> Lexicographic TokenMap -> Lexicographic TokenMap Source #

min :: Lexicographic TokenMap -> Lexicographic TokenMap -> Lexicographic TokenMap Source #

Ord ( Lexicographic TokenBundle ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenBundle

Methods

compare :: Lexicographic TokenBundle -> Lexicographic TokenBundle -> Ordering Source #

(<) :: Lexicographic TokenBundle -> Lexicographic TokenBundle -> Bool Source #

(<=) :: Lexicographic TokenBundle -> Lexicographic TokenBundle -> Bool Source #

(>) :: Lexicographic TokenBundle -> Lexicographic TokenBundle -> Bool Source #

(>=) :: Lexicographic TokenBundle -> Lexicographic TokenBundle -> Bool Source #

max :: Lexicographic TokenBundle -> Lexicographic TokenBundle -> Lexicographic TokenBundle Source #

min :: Lexicographic TokenBundle -> Lexicographic TokenBundle -> Lexicographic TokenBundle Source #

Show a => Show ( Lexicographic a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

showsPrec :: Int -> Lexicographic a -> ShowS Source #

show :: Lexicographic a -> String Source #

showList :: [ Lexicographic a] -> ShowS Source #

Serialization

newtype Flat a Source #

When used with the Buildable or ToJSON instances, provides a flat serialization style, where token quantities are paired with their asset identifiers.

Constructors

Flat

Fields

Instances

Instances details
Eq a => Eq ( Flat a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

(==) :: Flat a -> Flat a -> Bool Source #

(/=) :: Flat a -> Flat a -> Bool Source #

Ord a => Ord ( Flat a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

compare :: Flat a -> Flat a -> Ordering Source #

(<) :: Flat a -> Flat a -> Bool Source #

(<=) :: Flat a -> Flat a -> Bool Source #

(>) :: Flat a -> Flat a -> Bool Source #

(>=) :: Flat a -> Flat a -> Bool Source #

max :: Flat a -> Flat a -> Flat a Source #

min :: Flat a -> Flat a -> Flat a Source #

Show a => Show ( Flat a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

showsPrec :: Int -> Flat a -> ShowS Source #

show :: Flat a -> String Source #

showList :: [ Flat a] -> ShowS Source #

Generic ( Flat a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Associated Types

type Rep ( Flat a) :: Type -> Type Source #

Methods

from :: Flat a -> Rep ( Flat a) x Source #

to :: Rep ( Flat a) x -> Flat a Source #

ToJSON ( Flat TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

toJSON :: Flat TokenMap -> Value Source #

toEncoding :: Flat TokenMap -> Encoding Source #

toJSONList :: [ Flat TokenMap ] -> Value Source #

toEncodingList :: [ Flat TokenMap ] -> Encoding Source #

FromJSON ( Flat TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

parseJSON :: Value -> Parser ( Flat TokenMap ) Source #

parseJSONList :: Value -> Parser [ Flat TokenMap ] Source #

Buildable ( Flat TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

build :: Flat TokenMap -> Builder Source #

Buildable ( Flat TokenBundle ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenBundle

Methods

build :: Flat TokenBundle -> Builder Source #

type Rep ( Flat a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

type Rep ( Flat a) = D1 (' MetaData "Flat" "Cardano.Wallet.Primitive.Types.TokenMap" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "Flat" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getFlat") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 a)))

newtype Nested a Source #

When used with the Buildable or ToJSON instances, provides a nested serialization style, where token quantities are grouped by policy identifier.

Constructors

Nested

Fields

Instances

Instances details
Eq a => Eq ( Nested a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

(==) :: Nested a -> Nested a -> Bool Source #

(/=) :: Nested a -> Nested a -> Bool Source #

Ord a => Ord ( Nested a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

compare :: Nested a -> Nested a -> Ordering Source #

(<) :: Nested a -> Nested a -> Bool Source #

(<=) :: Nested a -> Nested a -> Bool Source #

(>) :: Nested a -> Nested a -> Bool Source #

(>=) :: Nested a -> Nested a -> Bool Source #

max :: Nested a -> Nested a -> Nested a Source #

min :: Nested a -> Nested a -> Nested a Source #

Show a => Show ( Nested a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

showsPrec :: Int -> Nested a -> ShowS Source #

show :: Nested a -> String Source #

showList :: [ Nested a] -> ShowS Source #

Generic ( Nested a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Associated Types

type Rep ( Nested a) :: Type -> Type Source #

Methods

from :: Nested a -> Rep ( Nested a) x Source #

to :: Rep ( Nested a) x -> Nested a Source #

ToJSON ( Nested TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

toJSON :: Nested TokenMap -> Value Source #

toEncoding :: Nested TokenMap -> Encoding Source #

toJSONList :: [ Nested TokenMap ] -> Value Source #

toEncodingList :: [ Nested TokenMap ] -> Encoding Source #

FromJSON ( Nested TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

parseJSON :: Value -> Parser ( Nested TokenMap ) Source #

parseJSONList :: Value -> Parser [ Nested TokenMap ] Source #

Buildable ( Nested TokenMap ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

Methods

build :: Nested TokenMap -> Builder Source #

Buildable ( Nested TokenBundle ) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenBundle

Methods

build :: Nested TokenBundle -> Builder Source #

type Rep ( Nested a) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Types.TokenMap

type Rep ( Nested a) = D1 (' MetaData "Nested" "Cardano.Wallet.Primitive.Types.TokenMap" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "Nested" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getNested") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 a)))

Queries

getAssets :: TokenMap -> Set AssetId Source #

Transformations

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

Unsafe operations

unsafeSubtract :: TokenMap -> TokenMap -> TokenMap Source #

Subtracts the second token map from the first.

Pre-condition: the second map is less than or equal to the first map when compared with the leq function.

Throws a run-time exception if the pre-condition is violated.