Hard Fork Initiation Action¶

typedef struct cardano_hard_fork_initiation_action_t cardano_hard_fork_initiation_action_t¶: Represents the initiation action for a hard fork in the Cardano network.

cardano_error_t cardano_hard_fork_initiation_action_new(cardano_protocol_version_t *version, cardano_governance_action_id_t *governance_action_id, cardano_hard_fork_initiation_action_t **hard_fork_initiation_action)¶

Creates and initializes a new instance of the Hard Fork Initiation Action.

This function allocates and initializes a new instance of a cardano_hard_fork_initiation_action_t object, which represents an action to initiate a hard fork in the Cardano network. The action is defined by specifying a protocol version and an optional governance action identifier.

The action requires a governance action ID to reference the most recent enacted action of the same type. You can retrieve this information from the gov-state query:

cardano-cli conway query gov-state | jq .nextRatifyState.nextEnactState.prevGovActionIds

Example output:

{
  "Committee": {
    "govActionIx": 0,
    "txId": "6bff8515060c08e9cae4d4e203a4d8b2e876848aae8c4e896acda7202d3ac679"
  },
  "Constitution": null,
  "HardFork": null,
  "PParamUpdate": {
    "govActionIx": 0,
    "txId": "7e199d036f1e8d725ea8aba30c5f8d0d2ab9dbd45c7f54e7d85c92c022673f0f"
  }
}

Usage Example:

cardano_protocol_version_t* version = cardano_protocol_version_new(...); // Assume version is already initialized
cardano_governance_action_id_t* governance_action_id = cardano_governance_action_id_new(...);
cardano_hard_fork_initiation_action_t* hard_fork_initiation_action = NULL;
cardano_error_t result = cardano_hard_fork_initiation_action_new(version, governance_action_id, &hard_fork_initiation_action);

if (result == CARDANO_SUCCESS)
{
  // Use the hard fork initiation action
  // Free resources when done
  cardano_hard_fork_initiation_action_unref(&hard_fork_initiation_action);
}
else
{
  printf("Failed to create the hard fork initiation action: %s\n", cardano_error_to_string(result));
}

cardano_protocol_version_unref(&version);
cardano_governance_action_id_unref(&governance_action_id);

Parameters:¶

cardano_protocol_version_t *version¶: [in] A pointer to a cardano_protocol_version_t object representing the protocol version for the hard fork.
cardano_governance_action_id_t *governance_action_id¶: [in] An optional pointer to a cardano_governance_action_id_t object representing the unique identifier for the last enacted governance action of the same type. This parameter can be NULL if no governance action of this type is enacted.
cardano_hard_fork_initiation_action_t **hard_fork_initiation_action¶: [out] On successful initialization, this will point to a newly created cardano_hard_fork_initiation_action_t object. This object represents a “strong reference” to the hard fork initiation action, meaning that it is fully initialized and ready for use. The caller is responsible for managing the lifecycle of this object.

Returns:¶

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

cardano_error_t cardano_hard_fork_initiation_action_from_cbor(cardano_cbor_reader_t *reader, cardano_hard_fork_initiation_action_t **hard_fork_initiation_action)¶

Creates a cardano_hard_fork_initiation_action_t from a CBOR reader.

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

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_hard_fork_initiation_action_t* hard_fork_initiation_action = NULL;

