Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusTx.Blueprint.Schema

Synopsis

data Schema (referencedTypes ∷ [Type])
- = SchemaInteger SchemaInfo IntegerSchema
- | SchemaBytes SchemaInfo BytesSchema
- | SchemaList SchemaInfo (ListSchema referencedTypes)
- | SchemaMap SchemaInfo (MapSchema referencedTypes)
- | SchemaConstructor SchemaInfo (ConstructorSchema referencedTypes)
- | SchemaBuiltInData SchemaInfo
- | SchemaBuiltInUnit SchemaInfo
- | SchemaBuiltInBoolean SchemaInfo
- | SchemaBuiltInInteger SchemaInfo
- | SchemaBuiltInBytes SchemaInfo
- | SchemaBuiltInString SchemaInfo
- | SchemaBuiltInPair SchemaInfo (PairSchema referencedTypes)
- | SchemaBuiltInList SchemaInfo (Schema referencedTypes)
- | SchemaOneOf (NonEmpty (Schema referencedTypes))
- | SchemaAnyOf (NonEmpty (Schema referencedTypes))
- | SchemaAllOf (NonEmpty (Schema referencedTypes))
- | SchemaNot (Schema referencedTypes)
- | SchemaDefinitionRef DefinitionId
withSchemaInfo ∷ (SchemaInfo → SchemaInfo) → Schema referencedTypes → Schema referencedTypes
data IntegerSchema = MkIntegerSchema {
- multipleOf ∷ Maybe Integer
- minimum ∷ Maybe Integer
- maximum ∷ Maybe Integer
- exclusiveMinimum ∷ Maybe Integer
- exclusiveMaximum ∷ Maybe Integer
}
emptyIntegerSchema ∷ IntegerSchema
data BytesSchema = MkBytesSchema {
- enum ∷ [ByteString]
- minLength ∷ Maybe Natural
- maxLength ∷ Maybe Natural
}
emptyBytesSchema ∷ BytesSchema
data ListSchema (referencedTypes ∷ [Type]) = MkListSchema {
- itemSchema ∷ Schema referencedTypes
- minItems ∷ Maybe Natural
- maxItems ∷ Maybe Natural
- uniqueItems ∷ Maybe Bool
}
mkListSchema ∷ Schema referencedTypes → ListSchema referencedTypes
data MapSchema (referencedTypes ∷ [Type]) = MkMapSchema {
- keySchema ∷ Schema referencedTypes
- valueSchema ∷ Schema referencedTypes
- minItems ∷ Maybe Natural
- maxItems ∷ Maybe Natural
}
data ConstructorSchema (referencedTypes ∷ [Type]) = MkConstructorSchema {
- index ∷ Natural
- fieldSchemas ∷ [Schema referencedTypes]
}
data PairSchema (referencedTypes ∷ [Type]) = MkPairSchema {
- left ∷ Schema referencedTypes
- right ∷ Schema referencedTypes
}

Documentation

data Schema (referencedTypes ∷ [Type]) Source #

Blueprint schema definition, as defined by the CIP-0057: https://github.com/cardano-foundation/CIPs/tree/master/CIP-0057#core-vocabulary

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

SchemaInteger SchemaInfo IntegerSchema
SchemaBytes SchemaInfo BytesSchema
SchemaList SchemaInfo (ListSchema referencedTypes)
SchemaMap SchemaInfo (MapSchema referencedTypes)
SchemaConstructor SchemaInfo (ConstructorSchema referencedTypes)
SchemaBuiltInData SchemaInfo
SchemaBuiltInUnit SchemaInfo
SchemaBuiltInBoolean SchemaInfo
SchemaBuiltInInteger SchemaInfo
SchemaBuiltInBytes SchemaInfo
SchemaBuiltInString SchemaInfo
SchemaBuiltInPair SchemaInfo (PairSchema referencedTypes)
SchemaBuiltInList SchemaInfo (Schema referencedTypes)
SchemaOneOf (NonEmpty (Schema referencedTypes))
SchemaAnyOf (NonEmpty (Schema referencedTypes))
SchemaAllOf (NonEmpty (Schema referencedTypes))
SchemaNot (Schema referencedTypes)
SchemaDefinitionRef DefinitionId

