plutarch-ledger-api-3.3.0
Safe HaskellSafe-Inferred
LanguageHaskell2010

Plutarch.LedgerApi.Value

Description

Value-related functionality. In order to keep the interface efficient and safe at the same time, there is a type-level distinction between PValues that are guaranteed to be properly normalized and those that provide no such guarantee.

Also for efficiency reasons, the Ada-specific functions assume that there can be only one token name for the Ada currency symbol, and they don't check whether it matches adaToken.

Synopsis

Types

newtype PValue (keys :: KeyGuarantees) (amounts :: AmountGuarantees) (s :: S) Source #

Since: 2.0.0

Constructors

PValue (Term s (PMap keys PCurrencySymbol (PMap keys PTokenName PInteger))) 

Instances

Instances details
Semigroup (Term s (PValue 'Sorted normalization)) => Monoid (Term s (PValue 'Sorted normalization)) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

mempty :: Term s (PValue 'Sorted normalization) Source #

mappend :: Term s (PValue 'Sorted normalization) -> Term s (PValue 'Sorted normalization) -> Term s (PValue 'Sorted normalization) Source #

mconcat :: [Term s (PValue 'Sorted normalization)] -> Term s (PValue 'Sorted normalization) Source #

Semigroup (Term s (PValue 'Sorted 'NoGuarantees)) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(<>) :: Term s (PValue 'Sorted 'NoGuarantees) -> Term s (PValue 'Sorted 'NoGuarantees) -> Term s (PValue 'Sorted 'NoGuarantees) Source #

sconcat :: NonEmpty (Term s (PValue 'Sorted 'NoGuarantees)) -> Term s (PValue 'Sorted 'NoGuarantees) Source #

stimes :: Integral b => b -> Term s (PValue 'Sorted 'NoGuarantees) -> Term s (PValue 'Sorted 'NoGuarantees) Source #

Semigroup (Term s (PValue 'Sorted 'NonZero)) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(<>) :: Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero) Source #

sconcat :: NonEmpty (Term s (PValue 'Sorted 'NonZero)) -> Term s (PValue 'Sorted 'NonZero) Source #

stimes :: Integral b => b -> Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero) Source #

Semigroup (Term s (PValue 'Sorted 'Positive)) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(<>) :: Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive) Source #

sconcat :: NonEmpty (Term s (PValue 'Sorted 'Positive)) -> Term s (PValue 'Sorted 'Positive) Source #

stimes :: Integral b => b -> Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive) Source #

PEq (PValue 'Sorted 'NoGuarantees) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#==) :: forall (s :: S). Term s (PValue 'Sorted 'NoGuarantees) -> Term s (PValue 'Sorted 'NoGuarantees) -> Term s PBool

PEq (PValue 'Sorted 'NonZero) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#==) :: forall (s :: S). Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero) -> Term s PBool

PEq (PValue 'Sorted 'Positive) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#==) :: forall (s :: S). Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive) -> Term s PBool

PIsData (PValue keys amounts) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pfromDataImpl :: forall (s :: S). Term s (PAsData (PValue keys amounts)) -> Term s (PValue keys amounts)

pdataImpl :: forall (s :: S). Term s (PValue keys amounts) -> Term s PData

PLiftable (PValue 'Unsorted 'NoGuarantees) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type AsHaskell (PValue 'Unsorted 'NoGuarantees)

type PlutusRepr (PValue 'Unsorted 'NoGuarantees)

Methods

haskToRepr :: AsHaskell (PValue 'Unsorted 'NoGuarantees) -> PlutusRepr (PValue 'Unsorted 'NoGuarantees)

reprToHask :: PlutusRepr (PValue 'Unsorted 'NoGuarantees) -> Either LiftError (AsHaskell (PValue 'Unsorted 'NoGuarantees))

reprToPlut :: forall (s :: S). PlutusRepr (PValue 'Unsorted 'NoGuarantees) -> PLifted s (PValue 'Unsorted 'NoGuarantees)

plutToRepr :: (forall (s :: S). PLifted s (PValue 'Unsorted 'NoGuarantees)) -> Either LiftError (PlutusRepr (PValue 'Unsorted 'NoGuarantees))

