docs
API
Generated with
docs/scalus/scalus.cardano/scalus.cardano.ledger

scalus.cardano.ledger

package scalus.cardano.ledger

Members list

Type members

Classlikes

case class AddrKeyHash(hash: Hash28)

Represents a key hash used in addresses in the Cardano blockchain.

Represents a key hash used in addresses in the Cardano blockchain.

An AddrKeyHash is a 28-byte hash value that identifies a public key and is used in constructing addresses.

Value parameters

hash

The 28-byte hash value

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AddressBytes

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class Anchor(url: String, dataHash: Hash32)

Represents an anchor in the Cardano blockchain.

Represents an anchor in the Cardano blockchain.

An anchor contains a URL and a data hash that can be used to verify the data retrieved from the URL.

Value parameters

dataHash

A 32-byte hash of the data

url

The URL where the data can be retrieved

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class AssetName(bytes: ByteString)

Represents an asset name in Cardano's multi-asset framework

Represents an asset name in Cardano's multi-asset framework

Asset names can be between 0 and 32 bytes long.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AssetName

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
AssetName.type
enum AuxiliaryData

Represents auxiliary data in a Cardano transaction

Represents auxiliary data in a Cardano transaction

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AuxiliaryData

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class AuxiliaryDataHash(hash: Hash32)

Represents a hash of the auxiliary data (transaction metadata)

Represents a hash of the auxiliary data (transaction metadata)

This is simply a type alias for Hash32 to provide better type safety and readability.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Bech32

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Bech32.type
trait Blake2b_224

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Blake2b_224
case object Blake2b_224 extends Blake2b_224

Attributes

Companion
trait
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Blake2b_224
class Object
trait Matchable
class Any
Show all
Self type
trait Blake2b_256

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Blake2b_256
object Blake2b_256 extends Blake2b_256

Attributes

Companion
trait
Supertypes
trait Blake2b_256
class Object
trait Matchable
class Any
Self type
case class Block(header: BlockHeader, transactionBodies: Seq[TransactionBody], transactionWitnessSets: Seq[TransactionWitnessSet], auxiliaryDataSet: Map[Int, AuxiliaryData], invalidTransactions: Seq[Int])

Represents a complete block in the Cardano blockchain

Represents a complete block in the Cardano blockchain

Valid blocks must also satisfy the following constraints:

  1. The length of transaction_bodies and transaction_witness_sets must be the same 2. Every transaction_index must be strictly smaller than the length of transaction_bodies

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BlockFile(era: Int, block: Block)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BlockHeader(headerBody: BlockHeaderBody, bodySignature: ByteString)

Represents a block header in Cardano

Represents a block header in Cardano

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BlockHeaderBody(blockNumber: Long, slot: Long, prevHash: Option[Hash32], issuerVkey: ByteString, vrfVkey: ByteString, vrfResult: VrfCert, blockBodySize: Long, blockBodyHash: Hash32, operationalCert: OperationalCert, protocolVersion: ProtocolVersion)

Represents the body of a block header in Cardano

Represents the body of a block header in Cardano

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BootstrapWitness(publicKey: ByteString, signature: ByteString, chainCode: ByteString, attributes: ByteString)

Represents a bootstrap witness in Cardano (for Byron-era addresses)

Represents a bootstrap witness in Cardano (for Byron-era addresses)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum Certificate

Represents a certificate for stake operations on the blockchain

Represents a certificate for stake operations on the blockchain

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Certificate

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Coin(value: Long)

Represents an amount of Cardano's native currency (ADA)

Represents an amount of Cardano's native currency (ADA)

In Cardano, coins are represented as unsigned integers

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Coin

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Coin.type
case class Constitution(anchor: Anchor, scriptHash: Option[ScriptHash])

Represents a constitution in the Cardano blockchain governance system.

Represents a constitution in the Cardano blockchain governance system.

A constitution consists of an anchor (pointing to the constitution text) and an optional script hash for the constitution script.

Value parameters

anchor

The anchor pointing to the constitution text

scriptHash

Optional script hash for the constitution script

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class CostModels(models: Map[Int, List[Long]])

Represents cost models for script languages in the Cardano blockchain.

Represents cost models for script languages in the Cardano blockchain.

