Class BaseJsonRpcServer

ProtectedmExpressServer

ProtectedmHttpTerminator

ProtectedmJsonRpcServer

ProtectedmListeningHost

ProtectedmListeningPort

ProtectedmRequest

ProtectedmResponse

ProtectedmServer

ProtectedaddRPCMethods

• addRPCMethods(): void

• Adds all necessary JSON RPC methods to this.mJsonRpcServer

  Returns void

ProtectedafterConstruction

• afterConstruction(): void

• Allows descendants to do something after class construction

  Returns void

  void

ProtectedcreateInvalidParams

• createInvalidParams(data?): JSONRPCErrorException

• Creates an Invalid Params JSON RPC Error exception, with the message as Invalid Params. The caller must throw the return of this call.

  Parameters

  • Optionaldata: any

  Returns JSONRPCErrorException

  Invalid Params JSON RPC Error exception

ProtectedcreateInvalidParamsMessage

• createInvalidParamsMessage(message, data?): JSONRPCErrorException

• Creates an Invalid Params JSON RPC Error exception, with the given message. The caller must throw the return of this call.

  Parameters

  • message: string
  • Optionaldata: any

  Returns JSONRPCErrorException

  Invalid Params JSON RPC Error exception

ProtectedcreateInvalidRequest

• createInvalidRequest(data?): JSONRPCErrorException

• Creates an Invalid Request JSON RPC Error exception, with the message as Invalid Params. The caller must throw the return of this call.

  Parameters

  • Optionaldata: any

  Returns JSONRPCErrorException

  Invalid Request JSON RPC Error exception

ProtectedcreateInvalidRequestResponse

• createInvalidRequestResponse(request): JSONRPCErrorResponse

• Creates an Invalid Request JSON RPC Error response.

  Parameters

  • request: any

  Returns JSONRPCErrorResponse

  Invalid Params JSON RPC response

ProtectedcreateMethodNotFoundResponse

• createMethodNotFoundResponse(request): JSONRPCErrorException

• Creates a Method not found JSON RPC Error response, with the message as Invalid Params. The caller must throw the return of this call.

  Parameters

  • request: any

  Returns JSONRPCErrorException

  Invalid Request JSON RPC Error exception

ProtecteddoParseError

• doParseError(err, req, res, next): void

• Calls this.onParseError If onParseError doesn't handle the error, doParseError will send a JSON RPC Error response if the error is a parsing error, or pass the error up to the next middleware to handle

  Parameters

  • err: any
  • req: Request
  • res: Response
  • next: NextFunction

  Returns void

  Invalid Request JSON RPC Error exception

ProtectedhandleRequest

• handleRequest(request, response): Promise<void>

• Handles a single or a batch JSON RPC request.

  Parameters

  • request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
  • response: Response<any, Record<string, any>>

  Returns Promise<void>

ProtectedimplementedRPCMethods

• implementedRPCMethods(): SimpleJSONRPCMethod<void>[]

• Returns RPC methods implemented by the server Override to return an array of RPC methods implemented.

  Returns SimpleJSONRPCMethod<void>[]

  array of RPC methods implemented

ProtectedinitExpress

• initExpress(): Express

• Initializes the Express server and returns it

  Returns Express

ProtectedinitJsonRpcServer

• initJsonRpcServer(): JSONRPCServer<void>

• Initializes the JSON RPC server and returns it

  Returns JSONRPCServer<void>

ProtectedinitParseErrorHandler

• initParseErrorHandler(aExpress): void

• Returns a JSON parse error during express.json parsing

  Parameters

  • aExpress: Express

  Returns void

ProtectedJsonRpcErrorListener

• JsonRpcErrorListener(message, data): void

• Error listener for JSON RPC, override to handle. Called when an error occurred during the JSON RPC method call. Do not throw an exception within this method

  Parameters

  • message: string
  • data: unknown

  Returns void

Protectedlog

• log(...data): void

• Parameters

  • Rest...data: any[]

  Returns void

ProtectedlogListeningMethods

• logListeningMethods(methods): void

• Displays the JSON RPC methods being listened to

  Parameters

  • methods: SimpleJSONRPCMethod<void>[]

  Returns void

ProtectedonBeforeDispatchRequest

• onBeforeDispatchRequest(next, request, serverParams): JSONRPCResponsePromise

• Called before every valid JSON body is dispatched, this doesn't mean that the request is a valid JSON RPC call though. If the request is valid, the method should call next(request, serverParams) and return its result. If the request is invalid, it should throw an appropriate error.

  Parameters

  • next: JSONRPCServerMiddlewareNext<void>
  • request: JSONRPCRequest
  • serverParams: undefined | void

  Returns JSONRPCResponsePromise

ProtectedonBeforeListening

• onBeforeListening(): void

• This is called before the JSON RPC server starts listening on the port Override this, for example, to listen just on IPv4 by calling dns.setDefaultResultOrder('ipv4first');

  Returns void

ProtectedonParseError

• onParseError(err, request, response): void

• Called when there's a parsing error. The overridden method should create a JSON RPC Error response and send it using response.send(err_response) If the error is not handled, this class will return an error

  Parameters

  • err: any
  • request: Request
  • response: TSendHandler

  Returns void

ProtectedsendInvalidParams

• sendInvalidParams(data?): void

• Creates an Invalid Params JSON RPC Error exception and sends it.

  Parameters

  • Optionaldata: any

  Returns void

ProtectedsendInvalidRequest

• sendInvalidRequest(data?): void

• Creates an Invalid Request JSON RPC Error exception and sends it.

  Parameters

  • Optionaldata: any

  Returns void

ProtectedstopListening

• stopListening(): Promise<void>

• Returns Promise<void>

ProtectedwaitForServerListening

• waitForServerListening(): Promise<void>

• Waits for the server to starts listening before returning. Override to disable this

  Returns Promise<void>

ProtectedwaitForServerStopListening

• waitForServerStopListening(): Promise<void>

• Returns Promise<void>