Directory chain/common.queries

Module-level declarations

Common queries always accessed withing the directory chain

Types

blockchain_info

struct blockchain_info

blockchain_signers_info

struct blockchain_signers_info

cluster_data

struct cluster_data

container_data

struct container_data

container_unit_resource_limits

struct container_unit_resource_limits

Resource limits for 1 container unit.

module_args

struct module_args

node_data

struct node_data

node_info

struct node_info

provider_auth_blockchain_data

struct provider_auth_blockchain_data

provider_node_data

struct provider_node_data

subnode_image_data

struct subnode_image_data

Functions

get_blockchains_with_container

function get_blockchains_with_container(include_inactive: boolean): list<(blockchain: blockchain, container: container)>

get_subnode_image_data

function get_subnode_image_data(subnode_image: subnode_image): subnode_image_data

Queries

get_all_nodes

query get_all_nodes(include_inactive: boolean): list<(info: node_info, active: boolean, last_updated: integer, provider: immutable_mirror_struct<provider>)>

Returns all nodes.

get_all_providers

query get_all_providers(): list<immutable_mirror_struct<provider>>

Returns all providers.

get_blockchain

query get_blockchain(rid: byte_array): blockchain

Returns blockchain by rid.

get_blockchain_api_urls

query get_blockchain_api_urls(blockchain_rid: byte_array): list<text>

Returns blockchain nodes api urls.

get_blockchain_cluster

query get_blockchain_cluster(blockchain_rid: byte_array): text

Returns blockchain's cluster.

get_blockchain_info

query get_blockchain_info(rid: byte_array): blockchain_info?

Returns blockchain info.

get_blockchain_info_list

query get_blockchain_info_list(include_inactive: boolean): list<blockchain_info>

Returns blockchains info by criteria.

get_blockchain_replicas

query get_blockchain_replicas(blockchain_rid: byte_array): list<(byte_array, text, integer, boolean, integer)>

Returns blockchain replica nodes.

get_blockchain_signer_updates

query get_blockchain_signer_updates(blockchain_rid: byte_array, from_height: integer): list<blockchain_signers_info>

Returns blockchain configuration signers from height.

get_blockchain_signers

query get_blockchain_signers(blockchain_rid: byte_array): list<(byte_array, text, integer, boolean, integer)>

Returns blockchain signer nodes.

get_blockchains

query get_blockchains(include_inactive: boolean): list<immutable_mirror_struct<blockchain>>

Returns all blockchains by criteria.

get_cluster

query get_cluster(name: text): cluster

Returns cluster by name.

get_cluster_anchoring_configuration

query get_cluster_anchoring_configuration(): byte_array

Returns cluster anchoring raw config.

get_cluster_api_urls

query get_cluster_api_urls(name: text): list<text>

Returns cluster nodes api urls.

get_cluster_blockchains

query get_cluster_blockchains(name: text): list<byte_array>

Returns cluster's blockchains ids by cluster name.

get_cluster_container_unit_limits

query get_cluster_container_unit_limits(cluster_name: text): container_unit_resource_limits

Return resource limit specification for 1 cluster unit.

get_cluster_containers

query get_cluster_containers(cluster_name: text): list<(name: text, deployer: text)>

Returns cluster containers by cluster name.

get_cluster_data

query get_cluster_data(name: text): cluster_data

Returns information for a specified cluster, including any special subnode images supported by the cluster.

get_cluster_nodes

query get_cluster_nodes(name: text): list<(pubkey: byte_array, host: text, port: integer, api_url: text, active: boolean)>

Returns nodes by cluster name.

get_cluster_providers

query get_cluster_providers(name: text): list<(name: text, pubkey: byte_array)>

Returns providers by cluster name.

get_cluster_replica_nodes

query get_cluster_replica_nodes(name: text): list<(pubkey: byte_array, host: text, port: integer, api_url: text, active: boolean)>

Returns cluster replica nodes by cluster name.

get_cluster_subnode_images

query get_cluster_subnode_images(name: text): list<(name: text, url: text, digest: text)>

Returns subnode images for a cluster.

get_clusters

query get_clusters(): list<cluster_data>

Returns all clusters.

get_compressed_configuration_parts

query get_compressed_configuration_parts(configuration_part_hashes: set<byte_array>): list<byte_array>

