protobuf-fs2
API
Generated with
protobuf-fs2/org.plasmalabs/org.plasmalabs.sdk.models/org.plasmalabs.sdk.models.box/Value

Value

org.plasmalabs.sdk.models.box.Value
See theValue companion class
object Value extends GeneratedMessageCompanion[Value]

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Value]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Value.type

Members list

Type members

Classlikes

final case class Asset(groupId: Option[GroupId], seriesId: Option[SeriesId], quantity: Int128, groupAlloy: Option[ByteString], seriesAlloy: Option[ByteString], fungibility: FungibilityType, quantityDescriptor: QuantityDescriptorType, ephemeralMetadata: Option[Struct], commitment: Option[ByteString], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Asset]

A user-defined token

A user-defined token

Value parameters

commitment

This field is optional and meant to store a commitment in the form of a hash. This field is managed by the user. Metadata concerning this field can be added to the metadata.

ephemeralMetadata

This is the ephemeral metadata of an asset. It follows the schema defined in the ephemeral metadata schema of the series policy corresponding to the token being minted. The conformance of this field to the schema is not checked by the node. This field is managed by the user.

fungibility

Describes the fungibility of the asset..

groupAlloy

This field is optional and represents a Merkle root of the alloy of groups in this asset. This is only valid for tokens that are series fungible. length = 32

groupId

The group identifier of the group token that was used to mint this asset. When there is a groupAlloy this field is not used.

quantity

A quantity

quantityDescriptor

Describes the quantity behavior of this asset.

seriesAlloy

This field is optional and represents a Merkle root of the alloy of series in this asset. This is only valid for tokens that are group fungible. length = 32

seriesId

The series identifier of the series token that was used to mint this asset. When there is a seriesAlloy this field is not used.

Attributes

Companion
object
Supertypes
trait Updatable[Asset]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Asset extends GeneratedMessageCompanion[Asset]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Asset]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Asset.type
final case class ConfigProposal(value: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ConfigProposal]

Attributes

Companion
object
Supertypes
trait Updatable[ConfigProposal]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConfigProposal extends GeneratedMessageCompanion[ConfigProposal]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ConfigProposal]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class Group(groupId: GroupId, quantity: Int128, fixedSeries: Option[SeriesId], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Group]

A group constructor token

A group constructor token

Value parameters

fixedSeries

An optional series identifier. When this series identifier is defined, this groups that implement this policy can only be used to mint assets with the aforementioned series identifier

groupId

The ID of this Group. It is the digest of the Group Policy.

quantity

The quantity of group constructor tokens stored in a given UTXO.

Attributes

Companion
object
Supertypes
trait Updatable[Group]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Group extends GeneratedMessageCompanion[Group]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Group]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Group.type
final case class LVL(quantity: Int128, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[LVL]

A payment token

A payment token

Attributes

Companion
object
Supertypes
trait Updatable[LVL]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LVL extends GeneratedMessageCompanion[LVL]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[LVL]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
LVL.type
final case class Series(seriesId: SeriesId, quantity: Int128, tokenSupply: Option[Int], quantityDescriptor: QuantityDescriptorType, fungibility: FungibilityType, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Series]

A series constructor token

A series constructor token

Value parameters

fungibility

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

quantity

The quantity of series constructor tokens stored in a given UTXO.

quantityDescriptor

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

seriesId

The ID of this Series. It is the digest of the Series Policy.

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
Supertypes
trait Updatable[Series]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Series extends GeneratedMessageCompanion[Series]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Series]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Series.type
final case class TOPL(quantity: Int128, registration: Option[StakingRegistration], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[TOPL]

A staking token

A staking token

Value parameters

registration

Optional. If provided, the registration will take effect at the start of 2 epochs from now. If not provided, this token will not be used for staking purposes.

Attributes

Companion
object
Supertypes
trait Updatable[TOPL]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TOPL extends GeneratedMessageCompanion[TOPL]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TOPL]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
TOPL.type
final case class UpdateProposal(label: String, fEffective: Option[Ratio], vrfLddCutoff: Option[Int], vrfPrecision: Option[Int], vrfBaselineDifficulty: Option[Ratio], vrfAmplitude: Option[Ratio], chainSelectionKLookback: Option[Long], slotDuration: Option[Duration], forwardBiasedSlotWindow: Option[Long], operationalPeriodsPerEpoch: Option[Long], kesKeyHours: Option[Int], kesKeyMinutes: Option[Int], slotGapLeaderElection: Option[Long], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[UpdateProposal]

Value parameters

chainSelectionKLookback

chainSelectionKLookback

fEffective

fEffective

forwardBiasedSlotWindow

forwardBiasedSlotWindow

kesKeyHours

kesKeyHours Key-Evolving Signature: mechanism for securing chain selection process in Ouroboros proof-of-stake

kesKeyMinutes

kesKeyMinutes Key-Evolving Signature: mechanism for securing chain selection process in Ouroboros proof-of-stake

label

Update proposal label for humans (do not confuse with the actual update proposal identifier)

operationalPeriodsPerEpoch

operationalPeriodsPerEpoch, Epoch: Long time scale in Ouroboros, epochs are composed of many slots

slotDuration

slotDuration, Slot: Atomic time unit in Ouroboros, smallest piece of time (~1 second for Topl, 2 for Cardano)

slotGapLeaderElection

gap of non-eligibility after a block is minted

vrfAmplitude

vrfAmplitude

vrfBaselineDifficulty

vrfBaselineDifficulty

vrfLddCutoff

vrfLddCutoff Verifiable Random Function: mechanism for leader election in Ouroboros proof-of-stake Local dynamic difficulty, Short timescale variation of the block production eligibility threshold.

vrfPrecision

vrfPrecision

Attributes

Companion
object
Supertypes
trait Updatable[UpdateProposal]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateProposal extends GeneratedMessageCompanion[UpdateProposal]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateProposal]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object Value

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Value.type
sealed trait Value extends GeneratedOneof

