Stake De-Registration Certificate¶

typedef struct cardano_stake_deregistration_cert_t cardano_stake_deregistration_cert_t¶

This certificate is used when a stakeholder no longer wants to participate in staking.

It revokes the stake registration and the associated stake is no longer counted when calculating stake pool rewards.

cardano_error_t cardano_stake_deregistration_cert_new(cardano_credential_t *credential, cardano_stake_deregistration_cert_t **stake_deregistration)¶

Creates a new stake deregistration certificate.

This function allocates and initializes a new cardano_stake_deregistration_cert_t object. Stake deregistration certificates are used to deregister a staking credential from the Cardano network.

Usage Example:

cardano_credential_t* credential = ...;  // Assume credential is already initialized
cardano_stake_deregistration_cert_t* stake_deregistration = NULL;
cardano_error_t result = cardano_stake_deregistration_cert_new(credential, &stake_deregistration);

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

Note

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

Parameters:¶

cardano_credential_t *credential¶: [in] A pointer to an initialized cardano_credential_t object that represents the staking credential to be deregistered.
cardano_stake_deregistration_cert_t **stake_deregistration¶: [out] On successful execution, this will point to a newly created cardano_stake_deregistration_cert_t object. The caller is responsible for releasing this resource using cardano_stake_deregistration_cert_unref when it is no longer needed.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the 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_deregistration_cert_from_cbor(cardano_cbor_reader_t *reader, cardano_stake_deregistration_cert_t **stake_deregistration)¶

Creates a cardano_stake_deregistration_cert_t from a CBOR reader.

This function parses CBOR data using a provided cardano_cbor_reader_t and constructs a cardano_stake_deregistration_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_deregistration.

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_stake_deregistration_cert_t* stake_deregistration = NULL;

