Unregistration Certificate¶

typedef struct cardano_unregistration_cert_t cardano_unregistration_cert_t¶

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

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

cardano_error_t cardano_unregistration_cert_new(cardano_credential_t *credential, uint64_t deposit, cardano_unregistration_cert_t **unregistration)¶

Creates a new unregistration certificate.

This function allocates and initializes a new unregistration certificate. The certificate is used to unregister a stake key, removing it from the blockchain and reclaiming any deposits associated with it.

Usage Example:

cardano_credential_t* credential = ...; // Assume credential is already initialized
uint64_t deposit = 2000000; // 2 ADA in lovelace
cardano_unregistration_cert_t* unregistration = NULL;

cardano_error_t result = cardano_unregistration_cert_new(credential, deposit, &unregistration);
if (result == CARDANO_SUCCESS)
{
  // The unregistration certificate can now be used for blockchain transactions
  // Remember to free the unregistration certificate when done
  cardano_unregistration_cert_unref(&unregistration);
}
else
{
  printf("Failed to create unregistration certificate: %s\n", cardano_error_to_string(result));
}

Parameters:¶

cardano_credential_t *credential¶: [in] A pointer to an initialized cardano_credential_t object representing the stake credential.
uint64_t deposit¶: [in] The amount of deposit to be refunded upon successful unregistration, expressed in lovelace (1 ADA = 1,000,000 lovelace).
cardano_unregistration_cert_t **unregistration¶: [out] On successful execution, this will point to a newly created cardano_unregistration_cert_t object. The caller is responsible for managing the lifecycle of this object and must release it using cardano_unregistration_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 appropriate error code indicating the reason for failure (e.g., CARDANO_ERROR_POINTER_IS_NULL if any of the input pointers are NULL).

cardano_error_t cardano_unregistration_cert_from_cbor(cardano_cbor_reader_t *reader, cardano_unregistration_cert_t **unregistration_cert)¶

Creates a cardano_unregistration_cert_t from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_unregistration_cert_t* unregistration_cert = NULL;

cardano_error_t result = cardano_unregistration_cert_from_cbor(reader, &unregistration_cert);

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

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

Serializes the certificate into CBOR format using a CBOR writer.

