Octez RPC (Octez 23.0~rc2 (4e3e2258))

Download OpenAPI specification:

The RPC API served by the Octez node.

/bls/aggregate_proofs

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.

Request Body schema: application/json
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))

Responses

Request samples

Content type
application/json
{
  • "public_key": "string",
  • "proofs": [
    ]
}

Response samples

Content type
application/json
"string"

/bls/aggregate_public_keys

Aggregate BLS public keys after checking their BLS proofs

Request Body schema: application/json
Array
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))

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "public_key": "string",
  • "public_key_hash": "string"
}

/bls/aggregate_signatures

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.

Request Body schema: application/json
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))

Responses

Request samples

Content type
application/json
{
  • "public_key": "string",
  • "message": "string",
  • "signature_shares": [
    ]
}

Response samples

Content type
application/json
"string"

/bls/check_proof

Check a BLS proof

Request Body schema: application/json
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))

Responses

Request samples

Content type
application/json
{
  • "public_key": "string",
  • "proof": "string"
}

Response samples

Content type
application/json
true

/bls/threshold_signatures

Threshold BLS signatures

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "public_key": "string",
  • "message": "string",
  • "signature_shares": [
    ]
}

Response samples

Content type
application/json
"string"

/chains/{chain_id}

Forcefully set the bootstrapped flag of the node

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Request Body schema: application/json
bootstrapped
required
boolean

Responses

Request samples

Content type
application/json
{
  • "bootstrapped": true
}

Response samples

Content type
application/json
null

/chains/{chain_id}/active_peers_heads

The heads of all active peers

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
{
  • "active_peers_heads": [
    ]
}

/chains/{chain_id}/blocks

Lists block hashes from '', up to the last checkpoint, sorted with decreasing fitness. Without arguments it returns the head of the chain. Optional arguments allow to return the list of predecessors of a given block or of a set of blocks.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

query Parameters
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 min_date is provided, blocks with a timestamp before min_date are filtered out. However, if the length parameter is also provided, then up to that number of predecessors will be returned regardless of their date.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

/chains/{chain_id}/chain_id

The chain unique identifier.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
"string"

/chains/{chain_id}/delegators_contribution/{int32}/{pkh}

A breakdown of all the contributions to the delegation portion of the baking power of the given delegate for the given cycle.

path Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "own_delegated": "string",
  • "external_delegators": [
    ],
  • "former_delegators_unstake_requests": "string",
  • "overstaked": "string",
  • "total_delegated_including_overdelegated": "string",
  • "total_delegated_after_limits": "string",
  • "overdelegated": "string"
}

/chains/{chain_id}/invalid_blocks

Lists blocks that have been declared invalid along with the errors that led to them being declared invalid.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/chains/{chain_id}/invalid_blocks/{block_hash}

The errors that appears during the block (in)validation.

path Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "block": "string",
  • "level": -2147483648,
  • "errors": null
}

/chains/{chain_id}/invalid_blocks/{block_hash}

Remove an invalid block for the tezos storage

path Parameters
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)

Responses

Response samples

Content type
application/json
{ }

/chains/{chain_id}/is_bootstrapped

The bootstrap status of a chain

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
{
  • "bootstrapped": true,
  • "sync_state": "stuck"
}

/chains/{chain_id}/levels/caboose

The current caboose for this chain.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
{
  • "block_hash": "string",
  • "level": -2147483648
}

/chains/{chain_id}/levels/checkpoint

The current checkpoint for this chain.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
{
  • "block_hash": "string",
  • "level": -2147483648
}

/chains/{chain_id}/levels/savepoint

The current savepoint for this chain.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
{
  • "block_hash": "string",
  • "level": -2147483648
}

/chains/{chain_id}/protocols

Lists protocols of the chain.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/chains/{chain_id}/protocols/{Protocol_hash}

Information about a protocol of the chain.

path Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "protocol": "string",
  • "proto_level": -1073741824,
  • "activation_block": {
    }
}

/config

Return the runtime node configuration (this takes into account the command-line arguments and the on-disk configuration file)

Responses

Response samples