Returns compressed blockchain configuration part.

get_container

query get_container(name: text): container

Returns container.

get_container_blockchain

query get_container_blockchain(name: text): list<(rid: byte_array, name: text, system: boolean, state: blockchain_state)>

Returns container blockchains data.

get_container_data

query get_container_data(name: text): container_data

Returns container data.

get_containers

query get_containers(): list<(cluster: text, name: text, deployer: text)>

Returns all containers.

get_developers

query get_developers(): list<text>

Returns current developers of Core Team.

get_importing_foreign_blockchain_info

query get_importing_foreign_blockchain_info(blockchain_rid: byte_array): immutable_mirror_struct<importing_foreign_blockchain>?

Returns importing foreign blockchain.

get_moving_blockchain_info

query get_moving_blockchain_info(blockchain_rid: byte_array): (source_container: text, destination_container: text, final_height: integer)?

Returns moving blockchain.

get_node

query get_node(pubkey: byte_array): node

Returns node.

get_node_containers

query get_node_containers(pubkey: byte_array): list<(cluster: text, name: text, deployer: text)>

Returns containers of node's clusters.

get_node_data

query get_node_data(pubkey: byte_array): node_data

Returns node data.

get_nodes_by_provider

query get_nodes_by_provider(pubkey: byte_array): list<provider_node_data>

Returns nodes data by provider pubkey.

get_nodes_with_provider

query get_nodes_with_provider(): list<(pubkey: byte_array, node_active: boolean, host: text, port: integer, last_updated: integer, name: text, provider_active: boolean, provider: byte_array)>

get_operational_dapp_clusters

query get_operational_dapp_clusters(): list<cluster_data>

Returns information for all operational dapp clusters, including any special subnode images supported by the cluster.

get_provider_auth_blockchain

query get_provider_auth_blockchain(pubkey: byte_array): provider_auth_blockchain_data?

Returns provider blockchain auth information, or null if blockchain auth is not enabled for provider.

get_provider_by_key

query get_provider_by_key(pubkey: byte_array): byte_array?

Find provider by auth key and return provider identifier pubkey.

get_provider_clusters

query get_provider_clusters(pubkey: byte_array): list<text>

Returns clusters of a provider.

get_provider_data

query get_provider_data(pubkey: byte_array): immutable_mirror_struct<provider>

get_provider_keys

query get_provider_keys(pubkey: byte_array): provider_keys_data

Get keys for provider, their roles and threshold.

get_provider_points

query get_provider_points(pubkey: byte_array): integer

Returns actions rate limit points.

get_provider_quotas

query get_provider_quotas(): list<immutable_mirror_struct<provider_quota>>

Returns provider quotas.

get_providers

query get_providers(tier: provider_tier, system: boolean, require_active: boolean): list<immutable_mirror_struct<provider>>

Returns providers by criteria.

get_subnode_image

query get_subnode_image(name: text): subnode_image_data

Returns subnode image data.

get_subnode_images

query get_subnode_images(): list<subnode_image_data>

Returns all subnode images.

get_summary

query get_summary(): (providers: integer, clusters: integer, containers: integer, voter_sets: integer, nodes: integer, blockchains: integer)

Returns number of providers, clusters, containers, voter sets, nodes and blockchains.

get_unarchiving_blockchain_info

query get_unarchiving_blockchain_info(blockchain_rid: byte_array): (source_container: text, destination_container: text, final_height: integer)?

Returns unarchiving blockchain.

get_voter_set

query get_voter_set(name: text): voter_set

Returns voter set by name.

get_voter_set_governor

query get_voter_set_governor(name: text): text

Returns voter set governance.

get_voter_set_info

query get_voter_set_info(name: text): (name: text, threshold: integer, governor: text, members: list<byte_array>)

Returns voters set info.

get_voter_set_members

query get_voter_set_members(name: text): list<byte_array>

Returns voter set members.

get_voter_sets

query get_voter_sets(): list<(name: text, threshold: integer, gorvernor: text)>

Returns voter sets with governor.

list_clusters_of_node

query list_clusters_of_node(pubkey: byte_array): list<text>

Returns clusters of node.

list_voter_sets

query list_voter_sets(): list<immutable_mirror_struct<voter_set>>

Returns voters set.