"""
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
[docs]
class VoteDelegationCert:
"""
Represents a vote delegation certificate.
This certificate is used when an individual wants to delegate their voting
rights to a DRep (Delegated Representative).
"""
[docs]
def __init__(self, ptr) -> None:
if ptr == ffi.NULL:
raise CardanoError("VoteDelegationCert: 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_vote_delegation_cert_t**", self._ptr)
lib.cardano_vote_delegation_cert_unref(ptr_ptr)
self._ptr = ffi.NULL
[docs]
def __enter__(self) -> VoteDelegationCert:
return self
[docs]
def __exit__(self, exc_type, exc_val, exc_tb) -> None:
pass
[docs]
def __repr__(self) -> str:
return "VoteDelegationCert(...)"
[docs]
@classmethod
def new(cls, credential: Credential, drep: DRep) -> VoteDelegationCert:
"""
Creates a new vote delegation certificate.
Args:
credential: The stake credential delegating voting power.
drep: The DRep to delegate voting power to.
Returns:
A new VoteDelegationCert instance.
Raises:
CardanoError: If creation fails.
"""
out = ffi.new("cardano_vote_delegation_cert_t**")
err = lib.cardano_vote_delegation_cert_new(credential._ptr, drep._ptr, out)
if err != 0:
raise CardanoError(f"Failed to create VoteDelegationCert (error code: {err})")
return cls(out[0])
[docs]
@classmethod
def from_cbor(cls, reader: CborReader) -> VoteDelegationCert:
"""
Deserializes a VoteDelegationCert from CBOR data.
Args:
reader: A CborReader positioned at the certificate data.
Returns:
A new VoteDelegationCert deserialized from the CBOR data.
Raises:
CardanoError: If deserialization fails.
"""
out = ffi.new("cardano_vote_delegation_cert_t**")
err = lib.cardano_vote_delegation_cert_from_cbor(reader._ptr, out)
if err != 0:
raise CardanoError(
f"Failed to deserialize VoteDelegationCert 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_vote_delegation_cert_to_cbor(self._ptr, writer._ptr)
if err != 0:
raise CardanoError(
f"Failed to serialize VoteDelegationCert to CBOR (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_vote_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})")
@property
def credential(self) -> Credential:
"""
The stake credential delegating voting power.
Returns:
The Credential associated with this delegation.
"""
ptr = lib.cardano_vote_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_vote_delegation_cert_set_credential(self._ptr, value._ptr)
if err != 0:
raise CardanoError(f"Failed to set credential (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_vote_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_vote_delegation_cert_set_drep(self._ptr, value._ptr)
if err != 0:
raise CardanoError(f"Failed to set DRep (error code: {err})")