From fa71bad81357e66af2fe7f736e81b563dc4e08b4 Mon Sep 17 00:00:00 2001 From: Pavol Rusnak Date: Wed, 13 Jul 2022 16:53:14 +0200 Subject: [PATCH] Use LndHub and LNDHub.go consistently There are various spelling of LndHub used accross the documentation. Let's use LndHub for the original version and LNDHub.go for the rewrite. --- README.md | 2 +- docs/docs.go | 2 +- docs/swagger.json | 2 +- docs/swagger.yaml | 2 +- lib/service/invoicesubscription.go | 2 +- main.go | 2 +- notes.md | 8 ++++---- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e020497a..f4ae65b6 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/docs.go b/docs/docs.go index d80f0741..3cd97e7f 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -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, diff --git a/docs/swagger.json b/docs/swagger.json index 56b29d27..b3a9a1c7 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -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", diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 3654f751..e0012fbc 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -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: diff --git a/lib/service/invoicesubscription.go b/lib/service/invoicesubscription.go index 6a2ccfca..a2019c75 100644 --- a/lib/service/invoicesubscription.go +++ b/lib/service/invoicesubscription.go @@ -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 { diff --git a/main.go b/main.go index ac125bef..935a0eb5 100644 --- a/main.go +++ b/main.go @@ -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. diff --git a/notes.md b/notes.md index b11a5274..f5abf5e9 100644 --- a/notes.md +++ b/notes.md @@ -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: @@ -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 @@ -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