Moduleplutus-tx-1.70.0.0

PlutusTx.Blueprint

26 types
3 classes
23 values

Packageplutus-tx-1.70.0.0
Exports58
LicenceApache-2.0

valuedefinitionRef :: HasBlueprintDefinition t => Schema ts

valuedefinitionsFor :: DefinitionsFor ts => Definitions ts

valuederiveDefinitions :: DefinitionsFor (UnrollAll ts) => Definitions (UnrollAll ts)

valuedefinitionIdFromType :: Typeable t => DefinitionId

valuedefinitionIdFromTypeK :: Typeable t => DefinitionId

valuedefinitionIdList :: DefinitionId

valuedefinitionIdTuple2 :: DefinitionId

valuedefinitionIdTuple3 :: DefinitionId

valuedefinitionIdUnit :: DefinitionId

valueaddDefinition :: Definitions ts -> Definition t ts -> Definitions ts

valuedefinitionsToMap

:: Definitions ts
-> forall (xs :: [Type]). Schema xs -> v
-> Map DefinitionId v

valueoneOfASet :: ToJSON a => Set a -> Maybe Value

valuepurposeToText :: Purpose -> Text

valueemptyBytesSchema :: BytesSchema

valueemptyIntegerSchema :: IntegerSchema

valuemkListSchema :: Schema referencedTypes -> ListSchema referencedTypes

valuewithSchemaInfo

:: SchemaInfo -> SchemaInfo
-> Schema referencedTypes
-> Schema referencedTypes

valueannotationsToSchemaInfo :: [SchemaAnn] -> Either SchemaInfoError SchemaInfo

valueemptySchemaInfo :: SchemaInfo

valuecompiledValidator :: PlutusVersion -> ByteString -> CompiledValidator

valueencodeBlueprint :: ContractBlueprint -> ByteString

valuewriteBlueprint :: FilePath -> ContractBlueprint -> IO ()

datadata ArgumentBlueprint (referencedTypes :: [Type])

Constructors

MkArgumentBlueprint
- argumentTitle :: Maybe Text
- argumentDescription :: Maybe Text
- argumentPurpose :: Set Purpose
- argumentSchema :: Schema referencedTypes

Instances4Eq, Ord, Show, ToJSON

Eq (ArgumentBlueprint referencedTypes)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Argument
Ord (ArgumentBlueprint referencedTypes)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Argument
Show (ArgumentBlueprint referencedTypes)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Argument
ToJSON (ArgumentBlueprint referencedTypes)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Argument

classclass HasBlueprintSchema t (referencedTypes :: [Type]) where

Methods

schema :: Schema referencedTypes

Instances20HasBlueprintSchema, …

HasBlueprintSchema ByteString referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Class
HasBlueprintSchema Integer referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Class
HasBlueprintSchema Bool referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.IsData.Instances · orphan
HasBlueprintSchema Int referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Class
HasBlueprintSchema BuiltinByteString referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Class
HasBlueprintSchema BuiltinData referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Class
HasBlueprintSchema BuiltinString referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Class
HasBlueprintSchema BuiltinUnit referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Class
HasBlueprintSchema () referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.IsData.Instances · orphan
HasSchemaDefinition Integer referencedTypes => HasBlueprintSchema Rational referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Ratio
HasBlueprintSchema a referencedTypes => HasBlueprintSchema (BuiltinList a) referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Class
HasBlueprintSchema a referencedTypes => HasBlueprintSchema [a] referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Class
(HasBlueprintDefinition a, HasSchemaDefinition a referencedTypes) => HasBlueprintSchema (Maybe a) referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.IsData.Instances · orphan
(HasBlueprintSchema a referencedTypes, HasBlueprintSchema b referencedTypes) => HasBlueprintSchema (BuiltinPair a b) referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Class
(HasBlueprintSchema k referencedTypes, HasBlueprintSchema v referencedTypes) => HasBlueprintSchema (Map k v) referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.AssocMap
(HasBlueprintDefinition a, HasSchemaDefinition a referencedTypes, HasBlueprintDefinition b, HasSchemaDefinition b referencedTypes) => HasBlueprintSchema (Either a b) referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.IsData.Instances · orphan
(HasBlueprintDefinition a, HasSchemaDefinition a referencedTypes, HasBlueprintDefinition b, HasSchemaDefinition b referencedTypes) => HasBlueprintSchema (These a b) referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.These
(HasBlueprintDefinition a, HasSchemaDefinition a referencedTypes, HasBlueprintDefinition b, HasSchemaDefinition b referencedTypes) => HasBlueprintSchema (a, b) referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.IsData.Instances · orphan
(HasBlueprintDefinition a, HasSchemaDefinition a referencedTypes, HasBlueprintDefinition b, HasSchemaDefinition b referencedTypes, HasBlueprintDefinition c, HasSchemaDefinition c referencedTypes) => HasBlueprintSchema (a, b, c) referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.IsData.Instances · orphan
(HasBlueprintDefinition a, HasSchemaDefinition a referencedTypes, HasBlueprintDefinition b, HasSchemaDefinition b referencedTypes, HasBlueprintDefinition c, HasSchemaDefinition c referencedTypes, HasBlueprintDefinition d, HasSchemaDefinition d referencedTypes) => HasBlueprintSchema (a, b, c, d) referencedTypesDefined in plutus-tx-1.70.0.0 · PlutusTx.IsData.Instances · orphan

