Native Script - Require M Of N¶

typedef struct cardano_script_n_of_k_t cardano_script_n_of_k_t¶: This script evaluates to true if at least M (required field) of the sub-scripts evaluate to true.

cardano_error_t cardano_script_n_of_k_new(cardano_native_script_list_t *native_scripts, size_t required, cardano_script_n_of_k_t **script_n_of_k)¶

Creates and initializes a new instance of a script_n_of_k.

This function allocates and initializes a new instance of cardano_script_n_of_k_t with a provided list of native scripts and the required number of sub-scripts that must evaluate to true. It returns an error code to indicate success or failure of the operation.

Usage Example:

cardano_native_script_list_t* native_scripts = ...; // Assume this is initialized
size_t required = 2; // Number of sub-scripts that must evaluate to true
cardano_script_n_of_k_t* script_n_of_k = NULL;

// Attempt to create a new script_n_of_k
cardano_error_t result = cardano_script_n_of_k_new(native_scripts, required, &script_n_of_k);

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

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

Parameters:¶

cardano_native_script_list_t *native_scripts¶: [in] A pointer to a cardano_native_script_list_t containing the list of native scripts.
size_t required¶: [in] The number of sub-scripts that must evaluate to true for this script_n_of_k to evaluate to true.
cardano_script_n_of_k_t **script_n_of_k¶: [out] On successful initialization, this will point to a newly created cardano_script_n_of_k_t object. This object represents a “strong reference” to the script_n_of_k, meaning that it is fully initialized and ready for use. The caller is responsible for managing the lifecycle of this object. Specifically, once the script_n_of_k is no longer needed, the caller must release it by calling cardano_script_n_of_k_unref.

Returns:¶

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

cardano_error_t cardano_script_n_of_k_from_cbor(cardano_cbor_reader_t *reader, cardano_script_n_of_k_t **script_n_of_k)¶

Creates a script_n_of_k from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_script_n_of_k_t* script_n_of_k = NULL;

cardano_error_t result = cardano_script_n_of_k_from_cbor(reader, &script_n_of_k);

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

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

Returns:¶

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

cardano_error_t cardano_script_n_of_k_to_cbor(const cardano_script_n_of_k_t *script_n_of_k, cardano_cbor_writer_t *writer)¶

Serializes a script_n_of_k into CBOR format using a CBOR writer.

This function serializes the given cardano_script_n_of_k_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_script_n_of_k_t* script_n_of_k = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_script_n_of_k_to_cbor(script_n_of_k, 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_script_n_of_k_unref(&script_n_of_k);

Parameters:¶

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

cardano_error_t cardano_script_n_of_k_to_cip116_json(const cardano_script_n_of_k_t *script_n_of_k, cardano_json_writer_t *writer)¶

Serializes a native n_of_k script to CIP-116 JSON.

This function writes the JSON representation of a native script of kind “n-of-k” into writer following the CIP-116.

The function emits a complete JSON object (it writes the opening and closing braces). It can be called at the root, as an array element, or as the value of a property in an enclosing object.

For determinism, fields are written in the order: "tag", "scripts", then "n".

Parameters:¶

const cardano_script_n_of_k_t *script_n_of_k¶: [in] A valid pointer to an cardano_script_n_of_k_t.
cardano_json_writer_t *writer¶: [inout] A valid JSON writer positioned where a value is expected.

Returns:¶

CARDANO_SUCCESS The script was serialized successfully.

Returns:¶

CARDANO_ERROR_POINTER_IS_NULL script_n_of_k or writer is NULL.

Returns:¶

CARDANO_ERROR_ENCODING A nested script failed to serialize or the writer reported an encoding error.

cardano_error_t cardano_script_n_of_k_from_json(const char *json, size_t json_size, cardano_script_n_of_k_t **native_script)¶

Creates a script_n_of_k from a JSON string.

This function parses JSON data using a provided JSON string and constructs a cardano_script_n_of_k_t object. It assumes that the JSON data corresponds to the structure expected for a script_n_of_k.

Usage Example:

const char* json_string = "{\"type\": \"atLeast\", \"required\": 2, \"scripts\": [...]}"; // Example JSON string
size_t json_size = strlen(json_string); // Calculate the size of the JSON string
cardano_script_n_of_k_t* script_n_of_k = NULL;

// Attempt to create a new script_n_of_k from a JSON string
cardano_error_t result = cardano_script_n_of_k_from_json(json_string, json_size, &script_n_of_k);

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

  // Once done, ensure to clean up and release the script_n_of_k
  cardano_script_n_of_k_unref(&script_n_of_k);
}
else
{
  printf("Failed to create script_n_of_k from JSON. Error code: %d\n", result);
}

Parameters:¶

const char *json¶: [in] A pointer to a null-terminated string containing the JSON-encoded script_n_of_k data. This string must not be NULL.
size_t json_size¶: [in] The size of the JSON string, excluding the null terminator.
cardano_script_n_of_k_t **native_script¶: [out] A pointer to a pointer of cardano_script_n_of_k_t that will be set to the address of the newly created script_n_of_k object upon successful decoding. The caller is responsible for managing the lifecycle of this object by calling cardano_script_n_of_k_unref when it is no longer needed.

