MIR To Stake Credentials¶

typedef struct cardano_mir_to_stake_creds_cert_t cardano_mir_to_stake_creds_cert_t¶

Creates a move instantaneous rewards certificate that transfers funds to the given set of reward accounts.

cardano_error_t cardano_mir_to_stake_creds_cert_new(cardano_mir_cert_pot_type_t pot_type, cardano_mir_to_stake_creds_cert_t **mir_to_stake_creds_cert)¶

Creates a new Move Instantaneous Rewards to Stake Credentials certificate.

This function allocates and initializes a new instance of a cardano_mir_to_stake_creds_cert_t, which is used to facilitate the transfer of rewards to a set of stake credentials directly. The newly created certificate is capable of storing mappings from stake credentials to the amount of ADA to be transferred.

Usage Example:

cardano_mir_to_stake_creds_cert_t* cert = NULL;
cardano_error_t result = cardano_mir_to_stake_creds_cert_new(CARDANO_MIR_CERT_POT_TYPE_RESERVE, &cert);

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

  // Once done, ensure to clean up and release the certificate
  cardano_mir_to_stake_creds_cert_unref(&cert);
}

Parameters:¶

cardano_mir_cert_pot_type_t pot_type¶

[in] Determines the accounting pot from which the funds will be drawn. This is specified by the cardano_mir_to_pot_cert_t enumeration, which includes options for the reserve pot or the treasury pot.

cardano_mir_to_stake_creds_cert_t **mir_to_stake_creds_cert¶

[out] On successful execution, this will point to the newly created cardano_mir_to_stake_creds_cert_t object. The caller is responsible for managing the lifecycle of this object, including freeing it with the appropriate function when it is no longer needed.

Returns:¶

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

cardano_error_t cardano_mir_to_stake_creds_cert_from_cbor(cardano_cbor_reader_t *reader, cardano_mir_to_stake_creds_cert_t **mir_to_stake_creds_cert)¶

Creates a cardano_mir_to_stake_creds_cert_t from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_mir_to_stake_creds_cert_t* mir_to_stake_creds_cert = NULL;

cardano_error_t result = cardano_mir_to_stake_creds_cert_from_cbor(reader, &mir_to_stake_creds_cert);

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

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

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

Serializes the certificate into CBOR format using a CBOR writer.

