Smart Rollup Node RPCs (Octez 1111.0~rc2+dev (958bc09e))

Download OpenAPI specification:

Smart Rollup Node RPC API for protocol ProtoALphaALphaALphaALphaALphaALphaALphaALphaDdp3zK

/admin/batcher/queue

Clear operation queues of injectors

query Parameters

order_below	string
drop_no_order required	string

Responses

Response samples

200
default

Content type

application/json

null

/admin/cancel_gc

Cancel any ongoing GC

Responses

Response samples

200
default

Content type

application/json

true

/admin/injector/queues

Get operation queues of injectors

query Parameters

tag	string A kind of operation for the injector.

Responses

Response samples

200
default

Content type

application/json

[{"tags": ["add_messages"
],
"queue": [{"kind": "add_messages",
"message": ["string"
],
"errors": {"count": -1073741824,
"last": null
}
}
]
}
]

/admin/injector/queues

Clear operation queues of injectors

query Parameters

order_below	string
tag	string A kind of operation for the injector.
drop_no_order required	string

Responses

Response samples

200
default

Content type

application/json

null

/admin/injector/queues/total

Get total operations queued in injectors

Responses

Response samples

200
default

Content type

application/json

{"injectors": [{"tags": ["add_messages"
],
"queue_size": -1073741824
}
],
"total": -1073741824
}

/config

Returns the rollup node configuration

Responses

Response samples

200
default

Content type

application/json

{"smart-rollup-address": "string",
"etherlink": true,
"boot-sector": "string",
"smart-rollup-node-operator": {"operating": "string",
"batching": "string",
"cementing": "string",
"recovering": "string",
"executing_outbox": "string"
},
"rpc-addr": "string",
"rpc-port": 65535,
"acl": [{"address": "string",
"whitelist": ["string"
]
}
],
"metrics-addr": "string",
"performance-metrics": true,
"reconnection_delay": 0,
"fee-parameters": {"publish": {"minimal-fees": "string",
"minimal-nanotez-per-byte": ["string"
],
"minimal-nanotez-per-gas-unit": ["string"
],
"force-low-fee": true,
"fee-cap": "string",
"burn-cap": "string"
},
"add_messages": {"minimal-fees": "string",
"minimal-nanotez-per-byte": ["string"
],
"minimal-nanotez-per-gas-unit": ["string"
],
"force-low-fee": true,
"fee-cap": "string",
"burn-cap": "string"
},
"cement": {"minimal-fees": "string",
"minimal-nanotez-per-byte": ["string"
],
"minimal-nanotez-per-gas-unit": ["string"
],
"force-low-fee": true,
"fee-cap": "string",
"burn-cap": "string"
},
"timeout": {"minimal-fees": "string",
"minimal-nanotez-per-byte": ["string"
],
"minimal-nanotez-per-gas-unit": ["string"
],
"force-low-fee": true,
"fee-cap": "string",
"burn-cap": "string"
},
"refute": {"minimal-fees": "string",
"minimal-nanotez-per-byte": ["string"
],
"minimal-nanotez-per-gas-unit": ["string"
],
"force-low-fee": true,
"fee-cap": "string",
"burn-cap": "string"
},
"recover": {"minimal-fees": "string",
"minimal-nanotez-per-byte": ["string"
],
"minimal-nanotez-per-gas-unit": ["string"
],
"force-low-fee": true,
"fee-cap": "string",
"burn-cap": "string"
},
"execute_outbox_message": {"minimal-fees": "string",
"minimal-nanotez-per-byte": ["string"
],
"minimal-nanotez-per-gas-unit": ["string"
],
"force-low-fee": true,
"fee-cap": "string",
"burn-cap": "string"
},
"publish_dal_commitment": {"minimal-fees": "string",
"minimal-nanotez-per-byte": ["string"
],
"minimal-nanotez-per-gas-unit": ["string"
],
"force-low-fee": true,
"fee-cap": "string",
"burn-cap": "string"
}
},
"mode": {"custom": ["add_messages"
]
},
"loser-mode": [{"level": -1073741824,
"message_index": -1073741824,
"message_tick": "string"
}
],
"apply-unsafe-patches": true,
"unsafe-pvm-patches": [{"increase_max_nb_tick": "string"
}
],
"execute-outbox-messages-filter": [{"transaction": {"destination": "any",
"entrypoint": "any"
}
}
],
"DAL node endpoint": "string",
"pre-images-endpoint": "string",
"batcher": {"min_batch_elements": -1073741824,
"min_batch_size": -1073741824,
"max_batch_elements": -1073741824,
"max_batch_size": -1073741824
},
"injector": {"retention_period": 65535,
"attempts": 65535,
"injection_ttl": 65535
},
"l1_blocks_cache_size": -1073741824,
"l2_blocks_cache_size": -1073741824,
"prefetch_blocks": -1073741824,
"l1_rpc_timeout": 0,
"loop_retry_delay": 0,
"index_buffer_size": -1073741824,
"irmin_cache_size": -1073741824,
"log-kernel-debug": true,
"unsafe-disable-wasm-kernel-checks": true,
"no-degraded": true,
"gc-parameters": {"frequency": -2147483648,
"context_splitting_period": -1073741824
},
"history-mode": "full",
"cors": {"allowed_headers": ["string"
],
"allowed_origins": ["string"
]
},
"bail-on-disagree": true,
"opentelemetry": {"enable": true,
"instance_id": "string",
"debug": true,
"url_traces": "string",
"headers": [["string"
]
],
"batch_traces": -1073741824,
"batch_timeout_ms": -1073741824
}
}

