Class KristWsClient

A WebSocket client instance for the Krist API. Must be created with createWsClient.

After creating a KristWsClient, you can call connect to establish a new connection to the Krist server. After this, the client will automatically attempt to reconnect if the connection is lost.

KristWsClient is a standard event emitter. Events can be listened to with ws.on(event, callback).

When disconnecting from the Krist server, the client will automatically try to reconnect, starting with a 1 second delay, doubling with each attempt up to a maximum of 60 seconds (1 minute). The library will not stop attempting to reconnect - this is the responsibility of the caller.

Hierarchy

TypedEmitter<KristWsClientEvents>
- KristWsClient

Properties

`Private` connectDebounceMs

connectDebounceMs: number = DEFAULT_CONNECT_DEBOUNCE_MS

`Private` connectionState

connectionState: WsConnectionState = "connecting"

`Private` forceClosing

forceClosing: boolean = false

`Private` initSubscriptions

initSubscriptions: KristWsSubscription[] = []

`Private` maxReconnectSecs

maxReconnectSecs: number = 60

`Private` messageId

messageId: number = 1

`Private` messageResponses

messageResponses: Record<number, { reject: ((reason?: KristWsS2CResponseMessage) => void); resolve: ((value?: KristWsS2CResponseMessage) => void) }> = {}

`Protected` `Optional` privatekey

privatekey?: string

`Private` `Optional` reconnectionTimer

reconnectionTimer?: any

`Private` `Optional` wsp

wsp?: WebSocketAsPromised

`Static` BLOCK

BLOCK: string = "block"

Emitted when a block is submitted, if subscribed to the blocks or ownBlocks events. The whole KristWsBlockEvent message will be passed to the callback.

Event

`Static` EVENT

EVENT: string = "event"

Emitted when any event is received. The full KristWsEventMessage will be passed to the callback.

Event

`Static` KEEPALIVE

KEEPALIVE: string = "keepalive"

Emitted when the server sends a keepalive ping. The server's time as a Date will be passed to the callback.

Event

`Static` MESSAGE

MESSAGE: string = "message"

Emitted when any message is received. The full raw KristWsS2CMessage will be passed to the callback.

Event

`Static` NAME

NAME: string = "name"

Emitted when a name is purchased, if subscribed to the names or ownNames events. The whole KristWsNameEvent message will be passed to the callback.

Event

`Static` READY

READY: string = "ready"

Emitted when the client has connected to the server and is ready to receive messages. The hello message from the server will be passed as an argument to the event, containing full KristMotd information. This event will happen each time the client connects to the server, so it may happen more than once.

Event

`Static` STATE

STATE: string = "state"

Emitted when the connection state changes. The new and old states respectively will be passed as arguments to the callback.

Event

`Static` TRANSACTION

TRANSACTION: string = "transaction"

Emitted when a transaction is made, if subscribed to the transactions or ownTransactions events. The whole KristWsTransactionEvent message will be passed to the callback.

Event

`Static` defaultMaxListeners

defaultMaxListeners: number

API Fetch

getAddress

getAddress: ((this: KristWsClient, address: string, fetchNames?: boolean) => Promise<KristAddress>) = getAddress

Type declaration

- (this: KristWsClient, address: string, fetchNames?: boolean): Promise<KristAddress>
- Gets a single address.
 
 See
 - KristApi.getAddress
 - https://krist.dev/docs/#api-WebsocketGroup-WSGetAddress
 Returns
 The address.
 Parameters
 - this: KristWsClient
 - address: string
 
 The address to get.
 - Optional fetchNames: boolean
 
 When true, fetch the count of names owned by the address. The address object returned will have the names count field available.
 Returns Promise<KristAddress>

getMe

getMe: ((this: KristWsClient) => Promise<KristWsS2CMe>) = getMe

Type declaration

- (this: KristWsClient): Promise<KristWsS2CMe>
- Gets information about the user the websocket is currently authenticated as.
 
 See
 https://krist.dev/docs/#api-WebsocketGroup-WSMe
 
 Returns
 The whole KristWsS2CMe response from the server.
 Parameters
 - this: KristWsClient
 Returns Promise<KristWsS2CMe>

getSubscriptions

getSubscriptions: ((this: KristWsClient) => Promise<KristWsS2CGetSubscriptionLevel>) = getSubscriptions

Type declaration

- (this: KristWsClient): Promise<KristWsS2CGetSubscriptionLevel>
- Parameters
 - this: KristWsClient
 Returns Promise<KristWsS2CGetSubscriptionLevel>

getWork

getWork: ((this: KristWsClient) => Promise<KristWsS2CWork>) = getWork

Type declaration

- (this: KristWsClient): Promise<KristWsS2CWork>
- Parameters
 - this: KristWsClient
 Returns Promise<KristWsS2CWork>

