@acurast/transport-websocket v1.0.1

Acurast Transport Websocket

An implementation of the Acurast P2P WebSocket Transport.

Installation

$ npm install @acurast/transport-websocket

Documentation

WebSocketTransportClient

A client that can communicate with the Acurast P2P network using WebSocket.

To create a new instance call it constuctor and provide an Acurast P2P WebSocket server url and an optional connectionTimeoutMillis.

The connection timeout is the number of milliseconds to wait for an initial response from the server. If the server does not respond within the specified time, an error is thrown.

constructor(url: string, connectionTimeoutMillis: number)

connect

Opens a connection between the client and the server using the calling peer's P256 keyPair.

/*
interface KeyPair {
  publicKey: Uint8Array
  secretKey: Uint8Array
}
*/

connect(keyPair: KeyPair): Promise<void>

onMessage

Registers a new listener which will be notified on incoming message.

/*
interface Message {
  sender: Uint8Array
  recipient: Uint8Array
  payload: Uint8Array
}
*/

onMessage(listener: (message: Message) => void | Promise<void>): void

send

Sends a new message with the payload to a peer that identifies with the publicKey.

send(publicKey: Uint8Array, payload: Uint8Array): Promise<void>

close

Terminates the ongoing connection.

close(): Promise<void>