Attributes

Companion
object
Supertypes
trait GeneratedOneof
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Asset
object Empty
class Group
class Lvl
class Series
class Topl
Show all
implicit class ValueLens[UpperPB](_l: Lens[UpperPB, Value]) extends ObjectLens[UpperPB, Value]

Attributes

Supertypes
class ObjectLens[UpperPB, Value]
trait Lens[UpperPB, Value]
trait Serializable
class Object
trait Matchable
class Any
Show all

Inherited types

type ValueType = Value

Attributes

Inherited from:
GeneratedMessageCompanion

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def enumCompanionForFieldNumber(`__fieldNumber`: Int): GeneratedEnumCompanion[_]
def javaDescriptor: Descriptor

Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.

Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.

Attributes

def messageCompanionForFieldNumber(`__number`: Int): GeneratedMessageCompanion[_]
def of(value: Value): Value
def parseFrom(`_input__`: CodedInputStream): Value

Parses a message from a CodedInputStream.

Parses a message from a CodedInputStream.

Attributes

def scalaDescriptor: Descriptor

Inherited methods

def enumCompanionForField(field: FieldDescriptor): GeneratedEnumCompanion[_]

Attributes

Inherited from:
GeneratedMessageCompanion
def fromAscii(s: String): Value

Attributes

Inherited from:
GeneratedMessageCompanion
def merge(a: Value, input: CodedInputStream): Value

Merges the given message with the additional fields in the steam.

Merges the given message with the additional fields in the steam.

Attributes

Inherited from:
GeneratedMessageCompanion
def messageCompanionForField(field: FieldDescriptor): GeneratedMessageCompanion[_]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseDelimitedFrom(input: InputStream): Option[Value]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseDelimitedFrom(input: CodedInputStream): Option[Value]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseFrom(s: Array[Byte]): Value

Attributes

Inherited from:
GeneratedMessageCompanion
def parseFrom(input: InputStream): Value

Attributes

Inherited from:
GeneratedMessageCompanion
def streamFromDelimitedInput(input: InputStream): Stream[Value]

Attributes

Inherited from:
GeneratedMessageCompanion
def toByteArray(a: Value): Array[Byte]

Attributes

Inherited from:
GeneratedMessageCompanion
def validate(s: Array[Byte]): Try[Value]

Attributes

Inherited from:
GeneratedMessageCompanion
def validateAscii(s: String): Either[TextFormatError, Value]

Attributes

Inherited from:
GeneratedMessageCompanion

Concrete fields

final val ASSET_FIELD_NUMBER: 3
final val GROUP_FIELD_NUMBER: 4
final val LVL_FIELD_NUMBER: 1
final val SERIES_FIELD_NUMBER: 5
final val TOPL_FIELD_NUMBER: 2
lazy val nestedMessagesCompanions: Seq[GeneratedMessageCompanion[_ <: GeneratedMessage]]

Implicits

Implicits

final implicit def ValueLens[UpperPB](_l: Lens[UpperPB, Value]): ValueLens[UpperPB]
implicit def messageCompanion: GeneratedMessageCompanion[Value]
implicit def messageReads: Reads[Value]
implicit def validator: Validator[Value]
Generated with