Direct Deposit Map¶

typedef struct cardano_direct_deposit_map_t cardano_direct_deposit_map_t¶

Represents a map of reward address to lovelace amount.

A transaction body uses this map to credit reward accounts directly with lovelace, without creating a UTxO output. Each entry maps a reward address to the amount of lovelace deposited into that account.

cardano_error_t cardano_direct_deposit_map_new(cardano_direct_deposit_map_t **direct_deposit_map)¶

Creates and initializes a new instance of a direct deposit map.

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

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = NULL;

// Attempt to create a new direct_deposit_map
cardano_error_t result = cardano_direct_deposit_map_new(&direct_deposit_map);

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

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

Parameters:¶

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

Returns:¶

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

cardano_error_t cardano_direct_deposit_map_from_cbor(cardano_cbor_reader_t *reader, cardano_direct_deposit_map_t **direct_deposit_map)¶

Creates a direct deposit map from a CBOR reader.

This function parses CBOR data using a provided cardano_cbor_reader_t and constructs a cardano_direct_deposit_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 direct deposit map.

The map must not be empty on the wire; decoding an empty map fails with CARDANO_ERROR_INVALID_CBOR_MAP_SIZE. A map that contains the same reward address more than once fails with CARDANO_ERROR_DUPLICATED_KEY.

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_direct_deposit_map_t* direct_deposit_map = NULL;

cardano_error_t result = cardano_direct_deposit_map_from_cbor(reader, &direct_deposit_map);

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

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

Returns:¶

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

cardano_error_t cardano_direct_deposit_map_to_cbor(const cardano_direct_deposit_map_t *direct_deposit_map, cardano_cbor_writer_t *writer)¶

Serializes a direct deposit map into CBOR format using a CBOR writer.

