Stake Delegation Certificate¶

typedef struct cardano_stake_delegation_cert_t cardano_stake_delegation_cert_t¶

This certificate is used when a stakeholder wants to delegate their stake to a specific stake pool.

It includes the stake pool id to which the stake is delegated.

cardano_error_t cardano_stake_delegation_cert_new(cardano_credential_t *credential, cardano_blake2b_hash_t *pool_key_hash, cardano_stake_delegation_cert_t **stake_delegation)¶

Creates a new stake delegation certificate.

This function allocates and initializes a new cardano_stake_delegation_cert_t object that represents a stake delegation from a given credential to a specified staking pool.

Usage Example:

cardano_credential_t* credential = ...; // Assume credential is already initialized
cardano_blake2b_hash_t* pool_key_hash = ...; // Assume pool_key_hash is already initialized
cardano_stake_delegation_cert_t* stake_delegation = NULL;

cardano_error_t result = cardano_stake_delegation_cert_new(credential, pool_key_hash, &stake_delegation);

if (result == CARDANO_SUCCESS)
{
  // The stake delegation certificate can now be used for delegation operations
  // Remember to free the certificate when done
  cardano_stake_delegation_cert_unref(&stake_delegation);
}
else
{
  printf("Failed to create stake delegation certificate: %s\n", cardano_error_to_string(result));
}

cardano_credential_unref(&credential); // Cleanup the credential
cardano_blake2b_hash_unref(&pool_key_hash); // Cleanup the pool key hash

Note

This function increments the reference count of the credential and pool key hash objects passed to it. It is the caller’s responsibility to manage the lifecycle of both the certificate and the input objects, ensuring that each is released when no longer needed.

Parameters:¶

cardano_credential_t *credential¶: [in] A pointer to an initialized cardano_credential_t object representing the staker’s credential.
cardano_blake2b_hash_t *pool_key_hash¶: [in] A pointer to an initialized cardano_blake2b_hash_t object representing the hash of the pool’s public key to which the stake is being delegated.
cardano_stake_delegation_cert_t **stake_delegation¶: [out] On successful execution, this will point to a newly created cardano_stake_delegation_cert_t object. The caller is responsible for releasing this resource using cardano_stake_delegation_cert_unref when it is no longer needed.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the stake delegation certificate was successfully created, or an error code indicating the reason for failure (e.g., CARDANO_ERROR_POINTER_IS_NULL if any input pointers are NULL).

cardano_error_t cardano_stake_delegation_cert_from_cbor(cardano_cbor_reader_t *reader, cardano_stake_delegation_cert_t **stake_delegation_cert)¶

Creates a cardano_stake_delegation_cert_t from a CBOR reader.

This function parses CBOR data using a provided cardano_cbor_reader_t and constructs a cardano_stake_delegation_cert_t object. It assumes that the CBOR reader is set up correctly and that the CBOR data corresponds to the structure expected for a stake_delegation_cert.

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_stake_delegation_cert_t* stake_delegation_cert = NULL;

cardano_error_t result = cardano_stake_delegation_cert_from_cbor(reader, &stake_delegation_cert);

if (result == CARDANO_SUCCESS)
{
  // Use the stake_delegation_cert

  // Once done, ensure to clean up and release the stake_delegation_cert
  cardano_stake_delegation_cert_unref(&stake_delegation_cert);
}
else
{
  const char* error = cardano_cbor_reader_get_last_error(reader);
  printf("Failed to decode stake_delegation_cert: %s\n", error);
}

cardano_cbor_reader_unref(&reader); // Cleanup the CBOR reader

Note

If the function fails, the last error can be retrieved by calling cardano_cbor_reader_get_last_error with the reader. The caller is responsible for freeing the created cardano_stake_delegation_cert_t object by calling cardano_stake_delegation_cert_unref when it is no longer needed.

Parameters:¶

cardano_cbor_reader_t *reader¶: [in] A pointer to an initialized cardano_cbor_reader_t that is ready to read the CBOR-encoded data.
cardano_stake_delegation_cert_t **stake_delegation_cert¶: [out] A pointer to a pointer of cardano_stake_delegation_cert_t that will be set to the address of the newly created stake_delegation_cert object upon successful decoding.

