PoolRetirementCert

class cometa.certificates.pool_retirement_cert.PoolRetirementCert(ptr)[source]

Bases: object

Represents a pool retirement certificate.

This certificate is used to retire an existing stake pool from the Cardano blockchain. The pool will be retired at the specified epoch.

__init__(ptr)[source]
Return type:

None

__enter__()[source]
Return type:

PoolRetirementCert

__exit__(exc_type, exc_val, exc_tb)[source]
Return type:

None

__repr__()[source]

Return repr(self).

Return type:

str

classmethod new(pool_key_hash, epoch)[source]

Creates a new pool retirement certificate.

Parameters:
  • pool_key_hash (Blake2bHash) – The hash of the pool’s operator key.

  • epoch (int) – The epoch at which the pool should be retired.

Returns:

A new PoolRetirementCert instance.

Raises:

CardanoError – If creation fails.

Return type:

PoolRetirementCert

classmethod from_cbor(reader)[source]

Deserializes a PoolRetirementCert from CBOR data.

Parameters:

reader (CborReader) – A CborReader positioned at the certificate data.

Returns:

A new PoolRetirementCert deserialized from the CBOR data.

Raises:

CardanoError – If deserialization fails.

Return type:

PoolRetirementCert

to_cbor(writer)[source]

Serializes the certificate to CBOR format.

Parameters:

writer (CborWriter) – A CborWriter to write the serialized data to.

Raises:

CardanoError – If serialization fails.

Return type:

None

property pool_key_hash: Blake2bHash

The hash of the pool’s operator key.

Returns:

The Blake2bHash of the pool key.

property epoch: int

The epoch at which the pool will be retired.

Returns:

The retirement epoch number.

to_cip116_json(writer)[source]

Serializes this certificate to CIP-116 compliant JSON.

Parameters:

writer (JsonWriter) – The JsonWriter to write the JSON to.

Raises:

CardanoError – If serialization fails.

Return type:

None