thingy-post-rpc-client

Background

Over a long journey of simplifying the interfaces between webapps and services as well as service and services the tool evolved to a common RPC interface.

This is mainly a result of 2 factors:

1. The desire to have the same communication mechanics regardless if it is post request or websocket messages
2. The desire to have authentication built into the requesting protocol (with response authentication!)

An underlying factor is the simplification of the process when changes occur in the request-processing flows.

Now this module may be used from any client to do RPC requests. Notice that while very similar to JSON RPCs it is not exactly the same specification. So we call it Thingy RPC.

Usage

Requirements

We already rely on fetch in nodejs

• nodejs >= 19
• esm importablitly

Current Functionality

import { RPCPostClient } from "thingy-post-rpc-client"

options = {
    serverURL: "https://myservice.myserver.tld/thingy-post-rpc", # required
    serverId: "..." # required - verify the right server!
    serverContext: "..." # optional - default "thingy-rpc-post-connection"
    secretKeyHex: "..." # required
    publicKeyHex: "..." # optional - will be calculated from secretKeyHex
    name: "..." # optional - default rpc-client
    anonymousToken : "" # optional - default null
    publicToken: "" # optional - default null

}

## construct client
rpcClient = new RPCPostClient(options)


## doRPC Request
rpcClient.doRPC(func, args, authType)
rpcClient.doRPC(String, Object, String)

## getters
serverURL = rpcClient.getServerURL()
secretKeyHex = rpcClient.getSecretKey()
serverIdHex = await rpcClient.getServerId()
publicKeyHex = await rpcClient.getPublicKey()

## "setters"
rpcClient.updateKeys(newSecretKey, newPublicKey)
rpcClient.updateKeys( StringHex, StringHex )

rpcClient.updateServer(newServerURL, newServerId, newServerContext)
rpcClient.updateServer( String, String, String )

doRPC

This is the core function.

rpcClient.doRPC(func, args, authType)

Here func is the function name or in JSON-RPC terms then method. The args are the JSON arguments for this function equivalent to the JSON-RPC params. The authType is the special part here. The thingy-post-rpc-client will create the correct auth object according to this authType.

Available authTypes are:

• none details here
• anonymous details here
• publicAccess details here
• tokenSimple details here
• authCodeSHA2 details here
• signature details here
• clientSignature details here
• masterSignature details here

According to this authType also the response is being authenticated. Throwing an ResponseAuthError if the auth of the response request does not match.

Sessions

Some authTypes result in a session.

Namely these are:

• tokenSimple
• authCodeSHA2

For each of these options, the RPCPostClient will start a new session explicitly if we donot have a session of that authType yet.

Explicit Session start is calling the startSession function on the server via clientSignature, providing as arguments type = authType, name andclientId.

Note: one RPCPostClient may only have 1 session and this is either of these types.

Multiple Sessions

Generally one RPCPostClient only maintains one session per authType. For multiple sessions of the same authType and clientId you can use multiple RPCPostClients. In this situation the option name is important as the server should use the name to distinguish these sessions. Using the same name and clientId would result in overwriting previous session information.

License

CC0