Returns:¶

A cardano_error_t value indicating the outcome of the operation. Returns CARDANO_SUCCESS if the object was successfully created, or an appropriate error code if an error occurred.

cardano_error_t cardano_stake_delegation_cert_to_cbor(const cardano_stake_delegation_cert_t *stake_delegation_cert, cardano_cbor_writer_t *writer)¶

Serializes the certificate into CBOR format using a CBOR writer.

This function serializes the given cardano_stake_delegation_cert_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_stake_delegation_cert_t* stake_delegation_cert = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_stake_delegation_cert_to_cbor(stake_delegation_cert, writer);

  if (result == CARDANO_SUCCESS)
  {
    // Use the writer's buffer containing the serialized data
  }
  else
  {
    const char* error_message = cardano_cbor_writer_get_last_error(writer);
    printf("Serialization failed: %s\n", error_message);
  }

  cardano_cbor_writer_unref(&writer);
}

cardano_stake_delegation_cert_unref(&stake_delegation_cert);

Parameters:¶

const cardano_stake_delegation_cert_t *stake_delegation_cert¶: [in] A constant pointer to the cardano_stake_delegation_cert_t object that is to be serialized.
cardano_cbor_writer_t *writer¶: [out] A pointer to a cardano_cbor_writer_t where the CBOR serialized data will be written. The writer must already be initialized and ready to accept the data.

Returns:¶

Returns CARDANO_SUCCESS if the serialization is successful. If the stake_delegation_cert or writer is NULL, returns CARDANO_ERROR_POINTER_IS_NULL.

cardano_error_t cardano_stake_delegation_cert_to_cip116_json(const cardano_stake_delegation_cert_t *cert, cardano_json_writer_t *writer)¶

Serializes a stake delegation certificate to CIP-116 JSON.

The function writes the full JSON object, including the surrounding braces. Keys are written in the order: “tag”, “credential”, “pool_keyhash”.

Parameters:¶

const cardano_stake_delegation_cert_t *cert¶: [in] Pointer to a valid cardano_stake_delegation_cert_t.
cardano_json_writer_t *writer¶: [in] Pointer to a valid cardano_json_writer_t.

Returns:¶

CARDANO_SUCCESS On success. CARDANO_ERROR_POINTER_IS_NULL If cert or writer is NULL. CARDANO_ERROR_MEMORY_ALLOCATION_FAILED If memory allocation fails. Other Any error propagated from nested writers.

cardano_credential_t *cardano_stake_delegation_cert_get_credential(cardano_stake_delegation_cert_t *certificate)¶

Retrieves the credential from a stake delegation certificate.

This function fetches the credential associated with a given cardano_stake_delegation_cert_t object.

Usage Example:

const cardano_stake_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_credential_t* credential = cardano_stake_delegation_cert_get_credential(certificate);

if (credential != NULL)
{
  // Process the retrieved credential
  // No need to unref the returned credential, as it is managed by the certificate
}
else
{
  printf("Failed to retrieve credential from stake delegation certificate.\n");
}

Note

This function increments the reference count of the credential passed to it.

Parameters:¶

cardano_stake_delegation_cert_t *certificate¶: [in] A constant pointer to an initialized cardano_stake_delegation_cert_t object from which the credential is to be retrieved.

Returns:¶

A pointer to the cardano_credential_t object containing the staker’s credential. If the certificate is NULL or does not contain a valid credential, this function returns NULL.

cardano_error_t cardano_stake_delegation_cert_set_credential(cardano_stake_delegation_cert_t *certificate, cardano_credential_t *credential)¶

Sets the credential for a stake delegation certificate.

This function assigns a new credential to a given cardano_stake_delegation_cert_t object.

Usage Example:

cardano_stake_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_credential_t* credential = ...; // Assume credential is already initialized

cardano_error_t result = cardano_stake_delegation_cert_set_credential(certificate, credential);
if (result == CARDANO_SUCCESS)
{
  printf("Credential successfully set.\n");
}
else
{
  printf("Failed to set the credential.\n");
}

Note

This function increments the reference count of the credential. The caller is responsible for maintaining the original credential and releasing its reference appropriately. The certificate will maintain its own reference to the credential once set.

Parameters:¶

