val invalid_entity_message: text = "Entity name can only contain letters, numerals, underscores and must start with either a letter or numeral. Maximum allowed length is 64 characters."

Functions

_add_replica_node_to_cluster_internal

function _add_replica_node_to_cluster_internal(cluster: cluster, node: node)

_after_provider_registered_add_key

@extend(after_provider_registered) function _after_provider_registered_add_key(provider: provider, cluster: cluster?)

_is_node_provider

function _is_node_provider(tier: provider_tier): boolean

_remove_replica_node_from_cluster_internal

function _remove_replica_node_from_cluster_internal(cluster: cluster, node: node)

_require_provider_quota

function _require_provider_quota(quota: integer, quota_type: provider_quota_type, count: integer)

_setup_provider_quotas

function _setup_provider_quotas(actions_per_day: integer, max_containers: integer)

activate_cluster_anchoring_chain

@extend(after_cluster_operational) function activate_cluster_anchoring_chain(cluster: cluster)

add_blockchain

function add_blockchain(base_configuration: byte_array, signers: list<byte_array>, name: text, container: container, system: boolean, state: blockchain_state): blockchain

add_dependencies

function add_dependencies(raw_config: byte_array, brid: byte_array, height: integer)

add_node_internal

function add_node_internal(provider: provider, node_data: register_node_data, require_not_exists: boolean): node

add_node_to_cluster_internal

function add_node_to_cluster_internal(provider: provider, node: node, cluster: cluster)

If a provider is part of that cluster, and if provider do not already have a node in this cluster, add node as block signer to this cluster. blockchain_configuration_signers update is included.

after_cluster_creation

@extendable function after_cluster_creation(provider: provider, cluster: cluster)

after_cluster_operational

@extendable function after_cluster_operational(cluster: cluster)

after_cluster_subnode_image_added

@extendable function after_cluster_subnode_image_added(cluster: cluster, subnode_image: subnode_image)

after_cluster_subnode_image_removed

@extendable function after_cluster_subnode_image_removed(cluster: cluster, subnode_image: subnode_image)

after_cluster_updated

@extendable function after_cluster_updated(cluster: cluster)

after_node_added

@extendable function after_node_added(node: node)

after_node_added_to_cluster

@extendable function after_node_added_to_cluster(node: node, cluster: cluster)

after_node_removed_from_cluster

@extendable function after_node_removed_from_cluster(node: node, cluster: cluster?)

after_node_updated

@extendable function after_node_updated(node: node)

after_provider_registered

@extendable function after_provider_registered(provider: provider, cluster: cluster?)

after_provider_updated

@extendable function after_provider_updated(provider: provider)

after_replica_node_added_to_cluster

@extendable function after_replica_node_added_to_cluster(node: node, cluster: cluster)

after_replica_node_removed_from_cluster

@extendable function after_replica_node_removed_from_cluster(node: node, cluster: cluster?)

after_subnode_image_creation

@extendable function after_subnode_image_creation(subnode_image: subnode_image)

after_subnode_image_updated

@extendable function after_subnode_image_updated(subnode_image: subnode_image)

allow_blockchain_dependencies

function allow_blockchain_dependencies(): boolean

before_cluster_removal

@extendable function before_cluster_removal(cluster: cluster)

before_delete_blockchain

@extendable function before_delete_blockchain(blockchain: blockchain)

before_node_removal

@extendable function before_node_removal(node: node)

before_remove_container

@extendable function before_remove_container(container: container)

before_store_blockchain_configuration

@extendable function before_store_blockchain_configuration(blockchain: blockchain, config_map: map<text, gtv>)

before_system_container_removal

@extendable function before_system_container_removal(cluster: cluster)

begin_block

@extend(on_begin_block) function begin_block(height: integer)

calculate_configuration_hash

function calculate_configuration_hash(base_config: byte_array, signers: list<byte_array>): byte_array

check_operational

function check_operational(cl: cluster)

When all providers have provided a node each, cluster goes operational and stays operational even if a new provider is added to the cluster or a provider disables its node (if it is not the last node of the cluster).

compress_and_store_configuration

function compress_and_store_configuration(blockchain: blockchain, height: integer, configuration: byte_array, overwrite: boolean)

compress_root