Returns:¶

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

size_t cardano_script_n_of_k_get_length(const cardano_script_n_of_k_t *script_n_of_k)¶

Retrieves the length of the script list in a script_n_of_k object.

This function retrieves the number of elements in the provided cardano_script_n_of_k_t script list.

Usage Example:

cardano_native_script_list_t* native_scripts = ...; // Assume this is initialized and populated
cardano_script_n_of_k_t* script_n_of_k = NULL;
cardano_script_n_of_k_new(native_scripts, &script_n_of_k);

size_t length = cardano_script_n_of_k_get_length(script_n_of_k);
printf("Length of the script_n_of_k scripts: %zu\n", length);

// Clean up the script_n_of_k object once done
cardano_script_n_of_k_unref(&script_n_of_k);

Parameters:¶

const cardano_script_n_of_k_t *script_n_of_k¶: [in] A constant pointer to the cardano_script_n_of_k_t object whose scripts list length is to be retrieved.

Returns:¶

The number of scripts in the script_n_of_k. Returns 0 if the script_n_of_k is NULL.

size_t cardano_script_n_of_k_get_required(const cardano_script_n_of_k_t *script_n_of_k)¶

Retrieves the required number of sub-scripts that must evaluate to true for a script_n_of_k.

This function retrieves the number of sub-scripts that must evaluate to true for the provided cardano_script_n_of_k_t object to evaluate to true.

Usage Example:

cardano_script_n_of_k_t* script_n_of_k = ...; // Assume this is initialized

// Retrieve the required number of sub-scripts
size_t required = cardano_script_n_of_k_get_required(script_n_of_k);
printf("Number of required sub-scripts: %zu\n", required);

// Clean up the script_n_of_k object once done
cardano_script_n_of_k_unref(&script_n_of_k);

Parameters:¶

const cardano_script_n_of_k_t *script_n_of_k¶: [in] A constant pointer to the cardano_script_n_of_k_t object whose required count is to be retrieved. The object must not be NULL.

Returns:¶

The number of sub-scripts that must evaluate to true for this script_n_of_k to evaluate to true.

cardano_error_t cardano_script_n_of_k_set_required(cardano_script_n_of_k_t *script_n_of_k, size_t required)¶

Sets the required number of sub-scripts that must evaluate to true for a script_n_of_k.

This function sets the number of sub-scripts that must evaluate to true for the provided cardano_script_n_of_k_t object to evaluate to true.

Usage Example:

cardano_script_n_of_k_t* script_n_of_k = ...; // Assume this is initialized
size_t required = 3;

// Set the required number of sub-scripts
cardano_error_t result = cardano_script_n_of_k_set_required(script_n_of_k, required);

if (result == CARDANO_SUCCESS)
{
  printf("Successfully set the required number of sub-scripts to %zu\n", required);
}
else
{
  printf("Failed to set the required number of sub-scripts. Error code: %d\n", result);
}

// Clean up the script_n_of_k object once done
cardano_script_n_of_k_unref(&script_n_of_k);

Parameters:¶

cardano_script_n_of_k_t *script_n_of_k¶: [in] A pointer to the cardano_script_n_of_k_t object whose required count is to be set.
size_t required¶: [in] The number of sub-scripts that must evaluate to true.

Returns:¶

CARDANO_SUCCESS if the required number was successfully set, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_script_n_of_k_get_scripts(cardano_script_n_of_k_t *script_n_of_k, cardano_native_script_list_t **list)¶

Retrieves the list of native scripts associated with a cardano_script_n_of_k_t.

This function provides access to the list of native scripts in a cardano_script_n_of_k_t object. It returns a reference to a cardano_native_script_list_t object representing the scripts. This allows the scripts to be used independently of the original cardano_script_n_of_k_t object. The reference count of the list object is increased by one, making it the caller’s responsibility to release it by calling cardano_native_script_list_unref when it is no longer needed.

Usage Example:

cardano_script_n_of_k_t* script_n_of_k = cardano_script_n_of_k_new(...);
cardano_native_script_list_t* list_scripts = NULL;

// Attempt to retrieve the list of native scripts associated with script_n_of_k
cardano_error_t result = cardano_script_n_of_k_get_scripts(script_n_of_k, &list_scripts);

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

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

// Release the script_n_of_k object after use
cardano_script_n_of_k_unref(&script_n_of_k);

Parameters:¶

cardano_script_n_of_k_t *script_n_of_k¶: [in] A constant pointer to the cardano_script_n_of_k_t object from which the list of native scripts is to be retrieved.
cardano_native_script_list_t **list¶: [out] A pointer to store the reference to the cardano_native_script_list_t object containing the scripts. If the input script_n_of_k is NULL, returns NULL. The caller is responsible for managing the lifecycle of this object, including releasing it with cardano_native_script_list_unref.

Returns:¶

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

cardano_error_t cardano_script_n_of_k_set_scripts(cardano_script_n_of_k_t *script_n_of_k, cardano_native_script_list_t *list)¶