Cost models define the execution costs of operations in different script languages. The keys are language identifiers (0 for Plutus V1, 1 for Plutus V2, 2 for Plutus V3), and the values are lists of integers representing operation costs.

Value parameters

models

Map from language identifiers to lists of operation costs

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum Credential

Represents a credential in the Cardano blockchain. A credential can be either a key hash or a script hash.

Represents a credential in the Cardano blockchain. A credential can be either a key hash or a script hash.

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum DRep

Represents a Delegated Representative (DRep) in the Cardano blockchain.

Represents a Delegated Representative (DRep) in the Cardano blockchain.

A DRep can be one of several types:

  • KeyHash: A DRep identified by a key hash
  • ScriptHash: A DRep identified by a script hash
  • AlwaysAbstain: A special DRep that always abstains from voting
  • AlwaysNoConfidence: A special DRep that always votes no confidence

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DRepVotingThresholds(motionNoConfidence: UnitInterval, committeeNormal: UnitInterval, committeeNoConfidence: UnitInterval, updateConstitution: UnitInterval, hardFork: UnitInterval, ppNetworkGroup: UnitInterval, ppEconomicGroup: UnitInterval, ppTechnicalGroup: UnitInterval, ppGovernanceGroup: UnitInterval, treasuryWithdrawal: UnitInterval)

Represents voting thresholds for DReps in the Cardano blockchain.

Represents voting thresholds for DReps in the Cardano blockchain.

Defines the thresholds required for different governance actions to pass when voted on by delegated representatives.

Value parameters

committeeNoConfidence

Threshold for committee updates after no confidence

committeeNormal

Threshold for normal committee updates

hardFork

Threshold for hard fork initiations

motionNoConfidence

Threshold for no confidence motions

ppEconomicGroup

Threshold for economic protocol parameter changes

ppGovernanceGroup

Threshold for governance protocol parameter changes

ppNetworkGroup

Threshold for network protocol parameter changes

ppTechnicalGroup

Threshold for technical protocol parameter changes

treasuryWithdrawal

Threshold for treasury withdrawals

updateConstitution

Threshold for constitution updates

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DRepVotingThresholds

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum DatumOption

Represents a datum option in Cardano outputs

Represents a datum option in Cardano outputs

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ExUnitPrices(memPrice: NonNegativeInterval, stepPrice: NonNegativeInterval)

Represents execution unit prices in the Cardano blockchain.

Represents execution unit prices in the Cardano blockchain.

ExUnitPrices define the cost of execution units in terms of the protocol's currency, with separate prices for memory usage and CPU steps.

Value parameters

memPrice

Price per memory unit

stepPrice

Price per step unit

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ExUnits(mem: Long, steps: Long)

Represents execution units for Plutus scripts in Cardano

Represents execution units for Plutus scripts in Cardano

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum GovAction

Represents a governance action in the Cardano blockchain.

Represents a governance action in the Cardano blockchain.

Governance actions are proposals submitted to the blockchain for voting. Different types of actions exist for different governance activities.

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GovAction

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
GovAction.type
case class GovActionId(transactionId: Hash32, govActionIndex: Int)

Represents a governance action identifier in the Cardano blockchain.

Represents a governance action identifier in the Cardano blockchain.

A governance action ID consists of a transaction ID and an index, which uniquely identifies a governance action.

Value parameters

govActionIndex

The index of the action within the transaction (2 bytes)

transactionId

The hash of the transaction containing the action

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Hash

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Hash.type
case class Hash28(bytes: ByteString)

Represents a 28-byte hash value used in Cardano

Represents a 28-byte hash value used in Cardano

Hash28 is commonly used for address key hashes and script hashes

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Hash28

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Hash28.type
final case class Hash32(bytes: ByteString)

Represents a 32-byte hash value used in Cardano

Represents a 32-byte hash value used in Cardano

Hash32 is commonly used for transaction IDs, block hashes and other crypto hashes

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Hash32

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Hash32.type
object HashPurpose

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class HashSize[HF](size: Int)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HashSize

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
HashSize.type
case class KeepRaw[A](value: A, raw: Array[Byte])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object KeepRaw

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
KeepRaw.type
enum Language

Represents the supported scripting languages in Cardano

