cardano::stake_pool::DeregistrationCertificateManager class

An interface for managing stake pool retirement certificates.

Constructors, destructors, conversion operators

DeregistrationCertificateManager(cardano::shelley::PoolRetirement cert) explicit
Construct a manager object from a retirement certificate.
DeregistrationCertificateManager(const ColdVerificationKey& vkey, uint64_t epoch)
Construst a retirement certificate.

Public functions

auto certificate() const →  const cardano::shelley::PoolRetirement&
Provide a constant reference to the certificate struct.
void saveToFile(std::string_view fpath) const
Export the certifiate to a file in the text envelope format.
auto serialize() const →  std::vector<uint8_t>
Serialize the certificate to CBOR.
void setEpoch(uint64_t epoch)
Set the epoch in which the pool will retire.

Function documentation

cardano::stake_pool::DeregistrationCertificateManager::DeregistrationCertificateManager(cardano::shelley::PoolRetirement cert) explicit

Construct a manager object from a retirement certificate.

Parameters
cert The retirement certificate struct.

cardano::stake_pool::DeregistrationCertificateManager::DeregistrationCertificateManager(const ColdVerificationKey& vkey, uint64_t epoch)

Construst a retirement certificate.

Parameters
vkey The verification key of the retiring pool.
epoch The epoch in which the pool will retire.

const cardano::shelley::PoolRetirement& cardano::stake_pool::DeregistrationCertificateManager::certificate() const

Provide a constant reference to the certificate struct.

Returns A constant reference to the internal certificate struct.

void cardano::stake_pool::DeregistrationCertificateManager::saveToFile(std::string_view fpath) const

Export the certifiate to a file in the text envelope format.

Parameters
fpath Path to the file to be (over)written.

std::vector<uint8_t> cardano::stake_pool::DeregistrationCertificateManager::serialize() const

Serialize the certificate to CBOR.

Returns The CBOR byte string as a byte vector.

void cardano::stake_pool::DeregistrationCertificateManager::setEpoch(uint64_t epoch)

Set the epoch in which the pool will retire.

Parameters
epoch The epoch in which the pool will retire.