Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: add initial documentation on dunder's API endpoints #16

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Docs: add initial documentation on dunder's API endpoints #16

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fbcc17e
Docs: Readability.
sesam Feb 28, 2021
4d5216e
Docs: initial documentation of dunder's API endpoints
sesam Feb 28, 2021
2a479a0
Corrections.
sesam Apr 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,28 @@ on-chain fee.

More on how this works [here](https://github.com/hsjoberg/blixt-wallet/issues/242).

## Dunder's API

The API endpoints supplied by dunder LSP are:
sesam marked this conversation as resolved.
Show resolved Hide resolved

- /estimateFee - returns estimated fee (sats) and fee rate (sats per byte)

- /getInfo - returns info from lnd - for details, see https://github.com/LN-Zap/node-lnd-grpc/blob/master/proto/0.12.0-beta/lnrpc/rpc.proto#L1567
sesam marked this conversation as resolved.
Show resolved Hide resolved

- /ondemand-channel
- /check-status - checks validity and sats claimable.
- /claim - asks dunder to push the clamiable amount (minus fees) into a new channel.
- /register - registers a blixt wallet with dunder. Necessary to use claim below.
sesam marked this conversation as resolved.
Show resolved Hide resolved
- /service-status - returns status (boolean), minimum and maximum payment accepted, current fee estimate, and peer.

## Build

Dunder require lnd as the Lightning backend right now, though the plan is to
Dunder requires lnd as the Lightning backend right now, though the plan is to
make the service implementation independent.

The `master` branch always expects the latest version of lnd. Lnd compiled with routerrpc is required.
The `master` branch always expects the latest version of lnd, which must be compiled with routerrpc enabled.

1. Run lnd, wallet must be unlocked for Dunder to operate correctly
1. Run lnd. The wallet must be unlocked for Dunder to operate correctly.
sesam marked this conversation as resolved.
Show resolved Hide resolved
2. `git clone https://github.com/hsjoberg/dunder-lsp && cd dunder-lsp`
3. Copy `config/default.json_TEMPLATE` to `config/default.json` and set up your configuration
4. `yarn`
Expand Down