Pool Registration Certificate¶

typedef struct cardano_pool_registration_cert_t cardano_pool_registration_cert_t¶

This certificate is used to register a new stake pool.

It includes various details about the pool such as the pledge, costs, margin, reward account, and the pool’s owners and relays.

cardano_error_t cardano_pool_registration_cert_new(cardano_pool_params_t *params, cardano_pool_registration_cert_t **cardano_pool_registration_cert)¶

Creates a new pool registration certificate.

This function allocates and initializes a new cardano_pool_registration_cert_t object based on the provided pool parameters. A pool registration certificate is used in the Cardano network to register a new stake pool.

Usage Example:

cardano_pool_params_t* params = ...; // Assume params is already initialized
cardano_pool_registration_cert_t* registration_cert = NULL;

cardano_error_t result = cardano_pool_registration_cert_new(params, &registration_cert);

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

Parameters:¶

cardano_pool_params_t *params¶: [in] A pointer to an initialized cardano_pool_params_t object containing the parameters of the pool being registered.
cardano_pool_registration_cert_t **cardano_pool_registration_cert¶: [out] On successful execution, this will point to a newly created cardano_pool_registration_cert_t object. The caller is responsible for managing the lifecycle of this object using cardano_pool_registration_cert_unref when it is no longer needed.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the pool registration certificate was successfully created, 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_error_t cardano_pool_registration_cert_from_cbor(cardano_cbor_reader_t *reader, cardano_pool_registration_cert_t **pool_registration_cert)¶

Creates a cardano_pool_registration_cert_t from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_pool_registration_cert_t* pool_registration_cert = NULL;

cardano_error_t result = cardano_pool_registration_cert_from_cbor(reader, &pool_registration_cert);

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

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

Serializes the certificate into CBOR format using a CBOR writer.

This function serializes the given cardano_pool_registration_cert_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_pool_registration_cert_t* pool_registration_cert = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_pool_registration_cert_to_cbor(pool_registration_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_pool_registration_cert_unref(&pool_registration_cert);

Parameters:¶

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

cardano_error_t cardano_pool_registration_cert_to_cip116_json(const cardano_pool_registration_cert_t *cert, cardano_json_writer_t *writer)¶

Serializes a pool registration certificate to CIP-116 JSON.

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

Parameters:¶

const cardano_pool_registration_cert_t *cert¶: [in] Pointer to a valid cardano_pool_registration_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_error_t cardano_pool_registration_cert_get_params(cardano_pool_registration_cert_t *cert, cardano_pool_params_t **params)¶

Retrieves the pool parameters from a pool registration certificate.

This function extracts the pool parameters from the specified cardano_pool_registration_cert_t object. These parameters define the configurations of the stake pool being registered.

Usage Example:

cardano_pool_registration_cert_t* registration_cert = ...; // Assume registration_cert is already initialized
cardano_pool_params_t* params = NULL;

cardano_error_t result = cardano_pool_registration_cert_get_params(registration_cert, &params);

if (result == CARDANO_SUCCESS)
{
  // Process the pool parameters
  // Remember to free the params when done
  cardano_pool_params_unref(&params);
}
else
{
  printf("Failed to retrieve pool parameters: %s\n", cardano_error_to_string(result));
}

Parameters:¶

cardano_pool_registration_cert_t *cert¶: [in] A pointer to an initialized cardano_pool_registration_cert_t object from which the pool parameters are to be retrieved.
cardano_pool_params_t **params¶: [out] On successful execution, this will point to the cardano_pool_params_t object associated with the pool registration certificate. This output provides a reference to the pool parameters, which the caller must manage using cardano_pool_params_unref when no longer needed.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the pool parameters were successfully retrieved, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_pool_registration_cert_set_params(cardano_pool_registration_cert_t *cert, cardano_pool_params_t *params)¶

Sets the parameters for a pool registration certificate.

This function sets the pool parameters for an existing pool registration certificate. It updates the certificate to use the provided pool parameters.

Usage Example:

cardano_pool_registration_cert_t* cert = ...; // Assume initialized
cardano_pool_params_t* params = ...; // Assume initialized
cardano_error_t result = cardano_pool_registration_cert_set_params(cert, params);

if (result == CARDANO_SUCCESS)
{
  // The pool registration certificate now has the updated parameters
}

Parameters:¶

cardano_pool_registration_cert_t *cert¶: [in] A pointer to an initialized cardano_pool_registration_cert_t object representing the pool registration certificate.
cardano_pool_params_t *params¶: [in] A pointer to an initialized cardano_pool_params_t object representing the pool parameters to set.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the parameters were successfully set.

void cardano_pool_registration_cert_unref(cardano_pool_registration_cert_t **pool_registration_cert)¶

Decrements the reference count of a cardano_pool_registration_cert_t object.

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

Usage Example:

cardano_pool_registration_cert_t* pool_registration_cert = cardano_pool_registration_cert_new(major, minor);

// Perform operations with the pool_registration_cert...

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

Note

After calling cardano_pool_registration_cert_unref, the pointer to the cardano_pool_registration_cert_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_pool_registration_cert_t **pool_registration_cert¶: [inout] A pointer to the pointer of the pool_registration_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_pool_registration_cert_ref(cardano_pool_registration_cert_t *pool_registration_cert)¶

Increases the reference count of the cardano_pool_registration_cert_t object.

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

Usage Example:

// Assuming pool_registration_cert is a previously created pool_registration_cert object

cardano_pool_registration_cert_ref(pool_registration_cert);

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

Note

Always ensure that for every call to cardano_pool_registration_cert_ref there is a corresponding call to cardano_pool_registration_cert_unref to prevent memory leaks.

Parameters:¶

cardano_pool_registration_cert_t *pool_registration_cert¶: A pointer to the cardano_pool_registration_cert_t object whose reference count is to be incremented.

size_t cardano_pool_registration_cert_refcount(const cardano_pool_registration_cert_t *pool_registration_cert)¶

Retrieves the current reference count of the cardano_pool_registration_cert_t object.

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

Usage Example:

// Assuming pool_registration_cert is a previously created pool_registration_cert object

size_t ref_count = cardano_pool_registration_cert_refcount(pool_registration_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_pool_registration_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_pool_registration_cert_t *pool_registration_cert¶: A pointer to the cardano_pool_registration_cert_t object whose reference count is queried. The object must not be NULL.

Returns:¶

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

void cardano_pool_registration_cert_set_last_error(cardano_pool_registration_cert_t *pool_registration_cert, const char *message)¶

Sets the last error message for a given cardano_pool_registration_cert_t object.

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

const char *cardano_pool_registration_cert_get_last_error(const cardano_pool_registration_cert_t *pool_registration_cert)¶

Retrieves the last error message recorded for a specific pool_registration_cert.

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

Parameters:¶

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

Returns:¶

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