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

scalus.cardano.ledger

package scalus.cardano.ledger

Members list

Packages

package scalus.cardano.ledger.rules
package scalus.cardano.ledger.utils

Type members

Classlikes

object AddrKeyHash extends HashConstructors[AddrKeyHash, Blake2b_224, KeyHash]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object AddressBytes

Attributes

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

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
object ArbitraryInstances extends ArbitraryInstances

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Show all
Self type
trait ArbitraryInstances extends ArbitraryInstances

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
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
object AuxiliaryDataHash extends HashConstructors[AuxiliaryDataHash, Blake2b_256, AuxiliaryDataHash]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object Bech32

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
trait Blake2b_256

Attributes

Supertypes
class Object
trait Matchable
class Any
case class Block(header: BlockHeader, transactionBodies: IndexedSeq[KeepRaw[TransactionBody]], transactionWitnessSets: IndexedSeq[TransactionWitnessSet], auxiliaryDataSet: Map[Int, KeepRaw[AuxiliaryData]], invalidTransactions: IndexedSeq[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

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Block.type
case class BlockFile(era: Int, block: Block)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
BlockFile.type
object BlockHash extends HashConstructors[BlockHash, Blake2b_256, BlockHash]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
BlockHash.type
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[BlockHash], issuerVkey: ByteString, vrfVkey: ByteString, vrfResult: VrfCert, blockBodySize: Long, blockBodyHash: BlockHash, 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
object BloxbeanToLedgerTranslation

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
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

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

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Builtins.type
case class CardanoInfo(protocolParams: ProtocolParams, network: Network, slotConfig: SlotConfig)

Contains information about the Cardano network, including protocol parameters and slot configuration

Contains information about the Cardano network, including protocol parameters and slot configuration

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class CertState(vstate: VotingState, pstate: PoolsState, dstate: DelegationState)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
CertState.type
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)

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, IndexedSeq[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

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
CostModels.type
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

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
DRep.type
case class DRepState(expiry: EpochNo, anchor: Option[Anchor], deposit: Coin, delegates: Set[Credential])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DRepVotingThresholds(motionNoConfidence: UnitInterval, committeeNormal: UnitInterval, committeeNoConfidence: UnitInterval, updateToConstitution: UnitInterval, hardForkInitiation: UnitInterval, ppNetworkGroup: UnitInterval, ppEconomicGroup: UnitInterval, ppTechnicalGroup: UnitInterval, ppGovGroup: 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

hardForkInitiation

Threshold for hard fork initiations

motionNoConfidence

Threshold for no confidence motions

ppEconomicGroup

Threshold for economic protocol parameter changes

ppGovGroup

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

updateToConstitution

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
object DataHash extends HashConstructors[DataHash, Blake2b_256, DataHash]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
DataHash.type
enum DatumOption

Represents a datum option in Cardano outputs

Represents a datum option in Cardano outputs

Attributes

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class DelegationState(rewards: Map[Credential, Coin], deposits: Map[Credential, Coin], stakePools: Map[Credential, PoolKeyHash], dreps: Map[Credential, DRep])

Delegation State

Delegation State

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum Era(val value: Int) extends Enumeration

Attributes

Supertypes
trait Enum
trait Product
trait Equals
class Enumeration
trait Serializable
class Object
trait Matchable
class Any
Show all
enum EvaluatorMode extends Enum[EvaluatorMode]

Attributes

Supertypes
trait Enum
trait Product
trait Equals
class Enum[EvaluatorMode]
trait Serializable
trait Comparable[EvaluatorMode]
trait Constable
class Object
trait Matchable
class Any
Show all
case class ExUnitPrices(priceMemory: NonNegativeInterval, priceSteps: 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

priceMemory

Price per memory unit

priceSteps

Price per step unit

Attributes

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

Represents execution units for Plutus scripts in Cardano

Represents execution units for Plutus scripts in Cardano

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ExUnits.type
case class FutureGenDeleg(slot: Slot, genesisKeyHash: AddrKeyHash)

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: TransactionHash, 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

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

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Hash.type
object Hash28 extends HashConstructors[Hash28, Blake2b_224, Any]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Hash28.type
object Hash32 extends HashConstructors[Hash32, Blake2b_256, Any]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Hash32.type
trait HashConstructors[HashType >: Hash[HashFunction, Purpose], HashFunction, Purpose]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AddrKeyHash
object BlockHash
object DataHash
object Hash28
object Hash32
object MetadataHash
object PoolKeyHash
object ScriptHash
object StakeKeyHash
object VrfKeyHash
Show all
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]

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 extends Enum[Language]

Represents the supported scripting languages in Cardano

Represents the supported scripting languages in Cardano

Attributes

Companion
object
Supertypes
trait Enum
trait Product
trait Equals
class Enum[Language]
trait Serializable
trait Comparable[Language]
trait Constable
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
object LedgerToPlutusTranslation

Advanced interoperability layer for scalus.cardano.ledger domain model.

Advanced interoperability layer for scalus.cardano.ledger domain model.

This object provides conversion functions and utilities for working with native Scalus types instead of external library dependencies. It handles:

  • Data conversion between Plutus Data and Scalus Data
  • Transaction information construction for all Plutus versions
  • Script context building and script purpose resolution
  • Cost model translation and machine parameter setup
  • Address, credential, and certificate type conversions
  • Multi-asset value handling and ordering
  • Governance-related type conversions (Conway era)

All functions maintain compatibility with Cardano's CDDL specifications and preserve the deterministic ordering required for script validation.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class MajorProtocolVersion(version: Int) extends Ordered[MajorProtocolVersion]

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Ordered[MajorProtocolVersion]
trait Comparable[MajorProtocolVersion]
class Object
trait Matchable
class Any
Show all
object MajorProtocolVersion

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object MetadataHash extends HashConstructors[MetadataHash, Blake2b_256, MetadataHash]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait Metadatum

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 Metadatum

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Metadatum.type
object Mint

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Mint.type
case class MultiAsset

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
MultiAsset.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
sealed trait PlutusScript extends Script

Attributes

Companion
object
Supertypes
trait Script
class Object
trait Matchable
class Any
Known subtypes
class PlutusV1
class PlutusV2
class PlutusV3
object PlutusScript

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class PlutusScriptEvaluationException(message: String, cause: Throwable, val logs: Array[String]) extends RuntimeException

Attributes

Supertypes
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait PlutusScriptEvaluator

Evaluates Plutus V1, V2 or V3 scripts using the provided transaction and UTxO set.

Evaluates Plutus V1, V2 or V3 scripts using the provided transaction and UTxO set.

Attributes

Note

It's an experimental API and may change in future versions, even in patch releases.

Companion
object
Supertypes
class Object
trait Matchable
class Any
object PlutusScriptEvaluator

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object PoolKeyHash extends HashConstructors[PoolKeyHash, Blake2b_224, PoolKeyHash]

Attributes

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

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, hardForkInitiation: 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

hardForkInitiation

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 PoolsState()

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
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 ProtocolParams(collateralPercentage: Long, committeeMaxTermLength: Long, committeeMinSize: Long, costModels: CostModels, dRepActivity: Long, dRepDeposit: Long, dRepVotingThresholds: DRepVotingThresholds, executionUnitPrices: ExUnitPrices, govActionDeposit: Long, govActionLifetime: Long, maxBlockBodySize: Long, maxBlockExecutionUnits: ExUnits, maxBlockHeaderSize: Long, maxCollateralInputs: Long, maxTxExecutionUnits: ExUnits, maxTxSize: Long, maxValueSize: Long, minFeeRefScriptCostPerByte: Long, minPoolCost: Long, monetaryExpansion: Double, poolPledgeInfluence: Double, poolRetireMaxEpoch: Long, poolVotingThresholds: PoolVotingThresholds, protocolVersion: ProtocolVersion, stakeAddressDeposit: Long, stakePoolDeposit: Long, stakePoolTargetNum: Long, treasuryCut: Double, txFeeFixed: Long, txFeePerByte: Long, utxoCostPerByte: Long)

Protocol parameters for the Cardano blockchain of Babbage era Field names are taken from the cardano-cli query protocol-parameters output

Protocol parameters for the Cardano blockchain of Babbage era Field names are taken from the cardano-cli query protocol-parameters output

Attributes

Note

These names are different from CIP-55, don't ask me why.

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

Attributes

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

Represents a Cardano protocol version

Represents a Cardano protocol version

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Ordered[ProtocolVersion]
trait Comparable[ProtocolVersion]
class Object
trait Matchable
class Any
Show all
object ProtocolVersion

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
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

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Redeemer.type
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(address: StakeAddress)

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

address

The address of the reward account

Attributes

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

Attributes

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

Rewards calculation for an epoch

Rewards calculation for an epoch

Implements rewards computation according to the Cardano ledger specification. Based on the POOLREAP and REWARD rules.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait Script

Represents a script in Cardano

Represents a script in Cardano

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait PlutusScript
class PlutusV1
class PlutusV2
class PlutusV3
class Native
object Script

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Script.type
object ScriptDataHash extends HashConstructors[ScriptDataHash, Blake2b_256, ScriptDataHash]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ScriptDataHashGenerator

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ScriptHash extends HashConstructors[ScriptHash, Blake2b_224, ScriptHash]

Attributes

Supertypes
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
case class Sized[A]

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Sized.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 SlotConfig(zeroTime: Long, zeroSlot: Long, slotLength: Long)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
SlotConfig.type
object StakeDistribution

Stake distribution computation for an epoch

Stake distribution computation for an epoch

Implements the SNAP rule from the Cardano ledger specification. Computes stake distribution from the current ledger state.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object StakeKeyHash extends HashConstructors[StakeKeyHash, Blake2b_224, StakeKeyHash]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object TaggedOrderedSet extends TaggedSeq

Attributes

Supertypes
trait TaggedSeq
class Object
trait Matchable
class Any
Self type
object TaggedOrderedStrictSet extends TaggedSeq

Attributes

Supertypes
trait TaggedSeq
class Object
trait Matchable
class Any
Self type
trait TaggedSeq(tag: Tag = ...)

Tags in sets

Tags in sets

Conway introduced optional 258 tags in certain items that are considered sets semantically but encoded as arrays in CBOR.

Semantics: Tag 258 can be applied to a CBOR array data item to indicate that it is a set. Sets should be handled similarly to CBOR maps: a set that has duplicate items may be well-formed, but it is not valid. Like CBOR map keys, data items in a set do not need to be of the same type.

https://github.com/input-output-hk/cbor-sets-spec/blob/master/CBOR_SETS.md

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object TaggedSortedMap extends TaggedSeq

Attributes

Supertypes
trait TaggedSeq
class Object
trait Matchable
class Any
Self type
object TaggedSortedSet extends TaggedSeq

Attributes

Supertypes
trait TaggedSeq
class Object
trait Matchable
class Any
Self type
object TaggedSortedStrictMap extends TaggedSeq

Attributes

Supertypes
trait TaggedSeq
class Object
trait Matchable
class Any
Self type
enum Timelock

Cardano Timelock script

Cardano Timelock script

Timelock scripts are used to enforce time-based constraints on transactions. Implemented according to "A Formal Specification of the Cardano Ledger with a Native Multi-Asset Implementation" specification.

Attributes

See also
Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Timelock

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Timelock.type
case class Transaction(body: KeepRaw[TransactionBody], witnessSet: TransactionWitnessSet, isValid: Boolean = ..., auxiliaryData: Option[KeepRaw[AuxiliaryData]] = ...)

Represents a complete transaction in Cardano

Represents a complete transaction in Cardano

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class TransactionBody(inputs: TaggedSortedSet[TransactionInput], outputs: IndexedSeq[Sized[TransactionOutput]], fee: Coin, ttl: Option[Long] = ..., certificates: TaggedOrderedStrictSet[Certificate] = ..., withdrawals: Option[Withdrawals] = ..., auxiliaryDataHash: Option[AuxiliaryDataHash] = ..., validityStartSlot: Option[Long] = ..., mint: Option[Mint] = ..., scriptDataHash: Option[ScriptDataHash] = ..., collateralInputs: TaggedSortedSet[TransactionInput] = ..., requiredSigners: TaggedSortedSet[AddrKeyHash] = ..., networkId: Option[Int] = ..., collateralReturnOutput: Option[Sized[TransactionOutput]] = ..., totalCollateral: Option[Coin] = ..., referenceInputs: TaggedSortedSet[TransactionInput] = ..., votingProcedures: Option[VotingProcedures] = ..., proposalProcedures: TaggedOrderedSet[ProposalProcedure] = ..., 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
sealed abstract class TransactionException(message: String, cause: Throwable) extends RuntimeException

Attributes

Companion
object
Supertypes
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
Show all
object TransactionException

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object TransactionHash extends HashConstructors[TransactionHash, Blake2b_256, TransactionHash]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class TransactionInput(transactionId: TransactionHash, 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

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait 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
class Object
trait Matchable
class Any
Known subtypes
class Babbage
class Shelley
object TransactionOutput

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class TransactionWitnessSet(vkeyWitnesses: TaggedSortedSet[VKeyWitness] = ..., nativeScripts: TaggedSortedMap[ScriptHash, Native] = ..., bootstrapWitnesses: TaggedSortedSet[BootstrapWitness] = ..., plutusV1Scripts: TaggedSortedStrictMap[ScriptHash, PlutusV1] = ..., plutusData: KeepRaw[TaggedSortedMap[DataHash, KeepRaw[Data]]] = ..., redeemers: Option[KeepRaw[Redeemers]] = ..., plutusV2Scripts: TaggedSortedStrictMap[ScriptHash, PlutusV2] = ..., plutusV3Scripts: TaggedSortedStrictMap[ScriptHash, PlutusV3] = ...)

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 UTxOState(utxo: Utxos, deposited: Coin, fees: Coin, govState: GovState, stakeDistribution: StakeMap, donation: Coin)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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 Utxo(input: TransactionInput, output: TransactionOutput)

Unspent Transaction Output

Unspent Transaction Output

Attributes

Note

It's common to use UTXO as a resolved transaction input-output pair, regardless whether it's spent or unspent. We use Utxo in both cases for simplicity.

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Utxo.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
case class ValidityInterval(invalidBefore: Option[SlotNo], invalidHereafter: Option[SlotNo])

ValidityInterval is a half-open interval: closed on bottom, open on top.

ValidityInterval is a half-open interval: closed on bottom, open on top.

None on bottom is negative infinity, None on top is positive infinity

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Value(coin: Coin, assets: MultiAsset = ...)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Value

Attributes

Companion
class
Supertypes
trait Product
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

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Voter.type
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: SortedMap[Voter, SortedMap[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

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class VotingState(dreps: Map[Credential, DRepState])

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
object VrfKeyHash extends HashConstructors[VrfKeyHash, Blake2b_256, VrfKeyHash]

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
VrfKeyHash.type
case class Withdrawals(withdrawals: SortedMap[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
case class Word64(value: Long)

A case class representing an unsigned 64-bit integer.

A case class representing an unsigned 64-bit integer.

This type uses a signed Long underneath but provides operations that interpret the bits as an unsigned 64-bit value, giving access to the full range 0 to 2^64-1.

The underlying Long storage means that values from 0 to Long.MAX_VALUE (9,223,372,036,854,775,807) are stored as positive longs, while values from Long.MAX_VALUE + 1 to 2^64 - 1 are stored as negative longs using two's complement representation.

Example usage:

val small = Word64(1000L)
val large = Word64.fromUnsignedString("18446744073709551615") // 2^64 - 1

println(small.toUnsignedString) // "1000"
println(large.toUnsignedString) // "18446744073709551615"
println(large.toLong) // -1 (signed interpretation)

// Arithmetic works correctly with unsigned semantics
val sum = small + large
println(sum.toUnsignedString) // "999"

// Comparison uses unsigned semantics
println(large.compareUnsigned(small) > 0) // true

Attributes

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

Attributes

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

Types

type AddrKeyHash = Hash[Blake2b_224, KeyHash]

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

opaque type AddressBytes

Represents a Cardano address bytes

Represents a Cardano address bytes

Attributes

type AnyHash = Hash[Any, Any]
type EpochNo = Long
type GovState = Unit
opaque type Hash[+HashFunction, +Purpose]
type Hash28 = Hash[Blake2b_224, Any]

Represents a 28-byte Blake2b_224 hash value used in Cardano

Represents a 28-byte Blake2b_224 hash value used in Cardano

Hash28 is commonly used for address key hashes and script hashes

Attributes

type Hash32 = Hash[Blake2b_256, Any]
type Metadata = Map[Word64, Metadatum]

Metadata is a map from metadatum labels to metadatum values

Metadata is a map from metadatum labels to metadatum values

Attributes

opaque type Mint

Minting MultiAsset. Can't contain zeros, can't be empty

Minting MultiAsset. Can't contain zeros, can't be empty

Attributes

opaque type OriginalCborByteArray
type ScriptDataHash = Hash[Blake2b_256, ScriptDataHash]

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

type ScriptHash = Hash[Blake2b_224, ScriptHash]

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

type SlotNo = Long
type StakeMap = Map[Credential, Coin]
opaque type TaggedOrderedSet[A]

Represents a tagged set, which is an indexed sequence of unique elements with a tag.

Represents a tagged set, which is an indexed sequence of unique elements with a tag.

It's a new requirement for the Cardano ledger to have a tagged set. It's a stupid idea and God knows why they came up with it, but now we have to implement it.

Under the hood it's an IndexedSeq because we need to preserve the order of elements and need a fast access by index. And technically, it can contain duplicates in CBOR.

Unfortunately, we cannot make it as

opaque type TaggedSet[+A] <: IndexedSeq[A] = IndexedSeq[A]

because then Encoder[TaggedSet[A]] conflicts with Encoder.forIndexedSeq

Important: This implementation allows duplicates in input (i.e. does not throw exception) and keeps order of data (does not sort) but eliminates duplicates.

Attributes

opaque type TaggedOrderedStrictSet[+A]

Represents a tagged ordered set, which is an indexed sequence of unique elements with a tag.

Represents a tagged ordered set, which is an indexed sequence of unique elements with a tag.

It's a new requirement for the Cardano ledger to have a tagged set. It's a stupid idea and God knows why they came up with it, but now we have to implement it.

Under the hood it's an IndexedSeq because we need to preserve the order of elements and need a fast access by index. And technically, it can contain duplicates in CBOR.

Unfortunately, we cannot make it as

opaque type TaggedOrderedSet[+A] <: IndexedSeq[A] = IndexedSeq[A]

because then Encoder[TaggedOrderedSet[A]] conflicts with Encoder.forIndexedSeq

Important: This implementation does not allow duplicates in input (i.e. throws exception) and keeps order of data (does not sort).

Attributes

opaque type TaggedSortedMap[K, A]

Represents a tagged sorted map, which is a sorted set of keys and elements with a tag.

Represents a tagged sorted map, which is a sorted set of keys and elements with a tag.

Under the hood it's a SortedMap because we need to enforce the order of elements. Also, it allows make right CBOR serialization with tag 258.

Important: This implementation allows duplicate keys in input (i.e. does not throw exception) silently removes duplicates and does not keep order in data (sorts by keys).

Attributes

opaque type TaggedSortedSet[A]

Represents a tagged sorted set, which is a sorted set of elements with a tag.

Represents a tagged sorted set, which is a sorted set of elements with a tag.

Under the hood it's a SortedSet because we need to enforce the order of elements. Also, it allows make right CBOR serialization with tag 258.

Important: This implementation allows duplicates in input (i.e. does not throw exception), silently removes duplicates and does not keep order in data (sorts elements by given ordering).

Attributes

opaque type TaggedSortedStrictMap[K, A]

Represents a tagged sorted map with strict duplicate checking.

Represents a tagged sorted map with strict duplicate checking.

This type enforces that no duplicate keys exist in the input during decoding. If duplicates are found, an exception is thrown. This matches the behavior of Haskell's decodeMapLikeEnforceNoDuplicates used for Plutus scripts.

Under the hood it's a SortedMap because we need to enforce the order of elements. Also, it allows make right CBOR serialization with tag 258.

Important: This implementation throws an exception if duplicate keys are found in input during Conway protocol version (PV9+). Pre-Conway, duplicates are silently handled (last value wins).

Attributes

Deprecated types

type TransactionMetadatum = Metadatum

Attributes

Deprecated
[Since version 0.12] Use Metadatum instead
type TransactionMetadatumLabel = Word64

Attributes

Deprecated
[Since version 0.12] Use Word64 instead
type UTxO = Map[TransactionInput, TransactionOutput]

Attributes

Deprecated
[Since version 0.12.1] Use Utxos instead

Value members

Deprecated fields

val TransactionMetadatum: Metadatum.type

Attributes

Deprecated
[Since version 0.12] Use Metadatum instead
val TransactionMetadatumLabel: Word64.type

Attributes

Deprecated
[Since version 0.12] Use Word64 instead

Extensions

Extensions

extension (self: KeepRaw[Data])
Generated with