Download OpenAPI specification:
The RPC API served by the Octez node.
Aggregate BLS proofs. Return null if the provided proofs cannot be aggregated, or if their aggregation is not a valid proof for the provided public key.
required | (Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Bls12_381 public key (Base58Check-encoded)) |
required | Array of (Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Bls12_381 signature (Base58Check-encoded)) |
{- "public_key": "string",
- "proofs": [
- "string"
]
}
"string"
Aggregate BLS public keys after checking their BLS proofs
required | (Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Bls12_381 public key (Base58Check-encoded)) |
required | (Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Bls12_381 signature (Base58Check-encoded)) |
[- {
- "public_key": "string",
- "proof": "string"
}
]
{- "public_key": "string",
- "public_key_hash": "string"
}
Aggregate BLS signatures. Return null if the signatures cannot be aggregated, or if their aggregation is not a valid signature for the provided public key and message.
required | (Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Bls12_381 public key (Base58Check-encoded)) |
message required | string^([a-zA-Z0-9][a-zA-Z0-9])*$ |
required | Array of (Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Bls12_381 signature (Base58Check-encoded)) |
{- "public_key": "string",
- "message": "string",
- "signature_shares": [
- "string"
]
}
"string"
Check a BLS proof
required | (Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Bls12_381 public key (Base58Check-encoded)) |
required | (Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Bls12_381 signature (Base58Check-encoded)) |
{- "public_key": "string",
- "proof": "string"
}
true
Threshold BLS signatures
required | (Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Bls12_381 public key (Base58Check-encoded)) |
message required | string^([a-zA-Z0-9][a-zA-Z0-9])*$ |
required | Array of objects |
{- "public_key": "string",
- "message": "string",
- "signature_shares": [
- {
- "id": -128,
- "signature": "string"
}
]
}
"string"
Forcefully set the bootstrapped flag of the node
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
bootstrapped required | boolean |
{- "bootstrapped": true
}
null
The heads of all active peers
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "active_peers_heads": [
- {
- "peer_id": "string",
- "block_hash": "string",
- "block_level": -2147483648
}
]
}
Lists block hashes from '
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
length | string The requested number of predecessors to return (per request; see next argument). |
head | string block_hash (Base58Check-encoded) An empty argument requests blocks starting with the current head. A non empty list allows to request one or more specific fragments of the chain. |
min_date | string A date in seconds from epoch When |
[- [
- "string"
]
]
A breakdown of all the contributions to the delegation portion of the baking power of the given delegate for the given cycle.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
int32 required | string |
pkh required | string A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded) |
{- "own_delegated": "string",
- "external_delegators": [
- {
- "delegator_contract_hash": "string",
- "contribution": "string"
}
], - "former_delegators_unstake_requests": "string",
- "overstaked": "string",
- "total_delegated_including_overdelegated": "string",
- "total_delegated_after_limits": "string",
- "overdelegated": "string"
}
Lists blocks that have been declared invalid along with the errors that led to them being declared invalid.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
[- {
- "block": "string",
- "level": -2147483648,
- "errors": null
}
]
The errors that appears during the block (in)validation.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
block_hash required | string block_hash (Base58Check-encoded) |
{- "block": "string",
- "level": -2147483648,
- "errors": null
}
Remove an invalid block for the tezos storage
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
block_hash required | string block_hash (Base58Check-encoded) |
{ }
The bootstrap status of a chain
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "bootstrapped": true,
- "sync_state": "stuck"
}
The current caboose for this chain.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "block_hash": "string",
- "level": -2147483648
}
The current checkpoint for this chain.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "block_hash": "string",
- "level": -2147483648
}
The current savepoint for this chain.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "block_hash": "string",
- "level": -2147483648
}
Lists protocols of the chain.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
[- {
- "protocol": "string",
- "proto_level": -1073741824,
- "activation_block": {
- "block_hash": "string",
- "level": -2147483648
}
}
]
Information about a protocol of the chain.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
Protocol_hash required | string Protocol_hash (Base58Check-encoded) |
{- "protocol": "string",
- "proto_level": -1073741824,
- "activation_block": {
- "block_hash": "string",
- "level": -2147483648
}
}
Return the runtime node configuration (this takes into account the command-line arguments and the on-disk configuration file)
{- "data-dir": "string",
- "disable-config-validation": true,
- "rpc": {
- "listen-addrs": [
- "string"
], - "external-listen-addrs": [
- "string"
], - "listen-addr": "string",
- "cors-origin": [
- "string"
], - "cors-headers": [
- "string"
], - "crt": "string",
- "key": "string",
- "acl": [
- {
- "address": "string",
- "whitelist": [
- "string"
]
}
], - "media-type": "json",
- "max_active_rpc_connections": "unlimited",
- "enable-http-cache-headers": true
}, - "p2p": {
- "expected-proof-of-work": 0,
- "bootstrap-peers": [
- "string"
], - "listen-addr": "string",
- "advertised-net-port": 65535,
- "discovery-addr": "string",
- "private-mode": true,
- "limits": {
- "connection-timeout": 0,
- "authentication-timeout": 0,
- "min-connections": 65535,
- "expected-connections": 65535,
- "max-connections": 65535,
- "backlog": 255,
- "max-incoming-connections": 255,
- "max-download-speed": -1073741824,
- "max-upload-speed": -1073741824,
- "swap-linger": 0,
- "binary-chunks-size": 255,
- "read-buffer-size": -1073741824,
- "read-queue-size": -1073741824,
- "write-queue-size": -1073741824,
- "incoming-app-message-queue-size": -1073741824,
- "incoming-message-queue-size": -1073741824,
- "outgoing-message-queue-size": -1073741824,
- "max_known_points": [
- 65535
], - "max_known_peer_ids": [
- 65535
], - "peer_greylist_size": 65535,
- "ip_greylist_size_in_kilobytes": 65535,
- "ip_greylist_cleanup_delay": 0,
- "greylist-timeout": 0,
- "maintenance-idle-time": 0
}, - "disable_mempool": true,
- "enable_testchain": true,
- "greylisting_config": {
- "factor": 0,
- "initial-delay": 0,
- "disconnection-delay": 0,
- "increase-cap": 0
}, - "disable_peer_discovery": true
}, - "log": {
- "output": "string",
- "level": "info",
- "colors": true,
- "rules": "string",
- "advertises_level": true
}, - "internal-events": {
- "active_sinks": [
- "string"
]
}, - "shell": {
- "peer_validator": {
- "block_header_request_timeout": 0,
- "block_operations_request_timeout": 0,
- "protocol_request_timeout": 0,
- "new_head_request_timeout": 0
}, - "block_validator": {
- "protocol_request_timeout": 0,
- "operation_metadata_size_limit": "unlimited"
}, - "prevalidator": {
- "operations_request_timeout": 0,
- "max_refused_operations": 65535,
- "operations_batch_size": -1073741824
}, - "chain_validator": {
- "latency": 65535,
- "synchronisation_threshold": 255
}, - "history_mode": "archive",
- "disable_context_pruning": true,
- "storage_maintenance_delay": "disabled"
}, - "network": "sandbox",
- "metrics_addr": [
- "string"
]
}
Returns the history mode of the node's underlying storage. In full or rolling mode, it provides the values of additional_cycles
and blocks_preservation_cycles
. The sum of these values is the total number of stored cycles.
{- "history_mode": "archive",
- "blocks_preservation_cycles": 255
}
Replace the logging configuration of the node.
Array of Universal string representation (string) or Universal string representation (object) (Universal string representation) List of URIs to activate/configure sinks. |
{- "active_sinks": [
- "string"
]
}
{ }
Inject a block in the node and broadcast it. The operations
embedded in blockHeader
might be pre-validated using a contextual RPCs from the latest block (e.g. '/blocks/head/context/preapply'). Returns the ID of the block. By default, the RPC will wait for the block to be validated before answering. If ?async is true, the function returns immediately. Otherwise, the block will be validated before the result is returned. If ?force is true, it will be injected even on non strictly increasing fitness. An optional ?chain parameter can be used to specify whether to inject on the test chain or the main chain.
async | string |
force | string |
chain | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
data required | string^([a-zA-Z0-9][a-zA-Z0-9])*$ |
required | Array of objects (operation) [ items ] |
{- "data": "string",
- "operations": [
- [
- {
- "branch": "string",
- "data": "string"
}
]
]
}
"string"
Inject an operation in node and broadcast it. Returns the ID of the operation. The signedOperationContents
should be constructed using contextual RPCs from the latest block and signed by the client. The injection of the operation will apply it on the current mempool context. This context may change at each operation injection or operation reception from peers. By default, the RPC will wait for the operation to be (pre-)validated before returning. However, if ?async is true, the function returns immediately. The optional ?chain parameter can be used to specify whether to inject on the test chain or the main chain.
async | string |
chain | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
"string"
"string"
Inject a protocol in node. Returns the ID of the protocol. If ?async is true, the function returns immediately. Otherwise, the protocol will be validated before the result is returned.
async | string |
expected_env_version required | integer (protocol.environment_version) [ 0 .. 65535 ] |
required | Array of objects |
{- "expected_env_version": 65535,
- "components": [
- {
- "name": "string",
- "interface": "string",
- "implementation": "string"
}
]
}
"string"
Monitor all blocks that are successfully applied and stored by the node, disregarding whether they were selected as the new head or not.
protocol | string Protocol_hash (Base58Check-encoded) |
next_protocol | string Protocol_hash (Base58Check-encoded) |
chain | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "chain_id": "string",
- "hash": "string",
- "header": {
- "level": -2147483648,
- "proto": 255,
- "predecessor": "string",
- "timestamp": "string",
- "validation_pass": 255,
- "operations_hash": "string",
- "fitness": [
- "string"
], - "context": "string",
- "protocol_data": "string"
}, - "operations": [
- [
- {
- "branch": "string",
- "data": "string"
}
]
]
}
Wait for the node to have synchronized its chain with a few peers (configured by the node's administrator), streaming head updates that happen during the bootstrapping process, and closing the stream at the end. If the node was already bootstrapped, returns the current head immediately.
{- "block": "string",
- "timestamp": "string"
}
Monitor all blocks that are successfully validated and applied by the node and selected as the new head of the given chain.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
protocol | string Protocol_hash (Base58Check-encoded) |
next_protocol | string Protocol_hash (Base58Check-encoded) |
{- "hash": "string",
- "level": -2147483648,
- "proto": 255,
- "predecessor": "string",
- "timestamp": "string",
- "validation_pass": 255,
- "operations_hash": "string",
- "fitness": [
- "string"
], - "context": "string",
- "protocol_data": "string"
}
Monitor all newly received blocks that are not yet known by the store.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "hash": "string"
}
Monitor all blocks that were successfully validated by the node but are not applied nor stored yet, disregarding whether they are going to be selected as the new head or not.
protocol | string Protocol_hash (Base58Check-encoded) |
next_protocol | string Protocol_hash (Base58Check-encoded) |
chain | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "chain_id": "string",
- "hash": "string",
- "header": {
- "level": -2147483648,
- "proto": 255,
- "predecessor": "string",
- "timestamp": "string",
- "validation_pass": 255,
- "operations_hash": "string",
- "fitness": [
- "string"
], - "context": "string",
- "protocol_data": "string"
}, - "operations": [
- [
- {
- "branch": "string",
- "data": "string"
}
]
]
}
[- {
- "incoming": true,
- "peer_id": "string",
- "id_point": {
- "addr": "string",
- "port": 65535
}, - "remote_socket_port": 65535,
- "announced_version": {
- "chain_name": "string",
- "distributed_db_version": 65535,
- "p2p_version": 65535
}, - "private": true,
- "local_metadata": {
- "disable_mempool": true,
- "private_node": true
}, - "remote_metadata": {
- "disable_mempool": true,
- "private_node": true
}
}
]
Details about the current P2P connection to the given peer.
peer_id required | string A cryptographic node identity (Base58Check-encoded) |
{- "incoming": true,
- "peer_id": "string",
- "id_point": {
- "addr": "string",
- "port": 65535
}, - "remote_socket_port": 65535,
- "announced_version": {
- "chain_name": "string",
- "distributed_db_version": 65535,
- "p2p_version": 65535
}, - "private": true,
- "local_metadata": {
- "disable_mempool": true,
- "private_node": true
}, - "remote_metadata": {
- "disable_mempool": true,
- "private_node": true
}
}
{- "stat": {
- "total_sent": "string",
- "total_recv": "string",
- "current_inflow": -1073741824,
- "current_outflow": -1073741824
}, - "incoming_connections": [
- {
- "incoming": true,
- "peer_id": "string",
- "id_point": {
- "addr": "string",
- "port": 65535
}, - "remote_socket_port": 65535,
- "announced_version": {
- "chain_name": "string",
- "distributed_db_version": 65535,
- "p2p_version": 65535
}, - "private": true,
- "local_metadata": {
- "disable_mempool": true,
- "private_node": true
}, - "remote_metadata": {
- "disable_mempool": true,
- "private_node": true
}
}
], - "outgoing_connections": [
- {
- "incoming": true,
- "peer_id": "string",
- "id_point": {
- "addr": "string",
- "port": 65535
}, - "remote_socket_port": 65535,
- "announced_version": {
- "chain_name": "string",
- "distributed_db_version": 65535,
- "p2p_version": 65535
}, - "private": true,
- "local_metadata": {
- "disable_mempool": true,
- "private_node": true
}, - "remote_metadata": {
- "disable_mempool": true,
- "private_node": true
}
}
], - "peers": [
- [
- "string"
]
], - "points": [
- [
- "string"
]
]
}
Returns an object that contains a list of IP and the field "not_reliable_since". If the field "not_reliable_since" is None then the list contains the currently greylisted IP addresses. If the field "not_reliable_since" Contains a date, this means that the greylist has been overflowed and it is no more possible to obtain the exact list of greylisted IPs. Since the greylist of IP addresses has been design to work whatever his size, there is no security issue related to this overflow. Reinitialize the ACL structure by calling "delete /network/greylist" to get back this list reliable.
{- "ips": [
- "string"
], - "not_reliable_since": "string"
}
Details about a given peer.
peer_id required | string A cryptographic node identity (Base58Check-encoded) |
{- "score": 0,
- "trusted": true,
- "conn_metadata": {
- "disable_mempool": true,
- "private_node": true
}, - "peer_metadata": {
- "responses": {
- "sent": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "failed": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "received": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "unexpected": "string",
- "outdated": "string"
}, - "requests": {
- "sent": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "received": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "failed": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "scheduled": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}
}, - "valid_blocks": "string",
- "old_heads": "string",
- "prevalidator_results": {
- "cannot_download": "string",
- "cannot_parse": "string",
- "refused_by_prefilter": "string",
- "refused_by_postfilter": "string",
- "applied": "string",
- "branch_delayed": "string",
- "branch_refused": "string",
- "refused": "string",
- "duplicate": "string",
- "outdated": "string"
}, - "unactivated_chains": "string",
- "inactive_chains": "string",
- "future_blocks_advertised": "string",
- "unadvertised": {
- "block": "string",
- "operations": "string",
- "protocol": "string"
}, - "advertisements": {
- "sent": {
- "head": "string",
- "branch": "string"
}, - "received": {
- "head": "string",
- "branch": "string"
}
}
}, - "state": "running",
- "reachable_at": {
- "addr": "string",
- "port": 65535
}, - "stat": {
- "total_sent": "string",
- "total_recv": "string",
- "current_inflow": -1073741824,
- "current_outflow": -1073741824
}, - "last_failed_connection": [
- {
- "addr": "string",
- "port": 65535
}
], - "last_rejected_connection": [
- {
- "addr": "string",
- "port": 65535
}
], - "last_established_connection": [
- {
- "addr": "string",
- "port": 65535
}
], - "last_disconnection": [
- {
- "addr": "string",
- "port": 65535
}
], - "last_seen": [
- {
- "addr": "string",
- "port": 65535
}
], - "last_miss": [
- {
- "addr": "string",
- "port": 65535
}
]
}
Change the permissions of a given peer. With {acl: ban}
: blacklist the given peer and remove it from the whitelist if present. With {acl: open}
: removes the peer from the blacklist and whitelist. With {acl: trust}
: trust the given peer permanently and remove it from the blacklist if present. The peer cannot be blocked (but its host IP still can).
peer_id required | string A cryptographic node identity (Base58Check-encoded) |
acl | string Enum: "open" "trust" "ban" |
{- "acl": "open"
}
{- "score": 0,
- "trusted": true,
- "conn_metadata": {
- "disable_mempool": true,
- "private_node": true
}, - "peer_metadata": {
- "responses": {
- "sent": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "failed": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "received": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "unexpected": "string",
- "outdated": "string"
}, - "requests": {
- "sent": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "received": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "failed": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}, - "scheduled": {
- "branch": "string",
- "head": "string",
- "block_header": "string",
- "operations": "string",
- "protocols": "string",
- "operation_hashes_for_block": "string",
- "operations_for_block": "string",
- "checkpoint": "string",
- "protocol_branch": "string",
- "predecessor_header": "string",
- "other": "string"
}
}, - "valid_blocks": "string",
- "old_heads": "string",
- "prevalidator_results": {
- "cannot_download": "string",
- "cannot_parse": "string",
- "refused_by_prefilter": "string",
- "refused_by_postfilter": "string",
- "applied": "string",
- "branch_delayed": "string",
- "branch_refused": "string",
- "refused": "string",
- "duplicate": "string",
- "outdated": "string"
}, - "unactivated_chains": "string",
- "inactive_chains": "string",
- "future_blocks_advertised": "string",
- "unadvertised": {
- "block": "string",
- "operations": "string",
- "protocol": "string"
}, - "advertisements": {
- "sent": {
- "head": "string",
- "branch": "string"
}, - "received": {
- "head": "string",
- "branch": "string"
}
}
}, - "state": "running",
- "reachable_at": {
- "addr": "string",
- "port": 65535
}, - "stat": {
- "total_sent": "string",
- "total_recv": "string",
- "current_inflow": -1073741824,
- "current_outflow": -1073741824
}, - "last_failed_connection": [
- {
- "addr": "string",
- "port": 65535
}
], - "last_rejected_connection": [
- {
- "addr": "string",
- "port": 65535
}
], - "last_established_connection": [
- {
- "addr": "string",
- "port": 65535
}
], - "last_disconnection": [
- {
- "addr": "string",
- "port": 65535
}
], - "last_seen": [
- {
- "addr": "string",
- "port": 65535
}
], - "last_miss": [
- {
- "addr": "string",
- "port": 65535
}
]
}
Monitor network events related to a given peer.
peer_id required | string A cryptographic node identity (Base58Check-encoded) |
monitor | string |
[- {
- "kind": "rejecting_request",
- "timestamp": "string",
- "addr": "string",
- "port": 65535
}
]
Details about a given IP:addr
.
point required | string A network point (ipv4:port or [ipv6]:port). |
{- "trusted": true,
- "greylisted_until": "string",
- "state": {
- "event_kind": "requested"
}, - "p2p_peer_id": "string",
- "last_failed_connection": "string",
- "last_rejected_connection": [
- "string"
], - "last_established_connection": [
- "string"
], - "last_disconnection": [
- "string"
], - "last_seen": [
- "string"
], - "last_miss": "string",
- "expected_peer_id": "string"
}
Connect to a peer
point required | string A network point (ipv4:port or [ipv6]:port). |
timeout required | string A span of time in seconds |
{ }
{ }
Change the connectivity state of a given IP:addr
. With {acl : ban}
: blacklist the given address and remove it from the whitelist if present. With {acl: open}
: removes an address from the blacklist and whitelist. With {acl: trust}
: trust a given address permanently and remove it from the blacklist if present. With {peer_id: <id>}
set the peerId of the point. Connections from this address can still be closed on authentication if the peer is greylisted.
point required | string A network point (ipv4:port or [ipv6]:port). |
acl | string Enum: "open" "trust" "ban" |
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Cryptobox public key ID (Base58Check-encoded)) |
{- "acl": "open",
- "peer_id": "string"
}
{- "trusted": true,
- "greylisted_until": "string",
- "state": {
- "event_kind": "requested"
}, - "p2p_peer_id": "string",
- "last_failed_connection": "string",
- "last_rejected_connection": [
- "string"
], - "last_established_connection": [
- "string"
], - "last_disconnection": [
- "string"
], - "last_seen": [
- "string"
], - "last_miss": "string",
- "expected_peer_id": "string"
}
the interface of a protocol grouped by its implementing modules
Protocol_hash required | string Protocol_hash (Base58Check-encoded) |
{- "expected_env_version": 65535,
- "components": [
- {
- "name": "string",
- "interface": "string",
- "implementation": "string"
}
]
}
{- "minor_words": 0,
- "promoted_words": 0,
- "major_words": 0,
- "minor_collections": -1073741824,
- "major_collections": -1073741824,
- "forced_major_collections": -1073741824,
- "heap_words": -1073741824,
- "heap_chunks": -1073741824,
- "live_words": -1073741824,
- "live_blocks": -1073741824,
- "free_words": -1073741824,
- "free_blocks": -1073741824,
- "largest_free": -1073741824,
- "fragments": -1073741824,
- "compactions": -1073741824,
- "top_heap_words": -1073741824,
- "stack_size": -1073741824
}
{- "version": {
- "major": -1073741824,
- "minor": -1073741824,
- "additional_info": "dev"
}, - "network_version": {
- "chain_name": "string",
- "distributed_db_version": 65535,
- "p2p_version": 65535
}, - "commit_info": {
- "commit_hash": "string",
- "commit_date": "string"
}
}
{- "status": {
- "phase": "launching",
- "since": "string"
}, - "pending_requests": [
- {
- "pushed": "string",
- "request": {
- "block": "string",
- "chain_id": "string",
- "peer": "string"
}
}
], - "current_request": {
- "pushed": "string",
- "treated": "string",
- "request": {
- "block": "string",
- "chain_id": "string",
- "peer": "string"
}
}
}
[- {
- "chain_id": "string",
- "status": {
- "phase": "launching",
- "since": "string"
}, - "information": {
- "instances": -1073741824,
- "status": {
- "phase": "launching",
- "since": "string"
}, - "queue_length": -1073741824
}, - "pipelines": -32768
}
]
Introspect the state of a chain validator worker.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "status": {
- "phase": "launching",
- "since": "string"
}, - "pending_requests": [
- {
- "pushed": "string",
- "request": {
- "hash": "string"
}
}
], - "current_request": {
- "pushed": "string",
- "treated": "string",
- "request": {
- "hash": "string"
}
}
}
Introspect the state of the DDB attached to a chain validator worker.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "p2p_readers": -1073741824,
- "active_chains": -1073741824,
- "operation_db": {
- "table_length": -1073741824,
- "scheduler_length": -1073741824
}, - "operations_db": {
- "table_length": -1073741824,
- "scheduler_length": -1073741824
}, - "block_header_db": {
- "table_length": -1073741824,
- "scheduler_length": -1073741824
}, - "active_connections": -1073741824,
- "active_peers": -1073741824
}
Lists the peer validator workers and their status.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
[- {
- "peer_id": "string",
- "status": {
- "phase": "launching",
- "since": "string"
}, - "information": {
- "instances": -1073741824,
- "status": {
- "phase": "launching",
- "since": "string"
}, - "queue_length": -1073741824
}, - "pipelines": {
- "fetched_headers": -1073741824,
- "fetched_blocks": -1073741824
}
}
]
Introspect the state of a peer validator worker.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
peer_id required | string A cryptographic node identity (Base58Check-encoded) |
{- "status": {
- "phase": "launching",
- "since": "string"
}, - "pending_requests": [
- {
- "pushed": "string",
- "request": {
- "request": "new_head",
- "block": "string"
}
}
], - "current_request": {
- "pushed": "string",
- "treated": "string",
- "request": {
- "request": "new_head",
- "block": "string"
}
}
}
[- {
- "chain_id": "string",
- "status": {
- "phase": "launching",
- "since": "string"
}, - "information": {
- "instances": -1073741824,
- "status": {
- "phase": "launching",
- "since": "string"
}, - "queue_length": -1073741824
}, - "pipelines": -32768
}
]
Introspect the state of prevalidator workers.
chain_id required | string A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'. |
{- "status": {
- "phase": "launching",
- "since": "string"
}, - "pending_requests": [
- {
- "pushed": "string",
- "request": {
- "request": "flush",
- "block": "string",
- "event": "branch"
}
}
], - "current_request": {
- "pushed": "string",
- "treated": "string",
- "request": {
- "request": "flush",
- "block": "string",
- "event": "branch"
}
}
}