Hierarchy

Properties

initialSubscriptions?: KristWsSubscription[]

The events to subscribe to. Defaults to [] - no events will be received.

maxReconnectSecs?: number

The maximum time between reconnection attempts, in seconds.

password?: string

The password to use for authenticating to the websocket. If a password or private key are not supplied, the connection will be a "guest" connection.

username?: string

The username to use for authenticating to the websocket, if the wallet format requires a username.

walletFormat?: KristWalletFormatName

The wallet format to use if a password was supplied. Defaults to kristwallet.

Advanced

privatekey?: string

Instead of a password, the raw private key to use for authenticating to the websocket. No wallet format will be applied. If a private key or password are not supplied, the connection will be a "guest" connection.

sha256Fn?: Sha256Fn

The SHA-256 function to use. Defaults to a pure JS implementation. You do not normally need to supply this.

Generated using TypeDoc