Create a PValue that only contains a specific amount of tokens, described by a PAssetClassData.

Since: 3.10.0

Tagged version of passetClassDataValue.

Since: 3.14.1

Helper to construct the 'inner mapping' of a PValue.

Since: 3.9.0

As psingleValue, but using a Haskell-level AssetClass.

Since: 3.10.0

Tagged version of psingleValue`.

Since: 3.14.1

Construct a PValue from its underlying representation. There are NoGuarantees on the amounts.

Since: 3.10.0

Construct a PValue from its underlying representation. The amounts are guaranteed to be Positive, so this is suitable for construction of PTxOuts.

Since: 3.9.0

Get the amount of ada of a PValue.

Since: 3.9.0

As passetClassValueOf, but using a Haskell-level AssetClass.

Since: 3.9.0

Given a PAssetClass and a PValue, look up the amount corresponding to that PAssetClass.

Since: 3.9.0

Tagged version of passetClassValueOf`.

Since: 3.14.1

Tagged version of passetClassValueOf.

Since: 3.9.0

Given a PAssetClassData and a PValue, look up the amount corresponding to that PAssetClassData.

Since: 3.21.4

Tagged version of passetClassDataValueOf.

Since: 3.21.4

Extracts the amount given by the PAssetClass from (the internal representation of) a PValue.

Intuitively, this acts as a 'pattern match' on PValue. You don't have to provide every asset class, only the ones you are interested in.

Example

example :: forall (s :: S) .
   Term s (PBuiltinList (
     PBuiltinPair (PAsData PCurrencySymbol)
                  (PAsData (PMap 'Sorted PTokenName PInteger))
     ) -> TermConst s ()
example rep = do
   rec <- matchValueAssets @'['("ada", AssetClass "Ada")]
             rep
             (HCons (Labeled adaClass) HNil)
   -- Or using operators
   rec2 <- matchValueAssets rep $ (Proxy @"ada" .|== adaClass) HNIl
   let adaFromRep = rec.ada

Since: 3.9.0

Gets the first entry in the first item of the PValue mapping & returns the rest of the PValue.

Fails if the PValue is empty. In cases where we know that a PValue contains Ada, such as in a PScriptContext, then this will function will split the Ada value - since the Ada entry comes first.

NOTE: All properly normalized values will contain an Ada entry, even if that entry is 0.

Since: 3.9.0

Get the sum of all values belonging to a particular CurrencySymbol.

Since: 1.1.0

Get the negative and positive amount of a particular CurrencySymbol, and return nothing if it doesn't exist in the value.

Since: 3.14.1

Eliminator for the inner type of a PValue.

Since: 3.9.0

Eliminator for a sorted PValue. The function argument will receive:

• The smallest PCurrencySymbol for which we have a mapping;
• The smallest PTokenName for which the corresponding 'inner map' has a mapping;
• The PInteger associated with the above PTokenName; and
• The 'rest'.

If the 'inner map' corresponding to the PCurrencySymbol above contains only a single mapping, the 'rest' will not contain a mapping for that PCurrencySymbol; otherwise, it will contain the rest of the 'inner map'.

Note

The 'nil case' will be invoked in two situations:

• When the PValue has no entries; and
• When the 'inner map' corresponding to the first PCurrencySymbol key has no entries.

Since: 3.9.0

Compare only on the basis of a particular PCurrencySymbol and PTokenName entry.

Since: 3.9.0

Compare only the entries corresponding to a particular PCurrencySymbol.

Since: 3.9.0

As pbyClassComparator, but using a Haskell-level AssetClass instead.

Since: 3.9.0

Compute the guarantees known after adding two PValues.

Since: 1.1.0

Returns PTrue if the entire argument PValue contains exactly one token of the argument PCurrencySymbol (and contains no other assets).

This implementation makes a special case for ADA, where it allows zero-ada entries in the given PValue.

Since: 3.21.0

Returns PTrue if the argument PValue contains exactly one token of the argument PCurrencySymbol.

Note: unlike phasOnlyOneTokenOfCurrencySymbol this may still return PTrue if there are other assets in the PValue.

Since: 3.9.1

Returns PTrue if the argument PValue contains exactly one token of the argument PAssetClass.

Note: unlike phasOnlyOneTokenOfCurrencySymbol this may still return PTrue if there are other assets in the PValue.

Since: 3.9.1

Returns PTrue if the argument PValue contains exactly one token of the argument PAssetClassData.

Note: unlike phasOnlyOneTokenOfCurrencySymbol this may still return PTrue if there are other assets in the PValue.

Since: 3.21.4

Returns the count of non-zero currency symbols in a PValue.

So, for a value of the following shape:

      [("", [("", 0)]), ("feed", [("foo", 7)]), ("deed", [("bar", 1)])]
    

We get the result 2.

Since: 3.21.0