Value: a (total) map from asset classes (GYAssetClass) to amount (Integer).

Converts a GYValue to a Plutus Value

Converts a Plutus Value to a GYValue. Returns Left GYFromPlutusValueError if it fails.

Convert a GYValue to a Cardano Api Value

Convert a Cardano Api Value to a GYValue

Returns a GYValue containing only the given GYAssetClass with the given amount.

>>> valueSingleton (GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "GOLD") 100
valueFromList [(GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "GOLD",100)]

Create GYValue from a list of asset class and amount. Duplicates are merged.

Returns a list of all GYAssetClass and amount pairs contained in a given GYValue.

Returns a map from GYAssetClass to their amount contained in a given GYValue.

Map operation over the GYValues amounts.

Returns the total count of assets in a given GYValue

Insert an asset with its quantity.

Adjust the amount of a given GYAssetClass in the given GYValue. If the asset is not present in the value, original value is returned instead.

If the result of the adjustment is zero, the asset is removed from the value.

Same as valueAdjust but if the asset is not present in the value, we apply the function to 0 and insert the resultant (if non-zero) into the value.

The expression (valueAlter f asc val) alters the value x at asc, or absence thereof. valueAlter can be used to insert, delete, or update a value in a GYValue.

>>> valueAlter (Just . maybe 1 (+ 1)) GYLovelace $ mempty
valueFromList [(GYLovelace,1)]

>>> valueAlter (Just . maybe 1 (+ 1)) GYLovelace $ valueFromList [(GYLovelace, 1)]
valueFromList [(GYLovelace,2)]

>>> valueFromLovelace 0
valueFromList []

>>> valueFromLovelace 100
valueFromList [(GYLovelace,100)]

Set of assets within a GYValue in non-zero quantities.

Parse a GYValue from a JSON object.

Subtracts the second GYValue from the first one (asset class by asset class). Note that zero entries are filtered for.

>>> valueFromList [(GYLovelace, 100)] `valueMinus` valueFromList [(GYLovelace, 200)]
valueFromList [(GYLovelace,-100)]

>>> valueFromList [(GYLovelace, 100)] `valueMinus` valueFromList [(GYLovelace, 100)]
valueFromList []

Subtracts the second GYValue from the first one (asset class by asset class). However, this differs from valueMinus in that it filters out negative amounts (zero amounts are already filtered by valueMinus).

>>> valueFromList [(GYLovelace, 100)] `valueMonus` valueFromList [(GYLovelace, 200)]
valueFromList []

>>> valueFromList [(GYLovelace, 100)] `valueMonus` valueFromList [(GYLovelace, 50)]
valueFromList [(GYLovelace,50)]

Returns the given GYValue with all amounts negated.

Checks if all amounts of the given GYValue are positive ( > 0 ).

Checks if all amounts of the given GYValue are not negative ( >= 0 ).

Checks if all amounts of the first GYValue are greater or equal to the second GYValue.

Checks if all amounts of the first GYValue are greater than the second GYValue.

Checks if all amounts of the first GYValue are less than the second GYValue.

Combine two values with given function.

Left biased intersection of two GYValues.

Persist only the assets in the first value that also exist in the second.

Intersection of two GYValues with a combining function.

Returns the amount of a GYAssetClass contained in the given GYValue.

Splits a GYValue into the lovelace amount and the rest of it's components.

>>> valueSplitAda $ valueFromLovelace 100
(100,valueFromList [])

>>> valueSplitAda $ valueFromList [(GYLovelace, 100), (GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "GOLD",101)]
(100,valueFromList [(GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "GOLD",101)])

Get the lovelace amount from a GYValue.

Removes the lovelace amount from a GYValue.

Split a GYValue into its positive and negative components. The first element of the pair is the positive components of the value. The second element is the negative component.

>>> valueSplitSign $ valueFromList [(GYLovelace,22),(GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "GOLD",-10)]
(valueFromList [(GYLovelace,22)],valueFromList [(GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "GOLD",10)])

Checks if the given GYValue is empty

>>> isEmptyValue mempty
True

>>> isEmptyValue $ valueFromLovelace 100
False

>>> isEmptyValue $ valueMinus (valueFromLovelace 100) (valueFromLovelace 100)
True

Verify the value only consists of positive amounts, returning a map containing naturals as a result.

Check the GYValue representation invariants.

Should always evaluate to True

Errors raised during Value -> GYValue conversion.

Asset class. Either lovelace or minted token.

Converts a GYAssetClass into a Plutus AssetClass.

Converts a Plutus AssetClass into a GYAssetClass. Returns Left GYFromPlutusValueError if it fails.

Parse hex encoded currency symbol and hex encoded token name separated by the given separator. >>> parseAssetClassWithSep . "lovelace" Right GYLovelace

>>> parseAssetClassWithSep '.' ""
Right GYLovelace

>>> parseAssetClassWithSep '.' "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef.476f6c64"
Right (GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "Gold")
>>> parseAssetClassWithSep '#' "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef#476f6c64"
Right (GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "Gold")
>>> parseAssetClassWithSep '#' "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef#"
Right (GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "")

Parse hex encoded currency symbol and hex encoded token name joined together without any separator. >>> parseAssetClassWithoutSep "lovelace" Right GYLovelace

>>> parseAssetClassWithoutSep ""
Right GYLovelace

>>> parseAssetClassWithoutSep "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef476f6c64"
Right (GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "Gold")
>>> parseAssetClassWithoutSep "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef"
Right (GYToken "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" "")

Token name is an arbitrary byte string up to 32 bytes long.

TODO: it's unclear whether it's an arbitrary byte string or UTF8 encoded text #32 (which encoded byte form is 32 byte long at most). (https:/github.comgeniusyieldatlasissues/32) We treat it as an arbitrary string.

>>> LBS8.putStrLn $ Aeson.encode ("Gold" :: GYTokenName)
"476f6c64"

Convert Plutus TokenName to GYTokenName.