scalus.cardano.plutus.contract.blueprint
Members list
Type members
Classlikes
A description of a Scalus application, containing one or more contracts.
A description of a Scalus application, containing one or more contracts.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
Application.type
A CIP-57 compliant description of a set of validators.
A CIP-57 compliant description of a set of validators.
Each validator description contains schemas PlutusDataSchema of the datum and redeemer formats expected by the contracts.
Attributes
- See also
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A smart contract compiled with Scalus.
A smart contract compiled with Scalus.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class PlutusV3
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
CompilerInfo.type
Attributes
- Companion
- object
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The description of the data shape of a validator parameter, datum or redemeer.
The description of the data shape of a validator parameter, datum or redemeer.
For user types, the schema should generally be PlutusDataSchema.derived as opposed to manually assembled.
If assembled directly, it should be compliant with https://cips.cardano.org/cip/CIP-57.
Namely, composite types should be represented as DataType.Constructors, with properly indexed fields, tuples of arity >3 should be DataType.Lists with respective items, and pairs should be DataType.PairBuiltin. See BlueprintTest
for derivation examples and expectations.
Attributes
- See also
-
DataType for type description
Data for more info about onchain data types
- Note
-
the types described by these schemas are used as datums, redeemers and parameters. As such, only onchain data should be described by
PlutusDataSchema
. Therefore, attempting to derive schemas for types that cannot be on chain will lead to compile time errors. Generally, if one can derive scalus.builtin.Data.FromData for a type, one can also do so for the schema. If one cannot derive scalus.builtin.Data.FromData, it means that the type cannot exist on chain, and therefore should not be described withPlutusDataSchema
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
PlutusDataSchema.type
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait CompiledContractclass Objecttrait Matchableclass AnyShow all
An object that holds blueprint metadata. Does not include information about contracts and instead contains apps title and description, compiler information, plutus version used, etc.
An object that holds blueprint metadata. Does not include information about contracts and instead contains apps title and description, compiler information, plutus version used, etc.
For applications that only have 1 validator, the preamble data may repeat that of the validator.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TypeDescription.type
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all