cardano_stake_delegation_cert_t *certificate¶: [inout] A pointer to an initialized cardano_stake_delegation_cert_t object to which the credential will be set.
cardano_credential_t *credential¶: [in] A pointer to an initialized cardano_credential_t object representing the staker’s credential.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the credential was successfully set, or an appropriate error code indicating the failure reason, such as CARDANO_ERROR_POINTER_IS_NULL if any of the input pointers are NULL.

cardano_blake2b_hash_t *cardano_stake_delegation_cert_get_pool_key_hash(cardano_stake_delegation_cert_t *certificate)¶

Retrieves the pool key hash from a stake delegation certificate.

This function extracts the pool key hash from the specified cardano_stake_delegation_cert_t object. The pool key hash uniquely identifies the staking pool to which the stake rights are delegated.

Usage Example:

const cardano_stake_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_blake2b_hash_t* pool_key_hash = cardano_stake_delegation_cert_get_pool_key_hash(certificate);

if (pool_key_hash != NULL)
{
  // Process the pool key hash
  cardano_blake2b_hash_unref(&pool_key_hash);
}

Note

Since this function returns a reference, it must be unreferenced by the caller to prevent memory leaks.

Parameters:¶

cardano_stake_delegation_cert_t *certificate¶: [in] A constant pointer to an initialized cardano_stake_delegation_cert_t object.

Returns:¶

A pointer to the cardano_blake2b_hash_t object containing the pool key hash. If the certificate is NULL or if the pool key hash is not set, this function returns NULL.

cardano_error_t cardano_stake_delegation_cert_set_pool_key_hash(cardano_stake_delegation_cert_t *certificate, cardano_blake2b_hash_t *hash)¶

Sets the pool key hash for a stake delegation certificate.

This function assigns a new pool key hash to a given cardano_stake_delegation_cert_t object. The pool key hash uniquely identifies the staking pool to which the stake rights are delegated.

Usage Example:

cardano_stake_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_blake2b_hash_t* pool_key_hash = ...; // Assume pool_key_hash is already initialized

cardano_error_t result = cardano_stake_delegation_cert_set_pool_key_hash(certificate, pool_key_hash);
if (result == CARDANO_SUCCESS)
{
  // The pool key hash is now set for the stake delegation certificate
}
else
{
  printf("Failed to set the pool key hash.\n");
}

Note

This function takes a reference of the pool key hash; therefore, the caller must ensure that the hash remains valid and manage its lifecycle appropriately. The certificate will internally manage its own reference to the hash.

Parameters:¶

cardano_stake_delegation_cert_t *certificate¶: [in] A pointer to an initialized cardano_stake_delegation_cert_t object to which the pool key hash will be set.
cardano_blake2b_hash_t *hash¶: [in] A constant pointer to an initialized cardano_blake2b_hash_t object representing the new pool key hash.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the pool key hash was successfully set, or an appropriate error code indicating the failure reason, such as CARDANO_ERROR_POINTER_IS_NULL if any of the input pointers are NULL.

void cardano_stake_delegation_cert_unref(cardano_stake_delegation_cert_t **stake_delegation_cert)¶

Decrements the reference count of a cardano_stake_delegation_cert_t object.

This function is responsible for managing the lifecycle of a cardano_stake_delegation_cert_t object by decreasing its reference count. When the reference count reaches zero, the stake_delegation_cert is finalized; its associated resources are released, and its memory is deallocated.

Usage Example:

cardano_stake_delegation_cert_t* stake_delegation_cert = cardano_stake_delegation_cert_new(major, minor);

// Perform operations with the stake_delegation_cert...

cardano_stake_delegation_cert_unref(&stake_delegation_cert);
// At this point, stake_delegation_cert is NULL and cannot be used.

Note

After calling cardano_stake_delegation_cert_unref, the pointer to the cardano_stake_delegation_cert_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_stake_delegation_cert_t **stake_delegation_cert¶: [inout] A pointer to the pointer of the stake_delegation_cert object. This double indirection allows the function to set the caller’s pointer to NULL, avoiding dangling pointer issues after the object has been freed.

void cardano_stake_delegation_cert_ref(cardano_stake_delegation_cert_t *stake_delegation_cert)¶