Represents the supported scripting languages in Cardano

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Language

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Language.type
case class NonNegativeInterval(numerator: Long, denominator: Long)

Represents a non-negative interval in the Cardano blockchain.

Represents a non-negative interval in the Cardano blockchain.

A non-negative interval is represented as a fraction with a numerator and denominator, where both are non-negative and the denominator is positive.

Value parameters

denominator

The denominator of the fraction (positive)

numerator

The numerator of the fraction (non-negative)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NonNegativeInterval

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class OperationalCert(hotVKey: ByteString, sequenceNumber: Long, kesPeriod: Long, sigma: ByteString)

Represents an operational certificate in Cardano

Represents an operational certificate in Cardano

An operational certificate authorizes a node to create blocks

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object OriginalCborByteArray

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class PoolMetadata(url: String, metadataHash: Hash32)

Represents metadata for a stake pool in the Cardano blockchain.

Represents metadata for a stake pool in the Cardano blockchain.

Pool metadata provides information about the pool such as name, description, ticker symbol, etc. It's stored off-chain, and only the URL and hash are included in the blockchain.

Value parameters

metadataHash

Hash of the metadata for verification

url

URL where the metadata can be found

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PoolVotingThresholds(motionNoConfidence: UnitInterval, committeeNormal: UnitInterval, committeeNoConfidence: UnitInterval, hardFork: UnitInterval, ppSecurityGroup: UnitInterval)

Represents voting thresholds for stake pools in the Cardano blockchain.

Represents voting thresholds for stake pools in the Cardano blockchain.

Defines the thresholds required for different governance actions to pass when voted on by stake pools.

Value parameters

committeeNoConfidence

Threshold for committee updates after no confidence

committeeNormal

Threshold for normal committee updates

hardFork

Threshold for hard fork initiations

motionNoConfidence

Threshold for no confidence motions

ppSecurityGroup

Threshold for security protocol parameter changes

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PoolVotingThresholds

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ProposalProcedure(deposit: Coin, rewardAccount: RewardAccount, govAction: GovAction, anchor: Anchor)

Represents a proposal procedure in the Cardano blockchain governance system.

Represents a proposal procedure in the Cardano blockchain governance system.

A proposal procedure consists of a deposit, reward account, governance action, and an anchor with additional metadata.

Value parameters

anchor

The anchor with additional metadata

deposit

The deposit amount for the proposal

govAction

The governance action being proposed

rewardAccount

The reward account for returning the deposit

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ProtocolParamUpdate(minFeeA: Option[Coin], minFeeB: Option[Coin], maxBlockBodySize: Option[Int], maxTxSize: Option[Int], maxBlockHeaderSize: Option[Int], keyDeposit: Option[Coin], poolDeposit: Option[Coin], maxEpoch: Option[Int], nOpt: Option[Int], poolPledgeInfluence: Option[NonNegativeInterval], expansionRate: Option[UnitInterval], treasuryGrowthRate: Option[UnitInterval], minPoolCost: Option[Coin], adaPerUtxoByte: Option[Coin], costModels: Option[CostModels], executionCosts: Option[ExUnitPrices], maxTxExUnits: Option[ExUnits], maxBlockExUnits: Option[ExUnits], maxValueSize: Option[Int], collateralPercentage: Option[Int], maxCollateralInputs: Option[Int], poolVotingThresholds: Option[PoolVotingThresholds], drepVotingThresholds: Option[DRepVotingThresholds], minCommitteeSize: Option[Int], committeeTermLimit: Option[Int], governanceActionValidityPeriod: Option[Int], governanceActionDeposit: Option[Coin], drepDeposit: Option[Coin], drepInactivityPeriod: Option[Int], minFeeRefScriptCoinsPerByte: Option[NonNegativeInterval])

Represents a protocol parameter update in the Cardano blockchain.

Represents a protocol parameter update in the Cardano blockchain.

Protocol parameter updates are proposals to change various parameters that govern the behavior of the Cardano blockchain.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ProtocolParamUpdate

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ProtocolVersion(major: Int, minor: Int)

Represents a Cardano protocol version

Represents a Cardano protocol version

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Redeemer(tag: RedeemerTag, index: Int, data: Data, exUnits: ExUnits)