function compress_root(root: map<text, gtv>, path: list<text>, compressed_keys: list<compressed_key>): map<text, gtv>

create_cluster_impl

function create_cluster_impl(me: provider, name: text, governor: voter_set, providers: list<byte_array>, cluster_creation_data: cluster_creation_data): cluster

create_container_impl

function create_container_impl(me: provider, name: text, cluster: cluster, consensus_threshold: integer, deployers: list<byte_array>, container_units: integer, max_blockchains: integer, extra_storage: integer, extra_compute_requests: integer): container

create_container_with_limits

function create_container_with_limits(me: provider, name: text, cluster: cluster, voter_set: voter_set, container_units: integer, max_blockchains: integer, extra_storage: integer, extra_compute_requests: integer): container

create_system_container

function create_system_container(me: provider, name: text, cluster: cluster, voter_set: voter_set): container

current_provider_rate_limit

function current_provider_rate_limit(provider: provider, current_timestamp: integer): (current_points: integer, max_points: integer, update_time: integer)

decompress_configuration

function decompress_configuration(configuration: byte_array): byte_array

decompress_root

function decompress_root(root: map<text, gtv>, path: list<text>, compressed_keys: list<compressed_key>): map<text, gtv>

disable_provider

function disable_provider(provider: provider)

enable_provider

function enable_provider(provider: provider)

extract_config_delay

function extract_config_delay(config_map: map<text, gtv>): integer?

function#0

@extend(after_node_added_to_cluster) function (node: node, cluster: cluster)

function#1

@extend(after_replica_node_added_to_cluster) function (node: node, cluster: cluster)

get_available_cluster_units_for_node

function get_available_cluster_units_for_node(node: node): integer

get_available_container_units

function get_available_container_units(cluster: cluster): integer

get_available_extra_storage

function get_available_extra_storage(cluster: cluster): integer

get_available_extra_storage_for_node

function get_available_extra_storage_for_node(node: node): integer

get_blockchain_configuration

function get_blockchain_configuration(blockchain_rid: byte_array, height: integer): (base_config: byte_array, signers: list<byte_array>, config_hash: byte_array)?

get_blockchain_configuration_data

function get_blockchain_configuration_data(blockchain: blockchain, height: integer): byte_array?

get_blockchain_signer_nodes

function get_blockchain_signer_nodes(blockchain: blockchain): list<node>

get_cluster_count_for_node

function get_cluster_count_for_node(node: node): integer

get_cluster_for_blockchain

function get_cluster_for_blockchain(blockchain_rid: byte_array): cluster

get_config_map

function get_config_map(raw_config: byte_array): map<text, gtv>

get_container_blockchain_count

function get_container_blockchain_count(container: container): integer

get_container_limit_or_default

function get_container_limit_or_default(container: container, type: container_resource_limit_type, default: integer): integer

get_current_container_resource_limits

function get_current_container_resource_limits(container_name: text): map<container_resource_limit_type, integer>

get_dependencies

function get_dependencies(config_map: map<text, gtv>): list<(text, byte_array)>

get_latest_blockchain_configuration_data

function get_latest_blockchain_configuration_data(blockchain: blockchain): (height: integer, config: byte_array)

get_latest_pending_blockchain_configuration_data

function get_latest_pending_blockchain_configuration_data(blockchain: blockchain): (minimum_height: integer, base_config: byte_array, signers: byte_array)?

get_max_container_units_for_cluster

function get_max_container_units_for_cluster(cluster: cluster): integer

get_minimum_cluster_units_for_current_container_units

function get_minimum_cluster_units_for_current_container_units(cluster: cluster): integer

get_minimum_extra_storage_for_clusters

function get_minimum_extra_storage_for_clusters(clusters: list<cluster>): integer

get_pending_blockchain_configuration

function get_pending_blockchain_configuration(blockchain: blockchain, height: integer): list<(base_config: byte_array, signers: list<byte_array>, minimum_height: integer)>

get_pending_blockchain_configuration_by_hash

function get_pending_blockchain_configuration_by_hash(blockchain: blockchain, config_hash: byte_array): (base_config: byte_array, signers: list<byte_array>, minimum_height: integer)?

get_signers_for_configuration