/describe

RPCs documentation and input/output schema

query Parameters

recurse

required

string

Responses

Response samples

200
default

Content type

application/json

Example

Static

{"static": {"get_service": {"meth": "PATCH",
"path": ["string"
],
"description": "string",
"query": [{"name": "string",
"description": "string",
"kind": {"single": {"id": "single",
"name": "string",
"descr": "string"
}
}
}
],
"input": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
},
"output": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
},
"error": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
}
},
"post_service": {"meth": "PATCH",
"path": ["string"
],
"description": "string",
"query": [{"name": "string",
"description": "string",
"kind": {"single": {"id": "single",
"name": "string",
"descr": "string"
}
}
}
],
"input": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
},
"output": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
},
"error": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
}
},
"delete_service": {"meth": "PATCH",
"path": ["string"
],
"description": "string",
"query": [{"name": "string",
"description": "string",
"kind": {"single": {"id": "single",
"name": "string",
"descr": "string"
}
}
}
],
"input": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
},
"output": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
},
"error": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
}
},
"put_service": {"meth": "PATCH",
"path": ["string"
],
"description": "string",
"query": [{"name": "string",
"description": "string",
"kind": {"single": {"id": "single",
"name": "string",
"descr": "string"
}
}
}
],
"input": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
},
"output": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
},
"error": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
}
},
"patch_service": {"meth": "PATCH",
"path": ["string"
],
"description": "string",
"query": [{"name": "string",
"description": "string",
"kind": {"single": {"id": "single",
"name": "string",
"descr": "string"
}
}
}
],
"input": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
},
"output": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
},
"error": {"json_schema": null,
"binary_schema": {"toplevel": {"fields": [{"name": "string",
"layout": {"kind": "Zero_width"
},
"data_kind": {"size": -1073741824,
"kind": "Fixed"
},
"kind": "named"
}
]
},
"fields": [{"description": {"title": "string",
"description": "string"
},
"encoding": {"fields": [{"name": null,
"layout": null,
"data_kind": null,
"kind": null
}
]
}
}
]
}
}
},
"subdirs": {"suffixes": [{"name": "string",
"tree": {"static": { }
}
}
]
}
}
}

/global/block/{block_id}

Layer-2 block of the layer-2 chain with respect to a Layer 1 block identifier

path Parameters

block_id

required

string

An L1 block identifier.

query Parameters

outbox

required

string

Responses

Response samples

200
default

Content type

application/json

{"block_hash": "string",
"level": -2147483648,
"predecessor": "string",
"commitment_hash": "string",
"previous_commitment_hash": "string",
"context": "string",
"inbox_witness": "string",
"inbox_hash": "string",
"inbox": {"level": -2147483648,
"old_levels_messages": {"index": "string",
"content": {"hash": "string",
"level": -2147483648
},
"back_pointers": ["string"
]
}
},
"messages": ["string"
],
"commitment": {"compressed_state": "string",
"inbox_level": -2147483648,
"predecessor": "string",
"number_of_ticks": "string"
},
"outbox": [{"message_index": -1073741824,
"whitelist_update": ["string"
]
}
],
"initial_tick": "string",
"num_ticks": "string"
}