Represents a single redeemer in Cardano transaction A redeemer contains the execution context for a script

Represents a single redeemer in Cardano transaction A redeemer contains the execution context for a script

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum RedeemerTag

Represents the purpose of a redeemer in Cardano

Represents the purpose of a redeemer in Cardano

0: spend 1: mint 2: cert 3: reward 4: voting 5: proposing

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RedeemerTag

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Redeemers

Represents a collection of redeemers in the transaction witness set

Represents a collection of redeemers in the transaction witness set

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Array
class Map
object Redeemers

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Redeemers.type
enum Relay

Represents a relay for a stake pool in the Cardano blockchain.

Represents a relay for a stake pool in the Cardano blockchain.

A relay is a network endpoint for a stake pool that can be one of three types:

  • SingleHostAddr: An IP address with optional port
  • SingleHostName: A DNS name with optional port
  • MultiHostName: A DNS name for SRV lookup

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Relay

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Relay.type
case class RewardAccount(bytes: ByteString)

Represents a reward account in the Cardano blockchain.

Represents a reward account in the Cardano blockchain.

Reward accounts (also known as stake addresses) are used to receive staking rewards. They have a specific format with bits 7-5 set to 111 and bit 4 indicating whether the credential is a key hash or script hash.

Value parameters

bytes

The raw bytes of the reward account

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum Script

Represents a script in Cardano

Represents a script in Cardano

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ScriptDataHash(hash: Hash32)

Represents a hash of the script data

Represents a hash of the script data

This hash includes the redeemers, datums, and language views from the transaction. It's used to ensure the script's execution environment is consistent with what was intended.

This is simply a type alias for Hash32 to provide better type safety and readability.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ScriptHash(hash: Hash28)

Represents a script hash in Cardano

Represents a script hash in Cardano

To compute a script hash, a tag must be prepended to the script bytes before hashing. The tag is determined by the script language:

  • "\x00" for multisig scripts
  • "\x01" for Plutus V1 scripts
  • "\x02" for Plutus V2 scripts
  • "\x03" for Plutus V3 scripts

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ScriptHash

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ScriptHash.type
case class ScriptRef(script: Script)

Represents a reference to a script in Cardano

Represents a reference to a script in Cardano

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ScriptRef

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ScriptRef.type
final case class Slot(slot: Long)

Represents a slot number in Cardano

Represents a slot number in Cardano

A slot is a fixed period of time in the Cardano blockchain. Slots are where blocks can be added to the chain.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Transaction(body: TransactionBody, witnessSet: TransactionWitnessSet, isValid: Boolean, auxiliaryData: Option[AuxiliaryData])

Represents a complete transaction in Cardano

Represents a complete transaction in Cardano

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionBody(inputs: Set[TransactionInput], outputs: Seq[TransactionOutput], fee: Coin, ttl: Option[Long], certificates: Option[Set[Certificate]], withdrawals: Option[Withdrawals], auxiliaryDataHash: Option[AuxiliaryDataHash], validityStartSlot: Option[Long], mint: Option[Mint], scriptDataHash: Option[ScriptDataHash], collateralInputs: Option[Set[TransactionInput]], requiredSigners: Option[Set[AddrKeyHash]], networkId: Option[Int], collateralReturnOutput: Option[TransactionOutput], totalCollateral: Option[Coin], referenceInputs: Option[Set[TransactionInput]], votingProcedures: Option[VotingProcedures], proposalProcedures: Option[ProposalProcedures], currentTreasuryValue: Option[Coin], donation: Option[Coin])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TransactionBody

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TransactionInput(transactionId: Hash32, index: Int)

Represents an input to a transaction

Represents an input to a transaction

A transaction input is a reference to an output from a previous transaction, identified by the transaction ID and the index of the output.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait TransactionMetadatum

Represents transaction metadata in Cardano

Represents transaction metadata in Cardano

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Bytes
class Int
class List
class Map
class Text
object TransactionMetadatum

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class TransactionMetadatumLabel(value: Long)

Represents a transaction metadatum label in Cardano

Represents a transaction metadatum label in Cardano

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum TransactionOutput

Represents a transaction output in Cardano. Both Shelley-era and Babbage-era output formats are supported.