PlutusType (PValue keys amounts) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type PInner (PValue keys amounts) :: PType

type PCovariant' (PValue keys amounts)

type PContravariant' (PValue keys amounts)

type PVariant' (PValue keys amounts)

Methods

pcon' :: forall (s :: S). PValue keys amounts s -> Term s (PInner (PValue keys amounts))

pmatch' :: forall (s :: S) (b :: PType). Term s (PInner (PValue keys amounts)) -> (PValue keys amounts s -> Term s b) -> Term s b

PSemigroup (PValue 'Sorted normalization) => PMonoid (PValue 'Sorted normalization) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pmempty :: forall (s :: S). Term s (PValue 'Sorted normalization)

pmtimes :: forall (s :: S). Term s PNatural -> Term s (PValue 'Sorted normalization) -> Term s (PValue 'Sorted normalization)

PSemigroup (PValue 'Sorted 'NoGuarantees) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#<>) :: forall (s :: S). Term s (PValue 'Sorted 'NoGuarantees) -> Term s (PValue 'Sorted 'NoGuarantees) -> Term s (PValue 'Sorted 'NoGuarantees)

pstimes :: forall (s :: S). Term s PPositive -> Term s (PValue 'Sorted 'NoGuarantees) -> Term s (PValue 'Sorted 'NoGuarantees)

PSemigroup (PValue 'Sorted 'NonZero) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#<>) :: forall (s :: S). Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero)

pstimes :: forall (s :: S). Term s PPositive -> Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero)

PSemigroup (PValue 'Sorted 'Positive) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#<>) :: forall (s :: S). Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive)

pstimes :: forall (s :: S). Term s PPositive -> Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive)

PShow (PValue keys amounts) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pshow' :: forall (s :: S). Bool -> Term s (PValue keys amounts) -> Term s PString

Semigroup (Term s (PValue 'Sorted 'NoGuarantees)) => Group (Term s (PValue 'Sorted 'NoGuarantees)) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

inv :: Term s (PValue 'Sorted 'NoGuarantees) -> Term s (PValue 'Sorted 'NoGuarantees)

Semigroup (Term s (PValue 'Sorted 'NonZero)) => Group (Term s (PValue 'Sorted 'NonZero)) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

inv :: Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero)

Semigroup (Term s (PValue 'Sorted normalization)) => Monoid (Term s (PValue 'Sorted normalization)) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

mempty :: Term s (PValue 'Sorted normalization)

Semigroup (Term s (PValue 'Sorted 'NoGuarantees)) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(<>) :: Term s (PValue 'Sorted 'NoGuarantees) -> Term s (PValue 'Sorted 'NoGuarantees) -> Term s (PValue 'Sorted 'NoGuarantees)

Semigroup (Term s (PValue 'Sorted 'NonZero)) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(<>) :: Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero)

Semigroup (Term s (PValue 'Sorted 'Positive)) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(<>) :: Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive)

Generic (PValue keys amounts s) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type Rep (PValue keys amounts s) :: Type -> Type Source #

Methods

from :: PValue keys amounts s -> Rep (PValue keys amounts s) x Source #

to :: Rep (PValue keys amounts s) x -> PValue keys amounts s Source #

Generic (PValue keys amounts s) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type Code (PValue keys amounts s) :: [[Type]]

Methods

from :: PValue keys amounts s -> Rep (PValue keys amounts s)

to :: Rep (PValue keys amounts s) -> PValue keys amounts s

type AsHaskell (PValue 'Unsorted 'NoGuarantees) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type AsHaskell (PValue 'Unsorted 'NoGuarantees) = AsHaskell (DeriveNewtypePLiftable (PValue 'Unsorted 'NoGuarantees) Value)
type PlutusRepr (PValue 'Unsorted 'NoGuarantees) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PlutusRepr (PValue 'Unsorted 'NoGuarantees) = PlutusRepr (DeriveNewtypePLiftable (PValue 'Unsorted 'NoGuarantees) Value)
type PContravariant' (PValue keys amounts) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PContravariant' (PValue keys amounts) = PContravariant' (DeriveNewtypePlutusType (PValue keys amounts))
type PCovariant' (PValue keys amounts) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PCovariant' (PValue keys amounts) = PCovariant' (DeriveNewtypePlutusType (PValue keys amounts))
type PInner (PValue keys amounts) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type PInner (PValue keys amounts) = PInner (DeriveNewtypePlutusType (PValue keys amounts))
type PVariant' (PValue keys amounts) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PVariant' (PValue keys amounts) = PVariant' (DeriveNewtypePlutusType (PValue keys amounts))
type Rep (PValue keys amounts s) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

