Safe Haskell	Safe-Inferred
Language	Haskell2010

Cooked.Skeleton.Output

Contents

Type constraints
Data types
Optics
Smart constructors

Description

This module exposes the outputs constructs used in a TxSkel and their associated utilities. To build payments in a skeleton, the usual way is to invoke txSkelIns = [pk receives Value v, script receives (InlineDatum dat && ReferenceScript script)]

Synopsis

class IsTxSkelOutAllowedOwner a where
- toPKHOrVScript :: a -> User IsEither Allocation
data PayableKind where
- IsDatum :: PayableKind
- IsReferenceScript :: PayableKind
- IsValue :: PayableKind
- IsStakingCredential :: PayableKind
data Payable :: [PayableKind] -> Type where
- VisibleHashedDatum :: DatumConstrs a => a -> Payable '[IsDatum]
- InlineDatum :: DatumConstrs a => a -> Payable '[IsDatum]
- HiddenHashedDatum :: DatumConstrs a => a -> Payable '[IsDatum]
- ReferenceScript :: ToVScript s => s -> Payable '[IsReferenceScript]
- Value :: ToValue a => a -> Payable '[IsValue]
- FixedValue :: ToValue a => a -> Payable '[IsValue]
- StakingCredential :: ToMaybeStakingCredential cred => cred -> Payable '[IsStakingCredential]
- PayableAnd :: els ⩀ els' => Payable els -> Payable els' -> Payable (els ∪ els')
data TxSkelOut where
- TxSkelOut :: {..} -> TxSkelOut
txSkelOutValueL :: Lens' TxSkelOut Value
txSkelOutValueAutoAdjustL :: Lens' TxSkelOut Bool
txSkelOutDatumL :: Lens' TxSkelOut TxSkelOutDatum
txSkelOutMReferenceScriptL :: Lens' TxSkelOut (Maybe VScript)
txSkelOutReferenceScriptAT :: AffineTraversal' TxSkelOut VScript
txSkelOutMStakingCredentialL :: Lens' TxSkelOut (Maybe StakingCredential)
txSkelOutStakingCredentialAT :: AffineTraversal' TxSkelOut StakingCredential
txSkelOutCredentialG :: Getter TxSkelOut Credential
txSkelOutAddressG :: Getter TxSkelOut Address
txSkelOutReferenceScriptHashAF :: AffineFold TxSkelOut ScriptHash
txSkelOutOwnerL :: Lens' TxSkelOut (User 'IsEither 'Allocation)
(<&&>) :: els ⩀ els' => Payable els -> Payable els' -> Payable (els ∪ els')
receives :: IsTxSkelOutAllowedOwner owner => owner -> Payable els -> TxSkelOut

Type constraints

class IsTxSkelOutAllowedOwner a where Source #

A conveniency typeclass to automated the creation of TxSkelOut owners, to be used alongside Payable with the smart constructor receives.

Methods

toPKHOrVScript :: a -> User IsEither Allocation Source #

Instances

Instances details

IsTxSkelOutAllowedOwner VScript Source #
Instance details Defined in Cooked.Skeleton.Output Methods toPKHOrVScript :: VScript -> User 'IsEither 'Allocation Source #
IsTxSkelOutAllowedOwner Wallet Source #
Instance details Defined in Cooked.Skeleton.Output Methods toPKHOrVScript :: Wallet -> User 'IsEither 'Allocation Source #
IsTxSkelOutAllowedOwner PubKeyHash Source #
Instance details Defined in Cooked.Skeleton.Output Methods toPKHOrVScript :: PubKeyHash -> User 'IsEither 'Allocation Source #
IsTxSkelOutAllowedOwner (Versioned Validator) Source #
Instance details Defined in Cooked.Skeleton.Output Methods toPKHOrVScript :: Versioned Validator -> User 'IsEither 'Allocation Source #
Typeable a => IsTxSkelOutAllowedOwner (TypedValidator a) Source #
Instance details Defined in Cooked.Skeleton.Output Methods toPKHOrVScript :: TypedValidator a -> User 'IsEither 'Allocation Source #
Typeable a => IsTxSkelOutAllowedOwner (MultiPurposeScript a) Source #
Instance details Defined in Cooked.Skeleton.Output Methods toPKHOrVScript :: MultiPurposeScript a -> User 'IsEither 'Allocation Source #
IsTxSkelOutAllowedOwner (User 'IsEither 'Allocation) Source #
Instance details Defined in Cooked.Skeleton.Output Methods toPKHOrVScript :: User 'IsEither 'Allocation -> User 'IsEither 'Allocation Source #
IsTxSkelOutAllowedOwner (User 'IsPubKey 'Allocation) Source #
Instance details Defined in Cooked.Skeleton.Output Methods toPKHOrVScript :: User 'IsPubKey 'Allocation -> User 'IsEither 'Allocation Source #

Data types

data PayableKind where Source #

The kind of possible components of a TxSkelOut, other than the owner

Constructors

IsDatum :: PayableKind
IsReferenceScript :: PayableKind
IsValue :: PayableKind
IsStakingCredential :: PayableKind

data Payable :: [PayableKind] -> Type where Source #

Payable elements. Created from concrete elements or composed. Notice that there is no way of building an element of Type Payable '[] so when using an element of Type Payable els we are sure that something was in fact paid. Also, there is no way of building an element of type Payable '[a,a] so we also know at most one occurrence of each type of payment is performed.

Constructors

VisibleHashedDatum :: DatumConstrs a => a -> Payable '[IsDatum]	Hashed datums visible in the transaction are payable
InlineDatum :: DatumConstrs a => a -> Payable '[IsDatum]	Inline datums are payable
HiddenHashedDatum :: DatumConstrs a => a -> Payable '[IsDatum]	Hashed datums hidden from the transaction are payable
ReferenceScript :: ToVScript s => s -> Payable '[IsReferenceScript]	Reference scripts are payable
Value :: ToValue a => a -> Payable '[IsValue]	Values are payable and are subject to min ada adjustment
FixedValue :: ToValue a => a -> Payable '[IsValue]	Fixed Values are payable but are NOT subject to min ada adjustment
StakingCredential :: ToMaybeStakingCredential cred => cred -> Payable '[IsStakingCredential]	Staking credentials are payable
PayableAnd :: els ⩀ els' => Payable els -> Payable els' -> Payable (els ∪ els')	Payables can be combined as long as their list of tags are disjoint

data TxSkelOut where Source #

An output to be put into a TxSkel

Constructors

TxSkelOut
Fields :: { txSkelOutOwner :: User IsEither Allocation , txSkelOutStakingCredential :: Maybe StakingCredential , txSkelOutDatum :: TxSkelOutDatum , txSkelOutValue :: Value , txSkelOutValueAutoAdjust :: Bool , txSkelOutReferenceScript :: Maybe VScript } -> TxSkelOut

Instances

Instances details

Monoid DoubleSatDelta Source #
Instance details Defined in Cooked.Attack.DoubleSat Methods mempty :: DoubleSatDelta # mappend :: DoubleSatDelta -> DoubleSatDelta -> DoubleSatDelta # mconcat :: [DoubleSatDelta] -> DoubleSatDelta #
Semigroup DoubleSatDelta Source #
Instance details Defined in Cooked.Attack.DoubleSat Methods (<>) :: DoubleSatDelta -> DoubleSatDelta -> DoubleSatDelta # sconcat :: NonEmpty DoubleSatDelta -> DoubleSatDelta # stimes :: Integral b => b -> DoubleSatDelta -> DoubleSatDelta #
Show TxSkelOut Source #
Instance details Defined in Cooked.Skeleton.Output Methods showsPrec :: Int -> TxSkelOut -> ShowS # show :: TxSkelOut -> String # showList :: [TxSkelOut] -> ShowS #
PrettyCooked TxSkelOut Source #
Instance details Defined in Cooked.Pretty.Skeleton Methods prettyCookedOpt :: PrettyCookedOpts -> TxSkelOut -> DocCooked Source # prettyCooked :: TxSkelOut -> DocCooked Source #
PrettyCookedList TxSkelOut Source #
Instance details Defined in Cooked.Pretty.Skeleton Methods prettyCookedOptList :: PrettyCookedOpts -> TxSkelOut -> [DocCooked] Source # prettyCookedOptListMaybe :: PrettyCookedOpts -> TxSkelOut -> [Maybe DocCooked] Source # prettyCookedList :: TxSkelOut -> [DocCooked] Source #
Eq TxSkelOut Source #
Instance details Defined in Cooked.Skeleton.Output Methods (==) :: TxSkelOut -> TxSkelOut -> Bool # (/=) :: TxSkelOut -> TxSkelOut -> Bool #
Ord TxSkelOut Source #
Instance details Defined in Cooked.Skeleton.Output Methods compare :: TxSkelOut -> TxSkelOut -> Ordering # (<) :: TxSkelOut -> TxSkelOut -> Bool # (<=) :: TxSkelOut -> TxSkelOut -> Bool # (>) :: TxSkelOut -> TxSkelOut -> Bool # (>=) :: TxSkelOut -> TxSkelOut -> Bool # max :: TxSkelOut -> TxSkelOut -> TxSkelOut # min :: TxSkelOut -> TxSkelOut -> TxSkelOut #
ToAddress TxSkelOut Source #
Instance details Defined in Cooked.Skeleton.Output Methods toAddress :: TxSkelOut -> Address #
ToCredential TxSkelOut Source #
Instance details Defined in Cooked.Skeleton.Output Methods toCredential :: TxSkelOut -> Credential #

Optics

txSkelOutValueL :: Lens' TxSkelOut Value Source #

Focuses on the Value of this TxSkelOut

txSkelOutValueAutoAdjustL :: Lens' TxSkelOut Bool Source #

Focuses on whether the Value contained in this TxSkelOut can be adjusted to min ADA during transaction generation

txSkelOutDatumL :: Lens' TxSkelOut TxSkelOutDatum Source #

Optics focusing on the datum of a TxSkelOut

Focuses on the TxSkelOutDatum of this TxSkelOut

txSkelOutMReferenceScriptL :: Lens' TxSkelOut (Maybe VScript) Source #

Focuses on the Maybe VScript corresponding to the possible reference script contained in this TxSkelOut

txSkelOutReferenceScriptAT :: AffineTraversal' TxSkelOut VScript Source #

Focuses on the reference script of this TxSkelOut

txSkelOutMStakingCredentialL :: Lens' TxSkelOut (Maybe StakingCredential) Source #

Focuses on the Maybe StakingCredential of this TxSkelOut

txSkelOutStakingCredentialAT :: AffineTraversal' TxSkelOut StakingCredential Source #

Focuses on the staking credential of this TxSkelOut

txSkelOutCredentialG :: Getter TxSkelOut Credential Source #

Returns the credential of this TxSkelOut

txSkelOutAddressG :: Getter TxSkelOut Address Source #

Returns the address of this TxSkelOut

txSkelOutReferenceScriptHashAF :: AffineFold TxSkelOut ScriptHash Source #

Returns the possible reference script has of this TxSkelOut

txSkelOutOwnerL :: Lens' TxSkelOut (User 'IsEither 'Allocation) Source #

Focuses on the user of this TxSkelOut

Smart constructors

(<&&>) :: els ⩀ els' => Payable els -> Payable els' -> Payable (els ∪ els') Source #

An infix-usable alias for PayableAnd

receives :: IsTxSkelOutAllowedOwner owner => owner -> Payable els -> TxSkelOut infix 1 Source #

Smart constructor to build a TxSkelOut from an owner and Payable. This should be the main way of building outputs.