API Submit

makeTransaction

makeTransaction: ((this: KristWsClient, to: string, amount: number, options?: KristWsMakeTransactionOptions) => Promise<KristTransaction>) = makeTransaction

Type declaration

- (this: KristWsClient, to: string, amount: number, options?: KristWsMakeTransactionOptions): Promise<KristTransaction>
- Sends a transaction to the given address.
 
 See
 - KristApi.makeTransaction
 - https://krist.dev/docs/#api-WebsocketGroup-WSMakeTransaction
 Returns
 The KristTransaction that was made.
 Parameters
 - this: KristWsClient
 - to: string
 
 The address to send the transaction to. May be a Krist address or a name.
 - amount: number
 
 The amount to send.
 - Optional options: KristWsMakeTransactionOptions
 
 The KristApiMakeTransactionOptions options for the request. If a password or private key are not supplied, the request will error.
 Returns Promise<KristTransaction>

API Miscellaneous

subscribe: ((this: KristWsClient, event: KristWsSubscription) => Promise<KristWsS2CSubscribe>) = subscribe

Type declaration

- (this: KristWsClient, event: KristWsSubscription): Promise<KristWsS2CSubscribe>
- Parameters
 - this: KristWsClient
 - event: KristWsSubscription
 Returns Promise<KristWsS2CSubscribe>

unsubscribe

unsubscribe: ((this: KristWsClient, event: KristWsSubscription) => Promise<KristWsS2CUnsubscribe>) = unsubscribe

Type declaration

- (this: KristWsClient, event: KristWsSubscription): Promise<KristWsS2CUnsubscribe>
- Parameters
 - this: KristWsClient
 - event: KristWsSubscription
 Returns Promise<KristWsS2CUnsubscribe>

Methods

`Private` _connect

_connect(): Promise<void>
Returns Promise<void>

addListener

addListener(event: U, listener: KristWsClientEvents[U]): KristWsClient
Type Parameters
- U extends keyof KristWsClientEvents
Parameters
- event: U
- listener: KristWsClientEvents[U]
Returns KristWsClient

Inherited from TypedEmitter.addListener

connect

connect(): Promise<void>
Initiate a connection to the Krist server. From this point onwards, the client will take over responsibility for auto-reconnecting. Event handlers should be registered before calling this method.

The promise will be resolved when the connection has been opened (but will not necessarily be ready yet).

Returns Promise<void>

emit

emit(event: U, ...args: Parameters<KristWsClientEvents[U]>): boolean
Type Parameters
- U extends keyof KristWsClientEvents
Parameters
- event: U
- Rest ...args: Parameters<KristWsClientEvents[U]>
Returns boolean

Inherited from TypedEmitter.emit

eventNames

eventNames(): U[]
Type Parameters
- U extends keyof KristWsClientEvents
Returns U[]

Inherited from TypedEmitter.eventNames

forceClose

forceClose(): void
Forcibly close the websocket connection.

Returns void

getMaxListeners

getMaxListeners(): number
Returns number

Inherited from TypedEmitter.getMaxListeners

`Private` handleClose

handleClose(event: { code: number; reason: string }): void
Parameters
- event: { code: number; reason: string }
  - code: number
  - reason: string
Returns void

`Private` handleDisconnect

handleDisconnect(_err?: Error): void
Parameters
- Optional _err: Error
Returns void

`Private` handleHello

handleHello(msg: KristWsHelloMessage): Promise<void>
Parameters
- msg: KristWsHelloMessage
Returns Promise<void>

`Private` handleMessage

handleMessage(msg: KristWsS2CMessage): void
Parameters
- msg: KristWsS2CMessage
Returns void

listenerCount

listenerCount(type: keyof KristWsClientEvents): number
Parameters
- type: keyof KristWsClientEvents
Returns number

Inherited from TypedEmitter.listenerCount

listeners

listeners(type: U): KristWsClientEvents[U][]
Type Parameters
- U extends keyof KristWsClientEvents
Parameters
- type: U
Returns KristWsClientEvents[U][]

Inherited from TypedEmitter.listeners

off

off(event: U, listener: KristWsClientEvents[U]): KristWsClient
Type Parameters
- U extends keyof KristWsClientEvents
Parameters
- event: U
- listener: KristWsClientEvents[U]
Returns KristWsClient

Inherited from TypedEmitter.off

on

on(event: U, listener: KristWsClientEvents[U]): KristWsClient
Type Parameters
- U extends keyof KristWsClientEvents
Parameters
- event: U
- listener: KristWsClientEvents[U]
Returns KristWsClient

Inherited from TypedEmitter.on

once

once(event: U, listener: KristWsClientEvents[U]): KristWsClient
Type Parameters
- U extends keyof KristWsClientEvents
Parameters
- event: U
- listener: KristWsClientEvents[U]
Returns KristWsClient

