Committee Members Map¶

typedef struct cardano_committee_members_map_t cardano_committee_members_map_t¶: Represents a map of committee members to epoch.

cardano_error_t cardano_committee_members_map_new(cardano_committee_members_map_t **committee_members_map)¶

Creates and initializes a new instance of a committee members map.

This function allocates and initializes a new instance of cardano_committee_members_map_t, representing a map structure. It returns an error code to indicate the success or failure of the operation.

Usage Example:

cardano_committee_members_map_t* committee_members_map = NULL;

// Attempt to create a new committee_members_map
cardano_error_t result = cardano_committee_members_map_new(&committee_members_map);

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

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

Parameters:¶

cardano_committee_members_map_t **committee_members_map¶: [out] A pointer to a pointer to a cardano_committee_members_map_t object. Upon successful initialization, this will point to a newly created cardano_committee_members_map_t object. This object represents a “strong reference” to the committee_members_map, fully initialized and ready for use. The caller is responsible for managing the lifecycle of this object. Specifically, once the committee_members_map is no longer needed, the caller must release it by calling cardano_committee_members_map_unref.

Returns:¶

CARDANO_SUCCESS if the committee_members_map was successfully created, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_committee_members_map_from_cbor(cardano_cbor_reader_t *reader, cardano_committee_members_map_t **committee_members)¶

Creates a committee_members set from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_committee_members_map_t* committee_members = NULL;

