Genesis Key Delegation Certificate¶

typedef struct cardano_genesis_key_delegation_cert_t cardano_genesis_key_delegation_cert_t¶

This certificate is used to delegate from a Genesis key to a set of keys.

This was primarily used in the early phases of the Cardano network’s existence during the transition from the Byron to the Shelley era.

cardano_error_t cardano_genesis_key_delegation_cert_new(cardano_blake2b_hash_t *genesis_hash, cardano_blake2b_hash_t *genesis_delegate_hash, cardano_blake2b_hash_t *vrf_key_hash, cardano_genesis_key_delegation_cert_t **cert)¶

Creates a new Genesis Key Delegation certificate.

This function allocates and initializes a new instance of cardano_genesis_key_delegation_cert_t.

Usage Example:

cardano_blake2b_hash_t* genesis_hash = ...; // Assume genesis_hash is already initialized
cardano_blake2b_hash_t* genesis_delegate_hash = ...; // Assume genesis_delegate_hash is initialized
cardano_blake2b_hash_t* vrf_key_hash = ...; // Assume vrf_key_hash is initialized
cardano_genesis_key_delegation_cert_t* cert = NULL;

cardano_error_t result = cardano_genesis_key_delegation_cert_new(genesis_hash, genesis_delegate_hash, vrf_key_hash, &cert);
if (result == CARDANO_SUCCESS)
{
  // The Genesis Key Delegation certificate is now ready to be used
  // Remember to free the certificate when done
  cardano_genesis_key_delegation_cert_unref(&cert);
}
else
{
  printf("Failed to create Genesis Key Delegation certificate: %s\n", cardano_error_to_string(result));
}

cardano_blake2b_hash_unref(&genesis_hash);
cardano_blake2b_hash_unref(&genesis_delegate_hash);
cardano_blake2b_hash_unref(&vrf_key_hash);

Parameters:¶

cardano_blake2b_hash_t *genesis_hash¶: [in] A pointer to an initialized cardano_blake2b_hash_t object representing the hash of the genesis block. This hash uniquely identifies the blockchain and ensures that the delegation occurs on the intended chain.
cardano_blake2b_hash_t *genesis_delegate_hash¶: [in] A pointer to an initialized cardano_blake2b_hash_t object representing the hash of the delegate’s public key. This delegate is the new recipient of the block production rights originally held by the genesis key.
cardano_blake2b_hash_t *vrf_key_hash¶: [in] A pointer to an initialized cardano_blake2b_hash_t object representing the hash of the VRF key belonging to the delegate.
cardano_genesis_key_delegation_cert_t **cert¶: [out] On successful initialization, this parameter will point to the newly created cardano_genesis_key_delegation_cert_t object. The caller is responsible for managing the lifecycle of this object, including its deallocation through the appropriate unref function.

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 reason for failure, such as CARDANO_ERROR_POINTER_IS_NULL if any input pointers are NULL.

cardano_error_t cardano_genesis_key_delegation_cert_from_cbor(cardano_cbor_reader_t *reader, cardano_genesis_key_delegation_cert_t **genesis_key_delegation_cert)¶

Creates a cardano_genesis_key_delegation_cert_t from a CBOR reader.

This function parses CBOR data using a provided cardano_cbor_reader_t and constructs a cardano_genesis_key_delegation_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 genesis_key_delegation_cert.

Usage Example:

cardano_cbor_reader_t* reader = cardano_cbor_reader_new(cbor_data, data_size);
cardano_genesis_key_delegation_cert_t* genesis_key_delegation_cert = NULL;

cardano_error_t result = cardano_genesis_key_delegation_cert_from_cbor(reader, &genesis_key_delegation_cert);

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

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

Serializes the certificate into CBOR format using a CBOR writer.

This function serializes the given cardano_genesis_key_delegation_cert_t object using a cardano_cbor_writer_t.

Usage Example:

cardano_genesis_key_delegation_cert_t* genesis_key_delegation_cert = ...;
cardano_cbor_writer_t* writer = cardano_cbor_writer_new();

