src/info/NodesRefresher.ts
// https://github.com/andreashuber69/lightning-node-operator/develop/README.md
import CappedPromise from "capped-promise";
import type { AuthenticatedLightningArgs } from "lightning";
import { subscribeToChannels } from "lightning";
import { getChannels } from "../lightning/getChannels.js";
import type { Node } from "../lightning/getNode.js";
import { getNode } from "../lightning/getNode.js";
import { FullRefresher } from "./FullRefresher.js";
import type { Emitters, IRefresher } from "./Refresher.js";
type NodesEmitters = Emitters<"channels">;
export interface INodesRefresherArgs {
/** The {@linkcode AuthenticatedLightningArgs} of the node the data should be retrieved from. */
readonly lndArgs: AuthenticatedLightningArgs;
/** The length of time each refresh and notify operation will be delayed after a change has been detected. */
readonly delayMilliseconds?: number;
}
export type NodesElement = Node & { readonly id: string };
/** Implements {@linkcode IRefresher} for partner nodes. */
export class NodesRefresher extends FullRefresher<"nodes", NodesElement, NodesEmitters> {
/**
* Creates a new object implementing {@linkcode IRefresher} for partner nodes of public channels.
* @param args See {@linkcode INodesRefresherArgs}.
*/
public static async create(args: INodesRefresherArgs) {
return await this.init(new NodesRefresher(args));
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
protected override async getAllData(lndArgs: AuthenticatedLightningArgs) {
// eslint-disable-next-line @typescript-eslint/naming-convention
const channels = await getChannels({ ...lndArgs, is_public: true });
const createNodePromises =
channels.map((c) => async () => ({ id: c.id, ...await this.getNode(lndArgs, c.partner_public_key) }));
return await CappedPromise.all(10, createNodePromises);
}
protected override onServerChanged({ channels }: NodesEmitters, listener: () => void) {
channels.on("channel_opened", listener);
channels.on("channel_closed", listener);
}
protected override createServerEmitters(lndArgs: AuthenticatedLightningArgs) {
return { channels: subscribeToChannels(lndArgs) } as const;
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
private constructor(args: INodesRefresherArgs) {
super({ ...args, name: "nodes" });
}
private async getNode(lndArgs: AuthenticatedLightningArgs, publicKey: string) {
// eslint-disable-next-line @typescript-eslint/naming-convention
return await getNode({ ...lndArgs, public_key: publicKey });
}
}