/global/block/{block_id}/committed_status

Commitment status of the rollup state which will include content of this block

path Parameters

block_id

required

string

An L1 block identifier.

Responses

Response samples

200
default

Content type

application/json

Example

uncommitted

{"uncommitted": {"commitment_level": -2147483648,
"estimated_commitment_time": "string",
"estimated_cementation_time": "string"
}
}

/global/block/{block_id}/durable/wasm_2_0_0/length

Retrieve number of bytes in raw representation of value by key from PVM durable storage. PVM state is taken with respect to the specified block level.

path Parameters

block_id

required

string

An L1 block identifier.

query Parameters

key

required

string

Responses

Response samples

200
default

Content type

application/json

"string"

/global/block/{block_id}/durable/wasm_2_0_0/subkeys

Retrieve subkeys of the specified key from PVM durable storage. PVM state is taken with respect to the specified block level.

path Parameters

block_id

required

string

An L1 block identifier.

query Parameters

key

required

string

Responses

Response samples

200
default

Content type

application/json

["string"
]

/global/block/{block_id}/durable/wasm_2_0_0/value

Retrieve value by key from PVM durable storage. PVM state is taken with respect to the specified block level. Value returned in hex format.

path Parameters

block_id

required

string

An L1 block identifier.

query Parameters

key

required

string

Responses

Response samples

200
default

Content type

application/json

"string"

/global/block/{block_id}/durable/wasm_2_0_0/values

Retrieve values directly under a given key from PVM durable storage. PVM state is taken with respect to the specified block level.

path Parameters

block_id

required

string

An L1 block identifier.

query Parameters

key

required

string

Responses

Response samples

200
default

Content type

application/json

[{"key": "string",
"value": "string"
}
]

/global/block/{block_id}/hash

Tezos block hash of block known to the smart rollup node

path Parameters

block_id

required

string

An L1 block identifier.

Responses

Response samples

200
default

Content type

application/json

"string"

/global/block/{block_id}/helpers/proofs/outbox/{level}/messages

Generate serialized output proof for some outbox message at level and index

path Parameters

block_id required	string An L1 block identifier.
level required	string

query Parameters

index

string

Responses

Response samples

200
default

Content type

application/json

{"commitment": "string",
"proof": "string"
}

/global/block/{block_id}/inbox

Rollup inbox for block

path Parameters

block_id

required

string

An L1 block identifier.

Responses

Response samples

200
default

Content type

application/json

{"level": -2147483648,
"old_levels_messages": {"index": "string",
"content": {"hash": "string",
"level": -2147483648
},
"back_pointers": ["string"
]
}
}

/global/block/{block_id}/level

Level of Tezos block known to the smart rollup node

path Parameters

block_id

required

string

An L1 block identifier.

Responses

Response samples

200
default

Content type

application/json

-2147483648

/global/block/{block_id}/num_messages

Number of messages for specified block

path Parameters

block_id

required

string

An L1 block identifier.

Responses

Response samples

200
default

Content type

application/json

"string"

/global/block/{block_id}/outbox

Outbox at block for a given outbox level

path Parameters

block_id

required

string

An L1 block identifier.

query Parameters

outbox_level

string

Responses

Response samples

200
default

Content type

application/json

[{"outbox_level": 2147483647,
"message_index": "string",
"message": {"transactions": [{"parameters": {"int": "string"
},
"destination": "string",
"entrypoint": "string"
}
],
"kind": "untyped"
}
}
]

/global/block/{block_id}/outbox/{level}/messages

Outbox at block for a given outbox level

path Parameters

block_id required	string An L1 block identifier.
level required	string

Responses

Response samples

200
default

Content type

application/json

[{"outbox_level": 2147483647,
"message_index": "string",
"message": {"transactions": [{"parameters": {"int": "string"
},
"destination": "string",
"entrypoint": "string"
}
],
"kind": "untyped"
}
}
]

/global/block/{block_id}/simulate

Simulate messages evaluation by the PVM

path Parameters

block_id

required

string

An L1 block identifier.

Request Body schema: application/json

messages required	Array of strings[ items^([a-zA-Z0-9][a-zA-Z0-9])*$ ] Serialized messages for simulation.
reveal_pages	Array of strings[ items^([a-zA-Z0-9][a-zA-Z0-9])*$ ] Pages (at most 4kB) to be used for revelation ticks
	Array of pvm_state (object) or durable_storage (object) Paths in the PVM to inspect after the simulation
	(Universal string representation (Universal string representation (string) or Universal string representation (object))) File in which to emit kernel logs. This file will be created in /simulation_kernel_logs/, where is the data directory of the rollup node.

