Stake Vote Registration Delegation Certificate¶

typedef struct cardano_stake_vote_registration_delegation_cert_t cardano_stake_vote_registration_delegation_cert_t¶

This certificate is used when an individual wants to register its stake key, delegate their voting rights to any other DRep and simultaneously wants to delegate their stake to a specific stake pool.

cardano_error_t cardano_stake_vote_registration_delegation_cert_new(cardano_credential_t *credential, uint64_t deposit, cardano_drep_t *drep, cardano_blake2b_hash_t *pool_key_hash, cardano_stake_vote_registration_delegation_cert_t **vote_registration_delegation)¶

Creates a new stake vote registration delegation certificate.

This function allocates and initializes a new instance of cardano_stake_vote_registration_delegation_cert_t. This certificate combines stake registration with a delegation of voting rights to a delegated representative (DREP) and a specific staking pool, setting the groundwork for participation in governance and staking rewards.

Usage Example:

cardano_credential_t* credential = ...; // Assume credential is initialized
uint64_t deposit = ...; // Deposit required for registration
cardano_drep_t* drep = ...; // Assume drep is initialized
cardano_blake2b_hash_t* pool_key_hash = ...; // Assume pool key hash is initialized
cardano_stake_vote_registration_delegation_cert_t* vote_registration_delegation = NULL;

cardano_error_t result = cardano_stake_vote_registration_delegation_cert_new(
    credential, deposit, drep, pool_key_hash, &vote_registration_delegation);

if (result == CARDANO_SUCCESS)
{
  // Use the vote registration delegation certificate
  // Remember to free the certificate when done
  cardano_stake_vote_registration_delegation_cert_unref(&vote_registration_delegation);
}
else
{
  printf("Failed to create stake vote registration delegation certificate: %s\n",
         cardano_error_to_string(result));
}

Note

This function increments the reference count for the credential, drep, and pool_key_hash objects. It is the responsibility of the caller to manage these references and release them when they are no longer needed.

Parameters:¶

cardano_credential_t *credential¶

[in] A pointer to an initialized cardano_credential_t object representing the stake credential.

uint64_t deposit¶

[in] The deposit amount required for registration, which is specified by network protocol parameters.

cardano_drep_t *drep¶

[in] A pointer to an initialized cardano_drep_t object representing the delegated representative.

cardano_blake2b_hash_t *pool_key_hash¶

[in] A pointer to an initialized cardano_blake2b_hash_t object representing the pool’s key hash.

cardano_stake_vote_registration_delegation_cert_t **vote_registration_delegation¶

[out] On successful execution, this will point to a newly created cardano_stake_vote_registration_delegation_cert_t object.

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 input pointers are NULL).

cardano_error_t cardano_stake_vote_registration_delegation_cert_from_cbor(cardano_cbor_reader_t *reader, cardano_stake_vote_registration_delegation_cert_t **stake_registration)¶

Creates a cardano_stake_vote_registration_delegation_cert_t from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_stake_vote_registration_delegation_cert_t* stake_registration = NULL;

