Asset ID Map¶

typedef struct cardano_asset_id_map_t cardano_asset_id_map_t¶: Represents a map of asset id to coin amount.

cardano_error_t cardano_asset_id_map_new(cardano_asset_id_map_t **asset_id_map)¶

Creates and initializes a new instance of a asset id map.

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

Usage Example:

cardano_asset_id_map_t* asset_id_map = NULL;

// Attempt to create a new asset_id_map
cardano_error_t result = cardano_asset_id_map_new(&asset_id_map);

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

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

Parameters:¶

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

Returns:¶

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

size_t cardano_asset_id_map_get_length(const cardano_asset_id_map_t *asset_id_map)¶

Retrieves the length of the asset_id_map.

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

Usage Example:

cardano_asset_id_map_t* asset_id_map = cardano_asset_id_map_new();

// Populate the asset_id_map with key-value pairs

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

cardano_asset_id_map_unref(&asset_id_map);

Parameters:¶

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

Returns:¶

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

cardano_error_t cardano_asset_id_map_get(cardano_asset_id_map_t *asset_id_map, cardano_asset_id_t *key, int64_t *element)¶

Retrieves the value associated with a given key in the asset id map.

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

Usage Example:

cardano_asset_id_map_t* asset_id_map = cardano_asset_id_map_new();

// Populate the asset_id_map with key-value pairs

cardano_asset_id_t* key = ...; // Create a asset_id object representing the key
int64_t value = 0;
cardano_error_t result = cardano_asset_id_map_get(asset_id_map, key, &value);

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

cardano_asset_id_unref(&key); // Clean up the key resource
cardano_asset_id_map_unref(&asset_id_map);

Parameters:¶

cardano_asset_id_map_t *asset_id_map¶: [in] A constant pointer to the cardano_asset_id_map_t object from which the value is to be retrieved.
cardano_asset_id_t *key¶: [in] The key whose associated value is to be retrieved from the asset_id_map.
int64_t *element¶: [out] A pointer to a variable where the retrieved value will be stored. If the key is found in the asset id 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_asset_id_map_insert(cardano_asset_id_map_t *asset_id_map, cardano_asset_id_t *key, int64_t value)¶

Inserts a key-value pair into the asset id map.

This function inserts the specified key-value pair into the provided asset id map.

Usage Example:

cardano_asset_id_map_t* asset_id_map = cardano_asset_id_map_new();

// Create key and value objects
cardano_asset_id_t* key = ...;
int64_t value = 0;

// Insert the key-value pair into the asset_id_map
cardano_error_t result = cardano_asset_id_map_insert(asset_id_map, key, value);

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

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

cardano_asset_id_map_unref(&asset_id_map);

Remark

If the key already exists in the asset id map, the value associated with the key will be updated.

Parameters:¶

cardano_asset_id_map_t *asset_id_map¶: [in] A constant pointer to the cardano_asset_id_map_t object where the key-value pair is to be inserted.
cardano_asset_id_t *key¶: [in] The key to be inserted into the asset id map. The caller is responsible for managing the lifecycle of the key object.
int64_t value¶: [in] The value to be associated with the key and inserted into the asset_id_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_asset_id_map_get_keys(cardano_asset_id_map_t *asset_id_map, cardano_asset_id_list_t **keys)¶

Retrieves the keys from the asset id map.

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

Usage Example:

cardano_asset_id_map_t* asset_id_map = cardano_asset_id_map_new();

// Populate the asset_id_map with key-value pairs

cardano_asset_id_list_t* keys = NULL;
cardano_error_t result = cardano_asset_id_map_get_keys(asset_id_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_asset_id_list_unref(&keys);
}
else
{
  // Handle error
}

cardano_asset_id_map_unref(&asset_id_map);

Parameters:¶

cardano_asset_id_map_t *asset_id_map¶: [in] A constant pointer to the cardano_asset_id_map_t object from which the keys are to be retrieved.
cardano_asset_id_list_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_asset_id_list_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_asset_id_map_get_key_at(const cardano_asset_id_map_t *asset_id_map, size_t index, cardano_asset_id_t **asset_id)¶

Retrieves the asset id at a specific index from the asset id map.

This function retrieves the asset id at the specified index from the asset id map.

Usage Example:

cardano_asset_id_map_t* asset_id_map = NULL;
cardano_asset_id_t* asset_id = NULL;
size_t index = 0; // Index of the key hash to retrieve

// Assume asset_id_map is initialized properly

cardano_error_t result = cardano_asset_id_map_get_key_at(asset_id_map, index, &asset_id);

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

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

Parameters:¶