Instances

Instances details

ToJSON (Schema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods toJSON ∷ Schema referencedTypes → Value toEncoding ∷ Schema referencedTypes → Encoding toJSONList ∷ [Schema referencedTypes] → Value toEncodingList ∷ [Schema referencedTypes] → Encoding omitField ∷ Schema referencedTypes → Bool
Typeable referencedTypes ⇒ Data (Schema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → Schema referencedTypes → c (Schema referencedTypes) Source # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c (Schema referencedTypes) Source # toConstr ∷ Schema referencedTypes → Constr Source # dataTypeOf ∷ Schema referencedTypes → DataType Source # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c (Schema referencedTypes)) Source # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c (Schema referencedTypes)) Source # gmapT ∷ (∀ b. Data b ⇒ b → b) → Schema referencedTypes → Schema referencedTypes Source # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → Schema referencedTypes → r Source # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → Schema referencedTypes → r Source # gmapQ ∷ (∀ d. Data d ⇒ d → u) → Schema referencedTypes → [u] Source # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → Schema referencedTypes → u Source # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → Schema referencedTypes → m (Schema referencedTypes) Source # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → Schema referencedTypes → m (Schema referencedTypes) Source # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → Schema referencedTypes → m (Schema referencedTypes) Source #
Generic (Schema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Associated Types type Rep (Schema referencedTypes) ∷ Type → Type Source # Methods from ∷ Schema referencedTypes → Rep (Schema referencedTypes) x Source # to ∷ Rep (Schema referencedTypes) x → Schema referencedTypes Source #
Show (Schema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods showsPrec ∷ Int → Schema referencedTypes → ShowS Source # show ∷ Schema referencedTypes → String Source # showList ∷ [Schema referencedTypes] → ShowS Source #
Eq (Schema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods (==) ∷ Schema referencedTypes → Schema referencedTypes → Bool Source # (/=) ∷ Schema referencedTypes → Schema referencedTypes → Bool Source #
Ord (Schema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods compare ∷ Schema referencedTypes → Schema referencedTypes → Ordering Source # (<) ∷ Schema referencedTypes → Schema referencedTypes → Bool Source # (<=) ∷ Schema referencedTypes → Schema referencedTypes → Bool Source # (>) ∷ Schema referencedTypes → Schema referencedTypes → Bool Source # (>=) ∷ Schema referencedTypes → Schema referencedTypes → Bool Source # max ∷ Schema referencedTypes → Schema referencedTypes → Schema referencedTypes Source # min ∷ Schema referencedTypes → Schema referencedTypes → Schema referencedTypes Source #
Typeable referencedTypes ⇒ Plated (Schema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods plate ∷ Traversal' (Schema referencedTypes) (Schema referencedTypes)
type Rep (Schema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema type Rep (Schema referencedTypes) = D1 ('MetaData "Schema" "PlutusTx.Blueprint.Schema" "plutus-tx-1.34.1.0-inplace" 'False) ((((C1 ('MetaCons "SchemaInteger" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IntegerSchema)) :+: C1 ('MetaCons "SchemaBytes" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BytesSchema))) :+: (C1 ('MetaCons "SchemaList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ListSchema referencedTypes))) :+: C1 ('MetaCons "SchemaMap" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (MapSchema referencedTypes))))) :+: ((C1 ('MetaCons "SchemaConstructor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ConstructorSchema referencedTypes))) :+: C1 ('MetaCons "SchemaBuiltInData" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo))) :+: (C1 ('MetaCons "SchemaBuiltInUnit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo)) :+: (C1 ('MetaCons "SchemaBuiltInBoolean" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo)) :+: C1 ('MetaCons "SchemaBuiltInInteger" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo)))))) :+: (((C1 ('MetaCons "SchemaBuiltInBytes" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo)) :+: C1 ('MetaCons "SchemaBuiltInString" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo))) :+: (C1 ('MetaCons "SchemaBuiltInPair" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (PairSchema referencedTypes))) :+: C1 ('MetaCons "SchemaBuiltInList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SchemaInfo) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Schema referencedTypes))))) :+: ((C1 ('MetaCons "SchemaOneOf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty (Schema referencedTypes)))) :+: C1 ('MetaCons "SchemaAnyOf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty (Schema referencedTypes))))) :+: (C1 ('MetaCons "SchemaAllOf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty (Schema referencedTypes)))) :+: (C1 ('MetaCons "SchemaNot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Schema referencedTypes))) :+: C1 ('MetaCons "SchemaDefinitionRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DefinitionId)))))))

