Proposed Protocol Parameter Updates¶

typedef struct cardano_proposed_param_updates_t cardano_proposed_param_updates_t¶

In the Cardano network, stakeholders can propose changes to the protocol parameters.

These proposals are then collected into a set which represents the ProposedProtocolParameterUpdates.

This proposed protocol parameter updates are represented as a map of genesis delegate key hash to parameters updates. So in principles, each genesis delegate can propose a different update.

cardano_error_t cardano_proposed_param_updates_new(cardano_proposed_param_updates_t **proposed_param_updates)¶

Creates and initializes a new instance of the proposed protocol parameter updates.

This function allocates and initializes a new instance of the proposed protocol parameter updates, representing a set of proposed changes to the Cardano protocol parameters.

Usage Example:

cardano_proposed_param_updates_t* proposed_param_updates = NULL;

// Attempt to create a new proposed protocol parameter updates object
cardano_error_t result = cardano_proposed_param_updates_new(&proposed_param_updates);

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

  // Once done, ensure to clean up and release the proposed_param_updates
  cardano_proposed_param_updates_unref(&proposed_param_updates);
}

Parameters:¶

cardano_proposed_param_updates_t **proposed_param_updates¶

[out] On successful initialization, this will point to a newly created proposed protocol parameter updates object. This object represents a “strong reference”, meaning that it is fully initialized and ready for use. The caller is responsible for managing the lifecycle of this object. Specifically, once the proposed protocol parameter updates object is no longer needed, the caller must release it by calling cardano_proposed_param_updates_unref.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the proposed protocol parameter updates object was successfully created, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_proposed_param_updates_from_cbor(cardano_cbor_reader_t *reader, cardano_proposed_param_updates_t **proposed_param_updates)¶

Creates a cardano_proposed_param_updates_t from a CBOR reader.

This function parses CBOR data using a provided cardano_cbor_reader_t and constructs a cardano_proposed_param_updates_t object. It assumes that the CBOR reader is set up correctly and that the CBOR data corresponds to the structure expected for a proposed_param_updates.

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_proposed_param_updates_t* proposed_param_updates = NULL;

cardano_error_t result = cardano_proposed_param_updates_from_cbor(reader, &proposed_param_updates);

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

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

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

Serializes protocol version into CBOR format using a CBOR writer.

This function serializes the given cardano_proposed_param_updates_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_proposed_param_updates_t* proposed_param_updates = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_proposed_param_updates_to_cbor(proposed_param_updates, 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_proposed_param_updates_unref(&proposed_param_updates);

Parameters:¶

const cardano_proposed_param_updates_t *proposed_param_updates¶

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

cardano_error_t cardano_proposed_param_updates_to_cip116_json(const cardano_proposed_param_updates_t *updates, cardano_json_writer_t *writer)¶

Serializes proposed parameter updates to CIP-116 JSON.

The function writes a JSON object where keys are the hexadecimal representation of the genesis hash, and values are the protocol parameter update objects.

Parameters:¶

const cardano_proposed_param_updates_t *updates¶

[in] Pointer to a valid cardano_proposed_param_updates_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 updates or writer is NULL. CARDANO_ERROR_MEMORY_ALLOCATION_FAILED If memory allocation fails. Other Any error propagated from nested writers.

size_t cardano_proposed_param_updates_get_size(const cardano_proposed_param_updates_t *proposed_param_updates)¶

Retrieves the number of proposed parameter updates.

This function returns the number of proposed parameter updates in the proposed protocol parameter updates object.

Usage Example:

cardano_proposed_param_updates_t* proposed_param_updates = NULL;

// Assume proposed_param_updates is initialized properly

size_t size = cardano_proposed_param_updates_get_size(proposed_param_updates);
printf("Number of proposed parameter updates: %zu\n", size);

Parameters:¶

const cardano_proposed_param_updates_t *proposed_param_updates¶

[in] Pointer to the proposed protocol parameter updates object.

Returns:¶

The number of proposed parameter updates in the map.

cardano_error_t cardano_proposed_param_updates_insert(cardano_proposed_param_updates_t *proposed_param_updates, cardano_blake2b_hash_t *genesis_delegate_key_hash, cardano_protocol_param_update_t *protocol_param_update)¶

Inserts a new Protocol Parameter Update into the proposed protocol parameter updates.

This function inserts a new protocol parameter update into the proposed protocol parameter updates map.

Usage Example:

cardano_proposed_param_updates_t* proposed_param_updates = NULL;
cardano_blake2b_hash_t* genesis_delegate_key_hash = NULL;
cardano_protocol_param_update_t* protocol_param_update = NULL;

// Assume proposed_param_updates, genesis_delegate_key_hash, and protocol_param_update are initialized properly

cardano_error_t result = cardano_proposed_param_updates_insert(proposed_param_updates, genesis_delegate_key_hash, protocol_param_update);

if (result == CARDANO_SUCCESS)
{
  // The protocol parameter update was successfully inserted
}
else
{
  // Handle the error
}

Parameters:¶

cardano_proposed_param_updates_t *proposed_param_updates¶

[in] Pointer to the proposed protocol parameter updates object.

cardano_blake2b_hash_t *genesis_delegate_key_hash¶

[in] Pointer to the key hash of the genesis delegate proposing the update.

cardano_protocol_param_update_t *protocol_param_update¶

[in] Pointer to the protocol parameter update being proposed.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the Protocol Parameter Update was successfully inserted, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_proposed_param_updates_get(const cardano_proposed_param_updates_t *proposed_param_updates, cardano_blake2b_hash_t *genesis_delegate_key_hash, cardano_protocol_param_update_t **protocol_param_update)¶

Retrieves a Protocol Parameter Update from the proposed protocol parameter updates.

This function retrieves a protocol parameter update from the proposed protocol parameter updates map.

Usage Example:

cardano_proposed_param_updates_t* proposed_param_updates = NULL;
cardano_blake2b_hash_t* genesis_delegate_key_hash = NULL;
cardano_protocol_param_update_t* protocol_param_update = NULL;

// Assume proposed_param_updates and genesis_delegate_key_hash are initialized properly

cardano_error_t result = cardano_proposed_param_updates_get(proposed_param_updates, genesis_delegate_key_hash, &protocol_param_update);

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

  // Once done, ensure to clean up and release the protocol_param_update
  cardano_protocol_param_update_unref(&protocol_param_update);
}
else
{
  // Handle the error
}