function get_signers_for_configuration(blockchain: blockchain, height: integer): gtv

get_used_cluster_units_for_node

function get_used_cluster_units_for_node(node: node): integer

get_used_container_units

function get_used_container_units(cluster: cluster): integer

get_used_extra_storage_for_cluster

function get_used_extra_storage_for_cluster(cluster: cluster): integer

get_used_extra_storage_for_node

function get_used_extra_storage_for_node(node: node): integer

get_voter_set_members_sorted

function get_voter_set_members_sorted(name: text): list<byte_array>

initialize_module

function initialize_module(initial_provider: byte_array, genesis_node: node_info, system_anchoring_config: byte_array, cluster_anchoring_config: byte_array, majority_threshold: integer, provider_quota_max_containers: integer)

is_alive

function is_alive(blockchain: blockchain): boolean

is_container_available_for_removal

@extendable function is_container_available_for_removal(container: container): text?

is_initialized

function is_initialized(): boolean

make_config_unique

function make_config_unique(config_data: byte_array): byte_array

maybe_replicate_cluster_anchor_chain_on_node

function maybe_replicate_cluster_anchor_chain_on_node(node: node, cluster: cluster)

number_of_nodes_in_cluster

function number_of_nodes_in_cluster(cluster: cluster): integer

on_configuration_updated

@extendable function on_configuration_updated(message: configuration_updated)

provider_rate_limit

function provider_rate_limit(provider: provider, cost: integer)

Recover provider's action points and consume cost, if possible

receive_configuration_failed

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

receive_configuration_updated

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

recover_provider_rate_limit

function recover_provider_rate_limit(provider: provider, cost: integer): integer

register_and_enable_provider

@extendable function register_and_enable_provider(provider_info: provider_info, provider_tier: provider_tier, cluster: cluster?, voter_set: voter_set?, enabled_by_default: boolean)

remove_blockchain

function remove_blockchain(blockchain: blockchain)

remove_cluster_anchoring_chain

@extend(before_system_container_removal) function remove_cluster_anchoring_chain(cluster: cluster)

remove_cluster_impl

function remove_cluster_impl(cluster: cluster)

remove_container_and_voter_set

function remove_container_and_voter_set(container: container)

remove_container_blockchains

@extend(before_remove_container) function remove_container_blockchains(container: container)

remove_container_impl

function remove_container_impl(container: container)

remove_system_container

@extend(before_cluster_removal) function remove_system_container(cluster: cluster)

require_active_blockchain

function require_active_blockchain(blockchain_rid: byte_array): blockchain

require_blockchain

function require_blockchain(blockchain_rid: byte_array, allowed_states: list<blockchain_state>?): blockchain

require_blockchain_rid

function require_blockchain_rid(blockchain_rid: byte_array)

require_cluster

function require_cluster(name: text): cluster

require_cluster_available_for_removal

function require_cluster_available_for_removal(cluster: cluster)

require_cluster_container_units

function require_cluster_container_units(cluster: cluster, wanted_container_units: integer)

require_cluster_extra_storage

function require_cluster_extra_storage(cluster: cluster, wanted_extra_storage: integer)

require_cluster_governor

function require_cluster_governor(cluster: cluster, provider: provider)

require_cluster_quotas

function require_cluster_quotas(cluster: cluster, wanted_container_units: integer, wanted_extra_storage: integer)

require_cluster_units_for_node

function require_cluster_units_for_node(cluster: cluster, node: node)

require_clusters

function require_clusters(names: list<text>): list<cluster>

require_container

function require_container(name: text): container

require_container_available_for_removal

function require_container_available_for_removal(container: container)

require_container_deployer

function require_container_deployer(container: container, provider: provider)

require_container_is_not_full

function require_container_is_not_full(container: container)

require_container_units

function require_container_units(container: container, new_container_units: integer)

require_extra_storage

function require_extra_storage(container: container, new_extra_storage: integer)

require_extra_storage_for_node

function require_extra_storage_for_node(cluster: cluster, node: node)

require_height_is_greater_or_equal_to_last_config_height

function require_height_is_greater_or_equal_to_last_config_height(blockchain: blockchain, height: integer)

require_is_provider_with_rate_limit