Responses

Request samples

Payload

Content type

application/json

{"messages": ["string"
],
"reveal_pages": ["string"
],
"insight_requests": [{"kind": "pvm_state",
"key": ["string"
]
}
],
"log_kernel_debug_file": "string"
}

Response samples

200
default

Content type

application/json

{"state_hash": "string",
"status": "string",
"output": [{"outbox_level": 2147483647,
"message_index": "string",
"message": {"transactions": [{"parameters": {"int": "string"
},
"destination": "string",
"entrypoint": "string"
}
],
"kind": "untyped"
}
}
],
"inbox_level": -2147483648,
"num_ticks": "string",
"insights": ["string"
]
}

/global/block/{block_id}/state

Retrieve value from key is PVM state of specified block

path Parameters

block_id

required

string

An L1 block identifier.

query Parameters

key

required

string

Responses

Response samples

200
default

Content type

application/json

"string"

/global/block/{block_id}/state_current_level

Retrieve the current level of a PVM

path Parameters

block_id

required

string

An L1 block identifier.

Responses

Response samples

200
default

Content type

application/json

0

0

/global/block/{block_id}/state_hash

State hash for this block

path Parameters

block_id

required

string

An L1 block identifier.

Responses

Response samples

200
default

Content type

application/json

"string"

/global/block/{block_id}/status

PVM status at block

path Parameters

block_id

required

string

An L1 block identifier.

Responses

Response samples

200
default

Content type

application/json

{"invalid_utf8_string": [255
]
}

/global/block/{block_id}/ticks

Number of ticks for specified level

path Parameters

block_id

required

string

An L1 block identifier.

Responses

Response samples

200
default

Content type

application/json

"string"

/global/block/{block_id}/total_ticks

Total number of ticks at specified block

path Parameters

block_id

required

string

An L1 block identifier.

Responses

Response samples

200
default

Content type

application/json

"string"

/global/last_stored_commitment

Last commitment computed by the node

Responses

Response samples

200
default

Content type

application/json

{"commitment": {"compressed_state": "string",
"inbox_level": -2147483648,
"predecessor": "string",
"number_of_ticks": "string"
},
"hash": "string"
}

/global/monitor_blocks

Monitor and streaming the L2 blocks

Responses

Response samples

200
default

Content type

application/json

{"block_hash": "string",
"level": -2147483648,
"predecessor": "string",
"commitment_hash": "string",
"previous_commitment_hash": "string",
"context": "string",
"inbox_witness": "string",
"inbox_hash": "string",
"initial_tick": "string",
"num_ticks": "string",
"property1": null,
"property2": null
}

/global/smart_rollup_address

Smart rollup address

Responses

Response samples

200
default

Content type

application/json

"string"

/global/tezos_head

Tezos head known to the smart rollup node

Responses

Response samples

200
default

Content type

application/json

"string"

/global/tezos_level

Tezos level known to the smart rollup node

Responses

Response samples

200
default

Content type

application/json

0

0

/health

Returns health status information for the rollup node

Responses

Response samples

200
default

Content type

application/json

{"healthy": true,
"degraded": true,
"l1": {"connection": "connected",
"blocks_late": -2147483648,
"last_seen_head": {"hash": "string",
"level": -2147483648,
"timestamp": "string"
}
},
"active_workers": [["string"
]
]
}

/local/batcher/injection

Inject messages in the batcher's queue

query Parameters

order	string
drop_duplicate required	string

Request Body schema: application/json

Array

string (sc_l2_message) ^([a-zA-Z0-9][a-zA-Z0-9])*$

A hex encoded smart rollup message

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
default

Content type

application/json

["string"
]

/local/batcher/queue

List messages present in the batcher's queue

Responses

Response samples

200
default

Content type

application/json

[{"order": "string",
"id": "string",
"message": {"content": "string",
"counter": "string"
},
"traceparent": "string"
}
]

/local/batcher/queue/{l2_message_id}

Retrieve an L2 message and its status

path Parameters

l2_message_id

required

string

A L2 message id.

Responses

Response samples

200
default

Content type

application/json

Example

unknown

