Directory chain/nm_api

Module-level declarations

Node Management API

Types

Link copied to clipboard
struct blockchain_configuration_info

Information about a blockchain configuration

Link copied to clipboard
struct blockchain_info

Information about a blockchain

Link copied to clipboard
struct container_image_info

Information about a container image

Link copied to clipboard
struct container_rate_limit

Information about container rate limits.

Link copied to clipboard
struct inactive_blockchain_info

Information about an inactive blockchain

Link copied to clipboard
struct migrating_blockchain_node_info

Information about a blockchain migration for a node

Functions

Link copied to clipboard
function _get_container_limit_or_default(value: integer, container_units: integer): integer
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Queries

Link copied to clipboard
query nm_api_version(): integer

Returns NM API Version NM API Version: 1

Link copied to clipboard
query nm_compute_blockchain_info_list(node_id: byte_array): list<blockchain_info>

Returns a list of blockchains to be launched or to be initialized on a node (RUNNING, PAUSED, IMPORTING, UNARCHIVING) NM API Version: 4 Compatibility:

  • NM API Version 4-8: Returns RUNNING or PAUSED blockchains

  • NM API Version 9-11: Returns RUNNING or PAUSED or IMPORTING blockchains

Link copied to clipboard
query nm_compute_blockchain_list(node_id: byte_array): list<byte_array>

Returns list of blockchains to be launched NM API Version: 1

Link copied to clipboard
query nm_find_next_configuration_height(blockchain_rid: byte_array, height: integer): integer?

Configuration updates are found in two tables. Both must be checked to get next configuration height. NM API Version: 1

Link copied to clipboard
query nm_find_next_inactive_blockchains(height: integer): list<inactive_blockchain_info>

Finds the next height blockchains were deactivated (removed, archived) at and returns found blockchain RIDs and heights. Returns an empty list if there are no blockchains deactivated after height. NM API Version 11

Link copied to clipboard
query nm_find_previous_configuration_height(blockchain_rid: byte_array, height: integer): integer?

Configuration updates are found in two tables. Both must be checked to get previous configuration height. NM API Version: 21

Link copied to clipboard
query nm_get_blockchain_configuration(blockchain_rid: byte_array, height: integer): byte_array?

Merge content of blockchain_configuration and blockchain_configuration_signers NM API Version: 1

Link copied to clipboard
query nm_get_blockchain_configuration_info(blockchain_rid: byte_array, height: integer): blockchain_configuration_info?

Returns blockchain configuration as a struct NM API Version: 18

Link copied to clipboard
query nm_get_blockchain_configuration_options(blockchain_rid: byte_array, height: integer): immutable_mirror_struct<blockchain_configuration_options>?

Returns blockchain_configuration_options structure for given blockchain and height or null NM API Version 8

Link copied to clipboard
query nm_get_blockchain_configuration_v5(blockchain_rid: byte_array, height: integer): (base_config: byte_array, signers: list<byte_array>, config_hash: byte_array)?

NM API Version: 5

Link copied to clipboard
query nm_get_blockchain_containers_for_node(node_id: byte_array, blockchain_rid: byte_array): list<text>

Returns a list of containers running on a node. NM API Version: 14

Link copied to clipboard
query nm_get_blockchain_dependencies(blockchain: blockchain, height: integer): list<(byte_array, text)>

Returns a list of brids with corresponding container that this blockchain is dependent on. At the given height. NM API Version: 3

Link copied to clipboard
query nm_get_blockchain_replica_node_map(blockchain_rids: set<byte_array>): map<byte_array, set<byte_array>>

NM API Version: 4

query nm_get_blockchain_signers_in_latest_configuration(blockchain_rid: byte_array): list<byte_array>

Returns the blockchain signers from the latest configuration NM API Version 9

Link copied to clipboard
query nm_get_blockchain_state(blockchain_rid: byte_array): text

Returns current state of blockchain NM API Version: 6

Link copied to clipboard
query nm_get_blockchains_for_container(container_name: text): list<byte_array>

NM API Version: 3

Link copied to clipboard
query nm_get_container_creation_time(name: text): integer?

Returns the time when the container was created, or null if that information is not available.

NM API Version: 23

Link copied to clipboard
query nm_get_container_for_blockchain(blockchain_rid: byte_array): text

Returns container blockchain is running in. NM API Version: 3

Link copied to clipboard
query nm_get_container_image(name: text): container_image_info?

Returns the Docker image required to run subnode for container, or null if the container does not specify any image.

NM API Version: 20

Link copied to clipboard
query nm_get_container_image_or_default(name: text): container_image_info?

Returns the Docker image required to run subnode for container, or the default subnode image if the container does not specify any image, or null if default image is not specified in directory chain.

NM API Version: 22

Link copied to clipboard
query nm_get_container_limits(name: text): map<text, integer>

NM API Version: 3

Link copied to clipboard
query nm_get_container_rate_limits(name: text): map<text, container_rate_limit>

Returns rate limit configuration for container as a map of task type to rate limit configuration for that type of tasks. If there is no rate limit for a particular task type for a container, it will be absent in the map. If there are no rate limits for anything for a container, the returned map will be empty.

NM API Version: 23

Link copied to clipboard
query nm_get_containers(pubkey: byte_array): list<text>

Returns node containers NM API Version: 3

Link copied to clipboard
query nm_get_faulty_blockchain_configuration(blockchain_rid: byte_array, height: integer): byte_array?

Precise Configuration Update: Returns a faulty blockchain config by height or null NM API Version: 5

Link copied to clipboard
query nm_get_management_chain(): byte_array

Returns Blockchain RID of management chain NM API Version: 7

Link copied to clipboard
query nm_get_migrating_blockchain_node_info(node_id: byte_array, blockchain_rid: byte_array): migrating_blockchain_node_info?

Returns migrating (moving or unarchiving) blockchain info. NM API Version 15

Link copied to clipboard
query nm_get_peer_infos(): list<(text, integer, byte_array, integer)>

Returns peer info list NM API Version: 1 (API expects array, so we need suppress naming)

Link copied to clipboard
query nm_get_pending_blockchain_configuration(blockchain_rid: byte_array, height: integer): list<(base_config: byte_array, signers: list<byte_array>, minimum_height: integer)>

Precise Configuration Update: Returns list of pending configs with minimum_height <= height NM API Version: 5

query nm_get_pending_blockchain_configuration_by_hash(blockchain_rid: byte_array, config_hash: byte_array): (base_config: byte_array, signers: list<byte_array>, minimum_height: integer)?

Precise Configuration Update: Returns a pending blockchain config by config hash or null NM API Version: 5

Link copied to clipboard
query nm_is_blockchain_provider(provider_pubkey: byte_array, blockchain_rid: byte_array): boolean

Returns true if pubkey is allowed to deploy to blockchain, otherwise false. NM API Version 19