Register DRep Certificate¶

typedef struct cardano_register_drep_cert_t cardano_register_drep_cert_t¶

In Voltaire, existing stake credentials will be able to delegate their stake to DReps for voting purposes, in addition to the current delegation to stake pools for block production.

DRep delegation will mimic the existing stake delegation mechanisms (via on-chain certificates).

This certificate register a stake key as a DRep.

cardano_error_t cardano_register_drep_cert_new(cardano_credential_t *drep_credential, uint64_t deposit, cardano_anchor_t *anchor, cardano_register_drep_cert_t **register_drep_cert)¶

Creates a new DRep registration certificate.

This function allocates and initializes a cardano_register_drep_cert_t object, which represents a certificate for registering a DRep in the Cardano network.

Usage Example:

cardano_credential_t* drep_credential = ...; // Assume drep_credential is already initialized
uint64_t deposit = 5000000; // Example deposit amount in lovelace
cardano_anchor_t anchor = ...; // Assume anchor is initialized
cardano_register_drep_cert_t* register_drep_cert = NULL;

cardano_error_t result = cardano_register_drep_cert_new(drep_credential, deposit, anchor, &register_drep_cert);

if (result == CARDANO_SUCCESS)
{
  // The DRep registration certificate can now be used
  // Remember to free the register_drep_cert when done
  cardano_register_drep_cert_unref(&register_drep_cert);
}
else
{
  printf("Failed to create DRep registration certificate: %s\n", cardano_error_to_string(result));
}

cardano_credential_unref(&drep_credential); // Cleanup the drep_credential

Parameters:¶

cardano_credential_t *drep_credential¶: [in] A pointer to an initialized cardano_credential_t object representing the credential of the decentralized representative.
uint64_t deposit¶: [in] The deposit amount required for registration.
cardano_anchor_t *anchor¶: [in] An instance of cardano_anchor_t representing the anchor of the metadata linked to this DRep. This is optional.
cardano_register_drep_cert_t **register_drep_cert¶: [out] On successful execution, this will point to a newly created cardano_register_drep_cert_t object. The caller is responsible for releasing this resource using cardano_register_drep_cert_unref when it is no longer needed.

Returns:¶

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

cardano_error_t cardano_register_drep_cert_from_cbor(cardano_cbor_reader_t *reader, cardano_register_drep_cert_t **register_drep_cert)¶

Creates a cardano_register_drep_cert_t from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_register_drep_cert_t* register_drep_cert = NULL;

cardano_error_t result = cardano_register_drep_cert_from_cbor(reader, &register_drep_cert);

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

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

Serializes the certificate into CBOR format using a CBOR writer.

