scalus.cardano.ledger
Members list
Type members
Classlikes
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
AddressBytes.type
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents auxiliary data in a Cardano transaction
Represents auxiliary data in a Cardano transaction
Attributes
- Companion
- object
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- enum
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
AuxiliaryData.type
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object Blake2b_224
Attributes
- Companion
- trait
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait Blake2b_224class Objecttrait Matchableclass AnyShow all
- Self type
-
Blake2b_224.type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object Blake2b_256
Attributes
- Companion
- trait
- Supertypes
- Self type
-
Blake2b_256.type
Represents a complete block in the Cardano blockchain
Represents a complete block in the Cardano blockchain
Valid blocks must also satisfy the following constraints:
- 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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a block header in Cardano
Represents a block header in Cardano
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents the body of a block header in Cardano
Represents the body of a block header in Cardano
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a bootstrap witness in Cardano (for Byron-era addresses)
Represents a bootstrap witness in Cardano (for Byron-era addresses)
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a certificate for stake operations on the blockchain
Represents a certificate for stake operations on the blockchain
Attributes
- Companion
- object
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- enum
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
Certificate.type
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
DRepVotingThresholds.type
Represents a datum option in Cardano outputs
Represents a datum option in Cardano outputs
Attributes
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents execution units for Plutus scripts in Cardano
Represents execution units for Plutus scripts in Cardano
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
HashPurpose.type
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents the supported scripting languages in Cardano
Represents the supported scripting languages in Cardano
Attributes
- Companion
- object
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
NonNegativeInterval.type
Represents an operational certificate in Cardano
Represents an operational certificate in Cardano
An operational certificate authorizes a node to create blocks
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
PoolVotingThresholds.type
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ProtocolParamUpdate.type
Represents a Cardano protocol version
Represents a Cardano protocol version
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- enum
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
RedeemerTag.type
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 Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a script in Cardano
Represents a script in Cardano
Attributes
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ScriptHash.type
Represents a reference to a script in Cardano
Represents a reference to a script in Cardano
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a complete transaction in Cardano
Represents a complete transaction in Cardano
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TransactionBody.type
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TransactionMetadatum.type
Represents a transaction metadatum label in Cardano
Represents a transaction metadatum label in Cardano
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- enum
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TransactionOutput.type
Represents the witness set for a transaction in Cardano
Represents the witness set for a transaction in Cardano
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
UnitInterval.type
Represents a verification key witness in Cardano
Represents a verification key witness in Cardano
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
VKeyWitness.type
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 Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
Withdrawals.type
Types
Represents a Cardano address bytes
Represents a Cardano address bytes
Attributes
Metadata is a map from metadatum labels to metadatum values
Metadata is a map from metadatum labels to metadatum values