if (writer)
{
  cardano_error_t result = cardano_genesis_key_delegation_cert_to_cbor(genesis_key_delegation_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_genesis_key_delegation_cert_unref(&genesis_key_delegation_cert);

Parameters:¶

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

cardano_error_t cardano_genesis_key_delegation_cert_to_cip116_json(const cardano_genesis_key_delegation_cert_t *cert, cardano_json_writer_t *writer)¶

Serializes a genesis-key-delegation certificate to CIP-116 JSON.

Keys are written in deterministic order: “tag”, “genesis_hash”, “genesis_delegate_hash”, “vrf_keyhash”. The function writes the full JSON object, including surrounding braces.

Parameters:¶

const cardano_genesis_key_delegation_cert_t *cert¶: [in] Pointer to a valid cardano_genesis_key_delegation_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_blake2b_hash_t *cardano_genesis_key_delegation_cert_get_genesis_hash(cardano_genesis_key_delegation_cert_t *certificate)¶

Retrieves the genesis hash from a genesis key delegation certificate.

This function extracts the genesis hash from the specified cardano_genesis_key_delegation_cert_t object. The genesis hash uniquely identifies the blockchain network and is used to confirm that the delegation occurs on the intended blockchain.

Usage Example:

const cardano_genesis_key_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_blake2b_hash_t* genesis_hash = cardano_genesis_key_delegation_cert_get_genesis_hash(certificate);

if (genesis_hash != NULL)
{
  // Process the genesis hash
  cardano_blake2b_hash_unref(&genesis_hash);
}

Parameters:¶

cardano_genesis_key_delegation_cert_t *certificate¶: [in] A constant pointer to an initialized cardano_genesis_key_delegation_cert_t object.

Returns:¶

A pointer to the cardano_blake2b_hash_t object containing the genesis hash. If the certificate is NULL or if the genesis hash is not set, this function returns NULL.

cardano_error_t cardano_genesis_key_delegation_cert_set_genesis_hash(cardano_genesis_key_delegation_cert_t *certificate, cardano_blake2b_hash_t *hash)¶

Sets the genesis hash in a genesis key delegation certificate.

This function assigns a new genesis hash to the specified cardano_genesis_key_delegation_cert_t object. The genesis hash uniquely identifies the blockchain network and is used to confirm that the delegation occurs on the intended blockchain.

Usage Example:

cardano_genesis_key_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_blake2b_hash_t* hash = ...; // Assume hash is initialized
cardano_error_t result = cardano_genesis_key_delegation_cert_set_genesis_hash(certificate, hash);

if (result == CARDANO_SUCCESS)
{
  printf("Genesis hash set successfully.\n");

 cardano_blake2b_hash_unref(&hash);
}
else
{
  printf("Failed to set genesis hash.\n");
}

Note

This function does not take ownership of the hash; the caller is responsible for managing the lifecycle of the hash object.

Parameters:¶

cardano_genesis_key_delegation_cert_t *certificate¶: [in] A pointer to an initialized cardano_genesis_key_delegation_cert_t object.
cardano_blake2b_hash_t *hash¶: [in] A pointer to an initialized cardano_blake2b_hash_t object representing the genesis hash.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the genesis hash 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_blake2b_hash_t *cardano_genesis_key_delegation_cert_get_genesis_delegate_hash(cardano_genesis_key_delegation_cert_t *certificate)¶

Retrieves the genesis delegate hash from a genesis key delegation certificate.

This function extracts the genesis delegate hash from the specified cardano_genesis_key_delegation_cert_t object. The genesis delegate hash is the public key hash of the delegate to whom the power of the genesis key is being delegated. This delegation is crucial during the transitional phase from the Byron era to the Shelley era, allowing specified delegates the rights to produce blocks.

Usage Example:

const cardano_genesis_key_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_blake2b_hash_t* delegate_hash = cardano_genesis_key_delegation_cert_get_genesis_delegate_hash(certificate);

if (delegate_hash != NULL)
{
  // Process the genesis delegate hash
  cardano_blake2b_hash_unref(&delegate_hash);
}

Note

This function returns a new reference that must be managed by the caller.

Parameters:¶

cardano_genesis_key_delegation_cert_t *certificate¶: [in] A constant pointer to an initialized cardano_genesis_key_delegation_cert_t object.

Returns:¶

A pointer to the cardano_blake2b_hash_t object containing the genesis delegate hash. If the certificate is NULL or if the genesis delegate hash is not set, this function returns NULL.

cardano_error_t cardano_genesis_key_delegation_cert_set_genesis_delegate_hash(cardano_genesis_key_delegation_cert_t *certificate, cardano_blake2b_hash_t *hash)¶

Sets the genesis delegate hash for a genesis key delegation certificate.

This function assigns a new genesis delegate hash to the specified cardano_genesis_key_delegation_cert_t object. The genesis delegate hash is the public key hash of the delegate to whom the power of the genesis key is being delegated, crucial during the transitional phase from the Byron era to the Shelley era.

Usage Example:

cardano_genesis_key_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_blake2b_hash_t* delegate_hash = ...; // Assume delegate_hash is already initialized

cardano_error_t result = cardano_genesis_key_delegation_cert_set_genesis_delegate_hash(certificate, delegate_hash);
if (result == CARDANO_SUCCESS)
{
  printf("Genesis delegate hash updated successfully.\n");
  cardano_blake2b_hash_unref(&delegate_hash);
}
else
{
  printf("Failed to set the genesis delegate hash.\n");
}

Note

This function does not take ownership of the hash; the caller is responsible for managing the lifecycle of the hash object.

Parameters:¶

cardano_genesis_key_delegation_cert_t *certificate¶: [in] A pointer to an initialized cardano_genesis_key_delegation_cert_t object.
cardano_blake2b_hash_t *hash¶: [in] A constant pointer to an initialized cardano_blake2b_hash_t object containing the new genesis delegate hash. The certificate object will hold a reference to this hash object, so it must remain valid for the duration of the certificate’s lifecycle or until a different hash is set.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the genesis delegate hash 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_blake2b_hash_t *cardano_genesis_key_delegation_cert_get_vrf_key_hash(cardano_genesis_key_delegation_cert_t *certificate)¶

Retrieves the VRF key hash from a genesis key delegation certificate.

This function extracts the VRF (Verifiable Random Function) key hash from the specified cardano_genesis_key_delegation_cert_t object. The VRF key hash is critical for ensuring the integrity and security of the random selection process in the blockchain’s consensus mechanism.

Usage Example:

const cardano_genesis_key_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
const cardano_blake2b_hash_t* vrf_key_hash = cardano_genesis_key_delegation_cert_get_vrf_key_hash(certificate);

if (vrf_key_hash != NULL)
{
  // Process the VRF key hash
  cardano_blake2b_hash_unref(&vrf_key_hash);
}
else
{
  printf("Failed to retrieve VRF key hash.\n");
}

Parameters:¶

cardano_genesis_key_delegation_cert_t *certificate¶: [in] A constant pointer to an initialized cardano_genesis_key_delegation_cert_t object.

Returns:¶

A pointer to the cardano_blake2b_hash_t object containing the VRF key hash. If the certificate is NULL or if the VRF key hash is not set, this function returns NULL. The returned hash object is a new reference, and the caller is responsible for releasing it using cardano_blake2b_hash_unref when it is no longer needed.

cardano_error_t cardano_genesis_key_delegation_cert_set_vrf_key_hash(cardano_genesis_key_delegation_cert_t *certificate, cardano_blake2b_hash_t *hash)¶

Sets the VRF key hash for a genesis key delegation certificate.

This function assigns a VRF (Verifiable Random Function) key hash to a given cardano_genesis_key_delegation_cert_t object. The VRF key hash is crucial for the secure and random selection process in the blockchain’s consensus mechanism.

Usage Example:

cardano_genesis_key_delegation_cert_t* certificate = ...; // Assume certificate is already initialized
cardano_blake2b_hash_t* vrf_key_hash = ...; // Assume vrf_key_hash is already initialized

cardano_error_t result = cardano_genesis_key_delegation_cert_set_vrf_key_hash(certificate, vrf_key_hash);
if (result == CARDANO_SUCCESS)
{
  printf("VRF key hash successfully set.\n");
  cardano_blake2b_hash_unref(&vrf_key_hash);
}
else
{
  printf("Failed to set VRF key hash.\n");
}

Note

This function does not take ownership of the hash; the caller is responsible for managing the lifecycle of the hash object.

Parameters:¶

cardano_genesis_key_delegation_cert_t *certificate¶: [inout] A pointer to an initialized cardano_genesis_key_delegation_cert_t object to which the VRF key hash will be set.
cardano_blake2b_hash_t *hash¶: [in] A pointer to an initialized cardano_blake2b_hash_t object representing the VRF key hash. The certificate takes a reference to this hash, ensuring it remains valid for the duration of the certificate’s usage.

Returns:¶

cardano_error_t indicating the outcome of the operation. Returns CARDANO_SUCCESS if the VRF key hash 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.

void cardano_genesis_key_delegation_cert_unref(cardano_genesis_key_delegation_cert_t **genesis_key_delegation_cert)¶

Decrements the reference count of a cardano_genesis_key_delegation_cert_t object.

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

Usage Example:

cardano_genesis_key_delegation_cert_t* genesis_key_delegation_cert = cardano_genesis_key_delegation_cert_new(major, minor);

// Perform operations with the genesis_key_delegation_cert...

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

Note

After calling cardano_genesis_key_delegation_cert_unref, the pointer to the cardano_genesis_key_delegation_cert_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_genesis_key_delegation_cert_t **genesis_key_delegation_cert¶: [inout] A pointer to the pointer of the genesis_key_delegation_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_genesis_key_delegation_cert_ref(cardano_genesis_key_delegation_cert_t *genesis_key_delegation_cert)¶

Increases the reference count of the cardano_genesis_key_delegation_cert_t object.

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

Usage Example:

// Assuming genesis_key_delegation_cert is a previously created genesis_key_delegation_cert object

cardano_genesis_key_delegation_cert_ref(genesis_key_delegation_cert);

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

Note

Always ensure that for every call to cardano_genesis_key_delegation_cert_ref there is a corresponding call to cardano_genesis_key_delegation_cert_unref to prevent memory leaks.

Parameters:¶

cardano_genesis_key_delegation_cert_t *genesis_key_delegation_cert¶: A pointer to the cardano_genesis_key_delegation_cert_t object whose reference count is to be incremented.

size_t cardano_genesis_key_delegation_cert_refcount(const cardano_genesis_key_delegation_cert_t *genesis_key_delegation_cert)¶

Retrieves the current reference count of the cardano_genesis_key_delegation_cert_t object.

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

Usage Example:

// Assuming genesis_key_delegation_cert is a previously created genesis_key_delegation_cert object

size_t ref_count = cardano_genesis_key_delegation_cert_refcount(genesis_key_delegation_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_genesis_key_delegation_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_genesis_key_delegation_cert_t *genesis_key_delegation_cert¶: A pointer to the cardano_genesis_key_delegation_cert_t object whose reference count is queried. The object must not be NULL.

Returns:¶

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

void cardano_genesis_key_delegation_cert_set_last_error(cardano_genesis_key_delegation_cert_t *genesis_key_delegation_cert, const char *message)¶

Sets the last error message for a given cardano_genesis_key_delegation_cert_t object.

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

const char *cardano_genesis_key_delegation_cert_get_last_error(const cardano_genesis_key_delegation_cert_t *genesis_key_delegation_cert)¶

Retrieves the last error message recorded for a specific genesis_key_delegation_cert.

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

Parameters:¶

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

Returns:¶

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