cardano_error_t result = cardano_stake_vote_registration_delegation_cert_from_cbor(reader, &stake_registration);

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

  // Once done, ensure to clean up and release the stake_registration
  cardano_stake_vote_registration_delegation_cert_unref(&stake_registration);
}
else
{
  const char* error = cardano_cbor_reader_get_last_error(reader);
  printf("Failed to decode stake_registration: %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_vote_registration_delegation_cert_t object by calling cardano_stake_vote_registration_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_vote_registration_delegation_cert_t **stake_registration¶

[out] A pointer to a pointer of cardano_stake_vote_registration_delegation_cert_t that will be set to the address of the newly created stake_registration 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_vote_registration_delegation_cert_to_cbor(const cardano_stake_vote_registration_delegation_cert_t *stake_registration, cardano_cbor_writer_t *writer)¶

Serializes the certificate into CBOR format using a CBOR writer.

This function serializes the given cardano_stake_vote_registration_delegation_cert_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_stake_vote_registration_delegation_cert_t* stake_registration = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_stake_vote_registration_delegation_cert_to_cbor(stake_registration, 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_vote_registration_delegation_cert_unref(&stake_registration);

Parameters:¶

const cardano_stake_vote_registration_delegation_cert_t *stake_registration¶

[in] A constant pointer to the cardano_stake_vote_registration_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_registration or writer is NULL, returns CARDANO_ERROR_POINTER_IS_NULL.

cardano_error_t cardano_stake_vote_registration_delegation_cert_to_cip116_json(const cardano_stake_vote_registration_delegation_cert_t *cert, cardano_json_writer_t *writer)¶

Serializes a stake vote registration 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”, “drep”, “coin”.

Parameters:¶

const cardano_stake_vote_registration_delegation_cert_t *cert¶

[in] Pointer to a valid cardano_stake_vote_registration_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_vote_registration_delegation_cert_get_credential(cardano_stake_vote_registration_delegation_cert_t *certificate)¶

Retrieves the stake credential from a stake vote registration delegation certificate.

This function extracts the stake credential from a given cardano_stake_vote_registration_delegation_cert_t object. The credential identifies the stakeholder in the context of the Cardano network.

Usage Example:

const cardano_stake_vote_registration_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_credential_t* credential = cardano_stake_vote_registration_delegation_cert_get_credential(certificate);

if (credential != NULL)
{
  // Process the credential
  // Remember to release the credential reference when done
  cardano_credential_unref(&credential);
}
else
{
  printf("Failed to retrieve credential or certificate is not initialized properly.\n");
}

Note

The returned cardano_credential_t object is a new reference and must be managed by the caller. It should be released using cardano_credential_unref when no longer needed.

Parameters:¶

cardano_stake_vote_registration_delegation_cert_t *certificate¶

[in] A constant pointer to an initialized cardano_stake_vote_registration_delegation_cert_t object.

Returns:¶

A pointer to a cardano_credential_t object containing the stake credential. If the input certificate is NULL, or if the credential is not set, this function returns NULL.

cardano_error_t cardano_stake_vote_registration_delegation_cert_set_credential(cardano_stake_vote_registration_delegation_cert_t *certificate, cardano_credential_t *credential)¶

Sets the stake credential for a stake vote registration delegation certificate.

This function assigns a stake credential to a given cardano_stake_vote_registration_delegation_cert_t object. The credential identifies the stakeholder in the context of the Cardano network.

Usage Example:

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

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

// Cleanup performed elsewhere for credential

Note

After setting, the certificate holds its own reference to the credential. The caller must manage and release its own references to the credential object.

Parameters:¶

cardano_stake_vote_registration_delegation_cert_t *certificate¶

[inout] A pointer to an initialized cardano_stake_vote_registration_delegation_cert_t object where the stake credential will be set.

cardano_credential_t *credential¶

[in] A pointer to an initialized cardano_credential_t object representing the stake credential. This function increments the reference count of the credential, and the caller remains responsible for releasing their own reference.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the stake 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_vote_registration_delegation_cert_get_pool_key_hash(cardano_stake_vote_registration_delegation_cert_t *certificate)¶

Retrieves the pool key hash from a stake vote registration delegation certificate.

This function extracts the pool key hash from the specified cardano_stake_vote_registration_delegation_cert_t object. The pool key hash is used to identify the stake pool to which the delegation is directed in the Cardano network.

Usage Example:

const cardano_stake_vote_registration_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_blake2b_hash_t* pool_key_hash = cardano_stake_vote_registration_delegation_cert_get_pool_key_hash(certificate);

if (pool_key_hash != NULL)
{
  // Process the pool key hash
  cardano_blake2b_hash_unref(&pool_key_hash); // Clean up the reference when done
}

Parameters:¶

cardano_stake_vote_registration_delegation_cert_t *certificate¶

[in] A constant pointer to an initialized cardano_stake_vote_registration_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_vote_registration_delegation_cert_set_pool_key_hash(cardano_stake_vote_registration_delegation_cert_t *certificate, cardano_blake2b_hash_t *hash)¶

Sets the pool key hash for a stake vote registration delegation certificate.

This function assigns a pool key hash to the specified cardano_stake_vote_registration_delegation_cert_t object.

Usage Example:

cardano_stake_vote_registration_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_blake2b_hash_t* hash = ...; // Assume hash is already initialized

cardano_error_t result = cardano_stake_vote_registration_delegation_cert_set_pool_key_hash(certificate, hash);
if (result == CARDANO_SUCCESS)
{
  printf("Pool key hash set successfully.\n");
}
else
{
  printf("Failed to set the pool key hash.\n");
}

// Cleanup
cardano_blake2b_hash_unref(&pool_key_hash); // Clean up the reference when done

Note

After setting, the certificate holds its own reference to the hash. The caller must manage and release its own references to the hash object.

Parameters:¶

cardano_stake_vote_registration_delegation_cert_t *certificate¶

[inout] A pointer to an initialized cardano_stake_vote_registration_delegation_cert_t object where the pool key hash will be set.

cardano_blake2b_hash_t *hash¶

[in] A pointer to an initialized cardano_blake2b_hash_t object representing the pool key hash. This function increments the reference count of the hash, and the caller is responsible for releasing their reference to the hash object.

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 reason for failure, such as CARDANO_ERROR_POINTER_IS_NULL if any of the input pointers are NULL.

cardano_drep_t *cardano_stake_vote_registration_delegation_cert_get_drep(cardano_stake_vote_registration_delegation_cert_t *certificate)¶

Retrieves the DRep associated with a stake vote registration delegation certificate.

This function extracts the DRep from the specified cardano_stake_vote_registration_delegation_cert_t object.

Usage Example:

const cardano_stake_vote_registration_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_drep_t* drep = cardano_stake_vote_registration_delegation_cert_get_drep(certificate);

if (drep != NULL)
{
  // Process the DRep
  // Remember to free the DRep when done
  cardano_drep_unref(&drep);
}

Parameters:¶

cardano_stake_vote_registration_delegation_cert_t *certificate¶

[in] A constant pointer to an initialized cardano_stake_vote_registration_delegation_cert_t object.

Returns:¶

A pointer to a new cardano_drep_t object containing the DRep. The caller is responsible for managing the lifecycle of this returned DRep object, including releasing it using cardano_drep_unref when it is no longer needed. If the certificate is NULL or if the DRep is not set, this function returns NULL.

cardano_error_t cardano_stake_vote_registration_delegation_cert_set_drep(cardano_stake_vote_registration_delegation_cert_t *certificate, cardano_drep_t *drep)¶

Sets the DRep for a stake vote registration delegation certificate.

This function assigns a DRep to the specified cardano_stake_vote_registration_delegation_cert_t object. The DRep is essential for representing delegate participation in the governance process within the Cardano network.

Usage Example:

cardano_stake_vote_registration_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_drep_t* drep = ...; // Assume drep is already initialized

cardano_error_t result = cardano_stake_vote_registration_delegation_cert_set_drep(certificate, drep);
if (result == CARDANO_SUCCESS)
{
  // The DRep is now set for the certificate
}
else
{
  printf("Failed to set the DRep.\n");
}

// Both certificate and drep need their references managed appropriately
cardano_drep_unref(&drep);

Note

This function increments the reference count of the drep argument, the caller must manage their own reference to it.

Parameters:¶

cardano_stake_vote_registration_delegation_cert_t *certificate¶

[in] A pointer to an initialized cardano_stake_vote_registration_delegation_cert_t object which will receive the DRep.

cardano_drep_t *drep¶

[in] A pointer to an initialized cardano_drep_t object to be set on the certificate. This function increments the reference count of the DRep, and the caller is still responsible for releasing their reference to the DRep object.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the DRep 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_stake_vote_registration_delegation_cert_get_deposit(const cardano_stake_vote_registration_delegation_cert_t *certificate)¶

Retrieves the deposit amount from a stake vote registration delegation certificate.

This function fetches the deposit amount that has been set on a cardano_stake_vote_registration_delegation_cert_t object. The deposit is a fixed amount required as part of the registration process, acting as a security measure within the Cardano network.

Usage Example:

cardano_stake_vote_registration_delegation_cert_t* certificate = ...; // Assume certificate is already initialized

uint64_t deposit = cardano_stake_vote_registration_delegation_cert_get_deposit(certificate);
printf("Deposit amount: %llu ADA\n", deposit);

Parameters:¶

const cardano_stake_vote_registration_delegation_cert_t *certificate¶

[in] A constant pointer to an initialized cardano_stake_vote_registration_delegation_cert_t object.

Returns:¶

The deposit amount set on the certificate. If the certificate is NULL, the function returns 0, which should be checked against possible error returns in real scenarios.

cardano_error_t cardano_stake_vote_registration_delegation_cert_set_deposit(cardano_stake_vote_registration_delegation_cert_t *certificate, uint64_t deposit)¶

Sets the deposit amount on a stake vote registration delegation certificate.

This function updates the deposit amount for a cardano_stake_vote_registration_delegation_cert_t object.

Usage Example:

cardano_stake_vote_registration_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
uint64_t deposit = 1000000; // 1 ADA, example deposit amount

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

Parameters:¶

cardano_stake_vote_registration_delegation_cert_t *certificate¶

[inout] A pointer to an initialized cardano_stake_vote_registration_delegation_cert_t object on which the deposit amount will be set.

uint64_t deposit¶

[in] The deposit amount to be set on the certificate. This amount should align with the protocol’s current requirements.

Returns:¶

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

void cardano_stake_vote_registration_delegation_cert_unref(cardano_stake_vote_registration_delegation_cert_t **stake_registration)¶

Decrements the reference count of a cardano_stake_vote_registration_delegation_cert_t object.

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

Usage Example:

cardano_stake_vote_registration_delegation_cert_t* stake_registration = cardano_stake_vote_registration_delegation_cert_new(major, minor);

// Perform operations with the stake_registration...

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

Note

After calling cardano_stake_vote_registration_delegation_cert_unref, the pointer to the cardano_stake_vote_registration_delegation_cert_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_stake_vote_registration_delegation_cert_t **stake_registration¶

[inout] A pointer to the pointer of the stake_registration 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_vote_registration_delegation_cert_ref(cardano_stake_vote_registration_delegation_cert_t *stake_registration)¶

Increases the reference count of the cardano_stake_vote_registration_delegation_cert_t object.

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

Usage Example:

// Assuming stake_registration is a previously created stake_registration object

cardano_stake_vote_registration_delegation_cert_ref(stake_registration);

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

Note

Always ensure that for every call to cardano_stake_vote_registration_delegation_cert_ref there is a corresponding call to cardano_stake_vote_registration_delegation_cert_unref to prevent memory leaks.

Parameters:¶

cardano_stake_vote_registration_delegation_cert_t *stake_registration¶

A pointer to the cardano_stake_vote_registration_delegation_cert_t object whose reference count is to be incremented.

size_t cardano_stake_vote_registration_delegation_cert_refcount(const cardano_stake_vote_registration_delegation_cert_t *stake_registration)¶

Retrieves the current reference count of the cardano_stake_vote_registration_delegation_cert_t object.

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

Usage Example:

// Assuming stake_registration is a previously created stake_registration object

size_t ref_count = cardano_stake_vote_registration_delegation_cert_refcount(stake_registration);

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_vote_registration_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_vote_registration_delegation_cert_t *stake_registration¶

A pointer to the cardano_stake_vote_registration_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_vote_registration_delegation_cert_t object. If the object is properly managed (i.e., every cardano_stake_vote_registration_delegation_cert_ref call is matched with a cardano_stake_vote_registration_delegation_cert_unref call), this count should reach zero right before the object is deallocated.

void cardano_stake_vote_registration_delegation_cert_set_last_error(cardano_stake_vote_registration_delegation_cert_t *stake_registration, const char *message)¶

Sets the last error message for a given cardano_stake_vote_registration_delegation_cert_t object.

Records an error message in the stake_registration’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_vote_registration_delegation_cert_t *stake_registration¶

[in] A pointer to the cardano_stake_vote_registration_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_registration’s last_error is set to an empty string, indicating no error.

const char *cardano_stake_vote_registration_delegation_cert_get_last_error(const cardano_stake_vote_registration_delegation_cert_t *stake_registration)¶

Retrieves the last error message recorded for a specific stake_registration.

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

Parameters:¶

const cardano_stake_vote_registration_delegation_cert_t *stake_registration¶

[in] A pointer to the cardano_stake_vote_registration_delegation_cert_t instance whose last error message is to be retrieved. If the stake_registration is NULL, the function returns a generic error message indicating the null stake_registration.

Returns:¶

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