{"content": "string",
"status": "unknown"
}

/local/commitments/{commitment_hash}

Commitment computed and published by the node

path Parameters

commitment_hash

required

string

A commitment hash.

Responses

Response samples

200
default

Content type

application/json

{"commitment": {"compressed_state": "string",
"inbox_level": -2147483648,
"predecessor": "string",
"number_of_ticks": "string"
},
"hash": "string",
"first_published_at_level": -2147483648,
"published_at_level": -2147483648
}

/local/dal/batcher/injection

Inject the given messages in the DAL queue, even in case of duplicates

Request Body schema: application/json

Array

One of

string (Universal string representation)

Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
default

Content type

application/json

null

/local/dal/injected/operations/statuses

Retrieve the statuses of all known operations injected via DAL.

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"status": {"status": "unknown"
}
}
]

/local/dal/injection/{injector_operation_hash}/forget

Forget information about the injection whose id is given

path Parameters

injector_operation_hash

required

string

injector_operation_hash (Base58Check-encoded)

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200
default

Content type

application/json

null

/local/dal/slot/indices

Provide the (new) list of slot indices to use to the rollup node's DAL injector

Request Body schema: application/json

indices

required

Array of integers[ items [ 0 .. 255 ] ]

Responses

Request samples

Payload

Content type

application/json

{"indices": [255
]
}

Response samples

200
default

Content type

application/json

null

/local/gc_info

Information about garbage collection

Responses

Response samples

200
default

Content type

application/json

{"first_available_level": -2147483648,
"last_gc_level": -2147483648,
"last_context_split_level": -2147483648,
"last_successful_gc_target": -2147483648
}

/local/injector/operation/{injector_operation_hash}/status

Retrieve the status of the injected operation using its injector ID.

path Parameters

injector_operation_hash

required

string

injector_operation_hash (Base58Check-encoded)

Responses

Response samples

200
default

Content type

application/json

Example

unknown

{"status": "unknown"
}

/local/last_published_commitment

Last commitment published by the node

Responses

Response samples

200
default

Content type

application/json

{"commitment": {"compressed_state": "string",
"inbox_level": -2147483648,
"predecessor": "string",
"number_of_ticks": "string"
},
"hash": "string",
"first_published_at_level": -2147483648,
"published_at_level": -2147483648
}

/local/outbox/pending

Pending outbox messages with their status (executable, pending, or lost)

query Parameters

outbox_level

string

Responses

Response samples

200
default

Content type

application/json

[{"outbox_level": -2147483648,
"messages": [{"message_index": -1073741824,
"message": {"whitelist_update": ["string"
]
}
}
],
"status": "pending"
}
]

/local/outbox/pending/executable

Pending outbox messages which can be executed

query Parameters

outbox_level

string

Responses

Response samples

200
default

Content type

application/json

[{"outbox_level": -2147483648,
"messages": [{"message_index": -1073741824,
"message": {"whitelist_update": ["string"
]
}
}
]
}
]

/local/outbox/pending/unexecutable

Pending outbox messages which cannot yet be executed

query Parameters

outbox_level

string

Responses

Response samples

200
default

Content type

application/json

[{"outbox_level": -2147483648,
"messages": [{"message_index": -1073741824,
"message": {"whitelist_update": ["string"
]
}
}
]
}
]

/local/synchronized

Wait for the node to have synchronized its L2 chain with the L1 chain, streaming its progress.

Responses

Response samples

200
default

Content type

application/json

Example

synchronized

"synchronized"

/openapi

OpenAPI specification of RPCs for rollup node

query Parameters

protocol

string

Protocol_hash (Base58Check-encoded)

Responses

Response samples

200
default

Content type

application/json

null

/ping

Returns an empty response if the rollup node can answer requests

Responses

Response samples

200
default

Content type

application/json

null

/stats/memory

Gets memory usage stats

Responses

Response samples

200
default

Content type

application/json

Example

Linux_proc_statm

{"page_size": -1073741824,
"size": "string",
"resident": "string",
"shared": "string",
"text": "string",
"lib": "string",
"data": "string",
"dt": "string"
}

/stats/ocaml_gc

Gets stats from the OCaml Garbage Collector

Responses

Response samples

200
default

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
}

/version

Returns the version information of the rollup node

Responses

Response samples

200
default

Content type

application/json

{"version": "string",
"store_version": "string",
"context_version": "string"
}