datadata ContractBlueprint where

Constructors

MkContractBlueprint :: Maybe Text -> Preamble -> Set (ValidatorBlueprint referencedTypes) -> Definitions referencedTypes -> ContractBlueprint
- contractId :: Maybe Text
- contractPreamble :: Preamble
- contractValidators :: Set (ValidatorBlueprint referencedTypes)
- contractDefinitions :: Definitions referencedTypes

Instances1ToJSON

ToJSON ContractBlueprintDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Contract

typetype DefinitionsFor (ts :: [Type]) = DefinitionsFor' ts ts

classclass DefinitionsFor' (referencedTypes :: [Type]) (acc :: k) where

Methods

definitionsFor' :: Definitions referencedTypes

Instances2DefinitionsFor'

DefinitionsFor' referencedTypes '[]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Derive
(HasBlueprintDefinition t, HasBlueprintSchema t referencedTypes, DefinitionsFor' referencedTypes ts) => DefinitionsFor' referencedTypes (t ': ts)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Derive

newtypenewtype DefinitionId

Instances9Eq, Data, Ord, Show, Generic, Semigroup, …

Eq DefinitionIdDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Id
Data DefinitionIdDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Id
Ord DefinitionIdDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Id
Show DefinitionIdDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Id
Generic DefinitionIdDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Id
Semigroup DefinitionIdDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Id
ToJSON DefinitionIdDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Id
ToJSONKey DefinitionIdDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Id
type Rep DefinitionId = D1 ('MetaData "DefinitionId" "PlutusTx.Blueprint.Definition.Id" "plutus-tx-1.70.0.0-6Ae79dzJelpIrjL4E9N8Jt" 'True) (C1 ('MetaCons "MkDefinitionId" 'PrefixI 'True) (S1 ('MetaSel ('Just "definitionIdToText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Id

valuedefinitionIdToText :: DefinitionId -> Text

datadata Definition (t :: k) (ts :: [Type])

Constructors

MkDefinition DefinitionId (Schema ts)

Instances1Show

Show (Definition t ts)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Internal

datadata Definitions (ts :: [Type]) where

Constructors

NoDefinitions :: Definitions ts
AddDefinition :: Definition t ts -> Definitions ts -> Definitions ts

Instances1Show

Show (Definitions ts)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Internal

typetype HasSchemaDefinition t (ts :: [Type]) = HasSchemaDefinition' t ts ts

familytype family HasSchemaDefinition' n (xs :: [Type]) (xs0 :: [Type]) :: Constraint where

Equations

HasSchemaDefinition' x (x ': xs) _1 = ()
HasSchemaDefinition' x (_1 ': xs) xs0 = HasSchemaDefinition' x xs xs0
HasSchemaDefinition' n xs xs0 = TypeError (('ShowType n ':<>: 'Text " type was not found in the list of types having schema definitions: ") ':<>: 'ShowType xs0)

familytype family GUnroll (t :: Type -> Type) :: [Type] where

Equations

GUnroll (M1 _1 _2 f) = GUnroll f
GUnroll (f :*: g) = GUnroll f ++ GUnroll g
GUnroll (f :+: g) = GUnroll f ++ GUnroll g
GUnroll (K1 _1 c) = Unrolled c
GUnroll U1 = '[]

classclass HasBlueprintDefinition t where

Associated types

type family Unroll t :: [Type]

Methods

definitionId :: DefinitionId

Instances18HasBlueprintDefinition, …

HasBlueprintDefinition VoidDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition IntegerDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition BoolDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition IntDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition BuiltinByteStringDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition BuiltinDataDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition BuiltinStringDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition BuiltinUnitDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition RationalDefined in plutus-tx-1.70.0.0 · PlutusTx.Ratio
HasBlueprintDefinition ()Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition a => HasBlueprintDefinition (Maybe a)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition a => HasBlueprintDefinition (BuiltinList a)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
HasBlueprintDefinition a => HasBlueprintDefinition [a]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
(Typeable a, Typeable b) => HasBlueprintDefinition (These a b)Defined in plutus-tx-1.70.0.0 · PlutusTx.These
(HasBlueprintDefinition a, HasBlueprintDefinition b) => HasBlueprintDefinition (BuiltinPair a b)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
(HasBlueprintDefinition a, HasBlueprintDefinition b) => HasBlueprintDefinition (a, b)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
(HasBlueprintDefinition k, HasBlueprintDefinition v) => HasBlueprintDefinition (Map k v)Defined in plutus-tx-1.70.0.0 · PlutusTx.AssocMap
(HasBlueprintDefinition a, HasBlueprintDefinition b, HasBlueprintDefinition c) => HasBlueprintDefinition (a, b, c)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll

familytype family RepIsStuckError (x :: t) :: k where

Equations

RepIsStuckError x = TypeError ((((('Text "Cannot derive generic representation for type '" ':<>: 'ShowType x) ':<>: 'Text "'.") ':$$: 'Text "Add 'deriving Generic' to enable automatic blueprint unrolling,") ':$$: 'Text "or provide a manual 'HasBlueprintDefinition' instance with") ':$$: 'Text "an explicit 'Unroll' type instance.")

familytype family Unroll t :: [Type]

Instances18Unroll, …

type Unroll Void = '[Void]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll Integer = '[Integer]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll Bool = '[Bool]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll Int = '[Int]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll BuiltinByteString = '[BuiltinByteString]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll BuiltinData = '[BuiltinData]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll BuiltinString = '[BuiltinString]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll BuiltinUnit = '[BuiltinUnit]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll Rational = '[Rational, Integer]Defined in plutus-tx-1.70.0.0 · PlutusTx.Ratio
type Unroll (Maybe a) = Insert (Maybe a) (Unrolled a)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll (Map k v) = '[Map k v, k, v]Defined in plutus-tx-1.70.0.0 · PlutusTx.AssocMap
type Unroll (BuiltinList a) = Insert (BuiltinList a) (Unrolled a)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll (BuiltinPair a b) = Insert (BuiltinPair a b) (Unrolled a ++ Unrolled b)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll (These a b) = Insert (These a b) (GUnroll (IfStuckRep (RepIsStuckError (These a b)) (Rep (These a b))))Defined in plutus-tx-1.70.0.0 · PlutusTx.These
type Unroll () = '[()]Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll (a, b) = Insert (a, b) (Unrolled a ++ Unrolled b)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll (a, b, c) = Insert (a, b, c) (Unrolled a ++ (Unrolled b ++ Unrolled c))Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll
type Unroll [a] = Insert [a] (Unrolled a)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Definition.Unroll

familytype family UnrollAll (xs :: [Type]) :: [Type] where

Equations

UnrollAll '[] = '[]
UnrollAll (x ': xs) = Nub (Concat (Unrolled x) (UnrollAll xs))

familytype family UnrollIsStuckError (x :: t) :: k where

Equations

UnrollIsStuckError x = TypeError ((((((((((('Text "Cannot unroll type '" ':<>: 'ShowType x) ':<>: 'Text "'.") ':$$: 'Text "The 'Unroll' type family is stuck because:") ':$$: 'Text " - The type may be abstract (a type variable), or") ':$$: 'Text " - It lacks a 'HasBlueprintDefinition' instance, or") ':$$: 'Text " - It lacks a 'Generic' instance for default unrolling.") ':$$: 'Text "") ':$$: 'Text "Tip: 'DefinitionsFor (UnrollAll ts)' requires all types in 'ts'") ':$$: 'Text "to be concrete at compile time. Polymorphic constraints like") ':$$: 'Text "'DefinitionsFor (UnrollAll '[a])' cannot be used as superclass") ':$$: 'Text "constraints because 'a' is not known when the class is defined.")

typetype Unrolled t = Reverse (IfStuckUnroll (UnrollIsStuckError t) (Unroll t))

datadata ParameterBlueprint (referencedTypes :: [Type])

Constructors

MkParameterBlueprint
- parameterTitle :: Maybe Text
- parameterDescription :: Maybe Text
- parameterPurpose :: Set Purpose
- parameterSchema :: Schema referencedTypes

Instances4Eq, Ord, Show, ToJSON

Eq (ParameterBlueprint referencedTypes)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Parameter
Ord (ParameterBlueprint referencedTypes)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Parameter
Show (ParameterBlueprint referencedTypes)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Parameter
ToJSON (ParameterBlueprint referencedTypes)Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Parameter

datadata PlutusVersion

PlutusV1 PlutusV2 PlutusV3 PlutusV4

Instances2Show, ToJSON

Show PlutusVersionDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.PlutusVersion
ToJSON PlutusVersionDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.PlutusVersion

datadata Preamble

Constructors

MkPreamble
- preambleTitle :: Text
- preambleDescription :: Maybe Text
- preambleVersion :: Text
- preamblePlutusVersion :: PlutusVersion
- preambleLicense :: Maybe Text

Instances4Show, Generic, ToJSON, Rep

Show PreambleDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Preamble
Generic PreambleDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Preamble
ToJSON PreambleDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Preamble
type Rep Preamble = D1 ('MetaData "Preamble" "PlutusTx.Blueprint.Preamble" "plutus-tx-1.70.0.0-6Ae79dzJelpIrjL4E9N8Jt" 'False) (C1 ('MetaCons "MkPreamble" 'PrefixI 'True) ((S1 ('MetaSel ('Just "preambleTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "preambleDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "preambleVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "preamblePlutusVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlutusVersion) :*: S1 ('MetaSel ('Just "preambleLicense") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))Defined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Preamble

datadata Purpose

Spend Mint Withdraw Publish

Instances5Eq, Ord, Show, ToJSON, Lift

Eq PurposeDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Purpose
Ord PurposeDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Purpose
Show PurposeDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Purpose
ToJSON PurposeDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Purpose
Lift PurposeDefined in plutus-tx-1.70.0.0 · PlutusTx.Blueprint.Purpose

datadata BytesSchema