Resignation Committee Member Certificate¶

typedef struct cardano_resign_committee_cold_cert_t cardano_resign_committee_cold_cert_t¶: This certificate is used then a committee member wants to resign early (will be marked on-chain as an expired member).

cardano_error_t cardano_resign_committee_cold_cert_new(cardano_credential_t *committee_cold_cred, cardano_anchor_t *anchor, cardano_resign_committee_cold_cert_t **resign_committee_cold_cert)¶

Creates a new resignation certificate for a committee cold key.

This function allocates and initializes a new instance of cardano_resign_committee_cold_cert_t.

Usage Example:

cardano_credential_t* committee_cold_cred = ...; // Assume committee_cold_cred is already initialized
cardano_anchor_t* anchor = ...; // Assume anchor is already initialized
cardano_resign_committee_cold_cert_t* resign_committee_cold_cert = NULL;

cardano_error_t result = cardano_resign_committee_cold_cert_new(committee_cold_cred, anchor, &resign_committee_cold_cert);

if (result == CARDANO_SUCCESS)
{
  // The resign committee cold certificate can now be used for transaction signing or other purposes
  // Remember to free the certificate when done
  cardano_resign_committee_cold_cert_unref(&resign_committee_cold_cert);
}
else
{
  printf("Failed to create resign committee cold certificate: %s\n", cardano_error_to_string(result));
}

Parameters:¶

cardano_credential_t *committee_cold_cred¶: [in] A pointer to an initialized cardano_credential_t object representing the committee’s cold credential.
cardano_anchor_t *anchor¶: [in] A pointer to an initialized cardano_anchor_t object associated with the resignation.
cardano_resign_committee_cold_cert_t **resign_committee_cold_cert¶: [out] On successful execution, this will point to a newly created cardano_resign_committee_cold_cert_t object. The caller is responsible for managing the lifecycle of this object, including releasing it when it is no longer needed using the appropriate unref function.

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_resign_committee_cold_cert_from_cbor(cardano_cbor_reader_t *reader, cardano_resign_committee_cold_cert_t **resign_committee_cold)¶

Creates a cardano_resign_committee_cold_cert_t from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_resign_committee_cold_cert_t* resign_committee_cold = NULL;

cardano_error_t result = cardano_resign_committee_cold_cert_from_cbor(reader, &resign_committee_cold);

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

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

Serializes the certificate into CBOR format using a CBOR writer.