This function serializes the given cardano_unregistration_cert_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_unregistration_cert_t* unregistration_cert = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_unregistration_cert_to_cbor(unregistration_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_unregistration_cert_unref(&unregistration_cert);

Parameters:¶

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

cardano_error_t cardano_unregistration_cert_to_cip116_json(const cardano_unregistration_cert_t *cert, cardano_json_writer_t *writer)¶

Serializes an unregistration certificate to CIP-116 JSON.

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

Parameters:¶

const cardano_unregistration_cert_t *cert¶: [in] Pointer to a valid cardano_unregistration_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_unregistration_cert_get_credential(cardano_unregistration_cert_t *certificate)¶

Retrieves the credential associated with an unregistration certificate.

This function fetches the credential from a given cardano_unregistration_cert_t object. The credential indicates the stake key being unregistered.

Usage Example:

const cardano_unregistration_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_credential_t* credential = cardano_unregistration_cert_get_credential(certificate);

if (credential != NULL)
{
  // Process the credential
  cardano_credential_unref(&credential);
}
else
{
  printf("No credential found or invalid certificate.\n");
}

Parameters:¶

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

Returns:¶

A pointer to the cardano_credential_t object representing the stake credential. If the input certificate pointer is NULL or the certificate does not contain a credential, this function returns NULL. Note that the returned credential is a new reference and must be released using cardano_credential_unref when it is no longer needed.

cardano_error_t cardano_unregistration_cert_set_credential(cardano_unregistration_cert_t *certificate, cardano_credential_t *credential)¶

Sets the credential for an unregistration certificate.

This function assigns a new stake credential to a cardano_unregistration_cert_t object. The credential specifies the stake key to be unregistered.

Usage Example:

cardano_unregistration_cert_t* unregistration_cert = ...; // Assume unregistration_cert is already initialized
cardano_credential_t* credential = ...; // Assume credential is initialized

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

// Clean up resources
cardano_credential_unref(&credential);

Note

This function increases the reference count of the credential object; therefore, the caller retain ownership of their respective references. It is the caller’s responsibility to release their reference to the credential when it is no longer needed.

Parameters:¶

cardano_unregistration_cert_t *certificate¶: [inout] A pointer to an initialized cardano_unregistration_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 stake credential to be unregistered.

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.

uint64_t cardano_unregistration_cert_get_deposit(const cardano_unregistration_cert_t *certificate)¶

Retrieves the deposit amount from an unregistration certificate.

This function retrieves the deposit amount that was associated with the unregistration certificate at the time of its creation.

Usage Example:

const cardano_unregistration_cert_t* unregistration_cert = ...; // Assume unregistration_cert is already initialized

uint64_t deposit = cardano_unregistration_cert_get_deposit(unregistration_cert);
printf("Deposit for unregistration: %llu lovelaces\n", deposit);

Parameters:¶

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

Returns:¶

The deposit amount in lovelaces. If the certificate is NULL, the function will return 0, which should be handled appropriately by the caller to distinguish from a genuine deposit of 0 lovelaces.

cardano_error_t cardano_unregistration_cert_set_deposit(cardano_unregistration_cert_t *certificate, uint64_t deposit)¶

Sets the deposit amount for an unregistration certificate.

This function sets the deposit amount required for unregistration of a stake credential.

Usage Example:

cardano_unregistration_cert_t* unregistration_cert = ...; // Assume unregistration_cert is already initialized
uint64_t deposit = 2000000;

cardano_error_t result = cardano_unregistration_cert_set_deposit(unregistration_cert, deposit);

if (result == CARDANO_SUCCESS)
{
  printf("Deposit set successfully.\n");
}
else
{
  printf("Failed to set deposit.\n");
}

Parameters:¶

cardano_unregistration_cert_t *certificate¶: [inout] A pointer to an initialized cardano_unregistration_cert_t object to which the deposit amount will be set.
uint64_t deposit¶: [in] The deposit amount in lovelaces to set for the unregistration.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the deposit amount was successfully set, or an appropriate error code indicating the failure reason, such as CARDANO_ERROR_POINTER_IS_NULL if the input certificate pointer is NULL.

void cardano_unregistration_cert_unref(cardano_unregistration_cert_t **unregistration_cert)¶

Decrements the reference count of a cardano_unregistration_cert_t object.

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

Usage Example:

cardano_unregistration_cert_t* unregistration_cert = cardano_unregistration_cert_new(major, minor);

// Perform operations with the unregistration_cert...

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

Note

After calling cardano_unregistration_cert_unref, the pointer to the cardano_unregistration_cert_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_unregistration_cert_t **unregistration_cert¶: [inout] A pointer to the pointer of the unregistration_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_unregistration_cert_ref(cardano_unregistration_cert_t *unregistration_cert)¶

Increases the reference count of the cardano_unregistration_cert_t object.

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

Usage Example:

// Assuming unregistration_cert is a previously created unregistration_cert object

cardano_unregistration_cert_ref(unregistration_cert);

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

Note

Always ensure that for every call to cardano_unregistration_cert_ref there is a corresponding call to cardano_unregistration_cert_unref to prevent memory leaks.

Parameters:¶

cardano_unregistration_cert_t *unregistration_cert¶: A pointer to the cardano_unregistration_cert_t object whose reference count is to be incremented.

size_t cardano_unregistration_cert_refcount(const cardano_unregistration_cert_t *unregistration_cert)¶

Retrieves the current reference count of the cardano_unregistration_cert_t object.

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

Usage Example:

// Assuming unregistration_cert is a previously created unregistration_cert object

size_t ref_count = cardano_unregistration_cert_refcount(unregistration_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_unregistration_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_unregistration_cert_t *unregistration_cert¶: A pointer to the cardano_unregistration_cert_t object whose reference count is queried. The object must not be NULL.

Returns:¶

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

void cardano_unregistration_cert_set_last_error(cardano_unregistration_cert_t *unregistration_cert, const char *message)¶

Sets the last error message for a given cardano_unregistration_cert_t object.

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

const char *cardano_unregistration_cert_get_last_error(const cardano_unregistration_cert_t *unregistration_cert)¶

Retrieves the last error message recorded for a specific unregistration_cert.

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

Parameters:¶

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

Returns:¶

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