From c0ddc9d482d573525ee243a49974c146f2448246 Mon Sep 17 00:00:00 2001 From: CJ Cobb <46455409+cjcobb23@users.noreply.github.com> Date: Wed, 23 Jun 2021 11:40:18 -0400 Subject: [PATCH] Add README to handlers folder --- src/handlers/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 src/handlers/README.md diff --git a/src/handlers/README.md b/src/handlers/README.md new file mode 100644 index 000000000..3e8f0e9ed --- /dev/null +++ b/src/handlers/README.md @@ -0,0 +1,10 @@ +This folder contains all of the RPC handlers. + +Generally, handlers parse the request and call the appropriate method of `BackendInterface` +to read from the database. + +Certain RPCs, such as `fee` and `submit`, are just forwarded to `rippled`, and the response +is propagated back to the client. + +If the database returns a timeout, an error is returned to the client. +This automatically happens, and is caught at a higher level, outside of the handler.