Lightning Accounts

Nodejs server that allows users to register and deposit/withdraw satoshis using the Bitcoin Lightning Network.

Quick Start

Install the dependencies:

yarn

Set the environment variables:

cp .env.example .env

# open .env and modify the environment variables (if needed)

Table of Contents

• Commands
• Environment Variables
• Project Structure
• API Documentation
• Error Handling
• Validation
• Authentication
• Authorization
• Logging
• Linting
• Stack
• Contributing

Commands

Running locally:

yarn start

Database:

# push changes to db
yarn db:push

# start prisma studio
yarn db:studio

Linting:

# run ESLint
yarn lint

# fix ESLint errors
yarn lint:fix

# run prettier
yarn prettier

# fix prettier errors
yarn prettier:fix

Environment Variables

The environment variables can be found and modified in the .env file. They come with these default values:

NODE_PORT=3000
NODE_ORIGIN="*"
NODE_DOMAIN=
NODE_DEBUG_LEVEL=info

# Postgres URL
DATABASE_URL="postgresql://postgres:secret@localhost:5432/mydb?schema=public"

# JWT
# JWT secret key
JWT_SECRET=thisisasamplesecret

JWT_BASE64_PUBLIC_KEY="base64 encoded public key"
JWT_BASE64_PRIVATE_KEY="base64 encoded private key"

# Number of minutes after which an access token expires
JWT_ACCESS_EXPIRATION_MINUTES=30
# Number of days after which a refresh token expires
JWT_REFRESH_EXPIRATION_DAYS=30
# Number of minutes after which a reset password token expires
JWT_RESET_PASSWORD_EXPIRATION_MINUTES=10
# Number of minutes after which a verify email token expires
JWT_VERIFY_EMAIL_EXPIRATION_MINUTES=10

# SMTP configuration options for the email service
# For testing, you can use a fake SMTP service like Ethereal: https://ethereal.email/create
SMTP_HOST=email-server
SMTP_PORT=587
SMTP_USERNAME=email-server-username
SMTP_PASSWORD=email-server-password
[email protected]

# LND Lightning daemon configuration
# For testing, you can use a lightning simulator like Polar: https://lightningpolar.com/
LND_CERT="base 64 encoded tls.cert"
LND_ADMIN_MACAROON="base 64 encoded admin.macaroon"
LND_SOCKET="127.0.0.1:10001"

Project Structure

src\
 |--config\         # Environment variables and configuration related things
 |--controllers\    # Route controllers (controller layer)
 |--docs\           # Swagger files
 |--middlewares\    # Custom express middlewares
 |--models\         # Mongoose models (data layer)
 |--routes\         # Routes
 |--services\       # Business logic (service layer)
 |--utils\          # Utility classes and functions
 |--validations\    # Request data validation schemas
 |--app.js          # Express app
 |--index.js        # App entry point

API Documentation

To view the list of available APIs and their specifications, run the server and go to http://localhost:3000/v1/docs in your browser. This documentation page is automatically generated using the swagger definitions written as comments in the route files.

API Endpoints

List of available routes:

Auth routes:
POST /v1/auth/register - register
POST /v1/auth/login - login
POST /v1/auth/me - profile
POST /v1/auth/refresh-tokens - refresh auth tokens
POST /v1/auth/forgot-password - send reset password email
POST /v1/auth/reset-password - reset password
POST /v1/auth/send-verification-email - send verification email
POST /v1/auth/verify-email - verify email

User routes:
POST /v1/users - create a user
GET /v1/users - get all users
GET /v1/users/:userId - get user
PATCH /v1/users/:userId - update user
DELETE /v1/users/:userId - delete user

Error Handling

The app has a centralized error handling mechanism.

Controllers should try to catch the errors and forward them to the error handling middleware (by calling next(error)). For convenience, you can also wrap the controller inside the catchAsync utility wrapper, which forwards the error.

const catchAsync = require("../utils/catchAsync")

const controller = catchAsync(async (req, res) => {
  // this error will be forwarded to the error handling middleware
  throw new Error("Something wrong happened")
})

The error handling middleware sends an error response, which has the following format:

{
  "code": 404,
  "message": "Not found"
}

When running in development mode, the error response also contains the error stack.

The app has a utility ApiError class to which you can attach a response code and a message, and then throw it from anywhere (catchAsync will catch it).

For example, if you are trying to get a user from the DB who is not found, and you want to send a 404 error, the code should look something like:

const httpStatus = require("http-status")
const ApiError = require("../utils/ApiError")
const User = require("../models/User")

const getUser = async (userId) => {
  const user = await User.findById(userId)
  if (!user) {
    throw new ApiError(httpStatus.NOT_FOUND, "User not found")
  }
}

Validation

Request data is validated using Joi. Check the documentation for more details on how to write Joi validation schemas.

The validation schemas are defined in the src/validations directory and are used in the routes by providing them as parameters to the validate middleware.

const express = require("express")
const validate = require("../../middlewares/validate")
const userValidation = require("../../validations/user.validation")
const userController = require("../../controllers/user.controller")

const router = express.Router()

router.post("/users", validate(userValidation.createUser), userController.createUser)

Authentication

To require authentication for certain routes, you can use the auth middleware.

const express = require("express")
const auth = require("../../middlewares/auth")
const userController = require("../../controllers/user.controller")

const router = express.Router()

router.post("/users", auth(), userController.createUser)

These routes require a valid JWT access token in the Authorization request header using the Bearer schema. If the request does not contain a valid access token, an Unauthorized (401) error is thrown.

Generating Access Tokens:

An access token can be generated by making a successful call to the register (POST /v1/auth/register) or login (POST /v1/auth/login) endpoints. The response of these endpoints also contains refresh tokens (explained below).

An access token is valid for 30 minutes. You can modify this expiration time by changing the JWT_ACCESS_EXPIRATION_MINUTES environment variable in the .env file.

Refreshing Access Tokens:

After the access token expires, a new access token can be generated, by making a call to the refresh token endpoint (POST /v1/auth/refresh-tokens) and sending along a valid refresh token in the request body. This call returns a new access token and a new refresh token.

A refresh token is valid for 30 days. You can modify this expiration time by changing the JWT_REFRESH_EXPIRATION_DAYS environment variable in the .env file.

Authorization

The auth middleware can also be used to require certain rights/permissions to access a route.

const express = require("express")
const auth = require("../../middlewares/auth")
const userController = require("../../controllers/user.controller")

const router = express.Router()

router.post("/users", auth("manageUsers"), userController.createUser)

In the example above, an authenticated user can access this route only if that user has the manageUsers permission.

The permissions are role-based. You can view the permissions/rights of each role in the src/config/roles.js file.

If the user making the request does not have the required permissions to access this route, a Forbidden (403) error is thrown.

Logging

Import the logger from src/config/logger.js. It is using the Winston logging library.

Set the NODE_DEBUG_LEVEL environment variable

Logging should be done according to the following severity levels (ascending order from most important to least important):

const logger = require("<path to src>/config/logger")

logger.error("message") // level 0
logger.warn("message") // level 1
logger.info("message") // level 2
logger.http("message") // level 3
logger.verbose("message") // level 4
logger.debug("message") // level 5

Note: API request information (request url, response code, timestamp, etc.) are also automatically logged (using morgan).

Donations

Donate Bitcoin at jfrader.com

Inspirations

Based off this boilerplate https://github.com/antonio-lazaro/prisma-express-typescript-boilerplate

License

MIT