cardano_error_t result = cardano_committee_members_map_from_cbor(reader, &committee_members);

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

  // Once done, ensure to clean up and release the committee_members
  cardano_committee_members_map_unref(&committee_members);
}
else
{
  const char* error = cardano_cbor_reader_get_last_error(reader);
  printf("Failed to decode committee_members: %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_committee_members_map_t object by calling cardano_committee_members_map_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 committee_members data.
cardano_committee_members_map_t **committee_members¶: [out] A pointer to a pointer of cardano_committee_members_map_t that will be set to the address of the newly created committee_members object upon successful decoding.

Returns:¶

A cardano_error_t value indicating the outcome of the operation. Returns CARDANO_SUCCESS if the committee_members was successfully created, or an appropriate error code if an error occurred.

cardano_error_t cardano_committee_members_map_to_cbor(const cardano_committee_members_map_t *committee_members, cardano_cbor_writer_t *writer)¶

Serializes a committee_members into CBOR format using a CBOR writer.

This function serializes the given cardano_committee_members_map_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_committee_members_map_t* committee_members = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_committee_members_map_to_cbor(committee_members, 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_committee_members_map_unref(&committee_members);

Parameters:¶

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

cardano_error_t cardano_committee_members_map_to_cip116_json(const cardano_committee_members_map_t *map, cardano_json_writer_t *writer)¶

Serializes a committee members map to a CIP-116 JSON array.

This function serializes a map of [Credential -> Epoch] into a JSON array of key-value objects: [ { “key”: { …Credential… }, “value”: “<uint64_string>” }, … ]

Parameters:¶

const cardano_committee_members_map_t *map¶: [in] Pointer to a valid cardano_committee_members_map_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 map or writer is NULL. CARDANO_ERROR_MEMORY_ALLOCATION_FAILED If memory allocation fails. Other Any error propagated from nested writers.

size_t cardano_committee_members_map_get_length(const cardano_committee_members_map_t *committee_members_map)¶

Retrieves the length of the committee_members_map.

This function returns the number of key-value pairs contained in the specified committee_members_map.

Usage Example:

cardano_committee_members_map_t* committee_members_map = cardano_committee_members_map_new();

// Populate the committee_members_map with key-value pairs

size_t length = cardano_committee_members_map_get_length(committee_members_map);
printf("The length of the committee_members_map is: %zu\n", length);

cardano_committee_members_map_unref(&committee_members_map);

Parameters:¶

const cardano_committee_members_map_t *committee_members_map¶: [in] A constant pointer to the cardano_committee_members_map_t object for which the length is to be retrieved.

Returns:¶

The number of key-value pairs in the committee_members_map. Returns 0 if the committee_members_map is NULL.

cardano_error_t cardano_committee_members_map_get(cardano_committee_members_map_t *committee_members_map, cardano_credential_t *key, uint64_t *element)¶

Retrieves the value associated with a given key in the committee members map.

This function retrieves the value associated with the specified key in the provided committee members map. It returns the value through the output parameter element. If the key is not found in the committee members map, the output parameter element will be set to NULL.

Usage Example:

cardano_committee_members_map_t* committee_members_map = cardano_committee_members_map_new();

// Populate the committee_members_map with key-value pairs

cardano_credential_t* key = ...; // Create a credential object representing the key
uint64_t value = 0;
cardano_error_t result = cardano_committee_members_map_get(committee_members_map, key, &value);

if (result == CARDANO_SUCCESS && value != NULL)
{
  // Use the retrieved value
  // ...
}
else
{
  // Handle error or key not found
}

cardano_credential_unref(&key); // Clean up the key resource
cardano_committee_members_map_unref(&committee_members_map);

Parameters:¶

cardano_committee_members_map_t *committee_members_map¶: [in] A constant pointer to the cardano_committee_members_map_t object from which the value is to be retrieved.
cardano_credential_t *key¶: [in] The key whose associated value is to be retrieved from the committee_members_map.
uint64_t *element¶: [out] A pointer to a variable where the retrieved value will be stored. If the key is found in the committee members map, this variable will be set to the associated value. If the key is not found, this variable will be set to NULL.

Returns:¶

CARDANO_SUCCESS if the value associated with the key was successfully retrieved, or an appropriate error code if the input parameters are invalid or any other error occurs.

cardano_error_t cardano_committee_members_map_insert(cardano_committee_members_map_t *committee_members_map, cardano_credential_t *key, uint64_t value)¶

Inserts a key-value pair into the committee members map.

This function inserts the specified key-value pair into the provided committee members map.

Usage Example:

cardano_committee_members_map_t* committee_members_map = cardano_committee_members_map_new();

// Create key and value objects
cardano_credential_t* key = ...;
uint64_t value = 0;

// Insert the key-value pair into the committee_members_map
cardano_error_t result = cardano_committee_members_map_insert(committee_members_map, key, value);

if (result != CARDANO_SUCCESS)
{
  // Handle insertion failure
}

// Clean up key and value objects
cardano_credential_unref(&key);

cardano_committee_members_map_unref(&committee_members_map);

Parameters:¶

cardano_committee_members_map_t *committee_members_map¶: [in] A constant pointer to the cardano_committee_members_map_t object where the key-value pair is to be inserted.
cardano_credential_t *key¶: [in] The key to be inserted into the committee members map. The caller is responsible for managing the lifecycle of the key object.
uint64_t value¶: [in] The value to be associated with the key and inserted into the committee_members_map. The caller is responsible for managing the lifecycle of the value object.

Returns:¶

CARDANO_SUCCESS if the key-value pair was successfully inserted, or an appropriate error code if the input parameters are invalid or any other error occurs.

cardano_error_t cardano_committee_members_map_get_keys(cardano_committee_members_map_t *committee_members_map, cardano_credential_set_t **keys)¶

Retrieves the keys from the committee members map.

This function retrieves all the keys from the provided committee members map and returns them as a list. The caller is responsible for managing the lifecycle of the returned list by calling cardano_credential_set_t when it is no longer needed.

Usage Example:

cardano_committee_members_map_t* committee_members_map = cardano_committee_members_map_new();

// Populate the committee_members_map with key-value pairs

cardano_credential_set_t* keys = NULL;
cardano_error_t result = cardano_committee_members_map_get_keys(committee_members_map, &keys);

if (result == CARDANO_SUCCESS)
{
  // Use the list of keys
  // Keys must also be freed if retrieved from the list

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

cardano_committee_members_map_unref(&committee_members_map);

Parameters:¶

cardano_committee_members_map_t *committee_members_map¶: [in] A constant pointer to the cardano_committee_members_map_t object from which the keys are to be retrieved.
cardano_credential_set_t **keys¶: [out] A pointer to a variable where the retrieved keys will be stored as a list. If successful, this variable will be set to point to the list of keys. The caller is responsible for managing the lifecycle of this list. It must be released by calling cardano_credential_set_t when no longer needed.

Returns:¶

CARDANO_SUCCESS if the keys were successfully retrieved, or an appropriate error code if the input parameters are invalid or any other error occurs.

cardano_error_t cardano_committee_members_map_get_key_at(const cardano_committee_members_map_t *committee_members_map, size_t index, cardano_credential_t **credential)¶

Retrieves the credential at a specific index from the committee_members map.

This function retrieves the credential at the specified index from the committee members map.

Usage Example:

cardano_committee_members_map_t* committee_members_map = NULL;
cardano_credential_t* credential = NULL;
size_t index = 0; // Index of the credential to retrieve

// Assume committee_members_map is initialized properly

cardano_error_t result = cardano_committee_members_map_get_key_at(committee_members_map, index, &credential);

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

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

Parameters:¶

const cardano_committee_members_map_t *committee_members_map¶: [in] Pointer to the committee members map object.
size_t index¶: [in] The index of the credential to retrieve.
cardano_credential_t **credential¶: [out] On successful retrieval, this will point to the credential at the specified index. The caller is responsible for managing the lifecycle of this object. Specifically, once the credential is no longer needed, the caller must release it by calling cardano_credential_unref.

Returns:¶

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

cardano_error_t cardano_committee_members_map_get_value_at(const cardano_committee_members_map_t *committee_members_map, size_t index, uint64_t *epoch)¶

Retrieves the committee member epoch at a specific index from the committee members map.

This function retrieves the committee member epoch at the specified index from the committee_members map.

Usage Example:

cardano_committee_members_map_t* committee_members_map = NULL;
uint64_t epoch = 0;
size_t index = 0; // Index of the committee member epoch to retrieve

// Assume committee_members_map is initialized properly

cardano_error_t result = cardano_committee_members_map_get_value_at(committee_members_map, index, &epoch);

if (result == CARDANO_SUCCESS)
{
  // Use the epoch
}
else
{
  // Handle the error
}

Parameters:¶

const cardano_committee_members_map_t *committee_members_map¶: [in] Pointer to the committee members map object.
size_t index¶: [in] The index of the committee member epoch to retrieve.
uint64_t *epoch¶: [out] On successful retrieval, this will point to the committee member epoch at the specified index.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the committee member epoch was successfully retrieved, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_committee_members_map_get_key_value_at(const cardano_committee_members_map_t *committee_members_map, size_t index, cardano_credential_t **credential, uint64_t *epoch)¶

Retrieves the credential and committee member epoch at the specified index.

This function retrieves the credential and committee member epoch from the proposed committee member epochs at the specified index.

Usage Example:

cardano_committee_members_map_t* committee_members_map = NULL;
// Assume committee_members_map is initialized properly

size_t index = 0;
cardano_credential_t* credential = NULL;
uint64_t epoch = 0;

cardano_error_t result = cardano_committee_members_map_get_key_value_at(committee_members_map, index, &credential, &epoch);

if (result == CARDANO_SUCCESS)
{
  if (credential != NULL && epoch != NULL)
  {
    // Use the credential and committee member epoch
  }
  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_committee_members_map_unref(&committee_members_map);
cardano_credential_unref(&credential);

Parameters:¶

const cardano_committee_members_map_t *committee_members_map¶: [in] Pointer to the proposed committee member epochs object.
size_t index¶: [in] The index at which to retrieve the key-value pair.
cardano_credential_t **credential¶: [out] On successful retrieval, this will point to the credential at the specified index. The caller is responsible for managing the lifecycle of this object and should release it using cardano_credential_unref when it is no longer needed.
uint64_t *epoch¶: [out] On successful retrieval, this will point to the committee member epoch at the specified index.

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_committee_members_map_unref(cardano_committee_members_map_t **committee_members_map)¶

Decrements the reference count of a committee_members_map object.

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

Usage Example:

cardano_committee_members_map_t* committee_members_map = cardano_committee_members_map_new();

// Perform operations with the committee_members_map...

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

Note

After calling cardano_committee_members_map_unref, the pointer to the cardano_committee_members_map_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_committee_members_map_t **committee_members_map¶: [inout] A pointer to the pointer of the committee_members_map 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_committee_members_map_ref(cardano_committee_members_map_t *committee_members_map)¶

Increases the reference count of the cardano_committee_members_map_t object.

This function is used to manually increment the reference count of a committee_members_map 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_committee_members_map_unref.

Usage Example:

// Assuming committee_members_map is a previously created committee_members_map object

cardano_committee_members_map_ref(committee_members_map);

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

Note

Always ensure that for every call to cardano_committee_members_map_ref there is a corresponding call to cardano_committee_members_map_unref to prevent memory leaks.

Parameters:¶

cardano_committee_members_map_t *committee_members_map¶: A pointer to the committee_members_map object whose reference count is to be incremented.

size_t cardano_committee_members_map_refcount(const cardano_committee_members_map_t *committee_members_map)¶

Retrieves the current reference count of the cardano_committee_members_map_t object.

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

Usage Example:

// Assuming committee_members_map is a previously created committee_members_map object

size_t ref_count = cardano_committee_members_map_refcount(committee_members_map);

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_committee_members_map_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_committee_members_map_t *committee_members_map¶: A pointer to the committee_members_map object whose reference count is queried. The object must not be NULL.

Returns:¶

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

void cardano_committee_members_map_set_last_error(cardano_committee_members_map_t *committee_members_map, const char *message)¶

Sets the last error message for a given committee_members_map object.

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

const char *cardano_committee_members_map_get_last_error(const cardano_committee_members_map_t *committee_members_map)¶

Retrieves the last error message recorded for a specific committee_members_map.

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

Parameters:¶

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

Returns:¶

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