Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .serena/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/cache
/project.local.yml
159 changes: 159 additions & 0 deletions .serena/project.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
# the name by which the project can be referenced within Serena/when chatting with the LLM.
project_name: "cardano-node"

# list of languages for which language servers are started (LSP backend only); choose from:
# ada al angular ansible bash
# bsl clojure cpp cpp_ccls crystal
# csharp csharp_omnisharp cue dart elixir
# elm erlang fortran fsharp gdscript
# go groovy haskell haxe hlsl
# html java json julia kotlin
# latex lean4 lua luau markdown
# matlab msl nix ocaml pascal
# perl php php_phpactor php_phpantom powershell
# python python_jedi python_pyrefly python_ty r
# rego ruby ruby_solargraph rust scala
# scss solidity svelte swift systemverilog
# terraform toml typescript typescript_vts vue
# yaml zig
# (This list may be outdated; generated with scripts/print_language_list.py;
# For the current list, see values of Language enum here:
# https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py)
# For some languages, there are alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
# Note:
# - For C, use cpp
# - For JavaScript, use typescript
# - For Angular projects, use angular (subsumes typescript+html; requires `npm install` in the project root)
# - For Svelte projects, use svelte (subsumes typescript/javascript for .svelte projects; requires npm)
# - For SCSS / Sass / plain CSS, use scss (some-sass-language-server handles all three)
# - For Free Pascal/Lazarus, use pascal
# Special requirements:
# Some languages require additional setup/installations.
# See here for details: https://oraios.github.io/serena/01-about/020_programming-languages.html#language-servers
# When using multiple languages, the first language server that supports a given file will be used for that file.
# The first language is the default language and the respective language server will be used as a fallback.
# Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
languages:
- haskell

# the encoding used by text files in the project
# For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
encoding: "utf-8"

# optional shell command to run before the language backend (LSP or JetBrains) is initialised.
# the command runs in the project root directory and is only executed if the project is trusted
# (see trusted_project_path_patterns in the global configuration).
# serena waits for the command to exit: a non-zero exit code is logged as an error but does not
# abort activation. a per-project timeout (activation_command_timeout, default 180s) is the safety
# backstop for non-terminating commands; on expiry the process is killed and activation continues.
# example: activation_command: "npx nx run-many -t build"
activation_command:

# maximum time in seconds to wait for activation_command to complete before killing it (default 180s).
# must be a positive number.
activation_command_timeout: 180

# line ending convention to use when writing source files.
# Possible values: unset (use global setting), "lf", "crlf", or "native" (platform default)
# This does not affect Serena's own files (e.g. memories and configuration files), which always use native line endings.
line_ending:

# The language backend to use for this project.
# If not set, the global setting from serena_config.yml is used.
# Valid values: LSP, JetBrains
# Note: the backend is fixed at startup. If a project with a different backend
# is activated post-init, an error will be returned.
language_backend:

# whether to use project's .gitignore files to ignore files
ignore_all_files_in_gitignore: true

# advanced configuration option allowing to configure language server-specific options.
# Maps the language key to the options.
# The settings are considered only if the project is trusted (see global configuration to define trusted projects).
# See https://oraios.github.io/serena/02-usage/050_configuration.html#language-server-specific-settings
ls_specific_settings: {}

# list of workspace folder paths (LSP backend only).
# These folders will be used to build up Serena's symbol index.
# Paths must be within the project root and should thus be relative to the project root.
# Furthermore, the paths should not be filtered by ignore settings.
# Default setting: The entire project root folder (".") is considered.
# In (large) monorepos, this can be used to index only subfolders of the project root, e.g.
# ls_workspace_folders:
# - "./subproject1"
# - "./subproject2"
ls_workspace_folders: ["."]

# list of additional workspace folder paths for cross-package reference support.
# Paths can be absolute or relative to the project root.
# Each folder is registered as an LSP workspace folder, enabling language servers to discover
# symbols and references across package boundaries, but these folders are not indexed by Serena,
# i.e. the respective symbols will not be found using Serena's symbol search tools.
# Example:
# additional_workspace_folders:
# - ../sibling-package
# - ../shared-lib
ls_additional_workspace_folders: []

# list of additional paths to ignore in this project.
# Same syntax as gitignore, so you can use * and **.
# Note: global ignored_paths from serena_config.yml are also applied additively.
ignored_paths: []