Parameters:¶

const cardano_proposed_param_updates_t *proposed_param_updates¶

[in] Pointer to the proposed protocol parameter updates object.

cardano_blake2b_hash_t *genesis_delegate_key_hash¶

[in] Pointer to the key hash of the genesis delegate proposing the update.

cardano_protocol_param_update_t **protocol_param_update¶

[out] On successful retrieval, this will point to the protocol parameter update associated with the given genesis delegate key hash. The caller is responsible for managing the lifecycle of this object. Specifically, once the protocol parameter update is no longer needed, the caller must release it by calling cardano_protocol_param_update_unref.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the Protocol Parameter Update was successfully retrieved, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_proposed_param_updates_get_key_at(const cardano_proposed_param_updates_t *proposed_param_updates, size_t index, cardano_blake2b_hash_t **genesis_delegate_key_hash)¶

Retrieves the genesis delegate key hash at a specific index from the proposed protocol parameter updates.

This function retrieves the genesis delegate key hash at the specified index from the proposed protocol parameter updates map.

Usage Example:

cardano_proposed_param_updates_t* proposed_param_updates = NULL;
cardano_blake2b_hash_t* genesis_delegate_key_hash = NULL;
size_t index = 0; // Index of the key hash to retrieve

// Assume proposed_param_updates is initialized properly

cardano_error_t result = cardano_proposed_param_updates_get_key_at(proposed_param_updates, index, &genesis_delegate_key_hash);

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

  // Once done, ensure to clean up and release the genesis_delegate_key_hash
  cardano_blake2b_hash_unref(&genesis_delegate_key_hash);
}
else
{
  // Handle the error
}

Parameters:¶

const cardano_proposed_param_updates_t *proposed_param_updates¶

[in] Pointer to the proposed protocol parameter updates object.

size_t index¶

[in] The index of the genesis delegate key hash to retrieve.

cardano_blake2b_hash_t **genesis_delegate_key_hash¶

[out] On successful retrieval, this will point to the genesis delegate key hash at the specified index. The caller is responsible for managing the lifecycle of this object. Specifically, once the genesis delegate key hash is no longer needed, the caller must release it by calling cardano_blake2b_hash_unref.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the genesis delegate key hash was successfully retrieved, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_proposed_param_updates_get_value_at(const cardano_proposed_param_updates_t *proposed_param_updates, size_t index, cardano_protocol_param_update_t **protocol_param_update)¶

Retrieves the protocol parameter update at a specific index from the proposed protocol parameter updates.

This function retrieves the protocol parameter update at the specified index from the proposed protocol parameter updates map.

Usage Example:

cardano_proposed_param_updates_t* proposed_param_updates = NULL;
cardano_protocol_param_update_t* protocol_param_update = NULL;
size_t index = 0; // Index of the parameter update to retrieve

// Assume proposed_param_updates is initialized properly

cardano_error_t result = cardano_proposed_param_updates_get_value_at(proposed_param_updates, index, &protocol_param_update);

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

  // Once done, ensure to clean up and release the protocol_param_update
  cardano_protocol_param_update_unref(&protocol_param_update);
}
else
{
  // Handle the error
}

Parameters:¶

const cardano_proposed_param_updates_t *proposed_param_updates¶

[in] Pointer to the proposed protocol parameter updates object.

size_t index¶

[in] The index of the protocol parameter update to retrieve.

