Skip to content

Commit

Permalink
Use LndHub and LNDHub.go consistently
Browse files Browse the repository at this point in the history
There are various spelling of LndHub used accross the documentation.
Let's use LndHub for the original version and LNDHub.go for the rewrite.
  • Loading branch information
prusnak committed Jul 14, 2022
1 parent 8959601 commit fa71bad
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Alternatively you can also use the [Alby simnetwork](https://github.com/getAlby/

## Database

LndHub.go requires a PostgreSQL database backend.
LNDHub.go requires a PostgreSQL database backend.

## Prometheus

Expand Down
2 changes: 1 addition & 1 deletion docs/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -720,7 +720,7 @@ var SwaggerInfo = &swag.Spec{
Host: "",
BasePath: "/",
Schemes: []string{"https", "http"},
Title: "LNDhub.go",
Title: "LNDHub.go",
Description: "Accounting wrapper for the Lightning Network providing separate accounts for end-users.",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
Expand Down
2 changes: 1 addition & 1 deletion docs/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"swagger": "2.0",
"info": {
"description": "Accounting wrapper for the Lightning Network providing separate accounts for end-users.",
"title": "LNDhub.go",
"title": "LNDHub.go",
"contact": {
"name": "Alby",
"url": "https://getalby.com",
Expand Down
2 changes: 1 addition & 1 deletion docs/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ info:
license:
name: GNU GPL
url: https://www.gnu.org/licenses/gpl-3.0.en.html
title: LNDhub.go
title: LNDHub.go
version: 0.6.1
paths:
/auth:
Expand Down
2 changes: 1 addition & 1 deletion lib/service/invoicesubscription.go
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ func (svc *LndhubService) createKeysendInvoice(ctx context.Context, rawInvoice *
}
userLoginCustomRecord := rawInvoice.Htlcs[0].CustomRecords[TLV_WALLET_ID]
//Find user. Our convention here is that the TLV
//record should contain the user's LNDhub login string
//record should contain the user's login string
//(LND already returns the decoded string so there is no need to hex-decode it)
user, err := svc.FindUserByLogin(ctx, string(userLoginCustomRecord))
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var indexHtml string
//go:embed static/*
var staticContent embed.FS

// @title LNDhub.go
// @title LNDHub.go
// @version 0.6.1
// @description Accounting wrapper for the Lightning Network providing separate accounts for end-users.

Expand Down
8 changes: 4 additions & 4 deletions notes.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Rebuilding LndHub

Goal of this project is to build a simple accounting system with a [LNDHub](https://github.com/BlueWallet/LndHub) compatible API that focusses on simplicity, maintainability and ease of deployment.
Goal of this project is to build a simple accounting system with a [LndHub](https://github.com/BlueWallet/LndHub) compatible API that focusses on simplicity, maintainability and ease of deployment.

[LNDHub](https://github.com/BlueWallet/LndHub) is a simple accounting system for LND. It allows users to send and receive lightning payments. Through the API people can access funds through a shared lightning node. (see overview.png diagram)
[LndHub](https://github.com/BlueWallet/LndHub) is a simple accounting system for LND. It allows users to send and receive lightning payments. Through the API people can access funds through a shared lightning node. (see overview.png diagram)

Some design goals:

Expand All @@ -17,7 +17,7 @@ Some design goals:

### API endpoints

See [LNDHub API](https://github.com/BlueWallet/LndHub/blob/master/controllers/api.js) for enpoints and request/response signatures.
See [LndHub API](https://github.com/BlueWallet/LndHub/blob/master/controllers/api.js) for enpoints and request/response signatures.

#### /create
Create a new user account
Expand Down Expand Up @@ -59,4 +59,4 @@ Node information

### Links

* [LNDHub](https://github.com/BlueWallet/LndHub) - Current nodejs implementation
* [LndHub](https://github.com/BlueWallet/LndHub) - Current nodejs implementation

0 comments on commit fa71bad

Please sign in to comment.