BLAKE2b Hash Set¶

typedef struct cardano_blake2b_hash_set_t cardano_blake2b_hash_set_t¶

Represents a set of blake2b_hashs.

cardano_error_t cardano_blake2b_hash_set_new(cardano_blake2b_hash_set_t **blake2b_hash_set)¶

Creates and initializes a new instance of a blake2b_hash_set.

This function allocates and initializes a new instance of cardano_blake2b_hash_set_t. It returns an error code to indicate success or failure of the operation.

Usage Example:

cardano_blake2b_hash_set_t* blake2b_hash_set = NULL;

// Attempt to create a new blake2b_hash_set
cardano_error_t result = cardano_blake2b_hash_set_new(&blake2b_hash_set);

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

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

Parameters:¶

cardano_blake2b_hash_set_t **blake2b_hash_set¶

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

Returns:¶

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

cardano_error_t cardano_blake2b_hash_set_from_cbor(cardano_cbor_reader_t *reader, cardano_blake2b_hash_set_t **blake2b_hashs)¶

Creates a blake2b_hash set from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_blake2b_hash_set_t* blake2b_hash = NULL;

cardano_error_t result = cardano_blake2b_hash_set_from_cbor(reader, &blake2b_hash);

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

  // Once done, ensure to clean up and release the blake2b_hash
  cardano_blake2b_hash_set_unref(&blake2b_hash);
}
else
{
  const char* error = cardano_cbor_reader_get_last_error(reader);
  printf("Failed to decode blake2b_hash: %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_blake2b_hash_set_t object by calling cardano_blake2b_hash_set_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 blake2b_hash data.

cardano_blake2b_hash_set_t **blake2b_hashs¶

[out] A pointer to a pointer of cardano_blake2b_hash_set_t that will be set to the address of the newly created blake2b_hash object upon successful decoding.

Returns:¶

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

cardano_error_t cardano_blake2b_hash_set_to_cbor(const cardano_blake2b_hash_set_t *blake2b_hashs, cardano_cbor_writer_t *writer)¶

Serializes a blake2b_hash into CBOR format using a CBOR writer.

This function serializes the given cardano_blake2b_hash_set_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_blake2b_hash_set_t* blake2b_hash = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_blake2b_hash_set_to_cbor(blake2b_hash, 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_blake2b_hash_set_unref(&blake2b_hash);

Parameters:¶

const cardano_blake2b_hash_set_t *blake2b_hashs¶

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

cardano_error_t cardano_blake2b_hash_set_to_cip116_json(const cardano_blake2b_hash_set_t *hashes, cardano_json_writer_t *json)¶

Serializes a set of BLAKE2b-256 hashes to CIP-116 JSON.

Writes exactly one JSON array of lowercase hex strings (each 64 hex chars):

[
  "0000000000000000000000000000000000000000000000000000000000000000",
  "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
]

An empty set produces

[]

.

Parameters:¶

const cardano_blake2b_hash_set_t *hashes¶

[in] A valid set of hashes to serialize. Must not be NULL.

cardano_json_writer_t *json¶

[inout] A valid JSON writer positioned where a value is expected. Must not be NULL.

Returns:¶

CARDANO_SUCCESS on success; an appropriate error code otherwise.

size_t cardano_blake2b_hash_set_get_length(const cardano_blake2b_hash_set_t *blake2b_hash_set)¶

Retrieves the length of a blake2b_hash list.

This function retrieves the number of elements in the provided cardano_blake2b_hash_set_t object.

Usage Example:

cardano_blake2b_hash_set_t* blake2b_hash_set = cardano_blake2b_hash_set_new();

// Populate blake2b_hash_set with elements

size_t length = cardano_blake2b_hash_set_get_length(blake2b_hash_set);
printf("Length of the blake2b_hash_set: %zu\n", length);

// Clean up the blake2b_hash_set object once done
cardano_blake2b_hash_set_unref(&blake2b_hash_set);

Parameters:¶

const cardano_blake2b_hash_set_t *blake2b_hash_set¶

[in] A constant pointer to the cardano_blake2b_hash_set_t object whose length is to be retrieved.

Returns:¶

The number of elements in the blake2b_hash_set. Return 0 if the blake2b_hash_set is NULL.

cardano_error_t cardano_blake2b_hash_set_get(const cardano_blake2b_hash_set_t *blake2b_hash_set, size_t index, cardano_blake2b_hash_t **element)¶

Retrieves an element from a blake2b_hash list by index.

This function retrieves the element at the specified index from the provided cardano_blake2b_hash_set_t object and stores it in the output parameter.

Usage Example:

cardano_blake2b_hash_set_t* blake2b_hash_set = cardano_blake2b_hash_set_new();

// Populate blake2b_hash_set with elements

cardano_blake2b_hash_t* element = NULL;
cardano_error_t result = cardano_blake2b_hash_set_get(blake2b_hash_set, 2, &element);

if (result == CARDANO_SUCCESS)
{
  // Use the retrieved element
  // Remember to unreference the element once done if it's no longer needed
  cardano_blake2b_hash_unref(&element);
}

// Clean up the blake2b_hash_set object once done
cardano_blake2b_hash_set_unref(&blake2b_hash_set);

Parameters:¶

const cardano_blake2b_hash_set_t *blake2b_hash_set¶

[in] A constant pointer to the cardano_blake2b_hash_set_t object from which the element is to be retrieved.

size_t index¶

[in] The index of the element to retrieve from the blake2b_hash list. Indexing starts at 0.

cardano_blake2b_hash_t **element¶

[out] Pointer to a variable where the retrieved element will be stored. This variable will point to the retrieved cardano_blake2b_hash_t object. The caller is responsible for managing the lifecycle of the element by calling cardano_blake2b_hash_unref when it is no longer needed.

Returns:¶

CARDANO_SUCCESS if the element was successfully retrieved, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_blake2b_hash_set_add(cardano_blake2b_hash_set_t *blake2b_hash_set, cardano_blake2b_hash_t *element)¶

Adds an element to a blake2b_hash list.

This function adds the specified element to the end of the provided cardano_blake2b_hash_set_t object.

Usage Example:

cardano_blake2b_hash_set_t* blake2b_hash_set = cardano_blake2b_hash_set_new();

// Create and initialize a new blake2b_hash element
cardano_blake2b_hash_t* element = { ... };

// Add the element to the blake2b_hash_set
cardano_error_t result = cardano_blake2b_hash_set_add(blake2b_hash_set, element);

if (result == CARDANO_SUCCESS)
{
  // Element added successfully
}

// Clean up the blake2b_hash_set object once done
cardano_blake2b_hash_set_unref(&blake2b_hash_set);

Parameters:¶

cardano_blake2b_hash_set_t *blake2b_hash_set¶

[in] A constant pointer to the cardano_blake2b_hash_set_t object to which the element is to be added.

cardano_blake2b_hash_t *element¶

[in] Pointer to the cardano_blake2b_hash_t object that is to be added to the blake2b_hash_set. The element will be referenced by the blake2b_hash_set after addition.

Returns:¶

CARDANO_SUCCESS if the element was successfully added to the blake2b_hash_set, or an appropriate error code indicating the failure reason.

void cardano_blake2b_hash_set_unref(cardano_blake2b_hash_set_t **blake2b_hash_set)¶

Decrements the reference count of a blake2b_hash_set object.

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

Usage Example:

cardano_blake2b_hash_set_t* blake2b_hash_set = cardano_blake2b_hash_set_new();

// Perform operations with the blake2b_hash_set...

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

Note

After calling cardano_blake2b_hash_set_unref, the pointer to the cardano_blake2b_hash_set_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_blake2b_hash_set_t **blake2b_hash_set¶

[inout] A pointer to the pointer of the blake2b_hash_set 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_blake2b_hash_set_ref(cardano_blake2b_hash_set_t *blake2b_hash_set)¶

Increases the reference count of the cardano_blake2b_hash_set_t object.

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

Usage Example:

// Assuming blake2b_hash_set is a previously created blake2b_hash_set object

cardano_blake2b_hash_set_ref(blake2b_hash_set);

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

Note

Always ensure that for every call to cardano_blake2b_hash_set_ref there is a corresponding call to cardano_blake2b_hash_set_unref to prevent memory leaks.

Parameters:¶

cardano_blake2b_hash_set_t *blake2b_hash_set¶

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

size_t cardano_blake2b_hash_set_refcount(const cardano_blake2b_hash_set_t *blake2b_hash_set)¶

Retrieves the current reference count of the cardano_blake2b_hash_set_t object.

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

Usage Example:

// Assuming blake2b_hash_set is a previously created blake2b_hash_set object

size_t ref_count = cardano_blake2b_hash_set_refcount(blake2b_hash_set);

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_blake2b_hash_set_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_blake2b_hash_set_t *blake2b_hash_set¶

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

Returns:¶

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

void cardano_blake2b_hash_set_set_last_error(cardano_blake2b_hash_set_t *blake2b_hash_set, const char *message)¶

Sets the last error message for a given blake2b_hash_set object.

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

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

const char *cardano_blake2b_hash_set_get_last_error(const cardano_blake2b_hash_set_t *blake2b_hash_set)¶

Retrieves the last error message recorded for a specific blake2b_hash_set.

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

Parameters:¶

const cardano_blake2b_hash_set_t *blake2b_hash_set¶

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

Returns:¶

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