Inherited from TypedEmitter.once

prependListener

prependListener(event: U, listener: KristWsClientEvents[U]): KristWsClient
Type Parameters
- U extends keyof KristWsClientEvents
Parameters
- event: U
- listener: KristWsClientEvents[U]
Returns KristWsClient

Inherited from TypedEmitter.prependListener

prependOnceListener

prependOnceListener(event: U, listener: KristWsClientEvents[U]): KristWsClient
Type Parameters
- U extends keyof KristWsClientEvents
Parameters
- event: U
- listener: KristWsClientEvents[U]
Returns KristWsClient

Inherited from TypedEmitter.prependOnceListener

rawListeners

rawListeners(type: U): KristWsClientEvents[U][]
Type Parameters
- U extends keyof KristWsClientEvents
Parameters
- type: U
Returns KristWsClientEvents[U][]

Inherited from TypedEmitter.rawListeners

removeAllListeners

removeAllListeners(event?: keyof KristWsClientEvents): KristWsClient
Parameters
- Optional event: keyof KristWsClientEvents
Returns KristWsClient

Inherited from TypedEmitter.removeAllListeners

removeListener

removeListener(event: U, listener: KristWsClientEvents[U]): KristWsClient
Type Parameters
- U extends keyof KristWsClientEvents
Parameters
- event: U
- listener: KristWsClientEvents[U]
Returns KristWsClient

Inherited from TypedEmitter.removeListener

`Private` sendRaw

sendRaw(msg: KristWsRawC2SMessage): Promise<void>
Parameters
- msg: KristWsRawC2SMessage
Returns Promise<void>

`Private` setConnectionState

setConnectionState(state: WsConnectionState): void
Parameters
- state: WsConnectionState
Returns void

setMaxListeners

setMaxListeners(n: number): KristWsClient
Parameters
- n: number
Returns KristWsClient

Inherited from TypedEmitter.setMaxListeners

Advanced

sendAndWait

sendAndWait<S2C_T, C2S_T>(data: C2S_T): Promise<S2C_T>
Sends a raw message to the Krist server and waits for a response. The methods for a specific API request should be used instead of this function.

Returns
The response from the server.
Type Parameters
- S2C_T extends KristWsS2CResponseMessage = KristWsS2CResponseMessage
- C2S_T extends KristWsC2SMessage = KristWsC2SMessage
Parameters
- data: C2S_T
 
 The full message to send to the server. The message ID will be generated automatically.
Returns Promise<S2C_T>

Class KristWsClient

Hierarchy

Index

Properties

API Fetch

API Submit

API Miscellaneous

Methods

Advanced

Properties

Private connectDebounceMs

Private connectionState

Private forceClosing

Private initSubscriptions

Private maxReconnectSecs

Private messageId

Private messageResponses

Protected Optional privatekey

Private Optional reconnectionTimer

Private Optional wsp

Static BLOCK

Event

Static EVENT

Event

Static KEEPALIVE

Event

Static MESSAGE

Event

Static NAME

Event

Static READY

Event

Static STATE

Event

Static TRANSACTION

Event

Static defaultMaxListeners

API Fetch

getAddress

Type declaration

See

Returns

Parameters

this: KristWsClient

address: string

Optional fetchNames: boolean

Returns Promise<KristAddress>

getMe

Type declaration

See

Returns

Parameters

this: KristWsClient

Returns Promise<KristWsS2CMe>

getSubscriptions

Type declaration

Parameters

this: KristWsClient

Returns Promise<KristWsS2CGetSubscriptionLevel>

getWork

Type declaration

Parameters

this: KristWsClient

Returns Promise<KristWsS2CWork>

API Submit

makeTransaction

Type declaration

See

Returns

Parameters

this: KristWsClient

to: string

amount: number

Optional options: KristWsMakeTransactionOptions

Returns Promise<KristTransaction>

API Miscellaneous

subscribe

Type declaration

Parameters

this: KristWsClient

`Private` connectDebounceMs

`Private` connectionState

`Private` forceClosing

`Private` initSubscriptions

`Private` maxReconnectSecs

`Private` messageId

`Private` messageResponses

`Protected` `Optional` privatekey

`Private` `Optional` reconnectionTimer

`Private` `Optional` wsp

`Static` BLOCK

`Static` EVENT

`Static` KEEPALIVE

`Static` MESSAGE

`Static` NAME

`Static` READY

`Static` STATE

`Static` TRANSACTION

`Static` defaultMaxListeners

`Optional` fetchNames: boolean

`Optional` options: KristWsMakeTransactionOptions

`Private` _connect

`Rest` ...args: Parameters<KristWsClientEvents[U]>

`Private` handleClose

`Private` handleDisconnect

`Optional` _err: Error

`Private` handleHello

`Private` handleMessage