Safe Haskell | None |
---|---|
Language | Haskell2010 |
Cardano.Api.Value
Description
Currency values
Synopsis
- newtype Lovelace = Lovelace Integer
- newtype Quantity = Quantity Integer
- newtype PolicyId = PolicyId {}
- scriptPolicyId :: Script lang -> PolicyId
- newtype AssetName = AssetName ByteString
- data AssetId
- data Value
- selectAsset :: Value -> AssetId -> Quantity
- valueFromList :: [(AssetId, Quantity)] -> Value
- valueToList :: Value -> [(AssetId, Quantity)]
- filterValue :: (AssetId -> Bool) -> Value -> Value
- negateValue :: Value -> Value
- negateLedgerValue :: ShelleyBasedEra era -> Value (ShelleyLedgerEra era) -> Value (ShelleyLedgerEra era)
- calcMinimumDeposit :: Value -> Lovelace -> Lovelace
- quantityToLovelace :: Quantity -> Lovelace
- lovelaceToQuantity :: Lovelace -> Quantity
- selectLovelace :: Value -> Lovelace
- lovelaceToValue :: Lovelace -> Value
- valueToLovelace :: Value -> Maybe Lovelace
- newtype ValueNestedRep = ValueNestedRep [ValueNestedBundle]
- data ValueNestedBundle
- valueToNestedRep :: Value -> ValueNestedRep
- valueFromNestedRep :: ValueNestedRep -> Value
- renderValue :: Value -> Text
- renderValuePretty :: Value -> Text
- toByronLovelace :: Lovelace -> Maybe Lovelace
- fromByronLovelace :: Lovelace -> Lovelace
- toShelleyLovelace :: Lovelace -> Coin
- fromShelleyLovelace :: Coin -> Lovelace
- fromShelleyDeltaLovelace :: DeltaCoin -> Lovelace
- toMaryValue :: Value -> MaryValue StandardCrypto
- fromMaryValue :: MaryValue StandardCrypto -> Value
- fromLedgerValue :: ShelleyBasedEra era -> Value (ShelleyLedgerEra era) -> Value
- lovelaceToCoin :: Lovelace -> Coin
- toLedgerValue :: MaryEraOnwards era -> Value -> Value (ShelleyLedgerEra era)
- coinToLovelace :: Coin -> Lovelace
- data family AsType t
Documentation
Instances
Multi-asset values
Instances
Constructors
PolicyId | |
Fields |
Instances
Eq PolicyId Source # | |
Ord PolicyId Source # | |
Defined in Cardano.Api.Value | |
Show PolicyId Source # | |
IsString PolicyId Source # | |
Defined in Cardano.Api.Value Methods fromString :: String -> PolicyId Source # | |
FromJSON PolicyId Source # | |
Defined in Cardano.Api.Value | |
ToJSON PolicyId Source # | |
Defined in Cardano.Api.Value | |
HasTypeProxy PolicyId Source # | |
SerialiseAsRawBytes PolicyId Source # | |
Defined in Cardano.Api.Value Methods serialiseToRawBytes :: PolicyId -> ByteString Source # deserialiseFromRawBytes :: AsType PolicyId -> ByteString -> Either SerialiseAsRawBytesError PolicyId Source # | |
data AsType PolicyId Source # | |
Defined in Cardano.Api.Value |
scriptPolicyId :: Script lang -> PolicyId Source #
Constructors
AssetName ByteString |
Instances
Eq AssetName Source # | |
Ord AssetName Source # | |
Defined in Cardano.Api.Value | |
Show AssetName Source # | |
IsString AssetName Source # | |
Defined in Cardano.Api.Value Methods fromString :: String -> AssetName Source # | |
FromJSON AssetName Source # | |
Defined in Cardano.Api.Value | |
ToJSON AssetName Source # | |
Defined in Cardano.Api.Value | |
ToJSONKey AssetName Source # | |
Defined in Cardano.Api.Value | |
HasTypeProxy AssetName Source # | |
FromJSONKey AssetName Source # | |
Defined in Cardano.Api.Value Methods fromJSONKey :: FromJSONKeyFunction AssetName fromJSONKeyList :: FromJSONKeyFunction [AssetName] | |
SerialiseAsRawBytes AssetName Source # | |
Defined in Cardano.Api.Value Methods serialiseToRawBytes :: AssetName -> ByteString Source # deserialiseFromRawBytes :: AsType AssetName -> ByteString -> Either SerialiseAsRawBytesError AssetName Source # | |
data AsType AssetName Source # | |
Defined in Cardano.Api.Value |
Constructors
AdaAssetId | |
AssetId !PolicyId !AssetName |
Instances
Eq AssetId Source # | |
Ord AssetId Source # | |
Defined in Cardano.Api.Value | |
Show AssetId Source # | |
Instances
Eq Value Source # | |
Show Value Source # | |
Semigroup Value Source # | |
Monoid Value Source # | |
FromJSON Value Source # | |
Defined in Cardano.Api.Value Methods parseJSON :: Value0 -> Parser Value # parseJSONList :: Value0 -> Parser [Value] # omittedField :: Maybe Value # | |
ToJSON Value Source # | |
Defined in Cardano.Api.Value |
negateValue :: Value -> Value Source #
This lets you write a - b
as a <> negateValue b
.
negateLedgerValue :: ShelleyBasedEra era -> Value (ShelleyLedgerEra era) -> Value (ShelleyLedgerEra era) Source #
calcMinimumDeposit :: Value -> Lovelace -> Lovelace Source #
Calculate cost of making a UTxO entry for a given Value
and
mininimum UTxO value derived from the ProtocolParameters
Ada / Lovelace specifically
selectLovelace :: Value -> Lovelace Source #
lovelaceToValue :: Lovelace -> Value Source #
valueToLovelace :: Value -> Maybe Lovelace Source #
Check if the Value
consists of only Lovelace
and no other assets,
and if so then return the Lovelace.
See also selectLovelace
to select the Lovelace quantity from the Value,
ignoring other assets.
Alternative nested representation
newtype ValueNestedRep Source #
Constructors
ValueNestedRep [ValueNestedBundle] |
Instances
data ValueNestedBundle Source #
A bundle within a ValueNestedRep
for a single PolicyId
, or for the
special case of ada.
Constructors
ValueNestedBundleAda Quantity | |
ValueNestedBundle PolicyId (Map AssetName Quantity) |
Instances
Eq ValueNestedBundle Source # | |
Defined in Cardano.Api.Value Methods (==) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # (/=) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # | |
Ord ValueNestedBundle Source # | |
Defined in Cardano.Api.Value Methods compare :: ValueNestedBundle -> ValueNestedBundle -> Ordering Source # (<) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # (<=) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # (>) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # (>=) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # max :: ValueNestedBundle -> ValueNestedBundle -> ValueNestedBundle Source # min :: ValueNestedBundle -> ValueNestedBundle -> ValueNestedBundle Source # | |
Show ValueNestedBundle Source # | |
Defined in Cardano.Api.Value |
Rendering
renderValue :: Value -> Text Source #
Render a textual representation of a Value
.
renderValuePretty :: Value -> Text Source #
Render a "prettified" textual representation of a Value
.
Internal conversion functions
toByronLovelace :: Lovelace -> Maybe Lovelace Source #
fromByronLovelace :: Lovelace -> Lovelace Source #
toShelleyLovelace :: Lovelace -> Coin Source #
fromShelleyLovelace :: Coin -> Lovelace Source #
fromShelleyDeltaLovelace :: DeltaCoin -> Lovelace Source #
toMaryValue :: Value -> MaryValue StandardCrypto Source #
fromMaryValue :: MaryValue StandardCrypto -> Value Source #
fromLedgerValue :: ShelleyBasedEra era -> Value (ShelleyLedgerEra era) -> Value Source #
lovelaceToCoin :: Lovelace -> Coin Source #
toLedgerValue :: MaryEraOnwards era -> Value -> Value (ShelleyLedgerEra era) Source #
coinToLovelace :: Coin -> Lovelace Source #
Data family instances
A family of singleton types used in this API to indicate which type to use where it would otherwise be ambiguous or merely unclear.
Values of this type are passed to deserialisation functions for example.