SSE Message Events

[cstenglein]

I would like to discuss how to structure the SSE events to we have the same messages and I can adapt correctly.

General

The idea would be to send all data when the SSE connection is opnened and after that only the updates..

The frontend merges the object / array. Array objects are merged / replaced by their id.

variable names / message names can of course be changed, just tell me :)

Current messages:

syncstatus

Sends a object with the following keys:

key	type	description
syncStatus	number	block sync from 0 - 1 (as from bitcoind)
onchainBalance	number	on-chain balance in BTC
lnBalance	number	balance of your own channel in BTC
currBlock	number	current synced block
maxBlock	number	highest block
channelOnline	number	online ln channels
channelTotal	number	number of all channels
btcVersion	string	bitcoind version
btcStatus	string	status of the bitcoind client (online/offline)
btcNetwork	string	netzwerk of the bitcoind client (mainnet/testnet/signet)
lnVersion	string	version of lnd /c-lightning (e.g. lnd 0.13.0)
lnStatus	string	status of the lnd/c-lightning client (online/offline)
torAddress	string	Tor adresse of the raspiblitz node
sshAddress	string	SSH adresse of the raspiblitz node

transactions

Sends an array with the following objects:

key	type	description
id	string	transaction id
amount	number	amount in BTC
type	string ('onchain' / 'lightning')	onchain or lightning transaction
category	string ('send' / 'receive' / 'generate' / 'immature' / 'orphan')	type of transaction (only relevant for on-chain transactions)
comment	string	optional; comment (onchain: only relevant for oneself)

appstatus

appstatus shows online/offline info of the installed apps in the home dashboard

sends an array with the following objects:

key	type	description
id	string	unique id of the app (same as the icon name!)
name	string	name of the application
status	string ('online' / 'offline')	status of the app

apps

key	type	description
id	string	unique id of the app (needs to be the same as the icon!)
name	string	name of the application
description	string	short description of the app
installed	boolean	if the app is installed
address	string	optional; local address of the app
hiddenService	string	optional; tor adress of the app

install

delivers a message that the app with id id is being installed currently to block installation of ther apps.

key	type	description
id	string	null

Sugesstion:

I think the syncstatus message is quite big which is why i would split it into the following messages:

nodeinfo

Info about your node.

key	type	description
name	string	name of the node (new)
torAddress	string	Tor address of the raspiblitz node
sshAddress	string	SSH address of the raspiblitz node

btcstatus

Info regarding bitcoind

key	type	description
syncStatus	number	block sync from 0 - 1 (same as bitcoind)
currBlock	number	currently synced block
maxBlock	number	highest block
btcVersion	string	bitcoind version
btcStatus	string	status of the bitcoind client (online/offline)
btcNetwork	string	network of the bitcoind client (mainnet/testnet/signet)

lnstatus

info regarding LN

key	type	description
channelOnline	number	online ln channel
channelTotal	number	total number of channels
lnVersion	string	version of lnd /c-lightning (z.B. lnd 0.13.0)
lnStatus	string	status of lnd/c-lightning (online/offline)

balance

on-chain / ln balance

key	type	description
onchainBalance	number	on-chain balance in BTC
lnBalance	number	balance of your own channels in BTC

Other events like before