Safe Haskell | Safe-Inferred |
---|---|
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
- 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
- data family AsType t
Documentation
Instances
Multi-asset values
Instances
FromJSON Quantity Source # | |
Defined in Cardano.Api.Value | |
ToJSON Quantity Source # | |
Defined in Cardano.Api.Value Methods toEncoding ∷ Quantity → Encoding # toJSONList ∷ [Quantity] → Value # toEncodingList ∷ [Quantity] → Encoding # | |
Monoid Quantity Source # | |
Semigroup Quantity Source # | |
Num Quantity Source # | |
Defined in Cardano.Api.Value | |
Show Quantity Source # | |
Eq Quantity Source # | |
Ord Quantity Source # | |
Constructors
PolicyId | |
Fields |
Instances
FromJSON PolicyId Source # | |
Defined in Cardano.Api.Value | |
ToJSON PolicyId Source # | |
Defined in Cardano.Api.Value Methods toEncoding ∷ PolicyId → Encoding # toJSONList ∷ [PolicyId] → Value # toEncodingList ∷ [PolicyId] → Encoding # | |
IsString PolicyId Source # | |
Defined in Cardano.Api.Value Methods fromString ∷ String → PolicyId Source # | |
Show PolicyId Source # | |
HasTypeProxy PolicyId Source # | |
SerialiseAsRawBytes PolicyId Source # | |
Defined in Cardano.Api.Value | |
Eq PolicyId Source # | |
Ord PolicyId Source # | |
data AsType PolicyId Source # | |
Defined in Cardano.Api.Value |
scriptPolicyId ∷ Script lang → PolicyId Source #
Constructors
AssetName ByteString |
Instances
FromJSON AssetName Source # | |
Defined in Cardano.Api.Value | |
FromJSONKey AssetName Source # | |
Defined in Cardano.Api.Value | |
ToJSON AssetName Source # | |
Defined in Cardano.Api.Value Methods toEncoding ∷ AssetName → Encoding # toJSONList ∷ [AssetName] → Value # toEncodingList ∷ [AssetName] → Encoding # | |
ToJSONKey AssetName Source # | |
Defined in Cardano.Api.Value | |
IsString AssetName Source # | |
Defined in Cardano.Api.Value Methods fromString ∷ String → AssetName Source # | |
Show AssetName Source # | |
HasTypeProxy AssetName Source # | |
SerialiseAsRawBytes AssetName Source # | |
Defined in Cardano.Api.Value | |
Eq AssetName Source # | |
Ord AssetName Source # | |
Defined in Cardano.Api.Value | |
data AsType AssetName Source # | |
Defined in Cardano.Api.Value |
Constructors
AdaAssetId | |
AssetId !PolicyId !AssetName |
Instances
negateValue ∷ Value → Value Source #
This lets you write a - b
as a <> negateValue b
.
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
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
FromJSON ValueNestedRep Source # | |
Defined in Cardano.Api.Value | |
ToJSON ValueNestedRep Source # | |
Defined in Cardano.Api.Value Methods toJSON ∷ ValueNestedRep → Value # toEncoding ∷ ValueNestedRep → Encoding # toJSONList ∷ [ValueNestedRep] → Value # toEncodingList ∷ [ValueNestedRep] → Encoding # | |
Show ValueNestedRep Source # | |
Defined in Cardano.Api.Value | |
Eq ValueNestedRep Source # | |
Defined in Cardano.Api.Value Methods (==) ∷ ValueNestedRep → ValueNestedRep → Bool Source # (/=) ∷ ValueNestedRep → ValueNestedRep → Bool Source # | |
Ord ValueNestedRep Source # | |
Defined in Cardano.Api.Value Methods compare ∷ ValueNestedRep → ValueNestedRep → Ordering Source # (<) ∷ ValueNestedRep → ValueNestedRep → Bool Source # (<=) ∷ ValueNestedRep → ValueNestedRep → Bool Source # (>) ∷ ValueNestedRep → ValueNestedRep → Bool Source # (>=) ∷ ValueNestedRep → ValueNestedRep → Bool Source # max ∷ ValueNestedRep → ValueNestedRep → ValueNestedRep Source # min ∷ ValueNestedRep → ValueNestedRep → ValueNestedRep Source # |
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
Show ValueNestedBundle Source # | |
Defined in Cardano.Api.Value | |
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 # |
Rendering
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 #
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.