This function serializes the given cardano_direct_deposit_map_t object using a cardano_cbor_writer_t. Entries are written in insertion order.

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_direct_deposit_map_to_cbor(direct_deposit_map, 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_direct_deposit_map_unref(&direct_deposit_map);

Parameters:¶

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

size_t cardano_direct_deposit_map_get_length(const cardano_direct_deposit_map_t *direct_deposit_map)¶

Retrieves the length of the direct_deposit_map.

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

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = NULL;
cardano_error_t result = cardano_direct_deposit_map_new(&direct_deposit_map);

// Populate the direct_deposit_map with key-value pairs

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

cardano_direct_deposit_map_unref(&direct_deposit_map);

Parameters:¶

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

Returns:¶

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

cardano_error_t cardano_direct_deposit_map_get(const cardano_direct_deposit_map_t *direct_deposit_map, cardano_reward_address_t *key, uint64_t *element)¶

Retrieves the deposit amount associated with a given reward address in the direct deposit map.

This function retrieves the lovelace amount associated with the specified reward address in the provided direct deposit map. It returns the amount through the output parameter element. If the reward address is not found in the map, the function returns CARDANO_ERROR_ELEMENT_NOT_FOUND.

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = ...;
cardano_reward_address_t* key = ...; // Create a reward address object representing the key
uint64_t amount = 0;

cardano_error_t result = cardano_direct_deposit_map_get(direct_deposit_map, key, &amount);

if (result == CARDANO_SUCCESS)
{
  // Use the retrieved amount
}
else
{
  // Handle error or key not found
}

cardano_reward_address_unref(&key); // Clean up the key resource
cardano_direct_deposit_map_unref(&direct_deposit_map);

Parameters:¶

const cardano_direct_deposit_map_t *direct_deposit_map¶: [in] A constant pointer to the cardano_direct_deposit_map_t object from which the deposit amount is to be retrieved.
cardano_reward_address_t *key¶: [in] The reward address whose associated deposit amount is to be retrieved from the direct_deposit_map.
uint64_t *element¶: [out] A pointer to a variable where the retrieved deposit amount will be stored. If the reward address is found in the direct_deposit_map, this variable will be set to the associated amount.

Returns:¶

CARDANO_SUCCESS if the deposit amount was found, CARDANO_ERROR_ELEMENT_NOT_FOUND if the reward address is not present in the map, or an appropriate error code if the input parameters are invalid.

cardano_error_t cardano_direct_deposit_map_insert(cardano_direct_deposit_map_t *direct_deposit_map, cardano_reward_address_t *key, uint64_t value)¶

Inserts a key-value pair into the direct deposit map.

This function inserts the specified reward address and deposit amount into the provided direct deposit map. Entries keep their insertion order when the map is serialized. Inserting a reward address that is already present in the map fails with CARDANO_ERROR_DUPLICATED_KEY.

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = NULL;
cardano_error_t result = cardano_direct_deposit_map_new(&direct_deposit_map);

// Create the key object
cardano_reward_address_t* key = ...;
const uint64_t value = 1000000;

// Insert the key-value pair into the direct_deposit_map
result = cardano_direct_deposit_map_insert(direct_deposit_map, key, value);

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

// Clean up the key object
cardano_reward_address_unref(&key);

cardano_direct_deposit_map_unref(&direct_deposit_map);

Parameters:¶

cardano_direct_deposit_map_t *direct_deposit_map¶: [in] A constant pointer to the cardano_direct_deposit_map_t object where the key-value pair is to be inserted.
cardano_reward_address_t *key¶: [in] The reward address to be inserted into the direct deposit map. The caller is responsible for managing the lifecycle of the key object.
uint64_t value¶: [in] The amount of lovelace to deposit into the reward account.

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_direct_deposit_map_insert_ex(cardano_direct_deposit_map_t *direct_deposit_map, const char *reward_address, size_t reward_address_size, uint64_t value)¶

Inserts a direct deposit entry into the direct deposit map using a reward address.

This function inserts a direct deposit entry into the specified cardano_direct_deposit_map_t object. The deposit is associated with a reward address and specifies the amount of lovelace credited to that account.

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = ...; // Assume initialized
const char* reward_address = "stake1u..."; // Bech32-encoded reward address
uint64_t deposit_value = 1000000; // 1 ADA in lovelace

cardano_error_t result = cardano_direct_deposit_map_insert_ex(direct_deposit_map, reward_address, strlen(reward_address), deposit_value);

if (result == CARDANO_SUCCESS)
{
  // Deposit entry successfully added
}
else
{
  printf("Failed to insert deposit entry: %s\n", cardano_error_to_string(result));
}

// Cleanup when done
cardano_direct_deposit_map_unref(&direct_deposit_map);

Parameters:¶

cardano_direct_deposit_map_t *direct_deposit_map¶: [inout] A pointer to the cardano_direct_deposit_map_t object where the deposit entry will be inserted.
const char *reward_address¶: [in] A pointer to a string representing the Bech32-encoded reward address. This parameter must not be NULL.
size_t reward_address_size¶: [in] The length of the reward address string in bytes.
uint64_t value¶: [in] The amount of ADA (in lovelace) to deposit into the reward account.

Returns:¶

CARDANO_SUCCESS if the deposit entry was successfully inserted into the map, or an appropriate error code indicating the type of failure.

cardano_error_t cardano_direct_deposit_map_get_keys(cardano_direct_deposit_map_t *direct_deposit_map, cardano_reward_address_list_t **keys)¶

Retrieves the keys from the direct deposit map.

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

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = NULL;
cardano_error_t result = cardano_direct_deposit_map_new(&direct_deposit_map);

// Populate the direct_deposit_map with key-value pairs

cardano_reward_address_list_t* keys = NULL;
result = cardano_direct_deposit_map_get_keys(direct_deposit_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_reward_address_list_unref(&keys);
}
else
{
  // Handle error
}

cardano_direct_deposit_map_unref(&direct_deposit_map);

Parameters:¶

cardano_direct_deposit_map_t *direct_deposit_map¶: [in] A constant pointer to the cardano_direct_deposit_map_t object from which the keys are to be retrieved.
cardano_reward_address_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_reward_address_list_unref 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_direct_deposit_map_get_key_at(const cardano_direct_deposit_map_t *direct_deposit_map, size_t index, cardano_reward_address_t **reward_address)¶

Retrieves the reward address at a specific index from the direct deposit map.

This function retrieves the reward address at the specified index from the direct deposit map.

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = NULL;
cardano_reward_address_t* reward_address = NULL;
size_t index = 0; // Index of the reward address to retrieve

// Assume direct_deposit_map is initialized properly

cardano_error_t result = cardano_direct_deposit_map_get_key_at(direct_deposit_map, index, &reward_address);

if (result == CARDANO_SUCCESS)
{
  // Use the reward address

  // Once done, ensure to clean up and release the reward address
  cardano_reward_address_unref(&reward_address);
}
else
{
  // Handle the error
}

Parameters:¶

const cardano_direct_deposit_map_t *direct_deposit_map¶: [in] Pointer to the direct deposit map object.
size_t index¶: [in] The index of the reward address to retrieve.
cardano_reward_address_t **reward_address¶: [out] On successful retrieval, this will point to the reward address at the specified index. The caller is responsible for managing the lifecycle of this object. Specifically, once the reward address is no longer needed, the caller must release it by calling cardano_reward_address_unref.

Returns:¶

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

cardano_error_t cardano_direct_deposit_map_get_value_at(const cardano_direct_deposit_map_t *direct_deposit_map, size_t index, uint64_t *amount)¶

Retrieves the deposit amount at a specific index from the direct deposit map.

This function retrieves the lovelace amount at the specified index from the direct deposit map.

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = NULL;
uint64_t amount = 0;
size_t index = 0; // Index of the deposit amount to retrieve

// Assume direct_deposit_map is initialized properly

cardano_error_t result = cardano_direct_deposit_map_get_value_at(direct_deposit_map, index, &amount);

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

Parameters:¶

const cardano_direct_deposit_map_t *direct_deposit_map¶: [in] Pointer to the direct deposit map object.
size_t index¶: [in] The index of the deposit amount to retrieve.
uint64_t *amount¶: [out] On successful retrieval, this will point to the deposit amount at the specified index.

Returns:¶

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

cardano_error_t cardano_direct_deposit_map_get_key_value_at(const cardano_direct_deposit_map_t *direct_deposit_map, size_t index, cardano_reward_address_t **reward_address, uint64_t *amount)¶

Retrieves the reward address and deposit amount at the specified index.

This function retrieves the reward address and its associated lovelace amount from the direct deposit map at the specified index.

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = NULL;
// Assume direct_deposit_map is initialized properly

size_t index = 0;
cardano_reward_address_t* reward_address = NULL;
uint64_t amount = 0;

cardano_error_t result = cardano_direct_deposit_map_get_key_value_at(direct_deposit_map, index, &reward_address, &amount);

if (result == CARDANO_SUCCESS)
{
  // Use the reward address and the amount
}
else
{
  // Handle error
  printf("Failed to get key-value pair at index %zu.\n", index);
}

// Clean up
cardano_direct_deposit_map_unref(&direct_deposit_map);
cardano_reward_address_unref(&reward_address);

Parameters:¶

const cardano_direct_deposit_map_t *direct_deposit_map¶: [in] Pointer to the direct deposit map object.
size_t index¶: [in] The index at which to retrieve the key-value pair.
cardano_reward_address_t **reward_address¶: [out] On successful retrieval, this will point to the reward address at the specified index. The caller is responsible for managing the lifecycle of this object and should release it using cardano_reward_address_unref when it is no longer needed.
uint64_t *amount¶: [out] On successful retrieval, this will point to the deposit 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.

void cardano_direct_deposit_map_unref(cardano_direct_deposit_map_t **direct_deposit_map)¶

Decrements the reference count of a direct_deposit_map object.

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

Usage Example:

cardano_direct_deposit_map_t* direct_deposit_map = NULL;
cardano_error_t result = cardano_direct_deposit_map_new(&direct_deposit_map);

// Perform operations with the direct_deposit_map...

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

Note

After calling cardano_direct_deposit_map_unref, the pointer to the cardano_direct_deposit_map_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_direct_deposit_map_t **direct_deposit_map¶: [inout] A pointer to the pointer of the direct_deposit_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_direct_deposit_map_ref(cardano_direct_deposit_map_t *direct_deposit_map)¶

Increases the reference count of the cardano_direct_deposit_map_t object.

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

Usage Example:

// Assuming direct_deposit_map is a previously created direct_deposit_map object

cardano_direct_deposit_map_ref(direct_deposit_map);

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

Note

Always ensure that for every call to cardano_direct_deposit_map_ref there is a corresponding call to cardano_direct_deposit_map_unref to prevent memory leaks.

Parameters:¶

cardano_direct_deposit_map_t *direct_deposit_map¶: A pointer to the direct_deposit_map object whose reference count is to be incremented.

size_t cardano_direct_deposit_map_refcount(const cardano_direct_deposit_map_t *direct_deposit_map)¶

Retrieves the current reference count of the cardano_direct_deposit_map_t object.

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

Usage Example:

// Assuming direct_deposit_map is a previously created direct_deposit_map object

size_t ref_count = cardano_direct_deposit_map_refcount(direct_deposit_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_direct_deposit_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_direct_deposit_map_t *direct_deposit_map¶: A pointer to the direct_deposit_map object whose reference count is queried. The object must not be NULL.

Returns:¶

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

void cardano_direct_deposit_map_set_last_error(cardano_direct_deposit_map_t *direct_deposit_map, const char *message)¶

Sets the last error message for a given direct_deposit_map object.

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

const char *cardano_direct_deposit_map_get_last_error(const cardano_direct_deposit_map_t *direct_deposit_map)¶

Retrieves the last error message recorded for a specific direct_deposit_map.

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

Parameters:¶

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

Returns:¶

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