Class PoolRetirement

This certificate is used to retire a stake pool. It includes an epoch number indicating when the pool will be retired.

Hierarchy

PoolRetirement

Index

Constructors

Properties

#epoch #originalBytes #poolKeyHash

Methods

epoch poolKeyHash setEpoch setPoolKeyHash toCbor toCore fromCbor fromCore

Constructors

constructor

new PoolRetirement(poolKeyHash: Ed25519KeyHashHex, epoch: Cardano.EpochNo): Serialization.PoolRetirement
Initializes a new instance of the PoolRetirement class.
Parameters
- poolKeyHash: Ed25519KeyHashHex
  
  The pool key hash.
- epoch: Cardano.EpochNo
  
  The epoch at which the pool will be retired.
Returns Serialization.PoolRetirement
- Defined in packages/core/src/Serialization/Certificates/PoolRetirement.ts:21

Properties

`Private` #epoch

#epoch: Cardano.EpochNo

`Private` #originalBytes

#originalBytes: undefined | HexBlob = undefined

`Private` #poolKeyHash

#poolKeyHash: Ed25519KeyHashHex

Methods

epoch

epoch(): Cardano.EpochNo
Gets the epoch at which the pool will be retired.

Returns
The epoch at which the pool will be retired.

Returns Cardano.EpochNo
- Defined in packages/core/src/Serialization/Certificates/PoolRetirement.ts:130

poolKeyHash

poolKeyHash(): Ed25519KeyHashHex
Gets the pool has id from this certificate.

Returns
The pool key hash.

Returns Ed25519KeyHashHex
- Defined in packages/core/src/Serialization/Certificates/PoolRetirement.ts:111

setEpoch

setEpoch(epoch: Cardano.EpochNo): void
Sets the epoch at which the pool will be retired.
Parameters
- epoch: Cardano.EpochNo
  
  The epoch at which the pool will be retired.
Returns void
- Defined in packages/core/src/Serialization/Certificates/PoolRetirement.ts:139

setPoolKeyHash

setPoolKeyHash(poolKeyHash: Ed25519KeyHashHex): void
Sets the pool has id from this certificate.
Parameters
- poolKeyHash: Ed25519KeyHashHex
  
  The pool key hash.
Returns void
- Defined in packages/core/src/Serialization/Certificates/PoolRetirement.ts:120

toCbor

toCbor(): HexBlob
Serializes a PoolRetirement into CBOR format.

Returns
The PoolRetirement in CBOR format.

Returns HexBlob
- Defined in packages/core/src/Serialization/Certificates/PoolRetirement.ts:31

toCore

toCore(): Cardano.PoolRetirementCertificate
Creates a Core PoolRetirementCertificate object from the current PoolRetirement object.

Returns
The Core PoolRetirementCertificate object.

Returns Cardano.PoolRetirementCertificate
- Defined in packages/core/src/Serialization/Certificates/PoolRetirement.ts:89

`Static` fromCbor

fromCbor(cbor: HexBlob): Serialization.PoolRetirement
Deserializes the PoolRetirement from a CBOR byte array.

Returns
The new PoolRetirement instance.
Parameters
- cbor: HexBlob
  
  The CBOR encoded PoolRetirement object.
Returns Serialization.PoolRetirement
- Defined in packages/core/src/Serialization/Certificates/PoolRetirement.ts:54

`Static` fromCore

fromCore(cert: Cardano.PoolRetirementCertificate): Serialization.PoolRetirement
Creates a PoolRetirement object from the given Core StakeAddressCertificate object.
Parameters
- cert: Cardano.PoolRetirementCertificate
  
  core PoolRetirementCertificate object.
Returns Serialization.PoolRetirement
- Defined in packages/core/src/Serialization/Certificates/PoolRetirement.ts:102

Generated using TypeDoc