Content type
application/json
{
  • "data-dir": "string",
  • "disable-config-validation": true,
  • "rpc": {
    },
  • "p2p": {
    },
  • "log": {
    },
  • "internal-events": {
    },
  • "shell": {
    },
  • "network": "sandbox",
  • "metrics_addr": [
    ]
}

/config/history_mode

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.

Responses

Response samples

Content type
application/json
{
  • "history_mode": "archive",
  • "blocks_preservation_cycles": 255
}

/config/logging

Replace the logging configuration of the node.

Request Body schema: application/json
One of
Array of Universal string representation (string) or Universal string representation (object) (Universal string representation)

List of URIs to activate/configure sinks.

Responses

Request samples

Content type
application/json
Example
{
  • "active_sinks": [
    ]
}

Response samples

Content type
application/json
{ }

/config/network/dal

Configuration for the DAL

Responses

Response samples

Content type
application/json
{
  • "activated": true,
  • "bootstrap_peers": [
    ]
}

/config/network/user_activated_protocol_overrides

List of protocols which replace other protocols

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/config/network/user_activated_upgrades

List of protocols to switch to at given levels

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/errors

Schema for all the RPC errors from the shell

Responses

Response samples

Content type
application/json
null

/fetch_protocol/{Protocol_hash}

Fetch a protocol from the network.

path Parameters
Protocol_hash
required
string

Protocol_hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
null

/health/ready

Returns whether or not the node is ready to answer to requests.

Responses

Response samples

Content type
application/json
{
  • "ready": true
}

/injection/block

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.

query Parameters
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'.

Request Body schema: application/json
data
required
string^([a-zA-Z0-9][a-zA-Z0-9])*$
required
Array of objects (operation) [ items ]

Responses

Request samples

Content type
application/json
{
  • "data": "string",
  • "operations": [
    ]
}

Response samples

Content type
application/json
"string"

/injection/operation

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.

query Parameters
async
string
chain
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Request Body schema: application/json
string^([a-zA-Z0-9][a-zA-Z0-9])*$

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

/injection/protocol

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.

query Parameters
async
string
Request Body schema: application/json
expected_env_version
required
integer (protocol.environment_version) [ 0 .. 65535 ]
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "expected_env_version": 65535,
  • "components": [
    ]
}

Response samples

Content type
application/json
"string"

/monitor/active_chains

Monitor every chain creation and destruction. Currently active chains will be given as first elements

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/monitor/applied_blocks

Monitor all blocks that are successfully applied and stored by the node, disregarding whether they were selected as the new head or not.

query Parameters
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'.

Responses

Response samples

Content type
application/json
{
  • "chain_id": "string",
  • "hash": "string",
  • "header": {
    },
  • "operations": [
    ]
}

/monitor/bootstrapped

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.

Responses

Response samples

Content type
application/json
{
  • "block": "string",
  • "timestamp": "string"
}

/monitor/heads/{chain_id}

Monitor all blocks that are successfully validated and applied by the node and selected as the new head of the given chain.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

query Parameters
protocol
string

Protocol_hash (Base58Check-encoded)

next_protocol
string

Protocol_hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "hash": "string",
  • "level": -2147483648,
  • "proto": 255,
  • "predecessor": "string",
  • "timestamp": "string",
  • "validation_pass": 255,
  • "operations_hash": "string",
  • "fitness": [
    ],
  • "context": "string",
  • "protocol_data": "string"
}

/monitor/protocols

Monitor all economic protocols that are retrieved and successfully loaded and compiled by the node.

Responses

Response samples

Content type
application/json
"string"

/monitor/received_blocks/{chain_id}

Monitor all newly received blocks that are not yet known by the store.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
{
  • "hash": "string"
}

/monitor/validated_blocks

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.

query Parameters
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'.

Responses

Response samples

Content type
application/json
{
  • "chain_id": "string",
  • "hash": "string",
  • "header": {
    },
  • "operations": [
    ]
}

/network/connections

List the running P2P connection.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/network/connections/{peer_id}

Details about the current P2P connection to the given peer.

path Parameters
peer_id
required
string

