Plutus List¶

typedef struct cardano_plutus_list_t cardano_plutus_list_t¶

Represents a list of plutus data.

cardano_error_t cardano_plutus_list_new(cardano_plutus_list_t **plutus_list)¶

Creates and initializes a new instance of a plutus_list.

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

Usage Example:

cardano_plutus_list_t* plutus_list = NULL;

// Attempt to create a new plutus_list
cardano_error_t result = cardano_plutus_list_new(&plutus_list);

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

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

Parameters:¶

cardano_plutus_list_t **plutus_list¶

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

Returns:¶

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

cardano_error_t cardano_plutus_list_from_cbor(cardano_cbor_reader_t *reader, cardano_plutus_list_t **plutus_list)¶

Creates a plutus_list from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_plutus_list_t* plutus_list = NULL;

cardano_error_t result = cardano_plutus_list_from_cbor(reader, &plutus_list);

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

  // Once done, ensure to clean up and release the plutus_list
  cardano_plutus_list_unref(&plutus_list);
}
else
{
  const char* error = cardano_cbor_reader_get_last_error(reader);
  printf("Failed to decode plutus_list: %s\n", error);
}

cardano_cbor_reader_unref(&reader); // Cleanup the CBOR reader

Remark

In Cardano, entities are encoded in CBOR, but CBOR allows multiple valid ways to encode the same data. The Cardano blockchain does not enforce a canonical CBOR representation, meaning that if you decode a transaction from CBOR and then re-encode it, the resulting encoding could be different. This would change the data and invalidate any existing signatures. To prevent this, when a plutus data object is created using cardano_plutus_list_from_cbor, it caches the original CBOR representation internally. When cardano_plutus_list_to_cbor is called, it will output the cached CBOR. If the cached CBOR representation is not needed, the client can call cardano_plutus_list_clear_cbor_cache after the object has been created.

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_plutus_list_t object by calling cardano_plutus_list_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 plutus_list data.

cardano_plutus_list_t **plutus_list¶

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

Returns:¶

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

cardano_error_t cardano_plutus_list_to_cbor(const cardano_plutus_list_t *plutus_list, cardano_cbor_writer_t *writer)¶

Serializes a plutus_list into CBOR format using a CBOR writer.