withSchemaInfo ∷ (SchemaInfo → SchemaInfo) → Schema referencedTypes → Schema referencedTypes Source #

data IntegerSchema Source #

Constructors

MkIntegerSchema

Fields

multipleOf ∷ Maybe Integer
An instance is valid if division by this value results in an integer.
minimum ∷ Maybe Integer
An instance is valid only if it is greater than or exactly equal to "minimum".
maximum ∷ Maybe Integer
An instance is valid only if it is less than or exactly equal to "maximum".
exclusiveMinimum ∷ Maybe Integer
An instance is valid only if it is strictly greater than "exclusiveMinimum".
exclusiveMaximum ∷ Maybe Integer
An instance is valid only if it is strictly less than "exclusiveMaximum".

Instances

Instances details

Data IntegerSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → IntegerSchema → c IntegerSchema Source # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c IntegerSchema Source # toConstr ∷ IntegerSchema → Constr Source # dataTypeOf ∷ IntegerSchema → DataType Source # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c IntegerSchema) Source # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c IntegerSchema) Source # gmapT ∷ (∀ b. Data b ⇒ b → b) → IntegerSchema → IntegerSchema Source # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → IntegerSchema → r Source # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → IntegerSchema → r Source # gmapQ ∷ (∀ d. Data d ⇒ d → u) → IntegerSchema → [u] Source # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → IntegerSchema → u Source # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → IntegerSchema → m IntegerSchema Source # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → IntegerSchema → m IntegerSchema Source # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → IntegerSchema → m IntegerSchema Source #
Generic IntegerSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema Associated Types type Rep IntegerSchema ∷ Type → Type Source # Methods from ∷ IntegerSchema → Rep IntegerSchema x Source # to ∷ Rep IntegerSchema x → IntegerSchema Source #
Show IntegerSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods showsPrec ∷ Int → IntegerSchema → ShowS Source # show ∷ IntegerSchema → String Source # showList ∷ [IntegerSchema] → ShowS Source #
Eq IntegerSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods (==) ∷ IntegerSchema → IntegerSchema → Bool Source # (/=) ∷ IntegerSchema → IntegerSchema → Bool Source #
Ord IntegerSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods compare ∷ IntegerSchema → IntegerSchema → Ordering Source # (<) ∷ IntegerSchema → IntegerSchema → Bool Source # (<=) ∷ IntegerSchema → IntegerSchema → Bool Source # (>) ∷ IntegerSchema → IntegerSchema → Bool Source # (>=) ∷ IntegerSchema → IntegerSchema → Bool Source # max ∷ IntegerSchema → IntegerSchema → IntegerSchema Source # min ∷ IntegerSchema → IntegerSchema → IntegerSchema Source #
type Rep IntegerSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema type Rep IntegerSchema = D1 ('MetaData "IntegerSchema" "PlutusTx.Blueprint.Schema" "plutus-tx-1.34.1.0-inplace" 'False) (C1 ('MetaCons "MkIntegerSchema" 'PrefixI 'True) ((S1 ('MetaSel ('Just "multipleOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "minimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "maximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "exclusiveMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "exclusiveMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

emptyIntegerSchema ∷ IntegerSchema Source #

data BytesSchema Source #

Constructors

MkBytesSchema
Fields enum ∷ [ByteString] An instance validates successfully if once hex-encoded, its value matches one of the specified values. minLength ∷ Maybe Natural An instance is valid if its length is greater than, or equal to, this value. maxLength ∷ Maybe Natural An instance is valid if its length is less than, or equal to, this value.

Instances

Instances details

Data BytesSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → BytesSchema → c BytesSchema Source # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c BytesSchema Source # toConstr ∷ BytesSchema → Constr Source # dataTypeOf ∷ BytesSchema → DataType Source # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c BytesSchema) Source # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c BytesSchema) Source # gmapT ∷ (∀ b. Data b ⇒ b → b) → BytesSchema → BytesSchema Source # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → BytesSchema → r Source # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → BytesSchema → r Source # gmapQ ∷ (∀ d. Data d ⇒ d → u) → BytesSchema → [u] Source # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → BytesSchema → u Source # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → BytesSchema → m BytesSchema Source # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → BytesSchema → m BytesSchema Source # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → BytesSchema → m BytesSchema Source #
Generic BytesSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema Associated Types type Rep BytesSchema ∷ Type → Type Source # Methods from ∷ BytesSchema → Rep BytesSchema x Source # to ∷ Rep BytesSchema x → BytesSchema Source #
Show BytesSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods showsPrec ∷ Int → BytesSchema → ShowS Source # show ∷ BytesSchema → String Source # showList ∷ [BytesSchema] → ShowS Source #
Eq BytesSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods (==) ∷ BytesSchema → BytesSchema → Bool Source # (/=) ∷ BytesSchema → BytesSchema → Bool Source #
Ord BytesSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods compare ∷ BytesSchema → BytesSchema → Ordering Source # (<) ∷ BytesSchema → BytesSchema → Bool Source # (<=) ∷ BytesSchema → BytesSchema → Bool Source # (>) ∷ BytesSchema → BytesSchema → Bool Source # (>=) ∷ BytesSchema → BytesSchema → Bool Source # max ∷ BytesSchema → BytesSchema → BytesSchema Source # min ∷ BytesSchema → BytesSchema → BytesSchema Source #
type Rep BytesSchema Source #
Instance details Defined in PlutusTx.Blueprint.Schema type Rep BytesSchema = D1 ('MetaData "BytesSchema" "PlutusTx.Blueprint.Schema" "plutus-tx-1.34.1.0-inplace" 'False) (C1 ('MetaCons "MkBytesSchema" 'PrefixI 'True) (S1 ('MetaSel ('Just "enum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ByteString]) :: (S1 ('MetaSel ('Just "minLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "maxLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

emptyBytesSchema ∷ BytesSchema Source #

data ListSchema (referencedTypes ∷ [Type]) Source #

Constructors

MkListSchema

Fields

itemSchema ∷ Schema referencedTypes
Element schema
minItems ∷ Maybe Natural
An array instance is valid if its size is greater than, or equal to, this value.
maxItems ∷ Maybe Natural
An array instance is valid if its size is less than, or equal to, this value.
uniqueItems ∷ Maybe Bool
If this value is false, the instance validates successfully. If it is set to True, the instance validates successfully if all of its elements are unique.

Instances

Instances details

Typeable referencedTypes ⇒ Data (ListSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → ListSchema referencedTypes → c (ListSchema referencedTypes) Source # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c (ListSchema referencedTypes) Source # toConstr ∷ ListSchema referencedTypes → Constr Source # dataTypeOf ∷ ListSchema referencedTypes → DataType Source # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c (ListSchema referencedTypes)) Source # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c (ListSchema referencedTypes)) Source # gmapT ∷ (∀ b. Data b ⇒ b → b) → ListSchema referencedTypes → ListSchema referencedTypes Source # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → ListSchema referencedTypes → r Source # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → ListSchema referencedTypes → r Source # gmapQ ∷ (∀ d. Data d ⇒ d → u) → ListSchema referencedTypes → [u] Source # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → ListSchema referencedTypes → u Source # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → ListSchema referencedTypes → m (ListSchema referencedTypes) Source # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → ListSchema referencedTypes → m (ListSchema referencedTypes) Source # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → ListSchema referencedTypes → m (ListSchema referencedTypes) Source #
Generic (ListSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Associated Types type Rep (ListSchema referencedTypes) ∷ Type → Type Source # Methods from ∷ ListSchema referencedTypes → Rep (ListSchema referencedTypes) x Source # to ∷ Rep (ListSchema referencedTypes) x → ListSchema referencedTypes Source #
Show (ListSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods showsPrec ∷ Int → ListSchema referencedTypes → ShowS Source # show ∷ ListSchema referencedTypes → String Source # showList ∷ [ListSchema referencedTypes] → ShowS Source #
Eq (ListSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods (==) ∷ ListSchema referencedTypes → ListSchema referencedTypes → Bool Source # (/=) ∷ ListSchema referencedTypes → ListSchema referencedTypes → Bool Source #
Ord (ListSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods compare ∷ ListSchema referencedTypes → ListSchema referencedTypes → Ordering Source # (<) ∷ ListSchema referencedTypes → ListSchema referencedTypes → Bool Source # (<=) ∷ ListSchema referencedTypes → ListSchema referencedTypes → Bool Source # (>) ∷ ListSchema referencedTypes → ListSchema referencedTypes → Bool Source # (>=) ∷ ListSchema referencedTypes → ListSchema referencedTypes → Bool Source # max ∷ ListSchema referencedTypes → ListSchema referencedTypes → ListSchema referencedTypes Source # min ∷ ListSchema referencedTypes → ListSchema referencedTypes → ListSchema referencedTypes Source #
type Rep (ListSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema type Rep (ListSchema referencedTypes) = D1 ('MetaData "ListSchema" "PlutusTx.Blueprint.Schema" "plutus-tx-1.34.1.0-inplace" 'False) (C1 ('MetaCons "MkListSchema" 'PrefixI 'True) ((S1 ('MetaSel ('Just "itemSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Schema referencedTypes)) :: S1 ('MetaSel ('Just "minItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "uniqueItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

mkListSchema ∷ Schema referencedTypes → ListSchema referencedTypes Source #

data MapSchema (referencedTypes ∷ [Type]) Source #

Constructors

MkMapSchema
Fields keySchema ∷ Schema referencedTypes Key schema valueSchema ∷ Schema referencedTypes Value schema minItems ∷ Maybe Natural A map instance is valid if its size is greater than, or equal to, this value. maxItems ∷ Maybe Natural A map instance is valid if its size is less than, or equal to, this value.

Instances

Instances details

Typeable referencedTypes ⇒ Data (MapSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → MapSchema referencedTypes → c (MapSchema referencedTypes) Source # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c (MapSchema referencedTypes) Source # toConstr ∷ MapSchema referencedTypes → Constr Source # dataTypeOf ∷ MapSchema referencedTypes → DataType Source # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c (MapSchema referencedTypes)) Source # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c (MapSchema referencedTypes)) Source # gmapT ∷ (∀ b. Data b ⇒ b → b) → MapSchema referencedTypes → MapSchema referencedTypes Source # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → MapSchema referencedTypes → r Source # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → MapSchema referencedTypes → r Source # gmapQ ∷ (∀ d. Data d ⇒ d → u) → MapSchema referencedTypes → [u] Source # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → MapSchema referencedTypes → u Source # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → MapSchema referencedTypes → m (MapSchema referencedTypes) Source # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → MapSchema referencedTypes → m (MapSchema referencedTypes) Source # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → MapSchema referencedTypes → m (MapSchema referencedTypes) Source #
Generic (MapSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Associated Types type Rep (MapSchema referencedTypes) ∷ Type → Type Source # Methods from ∷ MapSchema referencedTypes → Rep (MapSchema referencedTypes) x Source # to ∷ Rep (MapSchema referencedTypes) x → MapSchema referencedTypes Source #
Show (MapSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods showsPrec ∷ Int → MapSchema referencedTypes → ShowS Source # show ∷ MapSchema referencedTypes → String Source # showList ∷ [MapSchema referencedTypes] → ShowS Source #
Eq (MapSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods (==) ∷ MapSchema referencedTypes → MapSchema referencedTypes → Bool Source # (/=) ∷ MapSchema referencedTypes → MapSchema referencedTypes → Bool Source #
Ord (MapSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods compare ∷ MapSchema referencedTypes → MapSchema referencedTypes → Ordering Source # (<) ∷ MapSchema referencedTypes → MapSchema referencedTypes → Bool Source # (<=) ∷ MapSchema referencedTypes → MapSchema referencedTypes → Bool Source # (>) ∷ MapSchema referencedTypes → MapSchema referencedTypes → Bool Source # (>=) ∷ MapSchema referencedTypes → MapSchema referencedTypes → Bool Source # max ∷ MapSchema referencedTypes → MapSchema referencedTypes → MapSchema referencedTypes Source # min ∷ MapSchema referencedTypes → MapSchema referencedTypes → MapSchema referencedTypes Source #
type Rep (MapSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema type Rep (MapSchema referencedTypes) = D1 ('MetaData "MapSchema" "PlutusTx.Blueprint.Schema" "plutus-tx-1.34.1.0-inplace" 'False) (C1 ('MetaCons "MkMapSchema" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keySchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Schema referencedTypes)) :: S1 ('MetaSel ('Just "valueSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Schema referencedTypes))) :: (S1 ('MetaSel ('Just "minItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

data ConstructorSchema (referencedTypes ∷ [Type]) Source #

Constructors

MkConstructorSchema
Fields index ∷ Natural Constructor index fieldSchemas ∷ [Schema referencedTypes] Field schemas

Instances

Instances details

Typeable referencedTypes ⇒ Data (ConstructorSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → ConstructorSchema referencedTypes → c (ConstructorSchema referencedTypes) Source # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c (ConstructorSchema referencedTypes) Source # toConstr ∷ ConstructorSchema referencedTypes → Constr Source # dataTypeOf ∷ ConstructorSchema referencedTypes → DataType Source # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c (ConstructorSchema referencedTypes)) Source # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c (ConstructorSchema referencedTypes)) Source # gmapT ∷ (∀ b. Data b ⇒ b → b) → ConstructorSchema referencedTypes → ConstructorSchema referencedTypes Source # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → ConstructorSchema referencedTypes → r Source # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → ConstructorSchema referencedTypes → r Source # gmapQ ∷ (∀ d. Data d ⇒ d → u) → ConstructorSchema referencedTypes → [u] Source # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → ConstructorSchema referencedTypes → u Source # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → ConstructorSchema referencedTypes → m (ConstructorSchema referencedTypes) Source # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → ConstructorSchema referencedTypes → m (ConstructorSchema referencedTypes) Source # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → ConstructorSchema referencedTypes → m (ConstructorSchema referencedTypes) Source #
Generic (ConstructorSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Associated Types type Rep (ConstructorSchema referencedTypes) ∷ Type → Type Source # Methods from ∷ ConstructorSchema referencedTypes → Rep (ConstructorSchema referencedTypes) x Source # to ∷ Rep (ConstructorSchema referencedTypes) x → ConstructorSchema referencedTypes Source #
Show (ConstructorSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods showsPrec ∷ Int → ConstructorSchema referencedTypes → ShowS Source # show ∷ ConstructorSchema referencedTypes → String Source # showList ∷ [ConstructorSchema referencedTypes] → ShowS Source #
Eq (ConstructorSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods (==) ∷ ConstructorSchema referencedTypes → ConstructorSchema referencedTypes → Bool Source # (/=) ∷ ConstructorSchema referencedTypes → ConstructorSchema referencedTypes → Bool Source #
Ord (ConstructorSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods compare ∷ ConstructorSchema referencedTypes → ConstructorSchema referencedTypes → Ordering Source # (<) ∷ ConstructorSchema referencedTypes → ConstructorSchema referencedTypes → Bool Source # (<=) ∷ ConstructorSchema referencedTypes → ConstructorSchema referencedTypes → Bool Source # (>) ∷ ConstructorSchema referencedTypes → ConstructorSchema referencedTypes → Bool Source # (>=) ∷ ConstructorSchema referencedTypes → ConstructorSchema referencedTypes → Bool Source # max ∷ ConstructorSchema referencedTypes → ConstructorSchema referencedTypes → ConstructorSchema referencedTypes Source # min ∷ ConstructorSchema referencedTypes → ConstructorSchema referencedTypes → ConstructorSchema referencedTypes Source #
type Rep (ConstructorSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema type Rep (ConstructorSchema referencedTypes) = D1 ('MetaData "ConstructorSchema" "PlutusTx.Blueprint.Schema" "plutus-tx-1.34.1.0-inplace" 'False) (C1 ('MetaCons "MkConstructorSchema" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "fieldSchemas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Schema referencedTypes])))

data PairSchema (referencedTypes ∷ [Type]) Source #

Constructors

MkPairSchema
Fields left ∷ Schema referencedTypes Schema of the first element right ∷ Schema referencedTypes Schema of the second element

Instances

Instances details

Typeable referencedTypes ⇒ Data (PairSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → PairSchema referencedTypes → c (PairSchema referencedTypes) Source # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c (PairSchema referencedTypes) Source # toConstr ∷ PairSchema referencedTypes → Constr Source # dataTypeOf ∷ PairSchema referencedTypes → DataType Source # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c (PairSchema referencedTypes)) Source # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c (PairSchema referencedTypes)) Source # gmapT ∷ (∀ b. Data b ⇒ b → b) → PairSchema referencedTypes → PairSchema referencedTypes Source # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → PairSchema referencedTypes → r Source # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → PairSchema referencedTypes → r Source # gmapQ ∷ (∀ d. Data d ⇒ d → u) → PairSchema referencedTypes → [u] Source # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → PairSchema referencedTypes → u Source # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → PairSchema referencedTypes → m (PairSchema referencedTypes) Source # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → PairSchema referencedTypes → m (PairSchema referencedTypes) Source # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → PairSchema referencedTypes → m (PairSchema referencedTypes) Source #
Generic (PairSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Associated Types type Rep (PairSchema referencedTypes) ∷ Type → Type Source # Methods from ∷ PairSchema referencedTypes → Rep (PairSchema referencedTypes) x Source # to ∷ Rep (PairSchema referencedTypes) x → PairSchema referencedTypes Source #
Show (PairSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods showsPrec ∷ Int → PairSchema referencedTypes → ShowS Source # show ∷ PairSchema referencedTypes → String Source # showList ∷ [PairSchema referencedTypes] → ShowS Source #
Eq (PairSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods (==) ∷ PairSchema referencedTypes → PairSchema referencedTypes → Bool Source # (/=) ∷ PairSchema referencedTypes → PairSchema referencedTypes → Bool Source #
Ord (PairSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema Methods compare ∷ PairSchema referencedTypes → PairSchema referencedTypes → Ordering Source # (<) ∷ PairSchema referencedTypes → PairSchema referencedTypes → Bool Source # (<=) ∷ PairSchema referencedTypes → PairSchema referencedTypes → Bool Source # (>) ∷ PairSchema referencedTypes → PairSchema referencedTypes → Bool Source # (>=) ∷ PairSchema referencedTypes → PairSchema referencedTypes → Bool Source # max ∷ PairSchema referencedTypes → PairSchema referencedTypes → PairSchema referencedTypes Source # min ∷ PairSchema referencedTypes → PairSchema referencedTypes → PairSchema referencedTypes Source #
type Rep (PairSchema referencedTypes) Source #
Instance details Defined in PlutusTx.Blueprint.Schema type Rep (PairSchema referencedTypes) = D1 ('MetaData "PairSchema" "PlutusTx.Blueprint.Schema" "plutus-tx-1.34.1.0-inplace" 'False) (C1 ('MetaCons "MkPairSchema" 'PrefixI 'True) (S1 ('MetaSel ('Just "left") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Schema referencedTypes)) :*: S1 ('MetaSel ('Just "right") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Schema referencedTypes))))