Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusTx.Blueprint.Parameter

Synopsis

data ParameterBlueprint (referencedTypes ∷ [Type]) = MkParameterBlueprint {
- parameterTitle ∷ Maybe Text
- parameterDescription ∷ Maybe Text
- parameterPurpose ∷ Set Purpose
- parameterSchema ∷ Schema referencedTypes
}
oneOfASet ∷ ToJSON a ⇒ Set a → Maybe Value

Documentation

data ParameterBlueprint (referencedTypes ∷ [Type]) Source #

Blueprint that defines validator's compile-time parameter.

The referencedTypes phantom type parameter is used to track the types used in the contract making sure their schemas are included in the blueprint and that they are referenced in a type-safe way.

Constructors

MkParameterBlueprint
Fields parameterTitle ∷ Maybe Text A short and descriptive name for the parameter. parameterDescription ∷ Maybe Text An informative description of the parameter. parameterPurpose ∷ Set Purpose One of "spend", "mint", "withdraw" or "publish", or a oneOf applicator of those. parameterSchema ∷ Schema referencedTypes A Plutus Data Schema.

Instances

Instances details

ToJSON (ParameterBlueprint referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Parameter Methods toJSON ∷ ParameterBlueprint referencedTypes → Value toEncoding ∷ ParameterBlueprint referencedTypes → Encoding toJSONList ∷ [ParameterBlueprint referencedTypes] → Value toEncodingList ∷ [ParameterBlueprint referencedTypes] → Encoding omitField ∷ ParameterBlueprint referencedTypes → Bool
Show (ParameterBlueprint referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Parameter Methods showsPrec ∷ Int → ParameterBlueprint referencedTypes → ShowS Source # show ∷ ParameterBlueprint referencedTypes → String Source # showList ∷ [ParameterBlueprint referencedTypes] → ShowS Source #
Eq (ParameterBlueprint referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Parameter Methods (==) ∷ ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes → Bool Source # (/=) ∷ ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes → Bool Source #
Ord (ParameterBlueprint referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Parameter Methods compare ∷ ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes → Ordering Source # (<) ∷ ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes → Bool Source # (<=) ∷ ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes → Bool Source # (>) ∷ ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes → Bool Source # (>=) ∷ ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes → Bool Source # max ∷ ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes Source # min ∷ ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes → ParameterBlueprint referencedTypes Source #

oneOfASet ∷ ToJSON a ⇒ Set a → Maybe Value Source #