README.md

Daemon

A websocket client for connecting to chia daemon.
This Daemon class is a singleton to prevent multiple useless connections being active at once.

Please note that you cannot create multiple daemon clients connecting to different url in single nodejs process.
If you need to do it, please let me know. I'll check whether its merit is considerable than changing entire code base.

You can generate this Daemon client as below.

const {getDaemon} = require("chia-agent");
const daemon = getDaemon();

daemon.connect(url?: string, timeoutMs?: number)

Connect to chia daemon via websocket.

If you don't pass any argument, it tries to connect to an url specified in chia configuration file. (Note: chia-agent cares environment variable CHIA_ROOT)

await daemon.connect();

You can specify chia daemon url to connect to.

await daemon.connect("wss://hostname:port");

url

Optional. A URL to the daemon server to connect.
The default url is wss://{DAEMON_HOST}:{DAEMON_PORT} where DAEMON_HOST is ui.daemon_host and DAEMON_PORT is ui.daemon_port in $CHIA_ROOT/config/config.yaml
(Usually wss://localhost:55400)

timeoutMs

Optional. Connection timeout in milliseconds.
The default value is 50000.

daemon.close()

Close active connection.
If no active connection found, it silently returns without error.

daemon.close();

After socket successfully closes, onClose event will dispatch. You can listen to the event as below:

daemon.addEventListener("close", () => {
  // Do some stuff here.
});

daemon.subscribe(service: string)

Start to monitor message channel via websocket.

await daemon.subscribe(service);
// service: "wallet_ui", "metrics" or "chia_plotter"

wallet_ui
Monitor messages sent to update GUI like connecting nodes, last attempted proof, wallet status, etc.

metrics
Monitor messages to measure internal app states.

chia_plotter
Monitor plot creation progress.

Messages can be monitored after message event listener is added to daemon instance.

// Subscribe message from `origin`.
// origin is "chia_wallet", "chia_farmer", "chia_full_node", "chia_plotter", etc.
// If origin is set to `undefined` or "all", all incoming messages are passed to the listener function.
daemon.addMessageListener(origin, (message) => {
  // Content of receiving message depends on origin and command.
  // command is a request type of message. e.g. "get_blockchain_state", "new_farming_info", etc.
});

The format of incoming message is:

{
  command: string;
  ack: boolean;
  data: any; // depends on command
  request_id: string;
  destination: string;
  origin: string;
}