This function serializes the given cardano_mir_to_stake_creds_cert_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_mir_to_stake_creds_cert_t* mir_to_stake_creds_cert = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_mir_to_stake_creds_cert_to_cbor(mir_to_stake_creds_cert, 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_mir_to_stake_creds_cert_unref(&mir_to_stake_creds_cert);

Parameters:¶

const cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert¶

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

cardano_error_t cardano_mir_to_stake_creds_cert_to_cip116_json(const cardano_mir_to_stake_creds_cert_t *cert, cardano_json_writer_t *writer)¶

Serializes a MIR-to-stake-credentials certificate to CIP-116 JSON.

Keys are written in deterministic order: “tag”, “pot”, then “rewards”. The function writes the full JSON object, including surrounding braces.

Parameters:¶

const cardano_mir_to_stake_creds_cert_t *cert¶

[in] Pointer to a valid cardano_mir_to_stake_creds_cert_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 cert or writer is NULL. CARDANO_ERROR_ENCODING If required fields are missing/invalid. Other Any error propagated from nested writers.

cardano_error_t cardano_mir_to_stake_creds_cert_get_pot(const cardano_mir_to_stake_creds_cert_t *mir_cert, cardano_mir_cert_pot_type_t *type)¶

Retrieves the source pot type from a Move Instantaneous Reward (MIR) certificate to stake credentials.

This function gets the type of pot from which the funds are drawn in the given cardano_mir_to_stake_creds_cert_t object.

Usage Example:

cardano_mir_to_stake_creds_cert_t* mir_cert = ...; // Assume this is initialized
cardano_mir_cert_pot_type_t type;
cardano_error_t result = cardano_mir_to_stake_creds_cert_get_pot(mir_cert, &type);

if (result == CARDANO_SUCCESS)
{
  // Type was successfully retrieved
}

Parameters:¶

const cardano_mir_to_stake_creds_cert_t *mir_cert¶

[in] A constant pointer to the cardano_mir_to_stake_creds_cert_t object.

cardano_mir_cert_pot_type_t *type¶

[out] A pointer to the cardano_mir_cert_pot_type_t where the type will be stored.

Returns:¶

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

cardano_error_t cardano_mir_to_stake_creds_cert_set_pot(cardano_mir_to_stake_creds_cert_t *mir_cert, cardano_mir_cert_pot_type_t type)¶

Sets the source pot type in a Move Instantaneous Reward (MIR) certificate to stake credentials.

This function sets the type of pot from which the funds are drawn in the given cardano_mir_to_stake_creds_cert_t object.

Usage Example:

cardano_mir_to_stake_creds_cert_t* mir_cert = ...; // Assume this is initialized
cardano_mir_cert_pot_type_t type = CARDANO_MIR_CERT_POT_TYPE_TREASURY;
cardano_error_t result = cardano_mir_to_stake_creds_cert_set_pot(mir_cert, type);

if (result == CARDANO_SUCCESS)
{
  // Type was successfully set
}

Parameters:¶

cardano_mir_to_stake_creds_cert_t *mir_cert¶

[in] A pointer to the cardano_mir_to_stake_creds_cert_t object.

cardano_mir_cert_pot_type_t type¶

[in] The cardano_mir_cert_pot_type_t value representing the source pot type to be set.

Returns:¶

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

size_t cardano_mir_to_stake_creds_cert_get_size(const cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert)¶

Gets the size of the credential-to-amount map in a Move Instantaneous Reward (MIR) certificate to stake credentials.

This function retrieves the number of entries in the map from credential to amount within the given cardano_mir_to_stake_creds_cert_t object.

Usage Example:

const cardano_mir_to_stake_creds_cert_t* mir_cert = ...; // Assume this is initialized
size_t map_size = cardano_mir_to_stake_creds_cert_get_size(mir_cert);
printf("Number of entries in the credential-to-amount map: %zu\n", map_size);

Parameters:¶

const cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert¶

[in] A constant pointer to the cardano_mir_to_stake_creds_cert_t object.

Returns:¶

The number of entries in the credential-to-amount map.

cardano_error_t cardano_mir_to_stake_creds_cert_insert(cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert, cardano_credential_t *credential, uint64_t amount)¶

Inserts a credential-to-amount mapping into a Move Instantaneous Reward (MIR) certificate to stake credentials.

This function inserts a new entry into the map from credential to amount within the given cardano_mir_to_stake_creds_cert_t object. The specified amount will be transferred as a reward to the provided credential from the selected pot.

Usage Example:

cardano_mir_to_stake_creds_cert_t* mir_cert = ...; // Assume this is initialized
cardano_credential_t* credential = ...; // Assume this is initialized
uint64_t amount = 1000;
cardano_error_t result = cardano_mir_to_stake_creds_cert_insert(mir_cert, credential, amount);

if (result == CARDANO_SUCCESS)
{
  // Entry was successfully inserted, and the specified amount will be transferred
  // as a reward to the credential from the selected pot.
}
else
{
  // Handle the error
}

// Free resources
cardano_credential_unref(&credential);
cardano_mir_to_stake_creds_cert_unref(&mir_cert);

Note

The certificate does not take ownership of the credential. It only stores a reference to it. The caller is responsible for freeing its own cardano_credential_t instance and the cardano_mir_to_stake_creds_cert_t instance when they are no longer needed.

Parameters:¶

cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert¶

[inout] A pointer to the cardano_mir_to_stake_creds_cert_t object.

cardano_credential_t *credential¶

[in] A pointer to the cardano_credential_t object representing the credential.

uint64_t amount¶

[in] The amount associated with the credential to be inserted into the map.

Returns:¶

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

cardano_error_t cardano_mir_to_stake_creds_cert_get_key_at(cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert, size_t index, cardano_credential_t **credential)¶

Retrieves the credential key at a specified index from the Move Instantaneous Reward (MIR) certificate to stake credentials.

This function retrieves the credential key at the specified index within the given cardano_mir_to_stake_creds_cert_t object. The credential represents a specific entry in the map from credential to amount.

Usage Example:

const cardano_mir_to_stake_creds_cert_t* mir_cert = ...; // Assume this is initialized
size_t index = 0;
cardano_credential_t* credential = NULL;
cardano_error_t result = cardano_mir_to_stake_creds_cert_get_key_at(mir_cert, index, &credential);

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

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

Note

The returned credential is a new reference, and the caller is responsible for managing its lifecycle. Once the credential is no longer needed, the caller must release it by calling cardano_credential_unref.

Parameters:¶

cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert¶

[in] A constant pointer to the cardano_mir_to_stake_creds_cert_t object.

size_t index¶

[in] The index of the entry to retrieve.

cardano_credential_t **credential¶

[out] A pointer to a pointer that will be set to the address of a newly created cardano_credential_t object, representing the retrieved credential.

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_mir_to_stake_creds_cert_get_value_at(const cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert, size_t index, uint64_t *amount)¶

Retrieves the amount associated with a credential at a specified index in a Move Instantaneous Reward (MIR) to stake credentials certificate.

This function fetches the amount of ADA to be transferred as a reward to the stake credential at the specified index within the MIR certificate. The amount is intended for redistribution from the selected pot to the specified credential.

Usage Example:

const cardano_mir_to_stake_creds_cert_t* mir_cert = ...; // Assume this is initialized
size_t index = 0;
uint64_t amount = 0;
cardano_error_t result = cardano_mir_to_stake_creds_cert_get_value_at(mir_cert, index, &amount);

if (result == CARDANO_SUCCESS)
{
  printf("Amount for credential at index %zu is %llu.\n", index, amount);
  // Further processing...
}
else
{
  // Handle the error
}

Parameters:¶

const cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert¶

[in] A constant pointer to the cardano_mir_to_stake_creds_cert_t object containing the mapping of credentials to amounts.

size_t index¶

[in] The index of the credential within the certificate whose associated amount is to be retrieved.

uint64_t *amount¶

[out] A pointer to a uint64_t variable where the retrieved amount will be stored.

Returns:¶

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

cardano_error_t cardano_mir_to_stake_creds_cert_get_key_value_at(cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert, size_t index, cardano_credential_t **credential, uint64_t *amount)¶

Retrieves both the credential and the amount associated with it at a specified index in a Move Instantaneous Reward (MIR) to stake credentials certificate.

This function provides access to the mapping at a given index within the MIR to stake credentials certificate, allowing the caller to retrieve the credential and the corresponding amount of ADA that is to be transferred as a reward. The credential and amount are used in the certificate’s internal representation of transfers from the treasury or reserve to stake addresses.

Usage Example:

const cardano_mir_to_stake_creds_cert_t* mir_cert = ...; // Assume this is initialized
size_t index = 0;
cardano_credential_t* credential = NULL;
uint64_t amount = 0;

cardano_error_t result = cardano_mir_to_stake_creds_cert_get_key_value_at(mir_cert, index, &credential, &amount);

if (result == CARDANO_SUCCESS)
{
  printf("Credential at index %zu will receive %llu ADA.\n", index, amount);
  // Further processing...

  // Don't forget to free the credential
  cardano_credential_unref(&credential);
}
else
{
  // Handle the error
}

Parameters:¶

cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert¶

[in] A constant pointer to the cardano_mir_to_stake_creds_cert_t object.

size_t index¶

[in] The index within the certificate’s internal map from which to retrieve the credential and associated amount.

cardano_credential_t **credential¶

[out] A pointer to a pointer of cardano_credential_t that will be set to point to a newly created reference of the credential. The caller is responsible for managing the lifecycle of this credential reference by calling cardano_credential_unref.

uint64_t *amount¶

[out] A pointer to a uint64_t where the amount of ADA to be transferred is stored.

Returns:¶

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

void cardano_mir_to_stake_creds_cert_unref(cardano_mir_to_stake_creds_cert_t **mir_to_stake_creds_cert)¶

Decrements the reference count of a cardano_mir_to_stake_creds_cert_t object.

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

Usage Example:

cardano_mir_to_stake_creds_cert_t* mir_to_stake_creds_cert = cardano_mir_to_stake_creds_cert_new(major, minor);

// Perform operations with the mir_to_stake_creds_cert...

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

Note

After calling cardano_mir_to_stake_creds_cert_unref, the pointer to the cardano_mir_to_stake_creds_cert_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_mir_to_stake_creds_cert_t **mir_to_stake_creds_cert¶

[inout] A pointer to the pointer of the mir_to_stake_creds_cert 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_mir_to_stake_creds_cert_ref(cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert)¶

Increases the reference count of the cardano_mir_to_stake_creds_cert_t object.

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

Usage Example:

// Assuming mir_to_stake_creds_cert is a previously created mir_to_stake_creds_cert object

cardano_mir_to_stake_creds_cert_ref(mir_to_stake_creds_cert);

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

Note

Always ensure that for every call to cardano_mir_to_stake_creds_cert_ref there is a corresponding call to cardano_mir_to_stake_creds_cert_unref to prevent memory leaks.

Parameters:¶

cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert¶

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

size_t cardano_mir_to_stake_creds_cert_refcount(const cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert)¶

Retrieves the current reference count of the cardano_mir_to_stake_creds_cert_t object.

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

Usage Example:

// Assuming mir_to_stake_creds_cert is a previously created mir_to_stake_creds_cert object

size_t ref_count = cardano_mir_to_stake_creds_cert_refcount(mir_to_stake_creds_cert);

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_mir_to_stake_creds_cert_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_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert¶

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

Returns:¶

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

void cardano_mir_to_stake_creds_cert_set_last_error(cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert, const char *message)¶

Sets the last error message for a given cardano_mir_to_stake_creds_cert_t object.

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

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

const char *cardano_mir_to_stake_creds_cert_get_last_error(const cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert)¶

Retrieves the last error message recorded for a specific mir_to_stake_creds_cert.

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

Parameters:¶

const cardano_mir_to_stake_creds_cert_t *mir_to_stake_creds_cert¶

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

Returns:¶

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