aljaz/aperture
1
1
Fork 0
mirror of https://github.com/lightninglabs/aperture.git synced 2026-01-31 15:14:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

#55 Removing demo section in README.md

Browse Source
This commit is contained in:
hieblmi
2022-04-21 01:46:07 +02:00
parent fb4b59400e
commit 090e6bc533
1 changed files with 0 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -50,51 +50,4 @@ services and APIs.
* Start aperture without any command line parameters (`./aperture`), all configuration
is done in the `~/.aperture/aperture.yaml` file.
## Demo
There is a demo installation available at
[test.swap.lightning.today:11010](https://test.swap.lightning.today:11010/).
### Use Case 1: Web GUI
If you visit the demo installation in the browser, you see a simple web GUI.
There you can request the current BOS scores for testnet. Notice that you can
only request the scores three times per IP addres. After the free requests have
been used up, you receive an LSAT token/macaroon and are challenged to pay an
invoice to authorize it.
You have two options to pay for the invoice:
1. If you have Joule installed in your browser and connected to a testnet node,
you can click the "Pay invoice with Joule" button to pay the invoice. After
successful payment the page should automatically refresh.
1. In case you want to pay the invoice manually, copy the payment request to
your wallet of choice that has the feature to reveal the preimage after a
successful payment. Copy the payment preimage in hex format, then click the
button "Paste preimage of manual payment" and paste it in the dialog box.
### Use Case 2: cURL
First, let's request the BOS scores until we hit the freebie limit:
`curl -k -v https://test.swap.lightning.today:11010/availability/v1/btc.json`
At some point, we will get an answer 402 with an authorization header:
```
www-authenticate: LSAT macaroon="...", invoice="lntb10n1..."
```
We will need both these values, the `macaroon` and the `invoice` so copy them
to a text file somewhere (without the single quotes!).
Let's pay the invoice now, choose any LN wallet that displays the preimage after
a successful payment. Copy the hex encoded preimage to the text file too once
you get it from the wallet.
Finally, you can issue the authenticated request with the following command:
```
curl -k -v \
--header "Authorization: LSAT <macaroon>:<preimage>" \
https://test.swap.lightning.today:11010/availability/v1/btc.json
```