core lightning

bindings/lni_nodejs/index.d.ts

@@ -16,20 +16,13 @@ export interface Bolt11Resp {
   paymentHash: string
   serialized: string
 }
-export interface PhoenixdMakeInvoiceParams {
-  invoiceType: InvoiceType
-  amountMsats: number
-  description?: string
-  descriptionHash?: string
-  expiry?: number
+export interface ClnConfig {
+  url: string
+  rune: string
 }
-export interface ListTransactionsParams {
-  from: number
-  until: number
-  limit: number
-  offset: number
-  unpaid: boolean
-  invoiceType: string
+export interface ClnNode {
+  url: string
+  rune: string
 }
 export const enum InvoiceType {
   Bolt11 = 'Bolt11',
@@ -59,6 +52,8 @@ export interface Transaction {
   createdAt: number
   expiresAt: number
   settledAt: number
+  payerNote?: string
+  externalId?: string
 }
 export interface NodeConnectionInfo {
   pubkey: string
@@ -145,6 +140,7 @@ export interface LightningBalanceResponse {
   nextMaxReceivableMpp: number
 }
 export interface PayInvoiceResponse {
+  paymentHash: string
   preimage: string
   fee: number
 }
@@ -159,6 +155,27 @@ export interface PaymentFailedEventProperties {
   transaction: Transaction
   reason: string
 }
+export interface ListTransactionsParams {
+  from: number
+  limit: number
+  paymentHash?: string
+}
+export interface CreateInvoiceParams {
+  invoiceType: InvoiceType
+  amountMsats?: number
+  offer?: string
+  description?: string
+  descriptionHash?: string
+  expiry?: number
+}
+export interface PayCode {
+  offerId: string
+  bolt12: string
+  label?: string
+  active?: boolean
+  singleUse?: boolean
+  used?: boolean
+}
 export interface Payment {
   paymentId: string
   circId: string
@@ -173,14 +190,23 @@ export declare class PhoenixdNode {
   getPassword(): string
   getConfig(): PhoenixdConfig
   getInfo(): Promise<NodeInfo>
-  makeInvoice(params: PhoenixdMakeInvoiceParams): Promise<Transaction>
+  createInvoice(params: CreateInvoiceParams): Promise<Transaction>
+  getOffer(): Promise<PayCode>
   lookupInvoice(paymentHash: string): Promise<Transaction>
   payOffer(offer: string, amountMsats: number, payerNote?: string | undefined | null): Promise<PayInvoiceResponse>
   listTransactions(params: ListTransactionsParams): Promise<Array<Transaction>>
 }
-export declare class Db {
-  constructor(path: string)
-  save(): void
-  writePayment(payment: Payment): void
-  lookupPayment(paymentId: string): Payment | null
+export declare class ClnNode {
+  constructor(config: ClnConfig)
+  getUrl(): string
+  getRune(): string
+  getConfig(): ClnConfig
+  getInfo(): Promise<NodeInfo>
+  createInvoice(params: CreateInvoiceParams): Promise<Transaction>
+  getOffer(search?: string | undefined | null): Promise<PayCode>
+  listOffers(search?: string | undefined | null): Promise<Array<PayCode>>
+  payOffer(offer: string, amountMsats: number, payerNote?: string | undefined | null): Promise<PayInvoiceResponse>
+  lookupInvoice(paymentHash: string): Promise<Transaction>
+  listTransactions(params: ListTransactionsParams): Promise<Array<Transaction>>
+  decode(str: string): Promise<string>
 }

bindings/lni_nodejs/index.js

@@ -310,8 +310,8 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { InvoiceType, PhoenixdNode, Db } = nativeBinding
+const { InvoiceType, PhoenixdNode, ClnNode } = nativeBinding
 
 module.exports.InvoiceType = InvoiceType
 module.exports.PhoenixdNode = PhoenixdNode
-module.exports.Db = Db
+module.exports.ClnNode = ClnNode

bindings/lni_nodejs/main.mjs

@@ -1,49 +1,101 @@
-import { PhoenixdNode, InvoiceType, Db } from "./index.js";
+import { PhoenixdNode, ClnNode, InvoiceType } from "./index.js";
 import dotenv from "dotenv";
 dotenv.config();
 
-const config = {
-  url: process.env.PHOENIXD_URL,
-  password: process.env.PHOENIXD_PASSWORD,
-  test_hash: process.env.PHOENIXD_TEST_PAYMENT_HASH,
-};
-const node = new PhoenixdNode(config);
-const info = await node.getInfo();
-console.log("Node info:", info);
-
-const configRes = await node.getConfig();
-console.log("Config:", configRes.url);
-
-const invoice = await node.makeInvoice({
-  amountMsats: 1000,
-  description: "test invoice",
-  invoiceType: InvoiceType.Bolt11,
-});
-console.log("Invoice:", invoice);
-
-const lookupInvoice = await node.lookupInvoice(process.env.PHOENIXD_TEST_PAYMENT_HASH);
-console.log("lookupInvoice:", lookupInvoice);
-
-const payOffer = await node.payOffer(process.env.TEST_OFFER, 3000, 'payment from lni nodejs');
-console.log("payOffer:", payOffer);
-
-const txns = await node.listTransactions({
-  from: 0,
-  until: 0,
-  limit: 10,
-  offset: 0,
-  unpaid: false,
-  invoiceType: "all",
-});
-console.log("Transactions:", txns);
-
-// const db = new Db("test.json");
-// db.writePayment({
-//   paymentId: "1",
-//   circId: "1",
-//   round: 1,
-//   relayFingerprint: "1",
-//   updatedAt: 1,
-//   amountMsats: 1,
-//   amount_msats: 1000,
-// });
+async function phoenixd() {
+  const config = {
+    url: process.env.PHOENIXD_URL,
+    password: process.env.PHOENIXD_PASSWORD,
+    test_hash: process.env.PHOENIXD_TEST_PAYMENT_HASH,
+  };
+  const node = new PhoenixdNode(config);
+  const info = await node.getInfo();
+  console.log("Node info:", info);
+
+  const configRes = await node.getConfig();
+  console.log("Config:", configRes.url);
+
+  const invoice = await node.createInvoice({
+    amountMsats: 1000,
+    description: "test invoice",
+    invoiceType: InvoiceType.Bolt11,
+  });
+  console.log("Invoice:", invoice);
+
+  const lookupInvoice = await node.lookupInvoice(
+    process.env.PHOENIXD_TEST_PAYMENT_HASH
+  );
+  console.log("lookupInvoice:", lookupInvoice);
+
+  const payOffer = await node.payOffer(
+    process.env.TEST_RECEIVER_OFFER,
+    3000,
+    "payment from lni nodejs"
+  );
+  console.log("payOffer:", payOffer);
+
+  const txns = await node.listTransactions({
+    from: 0,
+    limit: 10,
+  });
+  console.log("Transactions:", txns);
+
+  const offer = await node.getOffer();
+  console.log("Get Offer:", offer);
+}
+
+async function cln() {
+  const config = {
+    url: process.env.CLN_URL,
+    rune: process.env.CLN_RUNE,
+  };
+  const node = new ClnNode(config);
+  const info = await node.getInfo();
+  console.log("Node info:", info);
+
+  // const configRes = await node.getConfig();
+  // console.log("Config:", configRes.url);
+
+  const invoice = await node.createInvoice({
+    amountMsats: 1000,
+    description: "test invoice",
+    invoiceType: InvoiceType.Bolt11,
+  });
+  console.log("Invoice:", invoice);
+
+  const bolt11Invoice = await node.createInvoice({
+    amountMsats: 3000,
+    description: "test invoice",
+    invoiceType: InvoiceType.Bolt11,
+  });
+  console.log("CLN bolt11 Invoice:", bolt11Invoice);
+
+  const offer = await node.getOffer();
+  console.log("CLN Bolt12 Offer:", offer);
+
+  const lookupInvoice = await node.lookupInvoice(
+    process.env.CLN_TEST_PAYMENT_HASH
+  );
+  console.log("lookupInvoice:", lookupInvoice);
+
+  // TODO not working (cln <=> phoneixd issue?)
+  // const payOffer = await node.payOffer(
+  //   process.env.TEST_RECEIVER_OFFER,
+  //   3000,
+  //   "payment from lni nodejs"
+  // );
+  // console.log("payOffer:", payOffer);
+
+  const txns = await node.listTransactions({
+    from: 0,
+    limit: 10,
+  });
+  console.log("Transactions:", txns);
+}
+
+async function main() {
+  phoenixd();
+  cln();
+}
+
+main();