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

org.plasmalabs.sdk.models

package org.plasmalabs.sdk.models

Members list

Packages

package org.plasmalabs.sdk.models.box
package org.plasmalabs.sdk.models.common
package org.plasmalabs.sdk.models.transaction

Type members

Classlikes

final case class AccumulatorRootId(value: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[AccumulatorRootId]

Represents the identifier of an Accumulator Root. It is constructed from the evidence of the signable bytes of the Lock.

Represents the identifier of an Accumulator Root. It is constructed from the evidence of the signable bytes of the Lock.

Value parameters

value

The evidence of the Accumulator Root's signable bytes length = 32

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[AccumulatorRootId]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object AccumulatorRootIdValidator extends Validator[AccumulatorRootId]

Attributes

Supertypes
trait Validator[AccumulatorRootId]
trait Serializable
class Object
trait Matchable
class Any
Self type
object AddressProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class AssetMergingStatement(inputUtxos: Seq[TransactionOutputAddress], outputIdx: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[AssetMergingStatement]

Value parameters

inputUtxos

The non-empty list of UTXOs that we are using to compute the Merkle root for the alloy.

outputIdx

The index in the output sequence of the transaction where the merged tokens are stored.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[AssetMergingStatement]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object AssetMergingStatementValidator extends Validator[AssetMergingStatement]

Attributes

Supertypes
trait Validator[AssetMergingStatement]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class AssetMintingStatement(groupTokenUtxo: TransactionOutputAddress, seriesTokenUtxo: TransactionOutputAddress, quantity: Int128, permanentMetadata: Option[Struct], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[AssetMintingStatement]

Value parameters

groupTokenUtxo

The address of the UTXO that contains the group constructor token that we are using to mint the asset token.

permanentMetadata

This is the permanent metadata of an asset. It follows the schema defined in the permanent 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.

quantity

The number of assets that we are minting using the group and series constructor token references by the two other attributes.

seriesTokenUtxo

The address of the UTXO that contains the seriesconstructor token that we are using to mint the asset token.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[AssetMintingStatement]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object AssetMintingStatementValidator extends Validator[AssetMintingStatement]

Attributes

Supertypes
trait Validator[AssetMintingStatement]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class AssetSplittingStatement(outputIndexes: Seq[Int], inputUtxo: TransactionOutputAddress, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[AssetSplittingStatement]

Value parameters

inputUtxo

The UTXO that is being split.

outputIndexes

The non-empty list of indexes where the split asset is being put.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[AssetSplittingStatement]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object AssetSplittingStatementValidator extends Validator[AssetSplittingStatement]

Attributes

Supertypes
trait Validator[AssetSplittingStatement]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class Datum(value: Value, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Datum]

Datums represent a queryable product value of the arguments available from a certain Event. Datum may be evaluated during the Quivr protocol execution by providing events as Datum in a Dynamic Context.

Datums represent a queryable product value of the arguments available from a certain Event. Datum may be evaluated during the Quivr protocol execution by providing events as Datum in a Dynamic Context.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Datum]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Datum.type
object DatumProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
DatumProto.type
object DatumValidator extends Validator[Datum]

Attributes

Supertypes
trait Validator[Datum]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class Event(value: Value, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Event]

Events are uniquely identifiable occurrences of state mutations within the blockchain protocol. Each event is associated with certain data that may be updated every tick.

Events are uniquely identifiable occurrences of state mutations within the blockchain protocol. Each event is associated with certain data that may be updated every tick.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Event]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Event.type
object EventProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
EventProto.type
object EventValidator extends Validator[Event]

Attributes

Supertypes
trait Validator[Event]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class Evidence(digest: Digest, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Evidence]

Evidence should be a succinct, unique set of bytes used to distinguish between any two data objects. Evidence is also meant to have a minimal amount of structure such that other domains may provide their own similarly unique & succinct values. Quivr can cast such external domain "evidence" into Topl evidence through the use of ContainsSignable[Evidence[_]]

Evidence should be a succinct, unique set of bytes used to distinguish between any two data objects. Evidence is also meant to have a minimal amount of structure such that other domains may provide their own similarly unique & succinct values. Quivr can cast such external domain "evidence" into Topl evidence through the use of ContainsSignable[Evidence[_]]

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Evidence]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Evidence.type
object EvidenceProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
object EvidenceValidator extends Validator[Evidence]

Attributes

Supertypes
trait Validator[Evidence]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class GroupId(value: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GroupId]

Represents the identifier of an TAM V2 group. It is constructed using SHA-256 digest from fields label+fixedSeries+seriesTokenSupply+transactionId+utxoIndex.

Represents the identifier of an TAM V2 group. It is constructed using SHA-256 digest from fields label+fixedSeries+seriesTokenSupply+transactionId+utxoIndex.

Value parameters

value

The evidence of the Group signable bytes length = 32

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GroupId]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
GroupId.type
object GroupIdValidator extends Validator[GroupId]