const cardano_asset_id_map_t *asset_id_map¶: [in] Pointer to the asset id map object.
size_t index¶: [in] The index of the asset id to retrieve.
cardano_asset_id_t **asset_id¶: [out] On successful retrieval, this will point to the asset id at the specified index. The caller is responsible for managing the lifecycle of this object. Specifically, once the asset id is no longer needed, the caller must release it by calling cardano_asset_id_unref.

Returns:¶

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

cardano_error_t cardano_asset_id_map_get_value_at(const cardano_asset_id_map_t *asset_id_map, size_t index, int64_t *amount)¶

Retrieves the withdrawal amount at a specific index from the asset id map.

This function retrieves the withdrawal amount at the specified index from the asset id map.

Usage Example:

cardano_asset_id_map_t* asset_id_map = NULL;
int64_t amount = 0;
size_t index = 0; // Index of the withdrawal amount to retrieve

// Assume asset_id_map is initialized properly

cardano_error_t result = cardano_asset_id_map_get_value_at(asset_id_map, index, &amount);

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

Parameters:¶

const cardano_asset_id_map_t *asset_id_map¶: [in] Pointer to the asset id map object.
size_t index¶: [in] The index of the withdrawal amount to retrieve.
int64_t *amount¶: [out] On successful retrieval, this will point to the withdrawal amount at the specified index.

Returns:¶

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

cardano_error_t cardano_asset_id_map_get_key_value_at(const cardano_asset_id_map_t *asset_id_map, size_t index, cardano_asset_id_t **asset_id, int64_t *amount)¶

Retrieves the asset id and withdrawal amount at the specified index.

This function retrieves the asset id and withdrawal amount from the proposed withdrawal amounts at the specified index.

Usage Example:

cardano_asset_id_map_t* asset_id_map = NULL;
// Assume asset_id_map is initialized properly

size_t index = 0;
cardano_asset_id_t* asset_id = NULL;
int64_t amount = 0;

cardano_error_t result = cardano_asset_id_map_get_key_value_at(asset_id_map, index, &asset_id, &amount);

