"""
Copyright 2025 Biglup Labs.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
from __future__ import annotations
from .._ffi import ffi, lib
from ..errors import CardanoError
from ..cbor.cbor_reader import CborReader
from ..cbor.cbor_writer import CborWriter
from ..common.credential import Credential
from ..common.drep import DRep
from ..cryptography.blake2b_hash import Blake2bHash
[docs]
class StakeVoteRegistrationDelegationCert:
"""
Represents a combined stake registration, stake delegation, and vote delegation certificate.
This certificate allows registering a stake credential, delegating it to a pool,
and delegating voting power to a DRep, all in a single certificate.
"""
[docs]
def __init__(self, ptr) -> None:
if ptr == ffi.NULL:
raise CardanoError("StakeVoteRegistrationDelegationCert: invalid handle")
self._ptr = ptr
def __del__(self) -> None:
if getattr(self, "_ptr", ffi.NULL) not in (None, ffi.NULL):
ptr_ptr = ffi.new(
"cardano_stake_vote_registration_delegation_cert_t**", self._ptr
)
lib.cardano_stake_vote_registration_delegation_cert_unref(ptr_ptr)
self._ptr = ffi.NULL
[docs]
def __enter__(self) -> StakeVoteRegistrationDelegationCert:
return self
[docs]
def __exit__(self, exc_type, exc_val, exc_tb) -> None:
pass
[docs]
def __repr__(self) -> str:
return f"StakeVoteRegistrationDelegationCert(deposit={self.deposit})"
[docs]
@classmethod
def new(
cls,
credential: Credential,
deposit: int,
drep: DRep,
pool_key_hash: Blake2bHash,
) -> StakeVoteRegistrationDelegationCert:
"""
Creates a new stake vote registration and delegation certificate.
Args:
credential: The stake credential to register and delegate.
deposit: The deposit amount in lovelace.
drep: The DRep to delegate voting power to.
pool_key_hash: The hash of the pool's operator key to delegate stake to.
Returns:
A new StakeVoteRegistrationDelegationCert instance.
Raises:
CardanoError: If creation fails.
"""
out = ffi.new("cardano_stake_vote_registration_delegation_cert_t**")
err = lib.cardano_stake_vote_registration_delegation_cert_new(
credential._ptr, deposit, drep._ptr, pool_key_hash._ptr, out
)
if err != 0:
raise CardanoError(
f"Failed to create StakeVoteRegistrationDelegationCert (error code: {err})"
)
return cls(out[0])
[docs]
@classmethod
def from_cbor(cls, reader: CborReader) -> StakeVoteRegistrationDelegationCert:
"""
Deserializes a StakeVoteRegistrationDelegationCert from CBOR data.
Args:
reader: A CborReader positioned at the certificate data.
Returns:
A new StakeVoteRegistrationDelegationCert deserialized from the CBOR data.
Raises:
CardanoError: If deserialization fails.
"""
out = ffi.new("cardano_stake_vote_registration_delegation_cert_t**")
err = lib.cardano_stake_vote_registration_delegation_cert_from_cbor(
reader._ptr, out
)
if err != 0:
raise CardanoError(
f"Failed to deserialize StakeVoteRegistrationDelegationCert from CBOR (error code: {err})"
)
return cls(out[0])
[docs]
def to_cbor(self, writer: CborWriter) -> None:
"""
Serializes the certificate to CBOR format.
Args:
writer: A CborWriter to write the serialized data to.
Raises:
CardanoError: If serialization fails.
"""
err = lib.cardano_stake_vote_registration_delegation_cert_to_cbor(
self._ptr, writer._ptr
)
if err != 0:
raise CardanoError(
f"Failed to serialize StakeVoteRegistrationDelegationCert to CBOR (error code: {err})"
)
@property
def credential(self) -> Credential:
"""
The stake credential being registered and delegated.
Returns:
The Credential associated with this certificate.
"""
ptr = lib.cardano_stake_vote_registration_delegation_cert_get_credential(
self._ptr
)
if ptr == ffi.NULL:
raise CardanoError("Failed to get credential")
lib.cardano_credential_ref(ptr)
return Credential(ptr)
@credential.setter
def credential(self, value: Credential) -> None:
"""
Sets the stake credential.
Args:
value: The Credential to set.
Raises:
CardanoError: If setting fails.
"""
err = lib.cardano_stake_vote_registration_delegation_cert_set_credential(
self._ptr, value._ptr
)
if err != 0:
raise CardanoError(f"Failed to set credential (error code: {err})")
@property
def deposit(self) -> int:
"""
The deposit amount in lovelace.
Returns:
The deposit amount.
"""
return int(
lib.cardano_stake_vote_registration_delegation_cert_get_deposit(self._ptr)
)
@deposit.setter
def deposit(self, value: int) -> None:
"""
Sets the deposit amount.
Args:
value: The deposit amount in lovelace.
Raises:
CardanoError: If setting fails.
"""
err = lib.cardano_stake_vote_registration_delegation_cert_set_deposit(
self._ptr, value
)
if err != 0:
raise CardanoError(f"Failed to set deposit (error code: {err})")
@property
def drep(self) -> DRep:
"""
The DRep receiving the delegated voting power.
Returns:
The DRep associated with this delegation.
"""
ptr = lib.cardano_stake_vote_registration_delegation_cert_get_drep(self._ptr)
if ptr == ffi.NULL:
raise CardanoError("Failed to get DRep")
lib.cardano_drep_ref(ptr)
return DRep(ptr)
@drep.setter
def drep(self, value: DRep) -> None:
"""
Sets the DRep.
Args:
value: The DRep to set.
Raises:
CardanoError: If setting fails.
"""
err = lib.cardano_stake_vote_registration_delegation_cert_set_drep(
self._ptr, value._ptr
)
if err != 0:
raise CardanoError(f"Failed to set DRep (error code: {err})")
@property
def pool_key_hash(self) -> Blake2bHash:
"""
The hash of the pool's operator key.
Returns:
The Blake2bHash of the pool key.
"""
ptr = lib.cardano_stake_vote_registration_delegation_cert_get_pool_key_hash(
self._ptr
)
if ptr == ffi.NULL:
raise CardanoError("Failed to get pool key hash")
lib.cardano_blake2b_hash_ref(ptr)
return Blake2bHash(ptr)
@pool_key_hash.setter
def pool_key_hash(self, value: Blake2bHash) -> None:
"""
Sets the pool key hash.
Args:
value: The Blake2bHash of the pool key.
Raises:
CardanoError: If setting fails.
"""
err = lib.cardano_stake_vote_registration_delegation_cert_set_pool_key_hash(
self._ptr, value._ptr
)
if err != 0:
raise CardanoError(f"Failed to set pool key hash (error code: {err})")
[docs]
def to_cip116_json(self, writer: "JsonWriter") -> None:
"""
Serializes this certificate to CIP-116 compliant JSON.
Args:
writer: The JsonWriter to write the JSON to.
Raises:
CardanoError: If serialization fails.
"""
from ..json import JsonWriter
if not isinstance(writer, JsonWriter):
raise TypeError("writer must be a JsonWriter instance")
err = lib.cardano_stake_vote_registration_delegation_cert_to_cip116_json(self._ptr, writer._ptr)
if err != 0:
raise CardanoError(f"Failed to serialize to CIP-116 JSON (error code: {err})")