This function serializes the given cardano_resign_committee_cold_cert_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_resign_committee_cold_cert_t* resign_committee_cold = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_resign_committee_cold_cert_to_cbor(resign_committee_cold, 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_resign_committee_cold_cert_unref(&resign_committee_cold);

Parameters:¶

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

cardano_error_t cardano_resign_committee_cold_cert_to_cip116_json(const cardano_resign_committee_cold_cert_t *cert, cardano_json_writer_t *writer)¶

Serializes a committee cold resignation certificate to CIP-116 JSON.

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

Parameters:¶

const cardano_resign_committee_cold_cert_t *cert¶: [in] Pointer to a valid cardano_resign_committee_cold_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_resign_committee_cold_cert_get_credential(cardano_resign_committee_cold_cert_t *certificate)¶

Retrieves the committee cold credential from a resignation certificate.

This function extracts the committee’s cold credential from a cardano_resign_committee_cold_cert_t object. The returned credential is a reference counted object, and the caller is responsible for releasing it using cardano_credential_unref when it is no longer needed.

Usage Example:

const cardano_resign_committee_cold_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_credential_t* credential = cardano_resign_committee_cold_cert_get_credential(certificate);

if (credential != NULL)
{
  // Process the credential
  cardano_credential_unref(&credential); // Remember to unref the credential when done
}
else
{
  printf("No credential is set for this certificate.\n");
}

Note

This function increments the reference count of the returned credential. The caller must ensure to unref it to avoid memory leaks.

Parameters:¶

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

Returns:¶

A pointer to the cardano_credential_t object containing the committee’s cold credential. If the certificate is NULL or if the credential is not set, this function returns NULL.

cardano_error_t cardano_resign_committee_cold_cert_set_credential(cardano_resign_committee_cold_cert_t *certificate, cardano_credential_t *credential)¶

Sets the committee cold credential in a resignation certificate.

This function assigns a new committee cold credential to a given cardano_resign_committee_cold_cert_t object.

Usage Example:

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

cardano_error_t result = cardano_resign_committee_cold_cert_set_credential(certificate, credential);
if (result == CARDANO_SUCCESS)
{
  // The credential is now set for the certificate
}
else
{
  printf("Failed to set the committee's cold credential.\n");
}
// Both objects need to be managed and eventually unreferenced by the caller
cardano_credential_unref(&credential);
cardano_resign_committee_cold_cert_unref(&certificate);

Parameters:¶

cardano_resign_committee_cold_cert_t *certificate¶: [inout] A pointer to an initialized cardano_resign_committee_cold_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 committee’s cold credential.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the committee cold 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_anchor_t *cardano_resign_committee_cold_cert_get_anchor(cardano_resign_committee_cold_cert_t *certificate)¶

Retrieves the anchor associated with a resignation committee cold certificate.

This function returns the anchor used in a cardano_resign_committee_cold_cert_t object.

Usage Example:

const cardano_resign_committee_cold_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_anchor_t* anchor = cardano_resign_committee_cold_cert_get_anchor(certificate);

if (anchor != NULL)
{
  // Process the anchor information
}
else
{
  printf("No anchor is set for this certificate.\n");
}

Parameters:¶

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

Returns:¶

A pointer to a cardano_anchor_t object representing the anchor. If the certificate is NULL or does not have an anchor set, this function returns NULL.

cardano_error_t cardano_resign_committee_cold_cert_set_anchor(cardano_resign_committee_cold_cert_t *certificate, cardano_anchor_t *anchor)¶

Sets the anchor for a resignation committee cold certificate.

This function assigns a new anchor to a given cardano_resign_committee_cold_cert_t object.

Usage Example:

cardano_resign_committee_cold_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_anchor_t* new_anchor = ...; // Assume new_anchor is already initialized

cardano_error_t result = cardano_resign_committee_cold_cert_set_anchor(certificate, new_anchor);
if (result == CARDANO_SUCCESS)
{
  printf("Anchor set successfully.\n");
}
else
{
  printf("Failed to set the anchor.\n");
}

// Both certificate and new_anchor need their own unref calls when no longer needed

Note

This function increments the reference count of the anchor object passed to it. It is the caller’s responsibility to manage the lifecycle of both the certificate and the anchor.

Parameters:¶

cardano_resign_committee_cold_cert_t *certificate¶: [in] A pointer to an initialized cardano_resign_committee_cold_cert_t object to which the anchor will be set.
cardano_anchor_t *anchor¶: [in] A pointer to an initialized cardano_anchor_t object representing the new anchor. This function increases the reference count on the anchor, and the certificate will maintain its own reference to the anchor.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the anchor 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_resign_committee_cold_cert_unref(cardano_resign_committee_cold_cert_t **resign_committee_cold)¶

Decrements the reference count of a cardano_resign_committee_cold_cert_t object.

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

Usage Example:

cardano_resign_committee_cold_cert_t* resign_committee_cold = cardano_resign_committee_cold_cert_new(major, minor);

// Perform operations with the resign_committee_cold...

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

Note

After calling cardano_resign_committee_cold_cert_unref, the pointer to the cardano_resign_committee_cold_cert_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_resign_committee_cold_cert_t **resign_committee_cold¶: [inout] A pointer to the pointer of the resign_committee_cold 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_resign_committee_cold_cert_ref(cardano_resign_committee_cold_cert_t *resign_committee_cold)¶

Increases the reference count of the cardano_resign_committee_cold_cert_t object.

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

Usage Example:

// Assuming resign_committee_cold is a previously created resign_committee_cold object

cardano_resign_committee_cold_cert_ref(resign_committee_cold);

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

Note

Always ensure that for every call to cardano_resign_committee_cold_cert_ref there is a corresponding call to cardano_resign_committee_cold_cert_unref to prevent memory leaks.

Parameters:¶

cardano_resign_committee_cold_cert_t *resign_committee_cold¶: A pointer to the cardano_resign_committee_cold_cert_t object whose reference count is to be incremented.

size_t cardano_resign_committee_cold_cert_refcount(const cardano_resign_committee_cold_cert_t *resign_committee_cold)¶

Retrieves the current reference count of the cardano_resign_committee_cold_cert_t object.

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

Usage Example:

// Assuming resign_committee_cold is a previously created resign_committee_cold object

size_t ref_count = cardano_resign_committee_cold_cert_refcount(resign_committee_cold);

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_resign_committee_cold_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_resign_committee_cold_cert_t *resign_committee_cold¶: A pointer to the cardano_resign_committee_cold_cert_t object whose reference count is queried. The object must not be NULL.

Returns:¶

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

void cardano_resign_committee_cold_cert_set_last_error(cardano_resign_committee_cold_cert_t *resign_committee_cold, const char *message)¶

Sets the last error message for a given cardano_resign_committee_cold_cert_t object.

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

const char *cardano_resign_committee_cold_cert_get_last_error(const cardano_resign_committee_cold_cert_t *resign_committee_cold)¶

Retrieves the last error message recorded for a specific resign_committee_cold.

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

Parameters:¶

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

Returns:¶

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