A cryptographic node identity (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "incoming": true,
  • "peer_id": "string",
  • "id_point": {
    },
  • "remote_socket_port": 65535,
  • "announced_version": {
    },
  • "private": true,
  • "local_metadata": {
    },
  • "remote_metadata": {
    }
}

/network/connections/{peer_id}

Forced close of the current P2P connection to the given peer.

path Parameters
peer_id
required
string

A cryptographic node identity (Base58Check-encoded)

query Parameters
wait
string

Responses

Response samples

Content type
application/json
{ }

/network/full_stat

Full network statistics.

Responses

Response samples

Content type
application/json
{
  • "stat": {
    },
  • "incoming_connections": [
    ],
  • "outgoing_connections": [
    ],
  • "peers": [
    ],
  • "points": [
    ]
}

/network/greylist

Clear all greylists tables. This will unban all addresses and peers automatically greylisted by the system.

Responses

Response samples

Content type
application/json
{ }

/network/greylist/ips

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.

Responses

Response samples

Content type
application/json
{
  • "ips": [
    ],
  • "not_reliable_since": "string"
}

/network/greylist/peers

List of the last greylisted peers.

Responses

Response samples

Content type
application/json
[
  • "string"
]

/network/log

Stream of all network events

Responses

Response samples

Content type
application/json
Example
{
  • "event": "too_few_connections"
}

/network/peers

List the peers the node ever met.

query Parameters
filter
string

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

/network/peers/{peer_id}

Details about a given peer.

path Parameters
peer_id
required
string

A cryptographic node identity (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "score": 0,
  • "trusted": true,
  • "conn_metadata": {
    },
  • "peer_metadata": {
    },
  • "state": "running",
  • "reachable_at": {
    },
  • "stat": {
    },
  • "last_failed_connection": [
    ],
  • "last_rejected_connection": [
    ],
  • "last_established_connection": [
    ],
  • "last_disconnection": [
    ],
  • "last_seen": [
    ],
  • "last_miss": [
    ]
}

/network/peers/{peer_id}

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).

path Parameters
peer_id
required
string

A cryptographic node identity (Base58Check-encoded)

Request Body schema: application/json
acl
string
Enum: "open" "trust" "ban"

Responses

Request samples

Content type
application/json
{
  • "acl": "open"
}

Response samples

Content type
application/json
{
  • "score": 0,
  • "trusted": true,
  • "conn_metadata": {
    },
  • "peer_metadata": {
    },
  • "state": "running",
  • "reachable_at": {
    },
  • "stat": {
    },
  • "last_failed_connection": [
    ],
  • "last_rejected_connection": [
    ],
  • "last_established_connection": [
    ],
  • "last_disconnection": [
    ],
  • "last_seen": [
    ],
  • "last_miss": [
    ]
}

/network/peers/{peer_id}/banned

Check if a given peer is blacklisted or greylisted.

path Parameters
peer_id
required
string

A cryptographic node identity (Base58Check-encoded)

Responses

Response samples

Content type
application/json
true

/network/peers/{peer_id}/log

Monitor network events related to a given peer.

path Parameters
peer_id
required
string

A cryptographic node identity (Base58Check-encoded)

query Parameters
monitor
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/network/points

List the pool of known IP:port used for establishing P2P connections.

query Parameters
filter
string

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

/network/points/{point}

Details about a given IP:addr.

path Parameters
point
required
string

A network point (ipv4:port or [ipv6]:port).

Responses

Response samples

Content type
application/json
{
  • "trusted": true,
  • "greylisted_until": "string",
  • "state": {
    },
  • "p2p_peer_id": "string",
  • "last_failed_connection": "string",
  • "last_rejected_connection": [
    ],
  • "last_established_connection": [
    ],
  • "last_disconnection": [
    ],
  • "last_seen": [
    ],
  • "last_miss": "string",
  • "expected_peer_id": "string"
}

/network/points/{point}

Connect to a peer

path Parameters
point
required
string

A network point (ipv4:port or [ipv6]:port).

query Parameters
timeout
required
string

A span of time in seconds

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/network/points/{point}

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.