cardano_error_t result = cardano_hard_fork_initiation_action_from_cbor(reader, &hard_fork_initiation_action);

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

  // Once done, ensure to clean up and release the hard_fork_initiation_action
  cardano_hard_fork_initiation_action_unref(&hard_fork_initiation_action);
}
else
{
  const char* error = cardano_cbor_reader_get_last_error(reader);
  printf("Failed to decode hard_fork_initiation_action: %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_hard_fork_initiation_action_t object by calling cardano_hard_fork_initiation_action_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_hard_fork_initiation_action_t **hard_fork_initiation_action¶: [out] A pointer to a pointer of cardano_hard_fork_initiation_action_t that will be set to the address of the newly created hard_fork_initiation_action 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_hard_fork_initiation_action_to_cbor(const cardano_hard_fork_initiation_action_t *hard_fork_initiation_action, cardano_cbor_writer_t *writer)¶

Serializes the certificate into CBOR format using a CBOR writer.

This function serializes the given cardano_hard_fork_initiation_action_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_hard_fork_initiation_action_t* hard_fork_initiation_action = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_hard_fork_initiation_action_to_cbor(hard_fork_initiation_action, 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_hard_fork_initiation_action_unref(&hard_fork_initiation_action);

Parameters:¶

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

cardano_error_t cardano_hard_fork_initiation_action_to_cip116_json(const cardano_hard_fork_initiation_action_t *action, cardano_json_writer_t *writer)¶

Serializes a hard fork initiation action to CIP-116 JSON.

The function writes the full JSON object, including the surrounding braces. Keys are written in the order: “tag”, “gov_action_id” (if present), “protocol_version”.

Parameters:¶

const cardano_hard_fork_initiation_action_t *action¶: [in] Pointer to a valid cardano_hard_fork_initiation_action_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 action or writer is NULL. Other Any error propagated from nested writers.

cardano_error_t cardano_hard_fork_initiation_action_set_protocol_version(cardano_hard_fork_initiation_action_t *hard_fork_initiation_action, cardano_protocol_version_t *protocol_version)¶

Sets the protocol version in the hard fork initiation action.

This function updates the protocol version of a cardano_hard_fork_initiation_action_t object. The protocol version specifies the new set of rules that will become active after the hard fork.

Usage Example:

cardano_hard_fork_initiation_action_t* hard_fork_initiation_action = ...; // Assume hard_fork_initiation_action is already initialized
cardano_protocol_version_t* protocol_version = cardano_protocol_version_new(...); // Assume protocol_version is already initialized

cardano_error_t result = cardano_hard_fork_initiation_action_set_protocol_version(hard_fork_initiation_action, protocol_version);
if (result == CARDANO_SUCCESS)
{
  // The protocol version is now set for the hard fork initiation action
}
else
{
  printf("Failed to set the protocol version.\n");
}
// Clean up the hard_fork_initiation_action and protocol_version after use
cardano_hard_fork_initiation_action_unref(&hard_fork_initiation_action);
cardano_protocol_version_unref(&protocol_version);

Parameters:¶

cardano_hard_fork_initiation_action_t *hard_fork_initiation_action¶: [inout] A pointer to an initialized cardano_hard_fork_initiation_action_t object to which the protocol version will be set.
cardano_protocol_version_t *protocol_version¶: [in] A pointer to an initialized cardano_protocol_version_t object representing the new protocol version.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the protocol version was successfully set, 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_protocol_version_t *cardano_hard_fork_initiation_action_get_protocol_version(cardano_hard_fork_initiation_action_t *hard_fork_initiation_action)¶

Gets the protocol version from a hard_fork_initiation_action.

This function retrieves the protocol version from a given cardano_hard_fork_initiation_action_t object. The protocol version specifies the set of rules that will govern the network following the hard fork.

Usage Example:

cardano_hard_fork_initiation_action_t* hard_fork_initiation_action = ...; // Assume initialized
cardano_protocol_version_t* protocol_version = cardano_hard_fork_initiation_action_get_protocol_version(hard_fork_initiation_action);

if (protocol_version != NULL)
{
  // Use the protocol version

  // Once done, ensure to clean up and release the protocol version
  cardano_protocol_version_unref(&protocol_version);
}
else
{
  printf("ERROR: No protocol version set for this hard fork initiation action.\n");
}

Parameters:¶

cardano_hard_fork_initiation_action_t *hard_fork_initiation_action¶: [in] A pointer to an initialized cardano_hard_fork_initiation_action_t object from which the protocol version is retrieved.

Returns:¶

A pointer to the retrieved cardano_protocol_version_t object representing the protocol version. This will be a new reference, and the caller is responsible for releasing it with cardano_protocol_version_unref when it is no longer needed. If the hard_fork_initiation_action does not have a protocol version set, NULL is returned.

cardano_error_t cardano_hard_fork_initiation_action_set_governance_action_id(cardano_hard_fork_initiation_action_t *hard_fork_initiation_action, cardano_governance_action_id_t *governance_action_id)¶

Sets the governance action ID in the hard fork initiation action.

This function updates the governance action ID of a cardano_hard_fork_initiation_action_t object. The governance action ID represents the unique identifier for the most recently enacted governance action associated with a hard fork.

Usage Example:

cardano_hard_fork_initiation_action_t* hard_fork_initiation_action = ...; // Assume hard_fork_initiation_action is already initialized
cardano_governance_action_id_t* governance_action_id = cardano_governance_action_id_new(...); // Optionally initialized

cardano_error_t result = cardano_hard_fork_initiation_action_set_governance_action_id(hard_fork_initiation_action, governance_action_id);
if (result == CARDANO_SUCCESS)
{
  // The governance action ID is now set for the hard_fork_initiation_action
}
else
{
  printf("Failed to set the governance action ID.\n");
}

// Cleanup the hard_fork_initiation_action and optionally the governance action ID
cardano_hard_fork_initiation_action_unref(&hard_fork_initiation_action);

if (governance_action_id)
{
  cardano_governance_action_id_unref(&governance_action_id);
}

Note

This function maintains governance continuity by referencing the latest governance action ID of the same type, allowing only one active action at a time for each governance type.

Parameters:¶

cardano_hard_fork_initiation_action_t *hard_fork_initiation_action¶: [inout] A pointer to an initialized cardano_hard_fork_initiation_action_t object to which the governance action ID will be set.
cardano_governance_action_id_t *governance_action_id¶: [in] A pointer to an initialized cardano_governance_action_id_t object representing the last enacted action of the same type. This parameter can be NULL if the governance action ID is to be unset.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the governance action ID was successfully set, or an appropriate error code indicating the failure reason, such as CARDANO_ERROR_POINTER_IS_NULL if the hard_fork_initiation_action pointer is NULL.

cardano_governance_action_id_t *cardano_hard_fork_initiation_action_get_governance_action_id(cardano_hard_fork_initiation_action_t *hard_fork_initiation_action)¶

Retrieves the governance action ID from a hard fork initiation action.

This function retrieves the governance action ID from a given cardano_hard_fork_initiation_action_t object. The governance action ID references the most recent action of the same type.

Usage Example:

cardano_hard_fork_initiation_action_t* hard_fork_initiation_action = ...; // Assume initialized
cardano_governance_action_id_t* governance_action_id = cardano_hard_fork_initiation_action_get_governance_action_id(hard_fork_initiation_action);

if (governance_action_id != NULL)
{
  printf("Governance Action ID: %u\n", cardano_governance_action_id_to_uint(governance_action_id));
  // Use the governance action ID

  // Once done, ensure to clean up and release the governance action ID
  cardano_governance_action_id_unref(&governance_action_id);
}

Parameters:¶

cardano_hard_fork_initiation_action_t *hard_fork_initiation_action¶: [in] A pointer to an initialized cardano_hard_fork_initiation_action_t object from which the governance action ID is retrieved.

Returns:¶

A pointer to the retrieved cardano_governance_action_id_t object representing the governance action ID. This will be a new reference, and the caller is responsible for releasing it with cardano_governance_action_id_unref when it is no longer needed.

void cardano_hard_fork_initiation_action_unref(cardano_hard_fork_initiation_action_t **hard_fork_initiation_action)¶

Decrements the reference count of a cardano_hard_fork_initiation_action_t object.

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

Usage Example:

cardano_hard_fork_initiation_action_t* hard_fork_initiation_action = cardano_hard_fork_initiation_action_new(major, minor);

// Perform operations with the hard_fork_initiation_action...

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

Note

After calling cardano_hard_fork_initiation_action_unref, the pointer to the cardano_hard_fork_initiation_action_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_hard_fork_initiation_action_t **hard_fork_initiation_action¶: [inout] A pointer to the pointer of the hard_fork_initiation_action 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_hard_fork_initiation_action_ref(cardano_hard_fork_initiation_action_t *hard_fork_initiation_action)¶

Increases the reference count of the cardano_hard_fork_initiation_action_t object.

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

Usage Example:

// Assuming hard_fork_initiation_action is a previously created hard_fork_initiation_action object

cardano_hard_fork_initiation_action_ref(hard_fork_initiation_action);

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

Note

Always ensure that for every call to cardano_hard_fork_initiation_action_ref there is a corresponding call to cardano_hard_fork_initiation_action_unref to prevent memory leaks.

Parameters:¶

cardano_hard_fork_initiation_action_t *hard_fork_initiation_action¶: A pointer to the cardano_hard_fork_initiation_action_t object whose reference count is to be incremented.

size_t cardano_hard_fork_initiation_action_refcount(const cardano_hard_fork_initiation_action_t *hard_fork_initiation_action)¶

Retrieves the current reference count of the cardano_hard_fork_initiation_action_t object.

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

Usage Example:

// Assuming hard_fork_initiation_action is a previously created hard_fork_initiation_action object

size_t ref_count = cardano_hard_fork_initiation_action_refcount(hard_fork_initiation_action);

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_hard_fork_initiation_action_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_hard_fork_initiation_action_t *hard_fork_initiation_action¶: A pointer to the cardano_hard_fork_initiation_action_t object whose reference count is queried. The object must not be NULL.

Returns:¶

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

void cardano_hard_fork_initiation_action_set_last_error(cardano_hard_fork_initiation_action_t *hard_fork_initiation_action, const char *message)¶

Sets the last error message for a given cardano_hard_fork_initiation_action_t object.

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

const char *cardano_hard_fork_initiation_action_get_last_error(const cardano_hard_fork_initiation_action_t *hard_fork_initiation_action)¶

Retrieves the last error message recorded for a specific hard_fork_initiation_action.

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

Parameters:¶

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

Returns:¶

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