Client Config
client_config request type
Fetch the node's own local client config — timeouts, retry settings, and operator-chosen parameters.
client_config request type
Fetch the node's own local client config — timeouts, retry settings, and operator-chosen parameters.
Responses from the selected endpoint appear here after you run a request.
Live response output will appear here after you run a request.
This operation accepts a JSON-RPC body over POST to /.
Required request inputs: yes
{
"jsonrpc": "2.0",
"id": "fastnear",
"method": "client_config",
"params": []
}jsonrpc *string2.0id *stringmethod *stringclient_configparams *arrayEmpty array as this method takes no parameters
Successful response
jsonrpc *string2.0id *one ofresultobjectClientConfig where some fields can be updated at runtime.
archivebooleanNot clear old data, set true for archive nodes.
block_header_fetch_horizonintegerBehind this horizon header fetch kicks in.
block_production_tracking_delaystringDuration to check for producing / skipping block.
catchup_step_periodarrayTime between check to perform catchup.
itemsintegerchain_idstringChain id for status.
chunk_distribution_networkobjectnullableConfig for the Chunk Distribution Network feature. This allows nodes to push and pull chunks from a central stream. The two benefits of this approach are: (1) less request/response traffic on the peer-to-peer network and (2) lower latency for RPC nodes indexing the chain.
enabledbooleanurisobjectURIs for the Chunk Distribution Network feature.
chunk_request_retry_periodarrayTime between checking to re-request chunks.
itemsintegerchunk_validation_threadsintegerNumber of threads for ChunkValidationActor pool.
chunk_wait_multstringMultiplier for the wait time for all chunks to be received.
chunks_cache_height_horizonintegerHeight horizon for the chunk cache. A chunk is removed from the cache if its height + chunks_cache_height_horizon < largest_seen_height. The default value is DEFAULT_CHUNKS_CACHE_HEIGHT_HORIZON.
client_background_migration_threadsintegerNumber of threads to execute background migration work in client.
cloud_archival_writerobjectnullableConfiguration for a cloud-based archival writer. If this config is present, the writer is enabled and writes chunk-related data based on the tracked shards. This config also controls additional archival behavior such as block data and polling interval.
archive_block_databooleanDetermines whether block-related data should be written to cloud storage.
polling_intervalobjectInterval at which the system checks for new blocks or chunks to archive.
snapshot_every_n_epochsintegerCadence of state snapshots, in epochs. Higher values reduce bucket cost at the expense of potentially longer delta replay during reader bootstrap.
disable_tx_routingbooleanIf true, the node won't forward transactions to next the chunk producers.
doomslug_step_periodstringTime between running doomslug timer.
enable_early_prepare_transactionsbooleanIf true, transactions for the next chunk will be prepared early, right after the previous chunk's post-state is ready. This can help produce chunks faster, for high-throughput chains. The current implementation increases latency on low-load chains, which will be fixed in the future. The default is disabled.
enable_multiline_loggingbooleanenable_statistics_exportbooleanRe-export storage layer statistics as prometheus metrics.
epoch_lengthintegerEpoch length.
epoch_syncobjectOptions for epoch sync.
epoch_sync_horizon_num_epochsintegerNumber of epochs behind the network head beyond which the node will use epoch sync instead of header sync. At the consumption site, this is multiplied by epoch_length to get the horizon in blocks.
timeout_for_epoch_syncobjectTimeout for epoch sync requests. The node will continue retrying indefinitely even if this timeout is exceeded.
expected_shutdownstringGraceful shutdown at expected block height.
gcobjectConfiguration for garbage collection.
gc_blocks_limitintegerMaximum number of blocks to garbage collect at every garbage collection call.
gc_fork_clean_stepintegerMaximum number of height to go through at each garbage collection step when cleaning forks during garbage collection.
gc_num_epochs_to_keepintegerNumber of epochs for which we keep store data.
gc_step_periodobjectHow often gc should be run
header_sync_expected_height_per_secondintegerExpected increase of header head height per second during header sync
header_sync_initial_timeoutarrayHow much time to wait after initial header sync
itemsintegerheader_sync_progress_timeoutarrayHow much time to wait after some progress is made in header sync
itemsintegerheader_sync_stall_ban_timeoutarrayHow much time to wait before banning a peer in header sync if sync is too slow
itemsintegerlog_summary_periodarrayPeriod between logging summary information.
itemsintegerlog_summary_stylestringEnable coloring of the logs
plaincoloredmax_block_production_delaystringMaximum wait for approvals before producing block.
max_block_wait_delaystringMaximum duration before skipping given height.
max_gas_burnt_viewstringnullableGas amount
min_block_production_delaystringMinimum duration before producing block.
min_num_peersintegerMinimum number of peers to start syncing.
num_block_producer_seatsintegerNumber of block producer seats
orphan_state_witness_max_sizeintegerMaximum size of state witnesses in the OrphanStateWitnessPool. We keep only orphan witnesses which are smaller than this size. This limits the maximum memory usage of OrphanStateWitnessPool.
orphan_state_witness_pool_sizeintegerOrphanStateWitnessPool keeps instances of ChunkStateWitness which can't be processed because the previous block isn't available. The witnesses wait in the pool until the required block appears. This variable controls how many witnesses can be stored in the pool.
produce_chunk_add_transactions_time_limitstringLimit the time of adding transactions to a chunk. A node produces a chunk by adding transactions from the transaction pool until some limit is reached. This time limit ensures that adding transactions won't take longer than the specified duration, which helps to produce the chunk quickly.
produce_empty_blocksbooleanProduce empty blocks, use false for testing.
protocol_version_checkstringConfigures whether the node checks the next or the next next epoch for network version compatibility.
NextNextNextreceipt_to_tx_max_hint_windowintegerMax ±window accepted on EXPERIMENTAL_receipt_to_tx requests.
Caps caller's window. Applies to pre-first-scan CenterOut
against caller's literal hint; ancestor scans use
receipt_to_tx_max_hop_distance instead. Operators raising this
should also raise receipt_to_tx_max_hop_distance so backward reach
matches caller's wider hint scope. Requests with window over this
rejected with WindowTooLarge.
receipt_to_tx_max_hop_distanceintegerMax block-distance ancestor scan walks per hop once any scan in
walk refreshed current_height. Subsequent column-miss scans visit
h, h-1, ..., h-max_hop_distance from most-recent scan-refreshed
anchor, regardless of column hits between. Anchor included —
same-shard local receipts execute in same block as producing
outcome. Raise if cold archival traffic shows ancestor misses —
gap = scan-refreshed anchor to producer-outcome height of receipt
with missing column row (column hits don't reset anchor). Default
20 (matches receipt_to_tx_max_hint_window).
receipt_to_tx_max_outcomes_per_requestintegerPer-request ceiling on outcome rows the EXPERIMENTAL_receipt_to_tx
hint-fallback scanner reads across hops + shards. Caps cold-RocksDB
worst case on unauthenticated public endpoint. Default 20_000.
Operators serving cold archival traffic with deep walks or sparse
outcomes may raise; benchmark first (see TODO in
view_client_actor.rs). Mid-scan exhaustion fails with
BudgetExceeded { scanned, limit }.
resharding_configstringrpc_addrstringnullableListening rpc port for status.
save_invalid_witnessesbooleanSave observed instances of invalid ChunkStateWitness to the database in DBCol::InvalidChunkStateWitnesses. Saving invalid witnesses is useful for analysis and debugging. This option can cause extra load on the database and is not recommended for production use.
save_latest_witnessesbooleanSave observed instances of ChunkStateWitness to the database in DBCol::LatestChunkStateWitnesses. Saving the latest witnesses is useful for analysis and debugging. This option can cause extra load on the database and is not recommended for production use.
save_receipt_to_txbooleanWhether to persist receipt-to-tx origin mappings to disk or not.
save_state_changesbooleanWhether to persist state changes on disk or not.
save_trie_changesbooleansave_trie_changes should be set to true iff - archive if false - non-archival nodes need trie changes to perform garbage collection - archive is true, cold_store is configured and migration to split_storage is finished - node working in split storage mode needs trie changes in order to do garbage collection on hot.
save_tx_outcomesbooleanWhether to persist transaction outcomes to disk or not.
save_untracked_partial_chunks_partsbooleanWhether to persist partial chunk parts for untracked shards or not.
skip_sync_waitbooleanSkip waiting for sync (for testing or single node testnet).
state_request_server_threadsintegerNumber of threads for StateRequestActor pool.
state_request_throttle_periodarrayNumber of seconds between state requests for view client. Throttling window for state requests (headers and parts).
itemsintegerstate_requests_per_throttle_periodintegerMaximum number of state requests served per throttle period
state_syncobjectOptions for syncing state.
concurrencyobjectdumpobjectnullableConfigures how to dump state to external storage.
parts_compression_lvlintegerZstd compression level for state parts.
syncstringnullableSyncs state from the peers without reading anything from external storage.
Peersstate_sync_external_backoffarrayAdditional waiting period after a failed request to external storage
itemsintegerstate_sync_external_timeoutarrayHow long to wait for a response from centralized state sync
itemsintegerstate_sync_p2p_timeoutarrayHow long to wait for a response from p2p state sync
itemsintegerstate_sync_retry_backoffarrayHow long to wait after a failed state sync request
itemsintegersync_check_periodarrayHow often to check that we are not out of sync.
itemsintegersync_height_thresholdintegerSync height threshold: below this difference in height don't start syncing.
sync_max_block_requestsintegerMaximum number of block requests to send to peers to sync
sync_step_periodarrayWhile syncing, how long to check for each step.
itemsintegertracked_shards_configobjectOne of multiple possible types
transaction_pool_size_limitintegernullableLimit of the size of per-shard transaction pool measured in bytes. If not set, the size will be unbounded.
transaction_pool_strict_nonce_ttl_blocksintegerTTL in blocks for gapped strict-nonce transactions in the pool. Transactions with a nonce gap whose block_hash is older than this many blocks are evicted during prepare_transactions.
transaction_request_handler_threadsintegertrie_viewer_state_size_limitintegernullableUpper bound of the byte size of contract state that is still viewable. None is no limit
ttl_account_id_routerarrayTime to persist Accounts Id in the router without removing them.
itemsintegertx_routing_height_horizonintegerIf the node is not a chunk producer within that many blocks, then route to upcoming chunk producers.
versionobjectData structure for semver version and github tag or commit.
build *stringcommit *stringrustc_versionstringversion *stringview_client_threadsintegerNumber of threads for ViewClientActor pool.
block_fetch_horizonintegerHorizon at which instead of fetching block, fetch full state.
state_sync_enabledbooleanWhether to use the State Sync mechanism. If disabled, the node will do Block Sync instead of State Sync.
dynamic_resharding_dry_runbooleanIf true, the runtime will do a dynamic resharding 'dry run' at the last block of each epoch. This means calculating tentative boundary accounts for splitting the tracked shards.
errorobjectcodeintegermessagestringdataobject