Chain

Defines C API for querying internal chain state.

Functions

Functions Documentation

function get_active_producers

uint32_t get_active_producers(
    capi_name * producers,
    uint32_t datalen
)

Gets the set of active producers.

Parameters:

  • producers - Pointer to a buffer of account names
  • datalen - Byte length of buffer, when passed 0 will return the size required to store full output.

Returns:

uint32_t - Number of bytes actually populated

Precondition:

producers is a pointer to a range of memory at least datalen bytes long

Post

the passed in producers pointer gets the array of active producers.

Example:

capi_name producers[21];
uint32_t bytes_populated = get_active_producers(producers, sizeof(capi_name)*21);