SeriesPolicy

org.plasmalabs.sdk.models.SeriesPolicy
See theSeriesPolicy companion object
final case class SeriesPolicy(label: String, tokenSupply: Option[Int], registrationUtxo: TransactionOutputAddress, quantityDescriptor: QuantityDescriptorType, fungibility: FungibilityType, ephemeralMetadataScheme: Option[Struct], permanentMetadataScheme: Option[Struct], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[SeriesPolicy]

Value parameters

ephemeralMetadataScheme

Describes the schema of the data stored in the metadata field of the Asset Minting Statement.

fungibility

Describes the fungibility of the assets minted using the series constructor token derived from this policy.

label

The human readable name of this series. (do not confuse with the actual series identifier)

permanentMetadataScheme

Describes the schema of the data stored in the Asset Token.

quantityDescriptor

Describes the behavior of the quantity field of the assets minted using the series constructor derived from this policy.

registrationUtxo

The address of a UTXO. The UTXO contains the LVLs that are paid for minting the series constructor token.

tokenSupply

This is an optional field. When provided it fixes the quantity of tokens that will be minted when this series is consumed, and the series constructor is burned by the minting transaction. When not provided, the series constructor is not burned, thus making the token supply unlimited.

Attributes

Companion
object
Graph
Supertypes
trait Updatable[SeriesPolicy]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
def getTokenSupply: Int
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

def withLabel(`__v`: String): SeriesPolicy
def withTokenSupply(`__v`: Int): SeriesPolicy
def withUnknownFields(`__v`: UnknownFieldSet): SeriesPolicy
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage

Attributes

Inherited from:
Updatable
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage