feat: add get_invoice feature

.gitignore

@@ -1,3 +1,4 @@
 /target
 /Cargo.lock
 /.DS_Store
+.vscode/

bindings/una-js/index.d.ts

@@ -8,6 +8,7 @@ export class Node {
   constructor(backend: Backend, config: NodeConfig)
   createInvoice(invoice: CreateInvoiceParams): Promise<CreateInvoiceResult>
   getInfo(): Promise<NodeInfo>
+  getInvoice(payementHash: String): Promise<Invoice>
   payInvoice(invoice: PayInvoiceParams): Promise<PayInvoiceResult>
 }
 
@@ -37,6 +38,22 @@ export interface CreateInvoiceResult {
   payment_request: string;
 }
 
+export type InvoiceStatus = "Pending" | "Settled" | "Cancelled" | "Accepted";
+
+export interface Invoice {
+  amount: number;
+  amount_msat: number;
+  bolt11: string;
+  creation_date: number;
+  expiry: number;
+  memo: string;
+  payment_hash: string;
+  pre_image?: string | null;
+  settle_date?: number | null;
+  settled: boolean;
+  status: InvoiceStatus;
+}
+
 export type Network =
   | ("mainnet" | "testnet" | "regtest")
   | {

bindings/una-js/src/lib.rs

@@ -101,6 +101,22 @@ impl JsNode {
         )
     }
 
+    #[napi(
+        ts_args_type = "payementHash: String",
+        ts_return_type = "Promise<Invoice>"
+    )]
+    pub fn get_invoice(&self, env: Env, payement_hash: String) -> Result<JsObject> {
+        let node = self.0.clone();
+
+        env.execute_tokio_future(
+            async move {
+                let invoice = node.lock().await.get_invoice(payement_hash).await.unwrap();
+                Ok(invoice)
+            },
+            |&mut env, invoice| Ok(env.to_js_value(&invoice)),
+        )
+    }
+
     #[napi(
         ts_args_type = "invoice: PayInvoiceParams",
         ts_return_type = "Promise<PayInvoiceResult>"

bindings/una-js/test.mjs

