Scalus
1.5.0
Generated with
Scalus/scalus/scalus.cardano/scalus.cardano.address

scalus.cardano.address

package scalus.cardano.address

Members list

Type members

Classlikes

object Address

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Address.type
sealed trait Address

Base trait for all Cardano addresses

Base trait for all Cardano addresses

Provides common functionality and properties shared across different address types

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ByronAddress
class StakeAddress
object ArbitraryInstances extends ArbitraryInstances

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ByronAddress(bytes: ByteString) extends Address

Byron address - legacy Cardano address format using Base58 encoding.

Byron address - legacy Cardano address format using Base58 encoding.

Byron addresses have the following CBOR structure:

  • Outer: [tag24(payload_bytes), crc32_checksum]
  • Inner payload: [addrRoot (28 bytes), addrAttributes (map), addrType (uint)]

Address attributes (map):

  • Key 1: Optional derivation path (HD address payload)
  • Key 2: Optional network magic (CBOR-encoded Word32)

Address types:

  • 0: Verification key address (ATVerKey)
  • 2: Redeem address (ATRedeem)

Attributes

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

Attributes

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

Network identification for Cardano addresses

Network identification for Cardano addresses

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Mainnet
class Other
object Testnet
object Network

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Network.type
object ParsedByronAddress

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ParsedByronAddress(addrRoot: ByteString, addrType: Int, derivationPath: Option[ByteString], networkMagic: Option[Long], crc32: Long, computedCrc32: Long)

Parsed Byron address components

Parsed Byron address components

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Pointer(slot: Slot, txIdx: TxIdx, certIdx: CertIdx)

Represents a pointer to a stake registration certificate on the blockchain Used in pointer addresses to reference stake credentials indirectly

Represents a pointer to a stake registration certificate on the blockchain Used in pointer addresses to reference stake credentials indirectly

The ledger holds the slot in 32 bits and both indexes in 16 bits, so a pointer beyond Pointer.MaxSlot or Pointer.MaxIndex cannot be built; Pointer.parseFrom rejects one, or reads it as Pointer(Slot(0), 0, 0) before protocol version 9.

Value parameters

certIdx

Certificate index within the transaction

slot

Transaction slot number where the stake registration occurred

txIdx

Transaction index within the slot

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Pointer.type
case class ShelleyAddress(network: Network, payment: ShelleyPaymentPart, delegation: ShelleyDelegationPart) extends Address

A decoded Shelley address containing network, payment and delegation parts

A decoded Shelley address containing network, payment and delegation parts

Attributes

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

Attributes

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

The delegation part of a Shelley address - various ways to specify stake credentials

The delegation part of a Shelley address - various ways to specify stake credentials

Attributes

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

Attributes

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

The payment part of a Shelley address - can be either a key hash or script hash

The payment part of a Shelley address - can be either a key hash or script hash

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class StakeAddress(network: Network, payload: StakePayload) extends Address

A decoded Stake address for delegation purposes

A decoded Stake address for delegation purposes

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Address
class Object
trait Matchable
class Any
Show all
enum StakePayload

The payload of a Stake address - either stake key or script

The payload of a Stake address - either stake key or script

Attributes

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

Attributes

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

Types

type CertIdx = Long
type TxIdx = Long

Type aliases for clarity - matching Rust implementation

Type aliases for clarity - matching Rust implementation

Attributes

Generated with