Download OpenAPI specification:
The RPC API for the Octez DAL node.
Performs health checks on the DAL node, evaluating key components of the DAL node. Returns a health status indicating whether the DAL node is 'Up', 'Down', or 'Degraded' based on the results of these checks.
{- "status": "degraded",
- "checks": [
- {
- "name": "string",
- "status": "degraded"
}
]
}
Connect to a new peer.
timeout | string A span of time in seconds |
Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.
"string"
null
[- {
- "peer": {
- "peer_id": "string",
- "maybe_reachable_point": "string"
}, - "connection": {
- "topics": [
- {
- "slot_index": 255,
- "pkh": "string"
}
], - "direct": true,
- "outbound": true,
- "bootstrap": true
}
}
]
Returns the fanout peers per topic alongside the last publication time on the topic.
[- {
- "topic": {
- "slot_index": 255,
- "pkh": "string"
}, - "peers": [
- {
- "peer_id": "string",
- "maybe_reachable_point": "string"
}
], - "last_publication_time": "string"
}
]
Get the mesh of the peer. Concretely, the RPC returns a list of topics, where each topic is associated to the remote peers with which the current node shares a full connection (on that topic). Optional arguments allow to restrict the output to a given delegate or slot index.
delegate | string A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded) |
slot_index | string |
[- {
- "topic": {
- "slot_index": 255,
- "pkh": "string"
}, - "peers": [
- {
- "peer_id": "string",
- "maybe_reachable_point": "string"
}
]
}
]
When the 'all' flag is given, get an association list between each topic subscribed to by the connected peers and the remote peers subscribed to that topic. If the 'all' flag is not given, then restrict the output to the topics this peer is subscribed to.
all | string |
[- {
- "pkh": "string",
- "peers": [
- {
- "peer_id": "string",
- "maybe_reachable_point": "string"
}
]
}
]
When the 'all' flag is given, get an association list between each public key hash part of a topic subscribed to by the connected peers and the remote peers subscribed to such topics. If the 'all' flag is not given, then restrict the output to the topics this peer is subscribed to.
all | string |
[- {
- "slot_index": 255,
- "peers": [
- {
- "peer_id": "string",
- "maybe_reachable_point": "string"
}
]
}
]
When the 'all' flag is given, get an association list between each topic subscribed to by the connected peers and the remote peers subscribed to that topic. If the 'all' flag is not given, then restrict the output to the topics this peer is subscribed to.
all | string |
[- {
- "topic": {
- "slot_index": 255,
- "pkh": "string"
}, - "peers": [
- {
- "peer_id": "string",
- "maybe_reachable_point": "string"
}
]
}
]
Get info of the requested peer
peer_id required | string A cryptographic node identity (Base58Check-encoded) |
{- "info": {
- "score": 0,
- "trusted": true,
- "conn_metadata": {
- "advertised_net_addr": "string",
- "advertised_net_port": 65535,
- "is_bootstrap_peer": true
}, - "peer_metadata": null,
- "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). In all cases, the updated information for the peer is returned. If input is omitted, this is equivalent to using the GET
version of this RPC.
peer_id required | string A cryptographic node identity (Base58Check-encoded) |
acl | string Enum: "open" "trust" "ban" |
{- "acl": "open"
}
{- "info": {
- "score": 0,
- "trusted": true,
- "conn_metadata": {
- "advertised_net_addr": "string",
- "advertised_net_port": 65535,
- "is_bootstrap_peer": true
}, - "peer_metadata": null,
- "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
}
]
}
}
Get list of known peers and their corresponding info.
connected | string |
[- {
- "peer": "string",
- "info": {
- "score": 0,
- "trusted": true,
- "conn_metadata": {
- "advertised_net_addr": "string",
- "advertised_net_port": 65535,
- "is_bootstrap_peer": true
}, - "peer_metadata": null,
- "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
}
]
}
}
]
Get info of the requested point
point required | string A network point (ipv4:port or [ipv6]:port). |
{- "info": {
- "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"
}
}
By default, get the list of known points and their corresponding info. When the 'connected' flag is given, then only get the connected points.
connected | string |
[- {
- "point": "string",
- "info": {
- "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"
}
}
]
Update the list of profiles tracked by the DAL node. Note that it does not take the bootstrap profile as it is incompatible with other profiles.
operators | Array of integers[ items [ -1073741824 .. 1073741823 ] ] |
observers | Array of integers[ items [ -1073741824 .. 1073741823 ] ] |
Array of (Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Ed25519, Secp256k1, P256, or BLS public key hash (Base58Check-encoded)) |
{- "operators": [
- -1073741824
], - "observers": [
- -1073741824
], - "attesters": [
- "string"
]
}
null
Return the shard indexes assigned to the given public key hash at the given level.
pkh required | string A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded) |
int32 required | string |
[- -32768
]
Return the currently attestable slots at the given attested level by the given public key hash. A slot is attestable at level [l] if it is published at level [l - attestation_lag] and all the shards assigned at level [l] to the given public key hash are available in the DAL node's store.
pkh required | string A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded) |
int32 required | string |
{- "kind": "attestable_slots_set",
- "attestable_slots_set": [
- true
], - "published_level": -2147483648
}
Returns the protocol parameters as known by the DAL node. An optional 'level' argument can specify for which level to retrieve them.
level | string |
{- "feature_enable": true,
- "incentives_enable": true,
- "number_of_slots": -1073741824,
- "attestation_lag": -1073741824,
- "attestation_threshold": -1073741824,
- "traps_fraction": {
- "numerator": "string",
- "denominator": "string"
}, - "cryptobox_parameters": {
- "redundancy_factor": 255,
- "page_size": 65535,
- "slot_size": -1073741824,
- "number_of_shards": 65535
}, - "sc_rollup_challenge_window_in_blocks": -1073741824,
- "commitment_period_in_blocks": -1073741824,
- "dal_attested_slots_validity_lag": -1073741824,
- "blocks_per_cycle": -2147483648,
- "minimal_block_delay": "string"
}
For a given published level, return all the traps known by the node. Optional arguments allow to restrict the output to a given delegate or slot index.
int32 required | string |
delegate | string A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded) |
slot_index | string |
[- {
- "delegate": "string",
- "slot_index": 255,
- "shard": [
- -1073741824
], - "proof": "string"
}
]
Post a slot to the DAL node, computes its commitment and commitment proof, then computes the correspoding shards with their proof. The result of this RPC can be directly used to publish a slot header. If the sent data is smaller than the size of a DAL slot, it is padded with the character provided as padding query parameter (defaults to \000). If the slot_index query parameter is provided, the DAL node checks that its profile allows to publish data on the given slot index.
padding required | string |
slot_index required | string |
Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.
{- "invalid_utf8_string": [
- 255
]
}
{- "commitment": "string",
- "commitment_proof": "string"
}