# whether the project is in read-only mode
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
# Added on 2025-04-18
read_only: false

# list of tool names to exclude.
# This extends the existing exclusions (e.g. from the global configuration)
# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
excluded_tools: []

# list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default).
# This extends the existing inclusions (e.g. from the global configuration).
# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
included_optional_tools: []

# fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
# This cannot be combined with non-empty excluded_tools or included_optional_tools.
# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
fixed_tools: []

# list of mode names that are to be activated by default, overriding the setting in the global configuration.
# The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes.
# If the setting is undefined/empty, the default_modes from the global configuration (serena_config.yml) apply.
# Otherwise, this overrides the setting from the global configuration (serena_config.yml).
# Therefore, you can set this to [] if you do not want the default modes defined in the global config to apply
# for this project.
# This setting can, in turn, be overridden by CLI parameters (--mode).
# See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
default_modes:

# list of mode names to be activated additionally for this project, e.g. ["query-projects"]
# The full set of modes to be activated is base_modes (from global config) + default_modes + added_modes.
# See https://oraios.github.io/serena/02-usage/050_configuration.html#modes
added_modes:

# initial prompt for the project. It will always be given to the LLM upon activating the project
# (contrary to the memories, which are loaded on demand).
initial_prompt: ""

# time budget (seconds) per tool call for the retrieval of additional symbol information
# such as docstrings or parameter information.
# This overrides the corresponding setting in the global configuration; see the documentation there.
# If null or missing, use the setting from the global configuration.
symbol_info_budget:

# list of regex patterns which, when matched, mark a memory entry as read‑only.
# Extends the list from the global configuration, merging the two lists.
read_only_memory_patterns: []

# list of regex patterns for memories to completely ignore.
# Matching memories will not appear in list_memories or activate_project output
# and cannot be accessed via read_memory or write_memory.
# To access ignored memory files, use the read_file tool on the raw file path.
# Extends the list from the global configuration, merging the two lists.
# Example: ["_archive/.*", "_episodes/.*"]
ignored_memory_patterns: []
4 changes: 2 additions & 2 deletions cardano-node/src/Cardano/Node/Protocol/Checkpoints.hs
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ module Cardano.Node.Protocol.Checkpoints
import Cardano.Api

import qualified Cardano.Crypto.Hash.Class as Crypto
import Cardano.Protocol.Crypto (StandardCrypto)
import Cardano.Node.Types
import Cardano.Protocol.Crypto ()
import Ouroboros.Consensus.Block
import Ouroboros.Consensus.Cardano
import Ouroboros.Consensus.Cardano ()
import Ouroboros.Consensus.Config (CheckpointsMap (..), emptyCheckpointsMap)