cardano_protocol_param_update_t **protocol_param_update¶

[out] On successful retrieval, this will point to the protocol parameter update at the specified index. The caller is responsible for managing the lifecycle of this object. Specifically, once the protocol parameter update is no longer needed, the caller must release it by calling cardano_protocol_param_update_unref.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the protocol parameter update was successfully retrieved, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_proposed_param_updates_get_key_value_at(const cardano_proposed_param_updates_t *proposed_param_updates, size_t index, cardano_blake2b_hash_t **genesis_delegate_key_hash, cardano_protocol_param_update_t **protocol_param_update)¶

Retrieves the genesis delegate key hash and protocol parameter update at the specified index.

This function retrieves the genesis delegate key hash and protocol parameter update from the proposed parameter updates at the specified index.

Usage Example:

cardano_proposed_param_updates_t* proposed_param_updates = NULL;
// Assume proposed_param_updates is initialized properly

size_t index = 0;
cardano_blake2b_hash_t* genesis_delegate_key_hash = NULL;
cardano_protocol_param_update_t* protocol_param_update = NULL;

cardano_error_t result = cardano_proposed_param_updates_get_key_value_at(proposed_param_updates, index, &genesis_delegate_key_hash, &protocol_param_update);

if (result == CARDANO_SUCCESS)
{
  if (genesis_delegate_key_hash != NULL && protocol_param_update != NULL)
  {
    // Use the genesis delegate key hash and protocol parameter update
  }
  else
  {
    printf("Key-value pair not set at index %zu.\n", index);
  }
}
else
{
  // Handle error
  printf("Failed to get key-value pair at index %zu.\n", index);
}

// Clean up
cardano_proposed_param_updates_unref(&proposed_param_updates);
cardano_blake2b_hash_unref(&genesis_delegate_key_hash);
cardano_protocol_param_update_unref(&protocol_param_update);

Parameters:¶

const cardano_proposed_param_updates_t *proposed_param_updates¶

[in] Pointer to the proposed parameter updates object.

size_t index¶

[in] The index at which to retrieve the key-value pair.

cardano_blake2b_hash_t **genesis_delegate_key_hash¶

[out] On successful retrieval, this will point to the genesis delegate key hash at the specified index. The caller is responsible for managing the lifecycle of this object and should release it using cardano_blake2b_hash_unref when it is no longer needed.

cardano_protocol_param_update_t **protocol_param_update¶

[out] On successful retrieval, this will point to the protocol parameter update at the specified index. The caller is responsible for managing the lifecycle of this object and should release it using cardano_protocol_param_update_unref when it is no longer needed.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the key-value pair was successfully retrieved, or an appropriate error code indicating the failure reason.

void cardano_proposed_param_updates_unref(cardano_proposed_param_updates_t **proposed_param_updates)¶

Decrements the reference count of a cardano_proposed_param_updates_t object.

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

Usage Example:

cardano_proposed_param_updates_t* proposed_param_updates = cardano_proposed_param_updates_new(major, minor);

// Perform operations with the proposed_param_updates...

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

Note

After calling cardano_proposed_param_updates_unref, the pointer to the cardano_proposed_param_updates_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_proposed_param_updates_t **proposed_param_updates¶

[inout] A pointer to the pointer of the proposed_param_updates 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_proposed_param_updates_ref(cardano_proposed_param_updates_t *proposed_param_updates)¶

Increases the reference count of the cardano_proposed_param_updates_t object.

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

Usage Example:

// Assuming proposed_param_updates is a previously created proposed_param_updates object

cardano_proposed_param_updates_ref(proposed_param_updates);

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

Note

Always ensure that for every call to cardano_proposed_param_updates_ref there is a corresponding call to cardano_proposed_param_updates_unref to prevent memory leaks.

Parameters:¶

cardano_proposed_param_updates_t *proposed_param_updates¶

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

size_t cardano_proposed_param_updates_refcount(const cardano_proposed_param_updates_t *proposed_param_updates)¶

Retrieves the current reference count of the cardano_proposed_param_updates_t object.

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

Usage Example:

// Assuming proposed_param_updates is a previously created proposed_param_updates object

size_t ref_count = cardano_proposed_param_updates_refcount(proposed_param_updates);

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_proposed_param_updates_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_proposed_param_updates_t *proposed_param_updates¶

A pointer to the cardano_proposed_param_updates_t object whose reference count is queried. The object must not be NULL.

Returns:¶

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

void cardano_proposed_param_updates_set_last_error(cardano_proposed_param_updates_t *proposed_param_updates, const char *message)¶

Sets the last error message for a given cardano_proposed_param_updates_t object.

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

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

const char *cardano_proposed_param_updates_get_last_error(const cardano_proposed_param_updates_t *proposed_param_updates)¶

Retrieves the last error message recorded for a specific proposed_param_updates.

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

Parameters:¶

const cardano_proposed_param_updates_t *proposed_param_updates¶

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

Returns:¶

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