This function serializes the given cardano_register_drep_cert_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_register_drep_cert_t* register_drep_cert = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_register_drep_cert_to_cbor(register_drep_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_register_drep_cert_unref(&register_drep_cert);

Parameters:¶

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

cardano_error_t cardano_register_drep_cert_to_cip116_json(const cardano_register_drep_cert_t *cert, cardano_json_writer_t *writer)¶

Serializes a register DRep certificate to CIP-116 JSON.

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

Parameters:¶

const cardano_register_drep_cert_t *cert¶: [in] Pointer to a valid cardano_register_drep_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_register_drep_cert_get_credential(cardano_register_drep_cert_t *certificate)¶

Retrieves the DRep credential from a DRep registration certificate.

This function extracts the decentralized representative’s credential from the specified cardano_register_drep_cert_t object. This credential is used to identify the DRep within the Cardano network.

Usage Example:

const cardano_register_drep_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_credential_t* drep_credential = cardano_register_drep_cert_get_credential(certificate);

if (drep_credential != NULL)
{
  // Process the DRep credential
  // Note: The credential does not need to be freed; it is managed within the certificate object
}
else
{
  printf("No DRep credential is set for this certificate.\n");
}

Parameters:¶

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

Returns:¶

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

cardano_error_t cardano_register_drep_cert_set_credential(cardano_register_drep_cert_t *certificate, cardano_credential_t *credential)¶

Sets the DRep credential for a DRep registration certificate.

This function updates the DRep credential in a cardano_register_drep_cert_t object with the provided cardano_credential_t. The DRep credential identifies the decentralized representative within the Cardano network.

Usage Example:

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

cardano_error_t result = cardano_register_drep_cert_set_credential(certificate, credential);
if (result == CARDANO_SUCCESS)
{
  printf("DRep credential updated successfully.\n");
}
else
{
  printf("Failed to update DRep credential.\n");
}

Parameters:¶

cardano_register_drep_cert_t *certificate¶: [inout] A pointer to an initialized cardano_register_drep_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 DRep credential.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the DRep credential was successfully updated, 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_register_drep_cert_get_deposit(const cardano_register_drep_cert_t *certificate)¶

Retrieves the deposit amount from a DRep registration certificate.

This function fetches the deposit amount specified in a cardano_register_drep_cert_t object.

Usage Example:

const cardano_register_drep_cert_t* certificate = ...; // Assume certificate is already initialized
uint64_t deposit = cardano_register_drep_cert_get_deposit(certificate);

if (deposit > 0)
{
  printf("Deposit amount: %lu lovelace\n", deposit);
}
else
{
  printf("Failed to retrieve deposit amount.\n");
}

Parameters:¶

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

Returns:¶

The deposit amount in lovelace (1 ADA = 1,000,000 lovelace). If the certificate is NULL, this function will return 0.

cardano_error_t cardano_register_drep_cert_set_deposit(cardano_register_drep_cert_t *certificate, uint64_t deposit)¶

Sets the deposit amount in a DRep registration certificate.

This function assigns a new deposit amount to a cardano_register_drep_cert_t object.

Usage Example:

cardano_register_drep_cert_t* certificate = ...; // Assume certificate is already initialized
uint64_t deposit = 1000000; // Set deposit to 1 ADA

cardano_error_t result = cardano_register_drep_cert_set_deposit(certificate, deposit);
if (result == CARDANO_SUCCESS)
{
  printf("Deposit amount set successfully.\n");
}
else
{
  printf("Failed to set the deposit amount.\n");
}

Parameters:¶

cardano_register_drep_cert_t *certificate¶: [in] A pointer to an initialized cardano_register_drep_cert_t object which will have its deposit updated.
uint64_t deposit¶: [in] The deposit amount in lovelace (1 ADA = 1,000,000 lovelace) to be set in the certificate.

Returns:¶

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

cardano_anchor_t *cardano_register_drep_cert_get_anchor(cardano_register_drep_cert_t *certificate)¶

Retrieves the anchor from a DRep registration certificate.

This function extracts the anchor from the specified cardano_register_drep_cert_t object.

Usage Example:

const cardano_register_drep_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_anchor_t* anchor = cardano_register_drep_cert_get_anchor(certificate);

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

Parameters:¶

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

Returns:¶

A pointer to the cardano_anchor_t object containing the anchor. If the certificate is NULL or if the anchor is not set, this function returns NULL.

cardano_error_t cardano_register_drep_cert_set_anchor(cardano_register_drep_cert_t *certificate, cardano_anchor_t *anchor)¶

Sets the anchor for a DRep registration certificate.

This function updates the anchor in the specified cardano_register_drep_cert_t object.

Usage Example:

cardano_register_drep_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_anchor_t* anchor = ...; // Assume anchor is already initialized

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

Parameters:¶

cardano_register_drep_cert_t *certificate¶: [in] A pointer to an initialized cardano_register_drep_cert_t object which will receive the updated anchor.
cardano_anchor_t *anchor¶: [in] A pointer to an initialized cardano_anchor_t object that represents the new anchor. This function copies the anchor into the certificate.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the anchor was successfully updated, 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_register_drep_cert_unref(cardano_register_drep_cert_t **register_drep_cert)¶

Decrements the reference count of a cardano_register_drep_cert_t object.

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

Usage Example:

cardano_register_drep_cert_t* register_drep_cert = cardano_register_drep_cert_new(major, minor);

// Perform operations with the register_drep_cert...

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

Note

After calling cardano_register_drep_cert_unref, the pointer to the cardano_register_drep_cert_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_register_drep_cert_t **register_drep_cert¶: [inout] A pointer to the pointer of the register_drep_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_register_drep_cert_ref(cardano_register_drep_cert_t *register_drep_cert)¶

Increases the reference count of the cardano_register_drep_cert_t object.

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

Usage Example:

// Assuming register_drep_cert is a previously created register_drep_cert object

cardano_register_drep_cert_ref(register_drep_cert);

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

Note

Always ensure that for every call to cardano_register_drep_cert_ref there is a corresponding call to cardano_register_drep_cert_unref to prevent memory leaks.

Parameters:¶

cardano_register_drep_cert_t *register_drep_cert¶: A pointer to the cardano_register_drep_cert_t object whose reference count is to be incremented.

size_t cardano_register_drep_cert_refcount(const cardano_register_drep_cert_t *register_drep_cert)¶

Retrieves the current reference count of the cardano_register_drep_cert_t object.

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

Usage Example:

// Assuming register_drep_cert is a previously created register_drep_cert object

size_t ref_count = cardano_register_drep_cert_refcount(register_drep_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_register_drep_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_register_drep_cert_t *register_drep_cert¶: A pointer to the cardano_register_drep_cert_t object whose reference count is queried. The object must not be NULL.

Returns:¶

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

void cardano_register_drep_cert_set_last_error(cardano_register_drep_cert_t *register_drep_cert, const char *message)¶

Sets the last error message for a given cardano_register_drep_cert_t object.

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

const char *cardano_register_drep_cert_get_last_error(const cardano_register_drep_cert_t *register_drep_cert)¶

Retrieves the last error message recorded for a specific register_drep_cert.

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

Parameters:¶

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

Returns:¶

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