Sets the list of native scripts associated with a cardano_script_n_of_k_t.

This function sets the list of native scripts for a cardano_script_n_of_k_t object to the provided cardano_native_script_list_t object. It replaces n_of existing scripts associated with the cardano_script_n_of_k_t. The reference count of the provided list object is increased by one, making it the caller’s responsibility to release it when it is no longer needed.

Usage Example:

cardano_script_n_of_k_t* script_n_of_k = cardano_script_n_of_k_new(...);
cardano_native_script_list_t* new_list = ...; // Assume new_list is initialized here

// Attempt to set the new list of scripts associated with the script_n_of_k
cardano_error_t result = cardano_script_n_of_k_set_scripts(script_n_of_k, new_list);

if (result == CARDANO_SUCCESS)
{
  // Scripts successfully set
  printf("Scripts set successfully.\n");
}
else
{
  // Handle error
  fprintf(stderr, "Failed to set scripts: %s.\n", cardano_error_to_string(result));
}

// Release the script_n_of_k object after use
cardano_script_n_of_k_unref(&script_n_of_k);

Parameters:¶

cardano_script_n_of_k_t *script_n_of_k¶: [in] A pointer to the cardano_script_n_of_k_t object to which the list of native scripts is to be set.
cardano_native_script_list_t *list¶: [in] A pointer to the cardano_native_script_list_t object containing the new scripts to be set.

Returns:¶

CARDANO_SUCCESS if the scripts were successfully set, or an appropriate error code indicating the failure reason.

bool cardano_script_n_of_k_equals(const cardano_script_n_of_k_t *lhs, const cardano_script_n_of_k_t *rhs)¶

Checks if two script_n_of_k objects are equal.

This function compares two cardano_script_n_of_k_t objects to determine if they are equal. Two script_n_of_k objects are considered equal if they have the same number of elements and each corresponding pair of elements is equal according to the cardano_native_script_equals function.

Usage Example:

cardano_script_n_of_k_t* script1 = ...;  // Assume script1 is initialized here
cardano_script_n_of_k_t* script2 = ...;  // Assume script2 is initialized here

if (cardano_script_n_of_k_equals(script1, script2))
{
  // The two script_n_of_k objects are equal
}
else
{
  // The two script_n_of_k objects are not equal
}

Parameters:¶

const cardano_script_n_of_k_t *lhs¶: [in] A constant pointer to the first cardano_script_n_of_k_t object to be compared.
const cardano_script_n_of_k_t *rhs¶: [in] A constant pointer to the second cardano_script_n_of_k_t object to be compared.

Returns:¶

true if the two script_n_of_k objects are equal, false otherwise.

void cardano_script_n_of_k_unref(cardano_script_n_of_k_t **script_n_of_k)¶

Decrements the reference count of a script_n_of_k object.

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

Usage Example:

cardano_script_n_of_k_t* script_n_of_k = ...; // Assume script_n_of_k is initialized here

// Perform operations with the script_n_of_k...

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

Note

After calling cardano_script_n_of_k_unref, the pointer to the cardano_script_n_of_k_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_script_n_of_k_t **script_n_of_k¶: [inout] A pointer to the pointer of the script_n_of_k 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_script_n_of_k_ref(cardano_script_n_of_k_t *script_n_of_k)¶

Increases the reference count of the cardano_script_n_of_k_t object.

This function is used to manually increment the reference count of a script_n_of_k object, indicating that another part of the code has taken ownership of it. This ensures the object remains allocated and valid until n_of owners have released their reference by calling cardano_script_n_of_k_unref.

Usage Example:

// Assuming script_n_of_k is a previously created script_n_of_k object

cardano_script_n_of_k_ref(script_n_of_k);

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

Note

Always ensure that for every call to cardano_script_n_of_k_ref there is a corresponding call to cardano_script_n_of_k_unref to prevent memory leaks.

Parameters:¶

cardano_script_n_of_k_t *script_n_of_k¶: A pointer to the script_n_of_k object whose reference count is to be incremented.

size_t cardano_script_n_of_k_refcount(const cardano_script_n_of_k_t *script_n_of_k)¶

Retrieves the current reference count of the cardano_script_n_of_k_t object.

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

Usage Example:

// Assuming script_n_of_k is a previously created script_n_of_k object

size_t ref_count = cardano_script_n_of_k_refcount(script_n_of_k);

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

Returns:¶

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

void cardano_script_n_of_k_set_last_error(cardano_script_n_of_k_t *script_n_of_k, const char *message)¶

Sets the last error message for a given script_n_of_k object.

Records an error message in the script_n_of_k’s last_error buffer, overwriting n_of 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_script_n_of_k_t *script_n_of_k¶: [in] A pointer to the cardano_script_n_of_k_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 script_n_of_k’s last_error is set to an empty string, indicating no error.

const char *cardano_script_n_of_k_get_last_error(const cardano_script_n_of_k_t *script_n_of_k)¶

Retrieves the last error message recorded for a specific script_n_of_k.

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

Parameters:¶

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

Returns:¶

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