Directory chain/anchoring_chain_cluster

Module-level declarations

Cluster Anchoring Chain

Types

container_blockchain

entity container_blockchain

container_resource_usage_statistics

struct container_resource_usage_statistics

Represents the measured value of a specific resource for a container on a specific node.

struct current_range

icmf_messages_height

entity icmf_messages_height

struct module_args

node_availability

entity node_availability

node_availability_report_stat

object node_availability_report_stat

range_statistic

struct range_statistic

resource_usage_statistics

entity resource_usage_statistics

Resource usage value and its associated measurement time by node for each container.

signed_block_header_with_anchor_height

struct signed_block_header_with_anchor_height

Properties

DEFAULT_HEADERS_WITH_MESSAGES_QUERY_LIMIT

val DEFAULT_HEADERS_WITH_MESSAGES_QUERY_LIMIT: integer = 100

val INTEGER_SIZE: integer = 4

PRIMARY_HEADER_KEY

val PRIMARY_HEADER_KEY: text = "primary"

val query_limit: integer = null

Functions

calculate_node_availability

function calculate_node_availability(anchored_blocks: list<(blockchain_rid: byte_array, witness: byte_array, gtv?)>, block_range_size: integer): map<byte_array, decimal>

clean_up_node_availabiliy

function clean_up_node_availabiliy()

do_availability_reporting

function do_availability_reporting()

extract_number_of_signers_from_current_configuration

function extract_number_of_signers_from_current_configuration(): integer

extract_signers_from_witness

function extract_signers_from_witness(witness: byte_array): list<byte_array>

fetch_aggregated_node_availability

function fetch_aggregated_node_availability(start_time: integer, end_time: integer): map<byte_array, decimal>

fetch_blocks_and_calculate_and_store_node_availability

function fetch_blocks_and_calculate_and_store_node_availability(start_time: integer, end_time: integer, block_range_size: integer)

fetch_blocks_and_calculate_node_availability

function fetch_blocks_and_calculate_node_availability(start_time: integer, end_time: integer, block_range_size: integer): map<byte_array, decimal>

get_excluded_blockchains

function get_excluded_blockchains(): list<byte_array>

handle_resource_usage_statistics

function handle_resource_usage_statistics(node_pubkey: byte_array, container_name: text, measurement_time: integer, resource_type: resource_type, metric_value: decimal)

is_time_to_calculate_availability_report

function is_time_to_calculate_availability_report(): boolean

is_time_to_send_availability_report

function is_time_to_send_availability_report(): boolean

on_resource_usage_statistics_update

@extendable function on_resource_usage_statistics_update(node_pubkey: byte_array, container_name: text, measurement_time: integer, resource_type: resource_type, metric_value: decimal, previous_value: resource_usage_statistics?)

function parse_integer(bytes: byte_array, start_index: integer): integer

@extend(after_anchoring_block) function process_icmf(block_rid: byte_array, header: block_header)

receive_container_blockchain_update

@extend(receive_icmf_message) function receive_container_blockchain_update(sender: byte_array, topic: text, body: gtv)

receive_container_blockchain_update_impl

function receive_container_blockchain_update_impl(body: gtv)

send_node_availability_report

function send_node_availability_report()

send_resource_usage_statistics_update

@extend(on_resource_usage_statistics_update) function send_resource_usage_statistics_update(node_pubkey: byte_array, container_name: text, measurement_time: integer, type: resource_type, metric_value: decimal, previous_value: resource_usage_statistics?)

update_maximum_number_of_nodes_in_cluser_since_last_report

function update_maximum_number_of_nodes_in_cluser_since_last_report(current_number_of_signers: integer)

Queries

query api_version(): integer

get_latest_resource_usage_statistics

query get_latest_resource_usage_statistics(container_name: text, resource_type: resource_type?, node_pubkey: byte_array?): list<container_resource_usage_statistics>

Retrieves last measured resource usage statistics across nodes, for a given container optionally filtered by resource type and node.

icmf_get_headers_with_messages_after_height

query icmf_get_headers_with_messages_after_height(topic: text, from_anchor_height: integer): list<signed_block_header_with_anchor_height>

Operations

operation __begin_block(height: integer)

__resource_usage_statistics

operation __resource_usage_statistics(node_pubkey: byte_array, container_name: text, measurement_time: integer, resource_type: resource_type, metric_value: decimal)