function require_is_provider_with_rate_limit(pubkey: byte_array, provider_key_roles: list<provider_key_role>, cost: integer): provider

Requires given pubkey is a provider, is signing transaction, is active and not exceeds limit.

require_is_signer

function require_is_signer(pubkey: byte_array)

require_is_system_provider

function require_is_system_provider(pubkey: byte_array): provider

require_max_blockchains

function require_max_blockchains(container: container, new_max_blockchains: integer)

require_node

function require_node(pubkey: byte_array, include_disabled: boolean): node

require_node_provider

function require_node_provider(node_pubkey: byte_array, provider_pubkey: byte_array): node

require_provider

function require_provider(pubkey: byte_array): provider

require_provider_auth

function require_provider_auth(provider: provider, provider_key_roles: list<provider_key_role>): provider

Requires given pubkey is an active provider which is signing the transaction.

require_provider_auth_with_rate_limit

function require_provider_auth_with_rate_limit(provider: provider, provider_key_roles: list<provider_key_role>, cost: integer): provider

Requires given provider is signing transaction, is active and not exceeds limit.

require_provider_iccf_auth

function require_provider_iccf_auth(tx_to_prove: gtx_transaction, op_index: integer, op_name: text, op_arg_count: integer, provider: provider): list<gtv>

Requires given provider to authenticate using ICCF.

require_provider_iccf_auth_from_operations

function require_provider_iccf_auth_from_operations(all_operations: list<gtx_operation>, tx_to_prove: gtx_transaction, op_index: integer, op_name: text, op_arg_count: integer, provider: provider, should_update_state: boolean): list<gtv>

Requires given provider to authenticate using ICCF.

require_provider_quota

function require_provider_quota(provider: provider, quota_type: provider_quota_type)

require_provider_with_iccf_proof_and_rate_limit

function require_provider_with_iccf_proof_and_rate_limit(tx_to_prove: gtx_transaction, op_index: integer, op_name: text, op_arg_count: integer, provider: provider): list<gtv>

Requires given provider to authenticate this transaction, is active and not exceeds limit.

require_pubkey

function require_pubkey(pubkey: byte_array)

require_running_container

function require_running_container(name: text): container

require_subnode_image

function require_subnode_image(name: text): subnode_image

require_system_p_member

function require_system_p_member(provider: provider)

require_unique_blockchain

function require_unique_blockchain(name: text, base_configuration: byte_array, signers: list<byte_array>): byte_array

require_voter_set

function require_voter_set(name: text): voter_set

require_voter_set_governor

function require_voter_set_governor(voter_set: voter_set, provider: provider)

require_voter_set_member

function require_voter_set_member(voter_set: voter_set, provider: provider)

set_cluster_anchoring_config

function set_cluster_anchoring_config(config: byte_array)

set_latest_blockchain_configuration_values

@extend(before_store_blockchain_configuration) function set_latest_blockchain_configuration_values(blockchain: blockchain, config_map: map<text, gtv>)

store_configuration

function store_configuration(blockchain: blockchain, height: integer, configuration: byte_array, overwrite: boolean)

update_configuration_signers

function update_configuration_signers(cluster: cluster, excluded_node: node?)

update_configuration_signers_chain0

function update_configuration_signers_chain0(blockchain: blockchain, signers: list<byte_array>)

update_configuration_signers_regular

function update_configuration_signers_regular(blockchain: blockchain, signers: list<byte_array>, excluded_signer: byte_array?)

upgrade_container

function upgrade_container(container: container, container_units: integer, extra_storage: integer, max_blockchains: integer, extra_compute_requests: integer)

validate_blockchain_dependencies

function validate_blockchain_dependencies(dependencies: list<(text, byte_array)>, brid: byte_array, container: container, height: integer): list<dependency_blockchain_to_height>

validate_dependencies

function validate_dependencies(config_map: map<text, gtv>): boolean

validate_entity_name

function validate_entity_name(name: text)

validate_host

function validate_host(host: text)

validate_list_of_classes

function validate_list_of_classes(parameter_name: text, value: text)

validate_metadata_text

function validate_metadata_text(parameter_name: text, value: text)

validate_node_url

function validate_node_url(url: text)

validate_territory_code

function validate_territory_code(territory: text)

validate_url

function validate_url(url: text)