if (result == CARDANO_SUCCESS)
{
  if (asset_id != NULL && amount != NULL)
  {
    // Use the asset id and withdrawal amount
  }
  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_asset_id_map_unref(&asset_id_map);
cardano_asset_id_unref(&asset_id);

Parameters:¶

const cardano_asset_id_map_t *asset_id_map¶: [in] Pointer to the proposed withdrawal amounts object.
size_t index¶: [in] The index at which to retrieve the key-value pair.
cardano_asset_id_t **asset_id¶: [out] On successful retrieval, this will point to the asset id at the specified index. The caller is responsible for managing the lifecycle of this object and should release it using cardano_asset_id_unref when it is no longer needed.
int64_t *amount¶: [out] On successful retrieval, this will point to the withdrawal amount 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.

cardano_error_t cardano_asset_id_map_add(const cardano_asset_id_map_t *lhs, const cardano_asset_id_map_t *rhs, cardano_asset_id_map_t **result)¶

Combines two asset id maps by adding the quantities of assets with the same asset ids.

This function adds the asset quantities from two cardano_asset_id_map_t objects. It combines the quantities of assets that have the same asset ids. If an asset id exists in both maps, their quantities are summed. If an asset id exists in only one of the maps, its quantity is copied to the result.

Usage Example:

const cardano_asset_id_map_t* lhs = ...; // Assume lhs is already initialized with some assets
const cardano_asset_id_map_t* rhs = ...; // Assume rhs is also initialized with some assets
cardano_asset_id_map_t* result = NULL;

cardano_error_t add_result = cardano_asset_id_map_add(lhs, rhs, &result);
if (add_result == CARDANO_SUCCESS)
{
  // The assets have been successfully combined
  // Use the result as needed

  // When done, release the result
  cardano_asset_id_map_unref(&result);
}
else
{
  printf("Failed to combine assets: %s\n", cardano_error_to_string(add_result));
}

// Cleanup resources
cardano_asset_id_map_unref(&lhs);
cardano_asset_id_map_unref(&rhs);

Parameters:¶

const cardano_asset_id_map_t *lhs¶: [in] A constant pointer to the first cardano_asset_id_map_t object.
const cardano_asset_id_map_t *rhs¶: [in] A constant pointer to the second cardano_asset_id_map_t object.
cardano_asset_id_map_t **result¶: [out] On successful execution, this will point to a newly created cardano_asset_id_map_t object that represents the combined result of both input asset id maps. The result is dynamically allocated and must be freed by the caller using cardano_asset_id_map_unref when it is no longer needed.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the assets were successfully combined, 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_asset_id_map_subtract(const cardano_asset_id_map_t *lhs, const cardano_asset_id_map_t *rhs, cardano_asset_id_map_t **result)¶

Subtracts the quantities of assets under each asset id from one asset id map to another.

This function subtracts the assets from the second cardano_asset_id_map_t object (rhs) from the first cardano_asset_id_map_t object (lhs). It subtracts the quantities of assets under each asset id present in both maps. If an asset id exists only in the rhs, the value is copied as negative, effectively subtracting it from the lhs. If an asset id exists only in the lhs, the value is copied as is to the result.

Usage Example:

const cardano_asset_id_map_t* lhs = ...; // Assume lhs is already initialized with some assets
const cardano_asset_id_map_t* rhs = ...; // Assume rhs is also initialized with some assets to subtract
cardano_asset_id_map_t* result = NULL;

cardano_error_t subtract_result = cardano_asset_id_map_subtract(lhs, rhs, &result);
if (subtract_result == CARDANO_SUCCESS)
{
  // The assets have been successfully subtracted
  // Use the result
  cardano_asset_id_map_unref(&result);
}
else
{
  printf("Failed to subtract assets: %s\n", cardano_error_to_string(subtract_result));
}

// Cleanup resources
cardano_asset_id_map_unref(&lhs);
cardano_asset_id_map_unref(&rhs);

Parameters:¶

const cardano_asset_id_map_t *lhs¶: [in] A constant pointer to the first cardano_asset_id_map_t object from which assets will be subtracted.
const cardano_asset_id_map_t *rhs¶: [in] A constant pointer to the second cardano_asset_id_map_t object that provides the quantities to subtract.
cardano_asset_id_map_t **result¶: [out] On successful execution, this will point to a newly created cardano_asset_id_map_t object that represents the result of the subtraction. The result is dynamically allocated and must be freed by the caller using cardano_asset_id_map_unref when it is no longer needed.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the assets were successfully subtracted, or an appropriate error code indicating the failure reason, such as CARDANO_ERROR_POINTER_IS_NULL if any of the input pointers are NULL.

bool cardano_asset_id_map_equals(const cardano_asset_id_map_t *lhs, const cardano_asset_id_map_t *rhs)¶

Compares two asset id map objects for equality.

This function compares two asset_id_map objects to determine if they are equal.

Usage Example:

cardano_asset_id_map_t* asset_id_map1 = NULL;
cardano_asset_id_map_t* asset_id_map2 = NULL;

// Assume asset_id_map1 and asset_id_map2 are initialized properly

bool are_equal = cardano_asset_id_map_equals(asset_id_map1, asset_id_map2);

if (are_equal)
{
  printf("The asset_id_map objects are equal.\n");
}
else
{
  printf("The asset_id_map objects are not equal.\n");
}

// Clean up
cardano_asset_id_map_unref(&asset_id_map1);
cardano_asset_id_map_unref(&asset_id_map2);

Parameters:¶

const cardano_asset_id_map_t *lhs¶: [in] Pointer to the first asset id map object.
const cardano_asset_id_map_t *rhs¶: [in] Pointer to the second asset id map object.

Returns:¶

true if the asset id map objects are equal, false otherwise.

void cardano_asset_id_map_unref(cardano_asset_id_map_t **asset_id_map)¶

Decrements the reference count of a asset_id_map object.

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

Usage Example:

cardano_asset_id_map_t* asset_id_map = cardano_asset_id_map_new();

// Perform operations with the asset_id_map...

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

Note

After calling cardano_asset_id_map_unref, the pointer to the cardano_asset_id_map_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_asset_id_map_t **asset_id_map¶: [inout] A pointer to the pointer of the asset_id_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_asset_id_map_ref(cardano_asset_id_map_t *asset_id_map)¶

Increases the reference count of the cardano_asset_id_map_t object.

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

Usage Example:

// Assuming asset_id_map is a previously created asset_id_map object

cardano_asset_id_map_ref(asset_id_map);

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

Note

Always ensure that for every call to cardano_asset_id_map_ref there is a corresponding call to cardano_asset_id_map_unref to prevent memory leaks.

Parameters:¶

cardano_asset_id_map_t *asset_id_map¶: A pointer to the asset_id_map object whose reference count is to be incremented.

size_t cardano_asset_id_map_refcount(const cardano_asset_id_map_t *asset_id_map)¶

Retrieves the current reference count of the cardano_asset_id_map_t object.

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

Usage Example:

// Assuming asset_id_map is a previously created asset_id_map object

size_t ref_count = cardano_asset_id_map_refcount(asset_id_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_asset_id_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_asset_id_map_t *asset_id_map¶: A pointer to the asset_id_map object whose reference count is queried. The object must not be NULL.

Returns:¶

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

void cardano_asset_id_map_set_last_error(cardano_asset_id_map_t *asset_id_map, const char *message)¶

Sets the last error message for a given asset_id_map object.

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

const char *cardano_asset_id_map_get_last_error(const cardano_asset_id_map_t *asset_id_map)¶

Retrieves the last error message recorded for a specific asset_id_map.

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

Parameters:¶

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

Returns:¶

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