Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bumi/faraday_ln_paywall
Faraday middleware to support bitcoin lightning paywalls. (pay per request)
https://github.com/bumi/faraday_ln_paywall
api bitcoin faraday-middleware lightning lightning-network lightning-paywalls micropayments payments paywall
Last synced: 3 months ago
JSON representation
Faraday middleware to support bitcoin lightning paywalls. (pay per request)
- Host: GitHub
- URL: https://github.com/bumi/faraday_ln_paywall
- Owner: bumi
- License: mit
- Created: 2018-10-27T10:12:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-06-02T09:57:36.000Z (over 5 years ago)
- Last Synced: 2024-04-25T00:01:41.862Z (10 months ago)
- Topics: api, bitcoin, faraday-middleware, lightning, lightning-network, lightning-paywalls, micropayments, payments, paywall
- Language: Ruby
- Homepage:
- Size: 43 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Faraday middleware to send lightning payments
This is a [Faraday](https://github.com/lostisland/faraday#readme) middleware that handles payment requests by the server
and sends Bitcoin [lightning payments](https://lightning.network/).
## How does it work?
This Faraday middleware checks if the server responds with a `402 Payment Required` HTTP status code and
a lightning invoice ([BOLT11](https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md)).
If so it pays the invoice through the connected [lnd node](https://github.com/lightningnetwork/lnd/) and performs
a second request with the proof of payment.
### How does the server side look like?
Have a look at the [rack middleware rack-lightning for ruby](https://github.com/bumi/rack-lightning)
or at [@philippgille's middleware for Go](https://github.com/philippgille/ln-paywall).
## Requirements
The middleware uses the gRPC service provided by the [Lightning Network Daemon(lnd)](https://github.com/lightningnetwork/lnd/).
A running node with funded channels is required. Details about lnd can be found on their [github page](https://github.com/lightningnetwork/lnd/)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'faraday_ln_paywall'
```
## Usage
Simply use the `FaradayLnPaywall::Middleware` in your Faraday connection:
```ruby
conn = Faraday.new(:url => 'https://api.lightning.ws') do |faraday|
faraday.use FaradayLnPaywall::Middleware, { max_amount: 100 }
faraday.adapter Faraday.default_adapter
end
puts conn.get("/translate?text=Danke&to=en").body
```
## Configuration
The middleware accepts the following configuration options:
* `max_amount`: the maximum amount of an invoice that will automatically be paid. Raises a `FaradayLnPaywall::PaymentError` if the server request a higher amount
* `address`: the address of the lnd gRPC service( default: `localhost:10009`)
* `credentials_path`: path to the tls.cert (default: `~/.lnd/tls.cert`)
* `macaroon_path`: path to the macaroon path (default: `~/.lnd/data/chain/bitcoin/testnet/admin.macaroon`)
* `credentials`: instead of configuring a `credentials_path` you can pass the content of the tls.cert directly
* `macaroon`: instead of configuring a `macaroon_path` you can pass the hex content of the macaroon directly
you can get the macaroon content like this:
`xxd -p -c2000 admin.macaroon` or:
```ruby
::File.read(::File.expand_path("/path/to/admin.macaroon")).each_byte.map { |b| b.to_s(16).rjust(2,'0') }.join
```
## What is the Lightning Network?
The [Lightning Network](https://en.wikipedia.org/wiki/Lightning_Network) allows to send real near-instant microtransactions with extremely low fees.
It is a second layer on top of the Bitcoin network (and other crypto currencies).
Thanks to this properties it can be used to monetize APIs.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/bumi/faraday_ln_paywall.
## ToDo
- [ ] tests!!
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).