@synonymdev/slashtags-rpc

rpc

helper module for creating RPCs using Slashtags nodes

Installation

npm install @synonymdev/slashtags-rpc

Usage

import SlashtagsRPC from '@synonymdev/slashtags-rpc';
import Slashtag from '@synonymdev/slashtag';
import c from 'compact-encoding';

class Foo extends SlashtagsRPC {
  get id() {
    return 'foo';
  }

  get valueEncoding() {
    return c.string;
  }

  get handshakeEncoding() {
    return c.string;
  }

  handshake(socket) {
    return this.id + '-handshake:for:' + socket.remotePublicKey.toString('hex');
  }

  onopen(handshake, socket) {
    this.emit('handshake', handshake, socket.reomtePublicKey);
  }

  get methods() {
    const self = this;
    return [
      {
        name: 'echo',
        handler: self._onEcho.bind(self)
      }
    ]
  }

  _onEcho (req) {
    this.emit('echo', req)
    return req
  }

  async echo (key, message) {
    const rpc = await this.rpc(key)
    return rpc?.request('echo', message)
  }
}

const alice = new Slashtag();
await alice.listen();

const aliceFoo = new Foo(alice);
aliceFoo.on('echo', (req) => { console.log(req) })

const bob = new Slashtag();
const bobFoo = new Foo(bob);

const response = await bobFoo.echo(alice.key, 'hello world');

API

const rpc = new SlashtagsRPC({swarm})

Create a new instance of SlashtagsRPC using a Hyperswarm instance.

id

String identifies your RPC protocol.

valueEncoding

Default compact encoding for all requests and responses.

handshakeEncoding

Default compact encoding for handshake message, sent first thing on opening the channel.

handshake(stream) => any

A callback function that should returns the handshake value. stream is a SecretStream.

onopen(handshake, stream)

A callback on opening the rpc. handshake is the value sent on opening the channel, stream is a SecretStream.

methods

An array of methods objects that should be as following:

{
    name: string,
    options?: {
        // Optional encoding for both the request and response
        valueEncoding: Encoding,
        // Optional encoding for requests
        requestEncoding: Encoding,
        // Optional encoding for responses
        responseEncoding: Encoding
    },
    // Handler that takes the decoded request and returns a response value
    handler: (req) => any
}

rpc(key)

Returns a ProtomuxRPC instance after connecting to a Slashtag by its key, id or url. If connection is already opened, the same RPC instance is returned.

this is an idempotent operation, meaning if there is already an existing opened connection, it won't create new ones.