cardano_error_t result = cardano_stake_deregistration_cert_from_cbor(reader, &stake_deregistration);

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

  // Once done, ensure to clean up and release the stake_deregistration
  cardano_stake_deregistration_cert_unref(&stake_deregistration);
}
else
{
  const char* error = cardano_cbor_reader_get_last_error(reader);
  printf("Failed to decode stake_deregistration: %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_deregistration_cert_t object by calling cardano_stake_deregistration_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_deregistration_cert_t **stake_deregistration¶: [out] A pointer to a pointer of cardano_stake_deregistration_cert_t that will be set to the address of the newly created stake_deregistration 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_deregistration_cert_to_cbor(const cardano_stake_deregistration_cert_t *stake_deregistration, cardano_cbor_writer_t *writer)¶

Serializes the certificate into CBOR format using a CBOR writer.

This function serializes the given cardano_stake_deregistration_cert_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_stake_deregistration_cert_t* stake_deregistration = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_stake_deregistration_cert_to_cbor(stake_deregistration, 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_deregistration_cert_unref(&stake_deregistration);

Parameters:¶

const cardano_stake_deregistration_cert_t *stake_deregistration¶: [in] A constant pointer to the cardano_stake_deregistration_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_deregistration or writer is NULL, returns CARDANO_ERROR_POINTER_IS_NULL.

cardano_error_t cardano_stake_deregistration_cert_to_cip116_json(const cardano_stake_deregistration_cert_t *cert, cardano_json_writer_t *writer)¶

Serializes a stake deregistration certificate to CIP-116 JSON.

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

Parameters:¶

const cardano_stake_deregistration_cert_t *cert¶: [in] Pointer to a valid cardano_stake_deregistration_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. Other Any error propagated from nested writers.

cardano_credential_t *cardano_stake_deregistration_cert_get_credential(cardano_stake_deregistration_cert_t *certificate)¶

Retrieves the credential associated with a stake deregistration certificate.

This function extracts the credential from the specified cardano_stake_deregistration_cert_t object. The credential represents the staking identifier that was intended to be deregistered from the Cardano network.

Usage Example:

const cardano_stake_deregistration_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_credential_t* credential = cardano_stake_deregistration_cert_get_credential(certificate);

if (credential != NULL)
{
  // Process the credential
  cardano_credential_unref(&credential);
}

Parameters:¶

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

Returns:¶

A pointer to the cardano_credential_t object containing the credential. If the certificate is NULL, this function returns NULL. The returned credential object has its reference count increased and it is the caller’s responsibility to release this reference using cardano_credential_unref when it is no longer needed.

cardano_error_t cardano_stake_deregistration_cert_set_credential(cardano_stake_deregistration_cert_t *certificate, cardano_credential_t *credential)¶

Sets the credential for a stake deregistration certificate.

This function assigns a new credential to a given cardano_stake_deregistration_cert_t object. The credential represents the staking identifier that is intended to be deregistered from the Cardano network.

Usage Example:

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

cardano_error_t result = cardano_stake_deregistration_cert_set_credential(certificate, credential);
if (result == CARDANO_SUCCESS)
{
  // The credential is now set for the stake deregistration certificate
}
else
{
  printf("Failed to set the credential.\n");
}

// Remember to manage the lifecycle of the objects properly
cardano_credential_unref(&credential);
cardano_stake_deregistration_cert_unref(&certificate);

Parameters:¶

cardano_stake_deregistration_cert_t *certificate¶: [inout] A pointer to an initialized cardano_stake_deregistration_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 new credential. This function increments the reference count of the credential, and it will be managed by the certificate object thereafter.

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.

void cardano_stake_deregistration_cert_unref(cardano_stake_deregistration_cert_t **stake_deregistration)¶

Decrements the reference count of a cardano_stake_deregistration_cert_t object.

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

Usage Example:

cardano_stake_deregistration_cert_t* stake_deregistration = cardano_stake_deregistration_cert_new(major, minor);

// Perform operations with the stake_deregistration...

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

Note

After calling cardano_stake_deregistration_cert_unref, the pointer to the cardano_stake_deregistration_cert_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_stake_deregistration_cert_t **stake_deregistration¶: [inout] A pointer to the pointer of the stake_deregistration 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_deregistration_cert_ref(cardano_stake_deregistration_cert_t *stake_deregistration)¶

Increases the reference count of the cardano_stake_deregistration_cert_t object.

This function is used to manually increment the reference count of an cardano_stake_deregistration_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_deregistration_cert_unref.

Usage Example:

// Assuming stake_deregistration is a previously created stake_deregistration object

cardano_stake_deregistration_cert_ref(stake_deregistration);

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

Note

Always ensure that for every call to cardano_stake_deregistration_cert_ref there is a corresponding call to cardano_stake_deregistration_cert_unref to prevent memory leaks.

Parameters:¶

cardano_stake_deregistration_cert_t *stake_deregistration¶: A pointer to the cardano_stake_deregistration_cert_t object whose reference count is to be incremented.

size_t cardano_stake_deregistration_cert_refcount(const cardano_stake_deregistration_cert_t *stake_deregistration)¶

Retrieves the current reference count of the cardano_stake_deregistration_cert_t object.

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

Usage Example:

// Assuming stake_deregistration is a previously created stake_deregistration object

size_t ref_count = cardano_stake_deregistration_cert_refcount(stake_deregistration);

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_deregistration_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_deregistration_cert_t *stake_deregistration¶: A pointer to the cardano_stake_deregistration_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_deregistration_cert_t object. If the object is properly managed (i.e., every cardano_stake_deregistration_cert_ref call is matched with a cardano_stake_deregistration_cert_unref call), this count should reach zero right before the object is deallocated.

void cardano_stake_deregistration_cert_set_last_error(cardano_stake_deregistration_cert_t *stake_deregistration, const char *message)¶

Sets the last error message for a given cardano_stake_deregistration_cert_t object.

Records an error message in the stake_deregistration’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_deregistration_cert_t *stake_deregistration¶: [in] A pointer to the cardano_stake_deregistration_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_deregistration’s last_error is set to an empty string, indicating no error.

const char *cardano_stake_deregistration_cert_get_last_error(const cardano_stake_deregistration_cert_t *stake_deregistration)¶

Retrieves the last error message recorded for a specific stake_deregistration.

This function returns a pointer to the null-terminated string containing the last error message set by cardano_stake_deregistration_cert_set_last_error for the given stake_deregistration. 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_deregistration_cert_set_last_error for the same stake_deregistration, or until the stake_deregistration is deallocated.

Parameters:¶

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

Returns:¶

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