Skip to content

Commit fd54c4f

Browse files
authored
docs: add learnings to README (#80)
* Update README.md * docs: add limitation of ZapPlanner
1 parent 4a3e24b commit fd54c4f

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ https://zapplanner.albylabs.com/confirm?amount=21&[email protected]&ti
2121
- `returnUrl` encoded URL to show as link on confirmation page
2222
- `nwcUrl` a url-encoded NWC connection secret
2323

24+
## API
25+
26+
The API can be called to seamlessly setup subscriptions from other services / websites without having to visit ZapPlanner.com. The API is currently undocumented.
27+
2428
## Installation
2529

2630
Run `$ yarn install`
@@ -66,3 +70,16 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next
6670
## Inngest
6771

6872
ZapPlanner is a serverless application that uses [Inngest](https://www.inngest.com/) to power its background jobs.
73+
74+
## Alby Labs Project
75+
76+
ZapPlanner is a hackday / Alby Labs project to show how lightning subscriptions can be possible through the power of NWC. To be taken further the architecture needs to be re-thought so that it is more reliable and more scalable.
77+
78+
- NextJS as a serverless platform is not the right tool (and because of this requires inngest, which we also kind of abuse the purpose of inngest)
79+
- It doesn't really make sense that each subscription itself is responsible for re-scheduling payments for itself
80+
81+
There are two main use cases we see for subscription payments:
82+
- Setting up a recurring payment yourself - however, the UI/UX of this might be better directly integrated into the wallet (e.g. Alby Hub)
83+
- Setting up a subscription on a third party platform for some sort of service (e.g. a monthly movies platform subscription or internet / mobile plan). Similar to subscriptions powered by Paypal or Stripe, but using an NWC connection instead of a credit card, ZapPlanner would power the subscription payments behind the scenes. The UX is quite nice with the NWC 1-click connection flow - the user could simply connect their wallet (e.g. with [Bitcoin Connect](https://github.com/getAlby/bitcoin-connect)) and then confirm the subscription, without visiting ZapPlanner (the platform/site would just use the ZapPlanner API directly).
84+
85+
One limitation of setting up these "Push" subscriptions from ZapPlanner is it's harder for the service to be able to do flexible charging. Therefore, it might be better for the service to have access to the NWC connection secret instead, so it always has control of how much it can charge (within the connection budgets set by the user).

0 commit comments

Comments
 (0)