@@ -5,20 +5,20 @@ const config = {
     rest: {
       url: "https://127.0.0.1:8081",
       macaroon:
-        "0201036c6e6402f801030a100249a596de122aa0b6cee0d446f166231201301a160a0761646472657373120472656164120577726974651a130a04696e666f120472656164120577726974651a170a08696e766f69636573120472656164120577726974651a210a086d616361726f6f6e120867656e6572617465120472656164120577726974651a160a076d657373616765120472656164120577726974651a170a086f6666636861696e120472656164120577726974651a160a076f6e636861696e120472656164120577726974651a140a057065657273120472656164120577726974651a180a067369676e6572120867656e657261746512047265616400000620a66d3da5b13d50b2c506a2191927bce8ef13e8fd192af2c69b5dcefddb97199d",
+        "0201036c6e6402f801030a1090788030ebddcc36000f194b061613a41201301a160a0761646472657373120472656164120577726974651a130a04696e666f120472656164120577726974651a170a08696e766f69636573120472656164120577726974651a210a086d616361726f6f6e120867656e6572617465120472656164120577726974651a160a076d657373616765120472656164120577726974651a170a086f6666636861696e120472656164120577726974651a160a076f6e636861696e120472656164120577726974651a140a057065657273120472656164120577726974651a180a067369676e6572120867656e657261746512047265616400000620b1f79f1a88e156dff7b533a32a23abbe22546a6ef2e81dccd2991a2786007dff",
       tls_certificate:
-        "2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d4949434a7a434341637967417749424167495141553567664541653374586471776a6c494b476f6e6a414b42676771686b6a4f50515144416a41784d5238770a485159445651514b45785a73626d5167595856306232646c626d56795958526c5a43426a5a584a304d51347744415944565151444577566862476c6a5a5441650a467730794d6a41344d5455784e544d334e444a61467730794d7a45774d5441784e544d334e444a614d444578487a416442674e5642416f54466d78755a4342680a645852765a3256755a584a686447566b49474e6c636e5178446a414d42674e5642414d544257467361574e6c4d466b77457759484b6f5a497a6a3043415159490a4b6f5a497a6a30444151634451674145796c494245585854544d6f76526f594c515064454c6a38626a7257656744637556564b3044744b4a78774d65773754440a342b6f4c754438334c546b697137446b2b6d6842505a6e782f4f4754474b7a754a4c314465364f4278544342776a414f42674e56485138424166384542414d430a41715177457759445652306c42417777436759494b775942425155484177457744775944565230544151482f42415577417745422f7a416442674e56485134450a4667515563616b6351494e38553048734c735752527544394d304f47306d6b77617759445652305242475177596f4946595778705932574343577876593246730a6147397a644949465957787059325743446e4276624746794c5734784c57467361574e6c67675231626d6c3467677031626d6c346347466a61325630676764690a64575a6a623235756877522f4141414268784141414141414141414141414141414141414141414268775373465141454d416f4743437147534d343942414d430a41306b414d45594349514364767236702f466446464866597871596279594b483635344e6e7372557779344f544648386c31727662514968414f5433546c437a0a77477863642b35416367364e31596472652b76544f2f34525371636c7a5a6532776151520a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a",
+        "2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d4949434a7a43434163796741774942416749514f66564e7a49356e622b465831757662674844302b7a414b42676771686b6a4f50515144416a41784d5238770a485159445651514b45785a73626d5167595856306232646c626d56795958526c5a43426a5a584a304d51347744415944565151444577566862476c6a5a5441650a467730794d6a41344d4467774e6a4d314d7a6c61467730794d7a45774d444d774e6a4d314d7a6c614d444578487a416442674e5642416f54466d78755a4342680a645852765a3256755a584a686447566b49474e6c636e5178446a414d42674e5642414d544257467361574e6c4d466b77457759484b6f5a497a6a3043415159490a4b6f5a497a6a3044415163445167414578375568773146647543444f7a42456d634f346c374f6a33476b47674e734b75337a36454761782b39713042546655320a4d48336435396b45466a3534517562685739746942797669594d6e736633314f4537733744714f4278544342776a414f42674e56485138424166384542414d430a41715177457759445652306c42417777436759494b775942425155484177457744775944565230544151482f42415577417745422f7a416442674e56485134450a4667515572683771416c497875576e6a56536e4779352f4d4e77563454636f77617759445652305242475177596f4946595778705932574343577876593246730a6147397a644949465957787059325743446e4276624746794c5734304c57467361574e6c67675231626d6c3467677031626d6c346347466a61325630676764690a64575a6a623235756877522f4141414268784141414141414141414141414141414141414141414268775373464141454d416f4743437147534d343942414d430a41306b414d455943495143305536414d4a5a2b2f506c6859567a505736793637746877566b316743525243386d4c416c6e37752b4d514968414d675a6e4944370a7265727147474555386334622f6967697479776a36516737415a6e354c65306f696a6c450a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a",
     },
   },
   cln: {
     grpc: {
       url: "https://localhost:11002",
       tls_certificate:
-        "2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0d0a4d494942636a434341526967417749424167494a414d466c546169526559526a4d416f4743437147534d343942414d434d4259784644415342674e5642414d4d0d0a43324e73626942536232393049454e424d434158445463314d4445774d5441774d4441774d466f59447a51774f5459774d5441784d4441774d444177576a41570d0a4d52517745675944565151444441746a62473467556d3976644342445154425a4d424d4742797147534d34394167454743437147534d343941774548413049410d0a424c4344514c387469663542445051643943715976776361756749752b757274616e554359536c6b4b714b3736562f4d66646b307372464c364c6d6e684b32720d0a61434c494b475841334f4f545038426e5a5a3144547a4b6a5454424c4d426b4741315564455151534d42434341324e73626f494a6247396a5957786f62334e300d0a4d42304741315564446751574242526a68486d527145316c775a56656b53735a374f56456d4a6c65736a415042674e5648524d4241663845425441444151482f0d0a4d416f4743437147534d343942414d43413067414d45554349474b772b784259364f656b334b6c675957693050346459525a57632b67537343616835513554620d0a4a575959416945413538316b475337347335694a58475950514351416d777531524b4577426139432b625552526e4569676b633d0d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0d0a",
+        "2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0d0a4d4949426354434341526967417749424167494a415065324934484e463673474d416f4743437147534d343942414d434d4259784644415342674e5642414d4d0d0a43324e73626942536232393049454e424d434158445463314d4445774d5441774d4441774d466f59447a51774f5459774d5441784d4441774d444177576a41570d0a4d52517745675944565151444441746a62473467556d3976644342445154425a4d424d4742797147534d34394167454743437147534d343941774548413049410d0a424e30454c4e62366a3477674d693761695455322b79334c444272754a71546d672f533361772f50756d58785a71674c6a746d6a654e746f6f6a44364474654d0d0a4931444a4877354366765777796a6d72496455587346616a5454424c4d426b4741315564455151534d42434341324e73626f494a6247396a5957786f62334e300d0a4d4230474131556444675157424251477178664e67534f32393055445254786a4a7a6a65774364534e44415042674e5648524d4241663845425441444151482f0d0a4d416f4743437147534d343942414d43413063414d4551434941765a4b39647a6344356a6f7a7347666473493346685032337a364754656773384a695a574b530d0a5479597a416941546f7970426f4c77684d33645443764f3679626248626375422f78532f62665458765336774749453774773d3d0d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0d0a",
       tls_client_certificate:
-        "2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0d0a4d49494252544342374b41444167454341676b416a707851696b2f6852626b77436759494b6f5a497a6a304541774977466a45554d424947413155454177774c0d0a5932787549464a7662335167513045774942634e4e7a55774d5441784d4441774d444177576867504e4441354e6a41784d4445774d4441774d4442614d426f780d0a4744415742674e5642414d4d44324e736269426e636e426a49454e73615756756444425a4d424d4742797147534d34394167454743437147534d3439417745480d0a413049414247516a7057383170623545486749616878497165424e4d4138762f367070515761354f57366b33646e55484f434f465539686e72755630664d4a490d0a367444487363614a6c64327978666970575277712f2b6d32537a4f6a485441624d426b4741315564455151534d42434341324e73626f494a6247396a5957786f0d0a62334e304d416f4743437147534d343942414d43413067414d4555434951446e703555734f64457335304a6e3839596a5367456572635a4952314e70726831610d0a384e6b657736566d32514967523433303231333450654337617477363046524d3338414974433767672f686c78534c304f577a787833673d0d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0d0a",
+        "2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0d0a4d494942526a4342374b41444167454341676b4132595a375737573739526777436759494b6f5a497a6a304541774977466a45554d424947413155454177774c0d0a5932787549464a7662335167513045774942634e4e7a55774d5441784d4441774d444177576867504e4441354e6a41784d4445774d4441774d4442614d426f780d0a4744415742674e5642414d4d44324e736269426e636e426a49454e73615756756444425a4d424d4742797147534d34394167454743437147534d3439417745480d0a413049414248454b66516b6763733930516c36522f686e31305331482b676b6169455975646d327a6d647665374e494e51464d7179533879546b674c6a474c780d0a613072376e2b394e5a4351334a5041357a424e42646f6b3941586d6a485441624d426b4741315564455151534d42434341324e73626f494a6247396a5957786f0d0a62334e304d416f4743437147534d343942414d4341306b414d4559434951443462584675435832534f34744d2f4a4258376b32514a49494d3369726c533633550d0a46534475736272437777496841496c656435564854327547302b454135335a7a6677354a70477374563659526a52424e445a6d45783479340d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0d0a",
       tls_client_key:
-        "2d2d2d2d2d424547494e2050524956415445204b45592d2d2d2d2d0d0a4d494748416745414d424d4742797147534d34394167454743437147534d3439417745484247307761774942415151676c5a43666461766d53776b4939526c6a0d0a427062636e6f737757355351764348474b7346637744767642794b6852414e434141526b493656764e61572b52423443476f63534b6e67545441504c2f2b71610d0a55466d75546c75704e335a31427a676a685650595a36376c64487a43534f725178374847695a58647373583471566b634b762f70746b737a0d0a2d2d2d2d2d454e442050524956415445204b45592d2d2d2d2d0d0a",
+        "2d2d2d2d2d424547494e2050524956415445204b45592d2d2d2d2d0d0a4d494748416745414d424d4742797147534d34394167454743437147534d343941774548424730776177494241515167756c4e4532566247504a6a4c2b6b322b0d0a6f334249584b533032434657423663356f46363968516270566b796852414e4341415278436e304a49484c5064454a656b66345a39644574522f6f4a476f68470d0a4c6e5a7473356e6233757a53445542544b736b764d6b3549433478693857744b2b352f765457516b4e7954774f6377545158614a505146350d0a2d2d2d2d2d454e442050524956415445204b45592d2d2d2d2d0d0a",
     },
   },
   eclair: {
@@ -40,23 +40,23 @@ async function test_node(backend, config) {
 
   node
     .getInfo()
-    .then((info) => console.log(info))
+    .then((info) => console.log('getInfo(): ', info))
     .catch((err) => console.log(err.message, err.code));
 
-  node
-    .createInvoice(invoice)
-    .then((invoice) => console.log(invoice))
-    .catch((err) => console.log(err.message, err.code));
+    const createInvoiceResult = await node.createInvoice(invoice).catch((err) => console.log(err.message, err.code));
+    console.log('createInvoice(): ', createInvoiceResult);
+    const getInvoiceResult = await node.getInvoice(createInvoiceResult.payment_hash).catch((err) => console.log(err.message, err.code));
+    console.log('getInvoice(): ', getInvoiceResult);
 
   node
     .payInvoice({
       payment_request:
-        "lnbcrt10u1p30ag67p5v45p0xljwcktszppfj8a3wcg460xrwwhpt0xcghx36xcsr3dkz7spp5nctfmzx6k5dyv693t52y0fs95zrk33f37mue5f3geu4wt9cwgltsdpz2phkcctjypykuan0d93k2grxdaezqcn0vgxqyjw5qcqp2rzjq25z6j80gkd8vyr5nptma4lnmhjvyq66eretzvy5a4gty72g8xpejqqqdsqqqqgqqyqqqqlgqqqqqqgq9q9qyysgqd4e22wy6ejggnpg8kfkuxf6vkgxejfe4283zjgsfxmd8w7dsvk7k43lsgakwzyanzfu372w8ke8tsuyzmp28kng4e6xyz8eyh99ncagpa8myt0",
+        "lnbcrt500u1p30lxcjpp5nqerez0kcz78dakgd5kystfyf3nndzqxcuj3dc52vf42uvhlkemqdqqcqzpgxqyz5vqsp5r6ahdt5em43pt8578z4xvkzm9ah70x97ey0f768xx8r9msvlza6s9qyyssqfrt207yknpnvshqxtuku03r3rt99hvswpk7px0qy95yrym7md2mnfttxyhmxkjdm7agrqggcdf4at6ld9lkwx4q664y4hrrnd5p8argpx5yhdy",
     })
-    .then((result) => console.log(result))
+    .then((result) => console.log('payInvoice(): ', result))
     .catch((err) => console.log(err.message, err.code));
 }
 
 // test_node("LndRest", config.lnd.rest);
-test_node("EclairRest", config.eclair.rest);
-// test_node("ClnGrpc", config.cln.grpc);
+// test_node("EclairRest", config.eclair.rest);
+test_node("ClnGrpc", config.cln.grpc);

bindings/una-python/src/lib.rs

@@ -12,7 +12,7 @@ use una_core::{
     node::{Node, NodeMethods},
     types::{
         Backend, CreateInvoiceParams, CreateInvoiceResult, NodeConfig, NodeInfo, PayInvoiceParams,
-        PayInvoiceResult,
+        PayInvoiceResult, Invoice,
     },
 };
 
@@ -105,6 +105,16 @@ impl PyNode {
             Ok(result)
         })
     }
+
+    pub fn get_invoice<'p>(&self, py: Python<'p>, payment_request: String) -> PyResult<&'p PyAny> {
+        let node = self.0.clone();
+
+        pyo3_asyncio::tokio::future_into_py(py, async move {
+            let result = node.lock().await.get_invoice(payment_request).await.or_py_error()?;
+            let result = Python::with_gil(|py| pythonize::<Invoice>(py, &result).or_py_error())?;
+            Ok(result)
+        })
+    }
 }
 
 /// A Python module implemented in Rust.