This function serializes the given cardano_plutus_list_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_plutus_list_t* plutus_list = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_plutus_list_to_cbor(plutus_list, 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_plutus_list_unref(&plutus_list);

Remark

In Cardano, entities are encoded in CBOR, but CBOR allows multiple valid ways to encode the same data. The Cardano blockchain does not enforce a canonical CBOR representation, meaning that if you decode a transaction from CBOR and then re-encode it, the resulting encoding could be different. This would change the data and invalidate any existing signatures. To prevent this, when a plutus data object is created using cardano_plutus_list_from_cbor, it caches the original CBOR representation internally. When cardano_plutus_list_to_cbor is called, it will output the cached CBOR. If the cached CBOR representation is not needed, the client can call cardano_plutus_list_clear_cbor_cache after the object has been created.

Parameters:¶

const cardano_plutus_list_t *plutus_list¶

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

cardano_error_t cardano_plutus_list_to_cip116_json(const cardano_plutus_list_t *list, cardano_json_writer_t *writer)¶

Serializes a Plutus list to a CIP-116 JSON array.

This function recursively serializes the elements of the Plutus list as a JSON array. Each element in the list is serialized as a PlutusData object.

Parameters:¶

const cardano_plutus_list_t *list¶

[in] Pointer to a valid cardano_plutus_list_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 list or writer is NULL. Other Any error propagated from nested writers.

size_t cardano_plutus_list_get_length(const cardano_plutus_list_t *plutus_list)¶

Retrieves the length of a plutus list.

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

Usage Example:

cardano_plutus_list_t* plutus_list = cardano_plutus_list_new();

// Populate plutus_list with elements

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

// Clean up the plutus_list object once done
cardano_plutus_list_unref(&plutus_list);

Parameters:¶

const cardano_plutus_list_t *plutus_list¶

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

Returns:¶

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

cardano_error_t cardano_plutus_list_get(const cardano_plutus_list_t *plutus_list, size_t index, cardano_plutus_data_t **element)¶

Retrieves an element from a plutus list by index.

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

Usage Example:

cardano_plutus_list_t* plutus_list = cardano_plutus_list_new();

// Populate plutus_list with elements

cardano_plutus_data_t* element = NULL;
cardano_error_t result = cardano_plutus_list_get(plutus_list, 2, &element);

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

// Clean up the plutus_list object once done
cardano_plutus_list_unref(&plutus_list);

Parameters:¶

const cardano_plutus_list_t *plutus_list¶

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

size_t index¶

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

cardano_plutus_data_t **element¶

[out] Pointer to a variable where the retrieved element will be stored. This variable will point to the retrieved cardano_plutus_data_t object. The caller is responsible for managing the lifecycle of the element by calling cardano_plutus_data_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_plutus_list_add(cardano_plutus_list_t *plutus_list, cardano_plutus_data_t *element)¶

Adds an element to a plutus list.

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

Usage Example:

cardano_plutus_list_t* plutus_list = cardano_plutus_list_new();

// Create and initialize a new plutus_data element
cardano_plutus_data_t* element = { ... };

// Add the element to the plutus_list
cardano_error_t result = cardano_plutus_list_add(plutus_list, element);

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

// Clean up the plutus_list object once done
cardano_plutus_list_unref(&plutus_list);

Parameters:¶

cardano_plutus_list_t *plutus_list¶

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

cardano_plutus_data_t *element¶

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

Returns:¶

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

bool cardano_plutus_list_equals(const cardano_plutus_list_t *lhs, const cardano_plutus_list_t *rhs)¶

Checks if two plutus lists are equal.

This function compares two cardano_plutus_list_t objects to determine if they are equal. Two plutus lists are considered equal if they have the same number of elements and each corresponding pair of elements is equal according to the cardano_plutus_data_equals function.

Usage Example:

cardano_plutus_list_t* list1 = { ... };  // Assume list1 is initialized here
cardano_plutus_list_t* list2 = { ... };  // Assume list2 is initialized here

if (cardano_plutus_list_equals(list1, list2))
{
  // The two plutus_lists are equal
}
else
{
  // The two plutus_lists are not equal
}

Parameters:¶

const cardano_plutus_list_t *lhs¶

[in] A constant pointer to the first cardano_plutus_list_t object to be compared.

const cardano_plutus_list_t *rhs¶

[in] A constant pointer to the second cardano_plutus_list_t object to be compared.

Returns:¶

true if the two plutus_lists are equal, false otherwise.

void cardano_plutus_list_clear_cbor_cache(cardano_plutus_list_t *plutus_list)¶

Clears the cached CBOR representation from a plutus list.

This function removes the internally cached CBOR data from a cardano_plutus_list_t object. It is useful when you have modified the plutus list after it was created from CBOR using cardano_plutus_list_from_cbor and you want to ensure that the next serialization reflects the current state of the plutus list, rather than using the original cached CBOR.

Usage Example:

// Assume plutus_list was created using cardano_plutus_list_from_cbor
cardano_plutus_list_t* plutus_list = ...;

// Modify the plutus_list as needed
// For example, change the fee

if (result != CARDANO_SUCCESS)
{
  printf("Failed to set new fee: %s\n", cardano_error_to_string(result));
}

// Clear the CBOR cache to ensure serialization uses the updated plutus_list
cardano_plutus_list_clear_cbor_cache(plutus_list);

// Serialize the plutus_list to CBOR
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

result = cardano_plutus_list_to_cbor(plutus_list, writer);

if (result == CARDANO_SUCCESS)
{
  // Process the CBOR data as needed
}
else
{
  const char* error_message = cardano_cbor_writer_get_last_error(writer);
  printf("Serialization failed: %s\n", error_message);
}

// Clean up resources
cardano_cbor_writer_unref(&writer);
cardano_plutus_list_unref(&plutus_list);

Warning

Clearing the CBOR cache may change the binary representation of the plutus list when serialized, which can alter the plutus list and invalidate any existing signatures. Use this function with caution, especially if the transaction has already been signed or if preserving the exact CBOR encoding is important for your application.

Parameters:¶

cardano_plutus_list_t *plutus_list¶

[inout] A pointer to an initialized cardano_plutus_list_t object from which the CBOR cache will be cleared.

void cardano_plutus_list_unref(cardano_plutus_list_t **plutus_list)¶

Decrements the reference count of a plutus_list object.

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

Usage Example:

cardano_plutus_list_t* plutus_list = cardano_plutus_list_new();

// Perform operations with the plutus_list...

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

Note

After calling cardano_plutus_list_unref, the pointer to the cardano_plutus_list_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_plutus_list_t **plutus_list¶

[inout] A pointer to the pointer of the plutus_list 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_plutus_list_ref(cardano_plutus_list_t *plutus_list)¶

Increases the reference count of the cardano_plutus_list_t object.

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

Usage Example:

// Assuming plutus_list is a previously created plutus_list object

cardano_plutus_list_ref(plutus_list);

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

Note

Always ensure that for every call to cardano_plutus_list_ref there is a corresponding call to cardano_plutus_list_unref to prevent memory leaks.

Parameters:¶

cardano_plutus_list_t *plutus_list¶

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

size_t cardano_plutus_list_refcount(const cardano_plutus_list_t *plutus_list)¶

Retrieves the current reference count of the cardano_plutus_list_t object.

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

Usage Example:

// Assuming plutus_list is a previously created plutus_list object

size_t ref_count = cardano_plutus_list_refcount(plutus_list);

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_plutus_list_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_plutus_list_t *plutus_list¶

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

Returns:¶

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

void cardano_plutus_list_set_last_error(cardano_plutus_list_t *plutus_list, const char *message)¶

Sets the last error message for a given plutus_list object.

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

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

const char *cardano_plutus_list_get_last_error(const cardano_plutus_list_t *plutus_list)¶

Retrieves the last error message recorded for a specific plutus_list.

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

Parameters:¶

const cardano_plutus_list_t *plutus_list¶

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

Returns:¶

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