type Rep (PValue keys amounts s) = D1 ('MetaData "PValue" "Plutarch.LedgerApi.Value" "plutarch-ledger-api-3.3.0-9uebfPQOA90BujqVBUbxih" 'True) (C1 ('MetaCons "PValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Term s (PMap keys PCurrencySymbol (PMap keys PTokenName PInteger))))))
type Code (PValue keys amounts s) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type Code (PValue keys amounts s) = GCode (PValue keys amounts s)

newtype PCurrencySymbol (s :: S) Source #

Since: 2.0.0

Constructors

PCurrencySymbol (Term s PByteString) 

Instances

Instances details
PEq PCurrencySymbol Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#==) :: forall (s :: S). Term s PCurrencySymbol -> Term s PCurrencySymbol -> Term s PBool

PIsData PCurrencySymbol Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pfromDataImpl :: forall (s :: S). Term s (PAsData PCurrencySymbol) -> Term s PCurrencySymbol

pdataImpl :: forall (s :: S). Term s PCurrencySymbol -> Term s PData

PLiftable PCurrencySymbol Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type AsHaskell PCurrencySymbol

type PlutusRepr PCurrencySymbol

Methods

haskToRepr :: AsHaskell PCurrencySymbol -> PlutusRepr PCurrencySymbol

reprToHask :: PlutusRepr PCurrencySymbol -> Either LiftError (AsHaskell PCurrencySymbol)

reprToPlut :: forall (s :: S). PlutusRepr PCurrencySymbol -> PLifted s PCurrencySymbol

plutToRepr :: (forall (s :: S). PLifted s PCurrencySymbol) -> Either LiftError (PlutusRepr PCurrencySymbol)

POrd PCurrencySymbol Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#<=) :: forall (s :: S). Term s PCurrencySymbol -> Term s PCurrencySymbol -> Term s PBool

(#<) :: forall (s :: S). Term s PCurrencySymbol -> Term s PCurrencySymbol -> Term s PBool

pmax :: forall (s :: S). Term s PCurrencySymbol -> Term s PCurrencySymbol -> Term s PCurrencySymbol

pmin :: forall (s :: S). Term s PCurrencySymbol -> Term s PCurrencySymbol -> Term s PCurrencySymbol

PlutusType PCurrencySymbol Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type PInner PCurrencySymbol :: PType

type PCovariant' PCurrencySymbol

type PContravariant' PCurrencySymbol

type PVariant' PCurrencySymbol

Methods

pcon' :: forall (s :: S). PCurrencySymbol s -> Term s (PInner PCurrencySymbol)

pmatch' :: forall (s :: S) (b :: PType). Term s (PInner PCurrencySymbol) -> (PCurrencySymbol s -> Term s b) -> Term s b

PShow PCurrencySymbol Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pshow' :: forall (s :: S). Bool -> Term s PCurrencySymbol -> Term s PString

Generic (PCurrencySymbol s) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type Rep (PCurrencySymbol s) :: Type -> Type Source #

Methods

from :: PCurrencySymbol s -> Rep (PCurrencySymbol s) x Source #

to :: Rep (PCurrencySymbol s) x -> PCurrencySymbol s Source #

Generic (PCurrencySymbol s) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type Code (PCurrencySymbol s) :: [[Type]]

Methods

from :: PCurrencySymbol s -> Rep (PCurrencySymbol s)

to :: Rep (PCurrencySymbol s) -> PCurrencySymbol s

type AsHaskell PCurrencySymbol Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type AsHaskell PCurrencySymbol = CurrencySymbol
type PlutusRepr PCurrencySymbol Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PlutusRepr PCurrencySymbol = ByteString
type PContravariant' PCurrencySymbol Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PContravariant' PCurrencySymbol = PContravariant' (DeriveNewtypePlutusType PTokenName)
type PCovariant' PCurrencySymbol Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PCovariant' PCurrencySymbol = PCovariant' (DeriveNewtypePlutusType PTokenName)
type PInner PCurrencySymbol Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type PInner PCurrencySymbol = PInner (DeriveNewtypePlutusType PTokenName)
type PVariant' PCurrencySymbol Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PVariant' PCurrencySymbol = PVariant' (DeriveNewtypePlutusType PTokenName)
type Rep (PCurrencySymbol s) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

type Rep (PCurrencySymbol s) = D1 ('MetaData "PCurrencySymbol" "Plutarch.LedgerApi.Value" "plutarch-ledger-api-3.3.0-9uebfPQOA90BujqVBUbxih" 'True) (C1 ('MetaCons "PCurrencySymbol" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Term s PByteString))))
type Code (PCurrencySymbol s) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type Code (PCurrencySymbol s) = GCode (PCurrencySymbol s)

newtype PTokenName (s :: S) Source #

Since: 2.0.0

Constructors

PTokenName (Term s PByteString) 

Instances

Instances details
PEq PTokenName Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#==) :: forall (s :: S). Term s PTokenName -> Term s PTokenName -> Term s PBool

PIsData PTokenName Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pfromDataImpl :: forall (s :: S). Term s (PAsData PTokenName) -> Term s PTokenName

pdataImpl :: forall (s :: S). Term s PTokenName -> Term s PData

PLiftable PTokenName Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type AsHaskell PTokenName

type PlutusRepr PTokenName

Methods

haskToRepr :: AsHaskell PTokenName -> PlutusRepr PTokenName

reprToHask :: PlutusRepr PTokenName -> Either LiftError (AsHaskell PTokenName)

reprToPlut :: forall (s :: S). PlutusRepr PTokenName -> PLifted s PTokenName

plutToRepr :: (forall (s :: S). PLifted s PTokenName) -> Either LiftError (PlutusRepr PTokenName)

POrd PTokenName Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#<=) :: forall (s :: S). Term s PTokenName -> Term s PTokenName -> Term s PBool

(#<) :: forall (s :: S). Term s PTokenName -> Term s PTokenName -> Term s PBool

pmax :: forall (s :: S). Term s PTokenName -> Term s PTokenName -> Term s PTokenName

pmin :: forall (s :: S). Term s PTokenName -> Term s PTokenName -> Term s PTokenName

PlutusType PTokenName Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type PInner PTokenName :: PType

type PCovariant' PTokenName

type PContravariant' PTokenName

type PVariant' PTokenName

Methods

pcon' :: forall (s :: S). PTokenName s -> Term s (PInner PTokenName)

pmatch' :: forall (s :: S) (b :: PType). Term s (PInner PTokenName) -> (PTokenName s -> Term s b) -> Term s b

PShow PTokenName Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pshow' :: forall (s :: S). Bool -> Term s PTokenName -> Term s PString

Generic (PTokenName s) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type Rep (PTokenName s) :: Type -> Type Source #

Methods

from :: PTokenName s -> Rep (PTokenName s) x Source #

to :: Rep (PTokenName s) x -> PTokenName s Source #

Generic (PTokenName s) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type Code (PTokenName s) :: [[Type]]

Methods

from :: PTokenName s -> Rep (PTokenName s)

to :: Rep (PTokenName s) -> PTokenName s

type AsHaskell PTokenName Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type AsHaskell PTokenName = TokenName
type PlutusRepr PTokenName Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PlutusRepr PTokenName = ByteString
type PContravariant' PTokenName Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PContravariant' PTokenName = PContravariant' (DeriveNewtypePlutusType PTokenName)
type PCovariant' PTokenName Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PCovariant' PTokenName = PCovariant' (DeriveNewtypePlutusType PTokenName)
type PInner PTokenName Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type PInner PTokenName = PInner (DeriveNewtypePlutusType PTokenName)
type PVariant' PTokenName Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PVariant' PTokenName = PVariant' (DeriveNewtypePlutusType PTokenName)
type Rep (PTokenName s) Source #

Since: 2.0.0

Instance details

Defined in Plutarch.LedgerApi.Value

type Rep (PTokenName s) = D1 ('MetaData "PTokenName" "Plutarch.LedgerApi.Value" "plutarch-ledger-api-3.3.0-9uebfPQOA90BujqVBUbxih" 'True) (C1 ('MetaCons "PTokenName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Term s PByteString))))
type Code (PTokenName s) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type Code (PTokenName s) = GCode (PTokenName s)

data AmountGuarantees Source #

Since: 2.0.0

Constructors

NoGuarantees 
NonZero 
Positive 

newtype PLovelace (s :: S) Source #

Since: 2.2.0

Constructors

PLovelace (Term s PInteger) 

Instances

Instances details
PEq PLovelace Source #

Since: 2.2.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#==) :: forall (s :: S). Term s PLovelace -> Term s PLovelace -> Term s PBool

PIsData PLovelace Source #

Since: 2.2.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pfromDataImpl :: forall (s :: S). Term s (PAsData PLovelace) -> Term s PLovelace

pdataImpl :: forall (s :: S). Term s PLovelace -> Term s PData

PLiftable PLovelace Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type AsHaskell PLovelace

type PlutusRepr PLovelace

Methods

haskToRepr :: AsHaskell PLovelace -> PlutusRepr PLovelace

reprToHask :: PlutusRepr PLovelace -> Either LiftError (AsHaskell PLovelace)

reprToPlut :: forall (s :: S). PlutusRepr PLovelace -> PLifted s PLovelace

plutToRepr :: (forall (s :: S). PLifted s PLovelace) -> Either LiftError (PlutusRepr PLovelace)

POrd PLovelace Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#<=) :: forall (s :: S). Term s PLovelace -> Term s PLovelace -> Term s PBool

(#<) :: forall (s :: S). Term s PLovelace -> Term s PLovelace -> Term s PBool

pmax :: forall (s :: S). Term s PLovelace -> Term s PLovelace -> Term s PLovelace

pmin :: forall (s :: S). Term s PLovelace -> Term s PLovelace -> Term s PLovelace

PlutusType PLovelace Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type PInner PLovelace :: PType

type PCovariant' PLovelace

type PContravariant' PLovelace

type PVariant' PLovelace

Methods

pcon' :: forall (s :: S). PLovelace s -> Term s (PInner PLovelace)

pmatch' :: forall (s :: S) (b :: PType). Term s (PInner PLovelace) -> (PLovelace s -> Term s b) -> Term s b

PShow PLovelace Source #

Since: 2.2.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pshow' :: forall (s :: S). Bool -> Term s PLovelace -> Term s PString

Generic (PLovelace s) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type Rep (PLovelace s) :: Type -> Type Source #

Methods

from :: PLovelace s -> Rep (PLovelace s) x Source #

to :: Rep (PLovelace s) x -> PLovelace s Source #

Generic (PLovelace s) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type Code (PLovelace s) :: [[Type]]

Methods

from :: PLovelace s -> Rep (PLovelace s)

to :: Rep (PLovelace s) -> PLovelace s

type AsHaskell PLovelace Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type AsHaskell PLovelace = AsHaskell (DeriveNewtypePLiftable PLovelace Lovelace)
type PlutusRepr PLovelace Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PlutusRepr PLovelace = PlutusRepr (DeriveNewtypePLiftable PLovelace Lovelace)
type PContravariant' PLovelace Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PContravariant' PLovelace = PContravariant' (DeriveNewtypePlutusType PLovelace)
type PCovariant' PLovelace Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PCovariant' PLovelace = PCovariant' (DeriveNewtypePlutusType PLovelace)
type PInner PLovelace Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type PInner PLovelace = PInner (DeriveNewtypePlutusType PLovelace)
type PVariant' PLovelace Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PVariant' PLovelace = PVariant' (DeriveNewtypePlutusType PLovelace)
type Rep (PLovelace s) Source #

Since: 2.2.0

Instance details

Defined in Plutarch.LedgerApi.Value

type Rep (PLovelace s) = D1 ('MetaData "PLovelace" "Plutarch.LedgerApi.Value" "plutarch-ledger-api-3.3.0-9uebfPQOA90BujqVBUbxih" 'True) (C1 ('MetaCons "PLovelace" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Term s PInteger))))
type Code (PLovelace s) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type Code (PLovelace s) = GCode (PLovelace s)

newtype PAssetClass (s :: S) Source #

Since: 3.3.0

Constructors

PAssetClass (Term s (PBuiltinPair (PAsData PCurrencySymbol) (PAsData PTokenName))) 

Instances

Instances details
PEq PAssetClass Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#==) :: forall (s :: S). Term s PAssetClass -> Term s PAssetClass -> Term s PBool

PIsData PAssetClass Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pfromDataImpl :: forall (s :: S). Term s (PAsData PAssetClass) -> Term s PAssetClass

pdataImpl :: forall (s :: S). Term s PAssetClass -> Term s PData

PLiftable PAssetClass Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type AsHaskell PAssetClass

type PlutusRepr PAssetClass

Methods

haskToRepr :: AsHaskell PAssetClass -> PlutusRepr PAssetClass

reprToHask :: PlutusRepr PAssetClass -> Either LiftError (AsHaskell PAssetClass)

reprToPlut :: forall (s :: S). PlutusRepr PAssetClass -> PLifted s PAssetClass

plutToRepr :: (forall (s :: S). PLifted s PAssetClass) -> Either LiftError (PlutusRepr PAssetClass)

POrd PAssetClass Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

(#<=) :: forall (s :: S). Term s PAssetClass -> Term s PAssetClass -> Term s PBool

(#<) :: forall (s :: S). Term s PAssetClass -> Term s PAssetClass -> Term s PBool

pmax :: forall (s :: S). Term s PAssetClass -> Term s PAssetClass -> Term s PAssetClass

pmin :: forall (s :: S). Term s PAssetClass -> Term s PAssetClass -> Term s PAssetClass

PlutusType PAssetClass Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type PInner PAssetClass :: PType

type PCovariant' PAssetClass

type PContravariant' PAssetClass

type PVariant' PAssetClass

Methods

pcon' :: forall (s :: S). PAssetClass s -> Term s (PInner PAssetClass)

pmatch' :: forall (s :: S) (b :: PType). Term s (PInner PAssetClass) -> (PAssetClass s -> Term s b) -> Term s b

PShow PAssetClass Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

Methods

pshow' :: forall (s :: S). Bool -> Term s PAssetClass -> Term s PString

Generic (PAssetClass s) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type Rep (PAssetClass s) :: Type -> Type Source #

Methods

from :: PAssetClass s -> Rep (PAssetClass s) x Source #

to :: Rep (PAssetClass s) x -> PAssetClass s Source #

Generic (PAssetClass s) Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

Associated Types

type Code (PAssetClass s) :: [[Type]]

Methods

from :: PAssetClass s -> Rep (PAssetClass s)

to :: Rep (PAssetClass s) -> PAssetClass s

type AsHaskell PAssetClass Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type AsHaskell PAssetClass = AsHaskell (DeriveNewtypePLiftable PAssetClass AssetClass)
type PlutusRepr PAssetClass Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PlutusRepr PAssetClass = PlutusRepr (DeriveNewtypePLiftable PAssetClass AssetClass)
type PContravariant' PAssetClass Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PContravariant' PAssetClass = PContravariant' (DeriveNewtypePlutusType PAssetClass)
type PCovariant' PAssetClass Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PCovariant' PAssetClass = PCovariant' (DeriveNewtypePlutusType PAssetClass)
type PInner PAssetClass Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type PInner PAssetClass = PInner (DeriveNewtypePlutusType PAssetClass)
type PVariant' PAssetClass Source # 
Instance details

Defined in Plutarch.LedgerApi.Value

type PVariant' PAssetClass = PVariant' (DeriveNewtypePlutusType PAssetClass)
type Rep (PAssetClass s) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type Rep (PAssetClass s) = D1 ('MetaData "PAssetClass" "Plutarch.LedgerApi.Value" "plutarch-ledger-api-3.3.0-9uebfPQOA90BujqVBUbxih" 'True) (C1 ('MetaCons "PAssetClass" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Term s (PBuiltinPair (PAsData PCurrencySymbol) (PAsData PTokenName))))))
type Code (PAssetClass s) Source #

Since: 3.3.0

Instance details

Defined in Plutarch.LedgerApi.Value

type Code (PAssetClass s) = GCode (PAssetClass s)

Functions

Creation

PCurrencySymbol

padaSymbol :: forall (s :: S). Term s PCurrencySymbol Source #

The PCurrencySymbol of the Ada currency.

Since: 2.1.1

padaSymbolData :: forall (s :: S). Term s (PAsData PCurrencySymbol) Source #

Data-encoded PCurrencySymbol of the Ada currency.

Since: 2.1.1

PTokenName

padaToken :: Term s PTokenName Source #

The PTokenName of the Ada currency.

Since: 2.1.1

PValue

psingleton :: forall (s :: S). Term s (PCurrencySymbol :--> (PTokenName :--> (PInteger :--> PValue 'Sorted 'NonZero))) Source #

Construct a singleton PValue containing only the given quantity of the given currency.

Since: 2.1.1

psingletonData :: forall (s :: S). Term s (PAsData PCurrencySymbol :--> (PAsData PTokenName :--> (PAsData PInteger :--> PValue 'Sorted 'NonZero))) Source #

Construct a singleton PValue containing only the given quantity of the given currency, taking data-encoded parameters.

Since: 2.1.1

pconstantPositiveSingleton :: forall (s :: S). (forall (s' :: S). Term s' PCurrencySymbol) -> (forall (s' :: S). Term s' PTokenName) -> (forall (s' :: S). Term s' PInteger) -> Term s (PValue 'Sorted 'Positive) Source #

Construct a constant singleton PValue containing only the given positive quantity of the given currency.

Since: 2.1.1

Transformation

passertPositive :: forall (kg :: KeyGuarantees) (ag :: AmountGuarantees) (s :: S). Term s (PValue kg ag :--> PValue kg 'Positive) Source #

Given a PValue, either construct another PValue with the same contents and a proof that all amounts in it are positive, or error.

Since: 2.0.0

passertNonZero :: forall (kg :: KeyGuarantees) (ag :: AmountGuarantees). forall (s :: S). Term s (PValue kg ag :--> PValue kg 'NonZero) Source #

passertSorted :: forall (anyKey :: KeyGuarantees) (anyAmount :: AmountGuarantees) (s :: S). Term s (PValue anyKey anyAmount :--> PValue 'Sorted 'NonZero) Source #

Assert the value is properly sorted and normalized.

Since: 2.1.1

pforgetPositive :: forall (a :: AmountGuarantees) (k :: KeyGuarantees) (s :: S). Term s (PValue k 'Positive) -> Term s (PValue k a) Source #

'Forget' that a Value has an only-positive guarantee.

Since: 2.0.0

pforgetSorted :: forall (a :: AmountGuarantees) (k :: KeyGuarantees) (s :: S). Term s (PValue 'Sorted a) -> Term s (PValue k a) Source #

Forget the knowledge of all value's guarantees.

Since: 2.1.1

pnormalize :: forall (any :: AmountGuarantees) (s :: S). Term s (PValue 'Sorted any :--> PValue 'Sorted 'NonZero) Source #

Normalize the argument to contain no zero quantity nor empty token map.

Since: 2.0.0

padaOnlyValue :: forall (v :: AmountGuarantees) (s :: S). Term s (PValue 'Sorted v :--> PValue 'Sorted v) Source #

Strip all non-Ada from a PValue.

Since: 2.1.1

pnoAdaValue :: forall (v :: AmountGuarantees) (s :: S). Term s (PValue 'Sorted v :--> PValue 'Sorted v) Source #

Strip all Ada from a PValue.

Since: 2.1.1

Partial ordering

pltPositive :: forall (s :: S). Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive) -> Term s PBool Source #

Mimics the lt operation on plutus-ledger-api's Value.

Since: 3.3.0

pltNonZero :: forall (s :: S). Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero) -> Term s PBool Source #

As pltPositive, but for nonzero guaranteed PValues instead.

Since: 3.3.0

pleqPositive :: forall (s :: S). Term s (PValue 'Sorted 'Positive) -> Term s (PValue 'Sorted 'Positive) -> Term s PBool Source #

Mimics the leq operation on plutus-ledger-api's Value.

Since: 3.3.0

pleqNonZero :: forall (s :: S). Term s (PValue 'Sorted 'NonZero) -> Term s (PValue 'Sorted 'NonZero) -> Term s PBool Source #

As pletPositive, but for nonzero guaranteed PValues instead.

Since: 3.3.0

pcheckBinRel :: forall (any0 :: AmountGuarantees) (any1 :: AmountGuarantees) (s :: S). Term s ((PInteger :--> (PInteger :--> PBool)) :--> (PValue 'Sorted any0 :--> (PValue 'Sorted any1 :--> PBool))) Source #

Given a description of a relation on amounts, check whether that relation holds over sorted PValues.

Important note

This is intended for use with boolean comparison functions, which must define at least a partial order (total orders and equivalences are acceptable as well). Use of this with anything else is not guaranteed to give anything resembling a sensible answer. Use with extreme care.

Since: 2.0.0

Combination

pleftBiasedCurrencyUnion :: forall (any0 :: AmountGuarantees) (any1 :: AmountGuarantees) (s :: S). Term s (PValue 'Sorted any0 :--> (PValue 'Sorted any1 :--> PValue 'Sorted 'NoGuarantees)) Source #

Combine two PValues, taking the tokens from the left only, if a currency occurs on both sides.

Since: 2.1.1

pleftBiasedTokenUnion :: forall (any0 :: AmountGuarantees) (any1 :: AmountGuarantees) (s :: S). Term s (PValue 'Sorted any0 :--> (PValue 'Sorted any1 :--> PValue 'Sorted 'NoGuarantees)) Source #

Combine two PValues, taking the tokens from the left only, if a token name of the same currency occurs on both sides.

Prefer this over 'punionResolvingCollisionsWith NonCommutative # plam const'. It is equivalent, but performs better.

Since: 2.1.1

punionResolvingCollisionsWith :: forall (any0 :: AmountGuarantees) (any1 :: AmountGuarantees) (s :: S). Commutativity -> Term s ((PInteger :--> (PInteger :--> PInteger)) :--> (PValue 'Sorted any0 :--> (PValue 'Sorted any1 :--> PValue 'Sorted 'NoGuarantees))) Source #

Combine two PValues applying the given function to any pair of quantities with the same asset class. Note that the result is _not_ normalized and may contain zero quantities.

Since: 2.0.0

punionResolvingCollisionsWithData :: forall (any0 :: AmountGuarantees) (any1 :: AmountGuarantees) (s :: S). Commutativity -> Term s ((PAsData PInteger :--> (PAsData PInteger :--> PAsData PInteger)) :--> (PValue 'Sorted any0 :--> (PValue 'Sorted any1 :--> PValue 'Sorted 'NoGuarantees))) Source #

Combine two PValues applying the given function to any pair of data-encoded quantities with the same asset class. Note that the result is _not_ normalized and may contain zero quantities.

Since: 2.1.1

Queries

pvalueOf :: forall (anyKey :: KeyGuarantees) (anyAmount :: AmountGuarantees) (s :: S). Term s (PValue anyKey anyAmount :--> (PCurrencySymbol :--> (PTokenName :--> PInteger))) Source #

Get the quantity of the given currency in the PValue.

Since: 2.1.1

plovelaceValueOf :: forall (v :: AmountGuarantees) (s :: S). Term s (PValue 'Sorted v :--> PInteger) Source #

Get the amount of Lovelace in the PValue.

Since: 2.1.1

pisAdaOnlyValue :: forall (s :: S). Term s (PValue 'Sorted 'Positive :--> PBool) Source #

Test if the value contains nothing but Ada

Since: 2.1.1