RGB-Tools / RGB-Tools/rgb-lightning-node

Feature Request: Support for HODL Invoices and Proxy Invoices

Open
#50 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
50
Forks
48
Avg merge
8h 52m
Merged PRs (30d)
2

Description

We would like to open a discussion and propose the addition of HODL invoices and Proxy invoices support in the RGB Lightning Node (RLN). These features would enable better coordination for atomic swaps and advanced cross-protocol HTLC-based interactions (e.g. RGB <> Taproot Assets swaps).


Draft API Design proposal
1. HODL Invoice
  • POST /hodlinvoice: Create a HODL invoice. It will not be automatically settled when paid.
  • POST /settleinvoice: Manually settle a previously created HODL invoice (if paid).
  • POST /cancelinvoice: Cancel a HODL invoice, even if it's been paid.
2. Proxy Invoice
  • POST /proxyinvoice: Takes a Lightning invoice as input and returns a new proxy HODL invoice with the same payment hash.
    • When the proxy is paid, RLN should pay the original invoice.
    • When the original invoice is settled and the preimage is known, the proxy invoice is then settled using the same preimage.

🔗 References

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the proposed /hodlinvoice, /settleinvoice, /cancelinvoice, and /proxyinvoice entry points alongside the linked HODL invoice and LN Proxy references. Define the API and payment-flow requirements first; the work is done when the project has an agreed design and both invoice types' stated settlement, cancellation, and forwarding behavior are implemented and verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, payments
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.