Attributes

Supertypes
trait Validator[GroupId]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class GroupPolicy(label: String, registrationUtxo: TransactionOutputAddress, fixedSeries: Option[SeriesId], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GroupPolicy]

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

label

Identifies the group policy for humans (do not confuse with the actual group identifier)

registrationUtxo

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

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GroupPolicy]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object GroupPolicyValidator extends Validator[GroupPolicy]

Attributes

Supertypes
trait Validator[GroupPolicy]
trait Serializable
class Object
trait Matchable
class Any
Self type
object IdentifierProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class Indices(x: Int, y: Int, z: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Indices]

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Indices]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Indices.type
object IndicesProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
object IndicesValidator extends Validator[Indices]

Attributes

Supertypes
trait Validator[Indices]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class LockAddress(network: Int, ledger: Int, id: LockId, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[LockAddress]

Used in UTXOs

Used in UTXOs

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[LockAddress]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object LockAddressValidator extends Validator[LockAddress]

Attributes

Supertypes
trait Validator[LockAddress]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class LockId(value: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[LockId]

Represents the identifier of a Lock. It is constructed from the evidence of the signable bytes of the Lock.

Represents the identifier of a Lock. It is constructed from the evidence of the signable bytes of the Lock.

Value parameters

value

The evidence of the Lock's signable bytes length = 32

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[LockId]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
LockId.type
object LockIdValidator extends Validator[LockId]

Attributes

Supertypes
trait Validator[LockId]
trait Serializable
class Object
trait Matchable
class Any
Self type
object PolicyStatementProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class SeriesId(value: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[SeriesId]

Represents the identifier of an TAM V2 series. It is constructed using SHA-256 digest from fields label+fixedSeries+seriesTokenSupply+transactionId+utxoIndex.

Represents the identifier of an TAM V2 series. It is constructed using SHA-256 digest from fields label+fixedSeries+seriesTokenSupply+transactionId+utxoIndex.

Value parameters

value

The evidence of the Group signable bytes length = 32

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SeriesId]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
SeriesId.type
object SeriesIdValidator extends Validator[SeriesId]

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SeriesPolicy]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object SeriesPolicyValidator extends Validator[SeriesPolicy]

Attributes

Supertypes
trait Validator[SeriesPolicy]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class TransactionId(value: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[TransactionId]

Represents the identifier of a Transaction. It is constructed from the evidence of the signable bytes of the Transaction.

Represents the identifier of a Transaction. It is constructed from the evidence of the signable bytes of the Transaction.

Value parameters

value

The evidence of the Transaction's signable bytes length = 32

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TransactionId]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object TransactionIdValidator extends Validator[TransactionId]

Attributes

Supertypes
trait Validator[TransactionId]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class TransactionInputAddress(network: Int, ledger: Int, index: Int, id: TransactionId, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[TransactionInputAddress]

Used in Challenge.PreviousProposition

Used in Challenge.PreviousProposition

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TransactionInputAddress]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object TransactionInputAddressValidator extends Validator[TransactionInputAddress]

Attributes

Supertypes
trait Validator[TransactionInputAddress]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class TransactionOutputAddress(network: Int, ledger: Int, index: Int, id: TransactionId, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[TransactionOutputAddress]

Used in STXOs

Used in STXOs

Value parameters

index

index of the output (UTXO) within the transaction targeted by id.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TransactionOutputAddress]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object TransactionOutputAddressValidator extends Validator[TransactionOutputAddress]

Attributes

Supertypes
trait Validator[TransactionOutputAddress]
trait Serializable
class Object
trait Matchable
class Any
Self type
Generated with