import Control.Exception (IOException)
Expand Down
2 changes: 1 addition & 1 deletion cardano-node/src/Cardano/Node/Protocol/Shelley.hs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import Cardano.Node.Tracing.Era.Shelley ()
import Cardano.Node.Tracing.Formatting ()
import Cardano.Node.Tracing.Tracers.ChainDB ()
import Cardano.Node.Types
import Cardano.Protocol.Crypto (StandardCrypto)
import Cardano.Protocol.Crypto ()
import qualified Ouroboros.Consensus.Cardano as Consensus
import Ouroboros.Consensus.HardFork.Combinator.AcrossEras ()
import Ouroboros.Consensus.Protocol.Praos.Common (PraosCanBeLeader (..),
Expand Down
11 changes: 8 additions & 3 deletions cardano-node/src/Cardano/Node/Run.hs
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ import Cardano.Node.Protocol.Types
import Cardano.Node.Queries
import Cardano.Rpc.Server
import Cardano.Rpc.Server.Config
import Data.IORef
import Cardano.Node.Startup
import Cardano.Node.TraceConstraints (TraceConstraints)
import Cardano.Node.Tracing (Tracers (..))
Expand Down Expand Up @@ -449,6 +450,7 @@ handleSimpleNode blockType runP tracers nc cmdPc networkMagic onKernel = do
#endif
nForkPolicy <- getForkPolicy $ ncResponderCoreAffinityPolicy nc
cForkPolicy <- getForkPolicy $ ncResponderCoreAffinityPolicy nc
nodeKernelAccessRef <- newIORef Nothing
void $
let diffusionNodeArguments :: Cardano.Diffusion.CardanoNodeArguments IO
diffusionNodeArguments = Cardano.Diffusion.CardanoNodeArguments {
Expand Down Expand Up @@ -481,7 +483,7 @@ handleSimpleNode blockType runP tracers nc cmdPc networkMagic onKernel = do
(readTVar ledgerPeerSnapshotVar)
nc
in
withAsync (rpcServerLoop (startupTracer tracers) (rpcTracer tracers) rpcConfigVar networkMagic) $ \_ ->
withAsync (rpcServerLoop (startupTracer tracers) (rpcTracer tracers) rpcConfigVar networkMagic nodeKernelAccessRef) $ \_ ->
Node.run
nodeArgs {
rnNodeKernelHook = \registry nodeKernel -> do
Expand All @@ -491,6 +493,8 @@ handleSimpleNode blockType runP tracers nc cmdPc networkMagic onKernel = do
useBootstrapVar ledgerPeerSnapshotPathVar ledgerPeerSnapshotVar
rpcConfigVar
rnNodeKernelHook nodeArgs registry nodeKernel
mkNodeKernelAccess (contramap RpcUnsupportedBlockType (startupTracer tracers)) blockType (pInfoConfig pInfo) nodeKernel
>>= writeIORef nodeKernelAccessRef
}
StdRunNodeArgs
{ srnBfcMaxConcurrencyBulkSync = unMaxConcurrencyBulkSync <$> ncMaxConcurrencyBulkSync nc
Expand Down Expand Up @@ -767,16 +771,17 @@ rpcServerLoop :: Tracer IO (StartupTrace blk)
-> Tracer IO TraceRpc
-> StrictTVar IO RpcConfig
-> NetworkMagic
-> IORef (Maybe NodeKernelAccess)
-> IO ()
rpcServerLoop startupTracer rpcTracer rpcConfigVar networkMagic = go
rpcServerLoop startupTracer rpcTracer rpcConfigVar networkMagic nodeKernelAccessRef = go
where
go = do
config@RpcConfig{isEnabled = Identity enabled} <- readTVarIO rpcConfigVar
if enabled
then
race_
(do
runRpcServer rpcTracer (config, networkMagic)
runRpcServer rpcTracer config networkMagic nodeKernelAccessRef
traceWith startupTracer RpcForceDisabled
disableRpcServer)
(waitForRpcConfigChange config)
Expand Down
2 changes: 2 additions & 0 deletions cardano-node/src/Cardano/Node/Startup.hs
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@ data StartupTrace blk =
| RpcConfigUpdate Text
-- | Log RPC configuration update error
| RpcConfigUpdateError Text
-- | Log that node kernel access is not supported for the running block type.
| RpcUnsupportedBlockType Text
-- | Log RPC is forcefully disabled after a RPC server crash.
| RpcForceDisabled

Expand Down
31 changes: 30 additions & 1 deletion cardano-node/src/Cardano/Node/Tracing/Tracers/Rpc.hs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import Cardano.Api.Pretty

import Cardano.Logging hiding (nsInner)
import Cardano.Rpc.Server (TraceRpc (..), TraceRpcQuery (..), TraceRpcSubmit (..),
TraceSpanEvent (..))
TraceRpcSync (..), TraceSpanEvent (..))

import Data.Aeson (Object, Value (..), (.=))

Expand Down Expand Up @@ -48,6 +48,13 @@ instance LogFormatting TraceRpc where
TraceRpcSubmitSpan s -> [spanToObject s]
TraceRpcEvalTxDecodingError _ -> []
TraceRpcEvalTxSpan s -> [spanToObject s]
TraceRpcSync syncTrace ->
["kind" .= String "SyncService"]
<> case syncTrace of
TraceRpcFetchBlockSpan s -> [spanToObject s]
TraceRpcFetchBlockNotFound _ -> []
TraceRpcNodeKernelAccessUnavailable -> []
TraceRpcForkerError _ -> []

forHuman = docToText . pretty

Expand All @@ -59,6 +66,7 @@ instance LogFormatting TraceRpc where
TraceRpcQuery (TraceRpcQuerySearchUtxosSpan (SpanBegin _)) -> [CounterM "rpc.request.QueryService.SearchUtxos" Nothing]
TraceRpcSubmit (TraceRpcSubmitSpan (SpanBegin _)) -> [CounterM "rpc.request.SubmitService.SubmitTx" Nothing]
TraceRpcSubmit (TraceRpcEvalTxSpan (SpanBegin _)) -> [CounterM "rpc.request.SubmitService.EvalTx" Nothing]
TraceRpcSync (TraceRpcFetchBlockSpan (SpanBegin _)) -> [CounterM "rpc.request.SyncService.FetchBlock" Nothing]
_ -> []

instance MetaTrace TraceRpc where
Expand All @@ -81,6 +89,13 @@ instance MetaTrace TraceRpc where
TraceRpcSubmitSpan _ -> ["SubmitTx", "Span"]
TraceRpcEvalTxDecodingError _ -> ["EvalTxDecodingError"]
TraceRpcEvalTxSpan _ -> ["EvalTx", "Span"]
TraceRpcSync syncTrace ->
"SyncService"
: case syncTrace of
TraceRpcFetchBlockSpan _ -> ["FetchBlock", "Span"]
TraceRpcFetchBlockNotFound _ -> ["FetchBlockNotFound"]
TraceRpcNodeKernelAccessUnavailable -> ["NodeKernelAccessUnavailable"]
TraceRpcForkerError _ -> ["ForkerError"]

severityFor (Namespace _ nsInner) _ = case nsInner of
["FatalError"] -> Just Error -- RPC server startup errors
Expand All @@ -94,6 +109,10 @@ instance MetaTrace TraceRpc where
["SubmitService", "TxDecodingError"] -> Just Debug -- request error
["SubmitService", "TxValidationError"] -> Just Debug -- request error
["SubmitService", "EvalTxDecodingError"] -> Just Debug -- request error
["SyncService", "FetchBlock", "Span"] -> Just Debug
["SyncService", "FetchBlockNotFound"] -> Just Debug -- normal: block may have been pruned
["SyncService", "NodeKernelAccessUnavailable"] -> Just Warning -- kernel not yet ready
["SyncService", "ForkerError"] -> Just Warning -- unexpected ledger forker error
_ -> Nothing

documentFor (Namespace _ nsInner) = case nsInner of
Expand All @@ -110,6 +129,10 @@ instance MetaTrace TraceRpc where
["SubmitService", "TxDecodingError"] -> Just "A regular request error, when submitted transaction decoding fails."
["SubmitService", "TxValidationError"] -> Just "A regular request error, when submitted transaction is invalid."
["SubmitService", "EvalTxDecodingError"] -> Just "A regular request error, when evalTx transaction decoding fails."
["SyncService", "FetchBlock", "Span"] -> Just "Span for the FetchBlock SyncService method."
["SyncService", "FetchBlockNotFound"] -> Just "Requested block was not found in ChainDB."
["SyncService", "NodeKernelAccessUnavailable"] -> Just "Node kernel access not yet initialised. The node is still starting up."
["SyncService", "ForkerError"] -> Just "Unexpected error from ledger forker."
_ -> Nothing

metricsDocFor (Namespace _ nsInner) = case nsInner of
Expand All @@ -123,6 +146,8 @@ instance MetaTrace TraceRpc where
[("rpc.request.SubmitService.SubmitTx", "Span for the SubmitTx UTXORPC method.")]
["SubmitService", "EvalTx", "Span"] ->
[("rpc.request.SubmitService.EvalTx", "Span for the EvalTx UTXORPC method.")]
["SyncService", "FetchBlock", "Span"] ->
[("rpc.request.SyncService.FetchBlock", "Span for the FetchBlock SyncService method.")]
_ -> []

allNamespaces =
Expand All @@ -138,6 +163,10 @@ instance MetaTrace TraceRpc where
, ["SubmitService", "TxDecodingError"]
, ["SubmitService", "TxValidationError"]
, ["SubmitService", "EvalTxDecodingError"]
, ["SyncService", "FetchBlock", "Span"]
, ["SyncService", "FetchBlockNotFound"]
, ["SyncService", "NodeKernelAccessUnavailable"]
, ["SyncService", "ForkerError"]
]

-- helper functions
Expand Down
Loading
Loading