Represents a transaction output in Cardano. Both Shelley-era and Babbage-era output formats are supported.

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TransactionOutput

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class TransactionWitnessSet(vkeyWitnesses: Option[Set[VKeyWitness]], nativeScripts: Option[Set[Timelock]], bootstrapWitnesses: Option[Set[BootstrapWitness]], plutusV1Scripts: Option[Set[ByteString]], plutusData: Option[Set[Data]], redeemers: Option[Redeemers], plutusV2Scripts: Option[Set[ByteString]], plutusV3Scripts: Option[Set[ByteString]])

Represents the witness set for a transaction in Cardano

Represents the witness set for a transaction in Cardano

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TransactionWitnessSet

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class UnitInterval(numerator: Long, denominator: Long)

Represents a unit interval (a number between 0 and 1) in the Cardano blockchain.

Represents a unit interval (a number between 0 and 1) in the Cardano blockchain.

A unit interval is represented as a fraction with a numerator and denominator, where numerator <= denominator and denominator > 0.

Value parameters

denominator

The denominator of the fraction

numerator

The numerator of the fraction

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UnitInterval

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class VKeyWitness(vkey: ByteString, signature: ByteString)

Represents a verification key witness in Cardano

Represents a verification key witness in Cardano

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VKeyWitness

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum Value

Represents a value in Cardano, which can be either pure ADA or ADA with multi-assets

Represents a value in Cardano, which can be either pure ADA or ADA with multi-assets

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Value

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Value.type
enum Vote

Represents voting options in the Cardano blockchain governance system.

Represents voting options in the Cardano blockchain governance system.

A vote can be one of three values:

  • No: Against the proposal
  • Yes: In favor of the proposal
  • Abstain: Neither for nor against the proposal

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Vote

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Vote.type
enum Voter

Represents a voter in the Cardano blockchain governance system.

Represents a voter in the Cardano blockchain governance system.

A voter can be one of several types:

  • ConstitutionalCommitteeHotKey: A hot key of a constitutional committee member
  • ConstitutionalCommitteeHotScript: A script for a constitutional committee
  • DRepKey: A delegated representative key
  • DRepScript: A delegated representative script
  • StakingPoolKey: A staking pool key

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class VotingProcedure(vote: Vote, anchor: Option[Anchor])

Represents a voting procedure in the Cardano blockchain governance system.

Represents a voting procedure in the Cardano blockchain governance system.

A voting procedure consists of a vote and an optional anchor with additional metadata.

Value parameters

anchor

Optional anchor with additional metadata

vote

The vote (Yes, No, or Abstain)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class VotingProcedures(procedures: Map[Voter, Map[GovActionId, VotingProcedure]])

Represents voting procedures in the Cardano blockchain governance system.

Represents voting procedures in the Cardano blockchain governance system.

VotingProcedures is a map from voters to maps of governance action IDs to voting procedures. It's used to record votes on governance actions.

Value parameters

procedures

Map from voters to maps of governance action IDs to voting procedures

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class VrfCert(output: ByteString, proof: ByteString)

Represents a VRF certificate in Cardano, consisting of output and proof

Represents a VRF certificate in Cardano, consisting of output and proof

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Withdrawals(withdrawals: Map[RewardAccount, Coin])

Represents withdrawals in a transaction.

Represents withdrawals in a transaction.

Withdrawals is a map from reward accounts to withdrawal amounts. It's used to withdraw staking rewards.

Value parameters

withdrawals

Map from reward accounts to withdrawal amounts

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Withdrawals

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Types

opaque type AddressBytes

Represents a Cardano address bytes

Represents a Cardano address bytes

Attributes

type H28 = Hash[Blake2b_224, Any]
type H32 = Hash[Blake2b_224, Any]
opaque type Hash[+HashFunction, +Purpose]
type Metadata = Map[TransactionMetadatumLabel, TransactionMetadatum]

Metadata is a map from metadatum labels to metadatum values

Metadata is a map from metadatum labels to metadatum values

Attributes

type Mint = MultiAsset[Long]
type MultiAsset[A] = Map[PolicyId, Map[AssetName, A]]
opaque type OriginalCborByteArray[A]
Generated with