path Parameters
point
required
string

A network point (ipv4:port or [ipv6]:port).

Request Body schema: application/json
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))

Responses

Request samples

Content type
application/json
{
  • "acl": "open",
  • "peer_id": "string"
}

Response samples

Content type
application/json
{
  • "trusted": true,
  • "greylisted_until": "string",
  • "state": {
    },
  • "p2p_peer_id": "string",
  • "last_failed_connection": "string",
  • "last_rejected_connection": [
    ],
  • "last_established_connection": [
    ],
  • "last_disconnection": [
    ],
  • "last_seen": [
    ],
  • "last_miss": "string",
  • "expected_peer_id": "string"
}

/network/points/{point}/banned

Check if a given address is blacklisted or greylisted. Port component is unused.

path Parameters
point
required
string

A network point (ipv4:port or [ipv6]:port).

Responses

Response samples

Content type
application/json
true

/network/points/{point}/log

Monitor network events related to an IP:addr.

path Parameters
point
required
string

A network point (ipv4:port or [ipv6]:port).

query Parameters
monitor
string

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

/network/self

Return the node's peer id

Responses

Response samples

Content type
application/json
"string"

/network/stat

Global network bandwidth statistics in B/s.

Responses

Response samples

Content type
application/json
{
  • "total_sent": "string",
  • "total_recv": "string",
  • "current_inflow": -1073741824,
  • "current_outflow": -1073741824
}

/profiler/registered_backend

Registered backend.

Responses

Response samples

Content type
application/json
{
  • "registered_backends": [
    ],
  • "backends": [
    ]
}

/protocols

the list of protocols supported by the node

Responses

Response samples

Content type
application/json
[
  • "string"
]

/protocols/{Protocol_hash}

the interface of a protocol grouped by its implementing modules

path Parameters
Protocol_hash
required
string

Protocol_hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "expected_env_version": 65535,
  • "components": [
    ]
}

/protocols/{Protocol_hash}/environment

the protocol environment version required by a protocol

path Parameters
Protocol_hash
required
string

Protocol_hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
65535

/stats/gc

Gets stats from the OCaml Garbage Collector

Responses

Response samples

Content type
application/json
{
  • "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
}

/stats/memory

Gets memory usage stats

Responses

Response samples

Content type
application/json
Example
{
  • "page_size": -1073741824,
  • "size": "string",
  • "resident": "string",
  • "shared": "string",
  • "text": "string",
  • "lib": "string",
  • "data": "string",
  • "dt": "string"
}

/version

Get information on the node version

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "network_version": {
    },
  • "commit_info": {
    }
}

/workers/block_validator

Introspect the state of the block_validator worker.

Responses

Response samples

Content type
application/json
{
  • "status": {
    },
  • "pending_requests": [
    ],
  • "current_request": {
    }
}

/workers/chain_validators

Lists the chain validator workers and their status.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/workers/chain_validators/{chain_id}

Introspect the state of a chain validator worker.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
{
  • "status": {
    },
  • "pending_requests": [
    ],
  • "current_request": {
    }
}

/workers/chain_validators/{chain_id}/ddb

Introspect the state of the DDB attached to a chain validator worker.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
{
  • "p2p_readers": -1073741824,
  • "active_chains": -1073741824,
  • "operation_db": {
    },
  • "operations_db": {
    },
  • "block_header_db": {
    },
  • "active_connections": -1073741824,
  • "active_peers": -1073741824
}

/workers/chain_validators/{chain_id}/peers_validators

Lists the peer validator workers and their status.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/workers/chain_validators/{chain_id}/peers_validators/{peer_id}

Introspect the state of a peer validator worker.

path Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": {
    },
  • "pending_requests": [
    ],
  • "current_request": {
    }
}

/workers/prevalidators

Lists the Prevalidator workers and their status.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/workers/prevalidators/{chain_id}

Introspect the state of prevalidator workers.

path Parameters
chain_id
required
string

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses

Response samples

Content type
application/json
{
  • "status": {
    },
  • "pending_requests": [
    ],
  • "current_request": {
    }
}