Increases the reference count of the cardano_stake_delegation_cert_t object.

This function is used to manually increment the reference count of an cardano_stake_delegation_cert_t object, indicating that another part of the code has taken ownership of it. This ensures the object remains allocated and valid until all owners have released their reference by calling cardano_stake_delegation_cert_unref.

Usage Example:

// Assuming stake_delegation_cert is a previously created stake_delegation_cert object

cardano_stake_delegation_cert_ref(stake_delegation_cert);

// Now stake_delegation_cert can be safely used elsewhere without worrying about premature deallocation

Note

Always ensure that for every call to cardano_stake_delegation_cert_ref there is a corresponding call to cardano_stake_delegation_cert_unref to prevent memory leaks.

Parameters:¶

cardano_stake_delegation_cert_t *stake_delegation_cert¶: A pointer to the cardano_stake_delegation_cert_t object whose reference count is to be incremented.

size_t cardano_stake_delegation_cert_refcount(const cardano_stake_delegation_cert_t *stake_delegation_cert)¶

Retrieves the current reference count of the cardano_stake_delegation_cert_t object.

This function returns the number of active references to an cardano_stake_delegation_cert_t object. It’s useful for debugging purposes or managing the lifecycle of the object in complex scenarios.

Usage Example:

// Assuming stake_delegation_cert is a previously created stake_delegation_cert object

size_t ref_count = cardano_stake_delegation_cert_refcount(stake_delegation_cert);

printf("Reference count: %zu\n", ref_count);

Warning

This function does not account for transitive references. A transitive reference occurs when an object holds a reference to another object, rather than directly to the cardano_stake_delegation_cert_t. As such, the reported count may not fully represent the total number of conceptual references in cases where such transitive relationships exist.

Parameters:¶

const cardano_stake_delegation_cert_t *stake_delegation_cert¶: A pointer to the cardano_stake_delegation_cert_t object whose reference count is queried. The object must not be NULL.

Returns:¶

The number of active references to the specified cardano_stake_delegation_cert_t object. If the object is properly managed (i.e., every cardano_stake_delegation_cert_ref call is matched with a cardano_stake_delegation_cert_unref call), this count should reach zero right before the object is deallocated.

void cardano_stake_delegation_cert_set_last_error(cardano_stake_delegation_cert_t *stake_delegation_cert, const char *message)¶

Sets the last error message for a given cardano_stake_delegation_cert_t object.

Records an error message in the stake_delegation_cert’s last_error buffer, overwriting any existing message. This is useful for storing descriptive error information that can be later retrieved. The message is truncated if it exceeds the buffer’s capacity.

Note

The error message is limited to 1023 characters, including the null terminator, due to the fixed size of the last_error buffer.

Parameters:¶

cardano_stake_delegation_cert_t *stake_delegation_cert¶: [in] A pointer to the cardano_stake_delegation_cert_t instance whose last error message is to be set. If NULL, the function does nothing.
const char *message¶: [in] A null-terminated string containing the error message. If NULL, the stake_delegation_cert’s last_error is set to an empty string, indicating no error.

const char *cardano_stake_delegation_cert_get_last_error(const cardano_stake_delegation_cert_t *stake_delegation_cert)¶

Retrieves the last error message recorded for a specific stake_delegation_cert.

This function returns a pointer to the null-terminated string containing the last error message set by cardano_stake_delegation_cert_set_last_error for the given stake_delegation_cert. If no error message has been set, or if the last_error buffer was explicitly cleared, an empty string is returned, indicating no error.

Note

The returned string points to internal storage within the object and must not be modified by the caller. The string remains valid until the next call to cardano_stake_delegation_cert_set_last_error for the same stake_delegation_cert, or until the stake_delegation_cert is deallocated.

Parameters:¶

const cardano_stake_delegation_cert_t *stake_delegation_cert¶: [in] A pointer to the cardano_stake_delegation_cert_t instance whose last error message is to be retrieved. If the stake_delegation_cert is NULL, the function returns a generic error message indicating the null stake_delegation_cert.

Returns:¶

A pointer to a null-terminated string containing the last error message for the specified stake_delegation_cert. If the stake_delegation_cert is NULL, “Object is NULL.” is returned to indicate the error.