ringtools/ringtools-server-ts
1
0
Fork 0
mirror of https://github.com/ringtools/ringtools-server-ts.git synced 2024-05-16 05:44:40 +02:00
Code Issues Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
Djuri Baars 2022-01-13 01:52:02 +01:00
commit bcc168d153
10 changed files with 3844 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.env.sample Normal file
View File

@ -0,0 +1,4 @@
PORT=8080
ALLOWED_HOSTS=['*']
MACAROON=ABC
LND_REST_API=localhost:8080

39
.eslintrc.json Normal file
View File

@ -0,0 +1,39 @@
{
"env": {
"browser": false,
"es2021": true
},
"extends": [
"plugin:@shopify/typescript",
"plugin:@shopify/typescript-type-checking",
"plugin:@shopify/node",
"plugin:@shopify/prettier"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 13,
"sourceType": "module",
"project": [
"./tsconfig.json"
]
},
"overrides": [
{
"files": [
"src/**/*.{ts,tsx}"
],
"extends": [
"plugin:@shopify/typescript-type-checking"
],
"parserOptions": {
"project": "./tsconfig.json"
},
"rules": {
"@typescript-eslint/no-unnecessary-condition": "off"
}
}
],
"plugins": [
"@typescript-eslint"
]
}

240
.gitignore vendored Normal file
View File

@ -0,0 +1,240 @@
# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,windows,linux,node,yarn
# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,macos,windows,linux,node,yarn
### Linux ###
*~
# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*
# KDE directory preferences
.directory
# Linux trash folder which might appear on any partition or disk
.Trash-*
# .nfs files are created when an open file is removed but is still being accessed
.nfs*
### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride
# Icon must end with two \r
Icon
# Thumbnails
._*
# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent
# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk
### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# Snowpack dependency directory (https://snowpack.dev/)
web_modules/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variables file
.env
.env.test
.env.production
# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache
# Next.js build output
.next
out
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
### Node Patch ###
# Serverless Webpack directories
.webpack/
# Optional stylelint cache
.stylelintcache
# SvelteKit build / generate output
.svelte-kit
### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace
# Local History for Visual Studio Code
.history/
### VisualStudioCode Patch ###
# Ignore all local history of files
.history
.ionide
# Support for Project snippet scope
!.vscode/*.code-snippets
### Windows ###
# Windows thumbnail cache files
Thumbs.db
Thumbs.db:encryptable
ehthumbs.db
ehthumbs_vista.db
# Dump file
*.stackdump
# Folder config file
[Dd]esktop.ini
# Recycle Bin used on file shares
$RECYCLE.BIN/
# Windows Installer files
*.cab
*.msi
*.msix
*.msm
*.msp
# Windows shortcuts
*.lnk
### yarn ###
# https://yarnpkg.com/advanced/qa#which-files-should-be-gitignored
.yarn/*
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
# if you are NOT using Zero-installs, then:
# comment the following lines
!.yarn/cache
# and uncomment the following lines
# .pnp.*
# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,windows,linux,node,yarn

7
.prettierrc Normal file
View File

@ -0,0 +1,7 @@
{
"arrowParens": "always",
"singleQuote": true,
"bracketSpacing": false,
"trailingComma": "all",
"quoteProps": "as-needed"
}

36
package.json Normal file
View File

@ -0,0 +1,36 @@
{
"name": "ringtools-server-ts",
"version": "1.0.0",
"main": "src/index.ts",
"license": "Apache-2.0",
"dependencies": {
"@fastify/ajv-compiler": "^3.0.0",
"@types/ws": "^8.2.2",
"ajv-formats": "^2.1.1",
"axios": "^0.24.0",
"dotenv": "^11.0.0",
"fastify": "^3.25.3",
"fastify-env": "^2.1.1",
"fastify-helmet": "^6.0.0",
"fastify-sensible": "^3.1.2",
"fastify-socket.io": "^3.0.0",
"rxjs": "^7.5.2",
"socket.io": "^4.4.1",
"typescript": "^4.5.4",
"ws": "^8.4.0"
},
"devDependencies": {
"@shopify/eslint-plugin": "^41.0.1",
"@types/node": "^17.0.8",
"@typescript-eslint/eslint-plugin": "^5.8.1",
"@typescript-eslint/parser": "^5.8.1",
"eslint": "^8.5.0",
"eslint-config-prettier": "^8.3.0",
"prettier": "^2.5.1",
"ts-node": "^10.4.0"
},
"scripts": {
"start": "ts-node src/index.ts",
"lint": "eslint . --ext .ts"
}
}

24
public/index.html Normal file
View File

@ -0,0 +1,24 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<h1>Look at the server log to see if the connection happened</h1>
</body>
<script src="/socket.io/socket.io.js"></script>
<script>
var channelSocket = io('/channel');
var nodeSocket = io('/node');
channelSocket.onAny((eventName) => {
console.log(eventName);
})
nodeSocket.onAny((eventName) => {
console.log(eventName);
})
</script>
</html>

194
src/index.ts Normal file
View File

@ -0,0 +1,194 @@
import dotenv from 'dotenv';
import fastify, {FastifyReply, FastifyRequest} from 'fastify';
import fastifyEnv from 'fastify-env';
import fastifySensible from 'fastify-sensible';
import socketioServer from 'fastify-socket.io';
import {Socket} from 'socket.io';
import {DefaultEventsMap} from 'socket.io/dist/typed-events';
import {LndService} from './lightning/lnd-service';
dotenv.config();
const lndService = new LndService(
process.env.LND_REST_API || 'localhost:8080',
process.env.MACAROON || '',
);
lndService.run();
const envSchema = {
type: 'object',
required: ['PORT'],
properties: {
PORT: {
type: 'string',
default: 3000,
},
},
};
const envOptions = {
dotenv: true,
schema: envSchema,
};
const server = fastify({
logger: true,
});
server.register(socketioServer);
// server.register(helmet, {enableCSPNonces: true});
server.register(fastifyEnv, envOptions);
server.register(fastifySensible);
server.get(
'/node/:pubKey',
{
schema: {
querystring: {
pubKey: {type: 'string'},
},
},
},
async (request: FastifyRequest<any>, reply: FastifyReply<any>) => {
if (request.params.pubKey.length !== 66) reply.notFound();
return lndService.getNode(request.params.pubKey);
},
);
server.get(
'/channel/:channelId',
{
schema: {
querystring: {
channelId: {type: 'integer'},
},
},
},
async (request: FastifyRequest<any>, reply: FastifyReply<any>) => {
return lndService.getChannel(request.params.channelId);
},
);
lndService.channelUpdateSubject.subscribe((data) => {
for (const channel of data) {
lndService
.getChannel(channel.chan_id)
.then((chanInfo) => {
server.io
.to([chanInfo.node1_pub, chanInfo.node2_pub, chanInfo.channel_id])
.emit('channel', chanInfo);
server.io.of('/channel').to(channel.chan_id).emit('channel', chanInfo);
server.io
.of('/node')
.to([chanInfo.node1_pub, chanInfo.node2_pub])
.emit('channel', chanInfo);
})
.catch(() => {});
}
});
lndService.nodeUpdateSubject.subscribe((data) => {
for (const node of data) {
lndService
.getNode(node.identity_key)
.then((nodeInfo) => {
server.io.to(nodeInfo.node.pub_key).emit('pubkey', nodeInfo);
server.io.of('/node').to(nodeInfo.node.pub_key).emit('node', nodeInfo);
})
.catch(() => {});
}
});
server.ready((err: Error) => {
if (err) throw err;
const nodeNamespace = server.io.of('/node');
const channelNamespace = server.io.of('/channel');
server.io.on(
'connection',
(socket: Socket<DefaultEventsMap, DefaultEventsMap>) => {
socket.on('subscribe_channel', (data) => {
for (const channelId of data.data) {
socket.join(channelId);
}
});
socket.on('subscribe_pubkey', (data) => {
for (const pubKey of data.data) {
socket.join(pubKey);
lndService
.getNode(pubKey)
.then((nodeInfo) => {
socket.emit('pubkey', nodeInfo);
})
.catch(() => {});
}
});
socket.on('unsubscribe_pubkey', (data) => {
for (const pubKey of data.data) {
socket.leave(pubKey);
}
});
socket.on('unsubscribe_all', (_data) => {
for (const room of socket.rooms) {
socket.leave(room);
}
});
},
);
channelNamespace.on(
'connection',
(socket: Socket<DefaultEventsMap, DefaultEventsMap>) => {
socket.on('subscribe', (data) => {
socket.join(data);
lndService
.getChannel(data)
.then((nodeInfo) => {
socket.emit('channel', nodeInfo);
})
.catch(() => {});
});
socket.on('unsubscribe_all', (_data) => {
for (const room of socket.rooms) {
socket.leave(room);
}
});
},
);
nodeNamespace.on(
'connection',
(socket: Socket<DefaultEventsMap, DefaultEventsMap>) => {
socket.on('subscribe', (data) => {
for (const pubKey of data) {
socket.join(pubKey);
lndService
.getNode(pubKey)
.then((nodeInfo) => {
socket.emit('node', nodeInfo);
})
.catch(() => {});
}
});
},
);
});
server.listen(process.env.PORT || 3000, (err, address) => {
if (err) {
console.error(err);
process.exit(1);
}
console.log(`Server listening at ${address}`);
});

87
src/lightning/lnd-service.ts Normal file
View File

@ -0,0 +1,87 @@
import * as https from 'https';
import axios from 'axios';
import {Subject} from 'rxjs';
import WebSocket from 'ws';
const httpsAgent = new https.Agent({
rejectUnauthorized: false,
});
axios.defaults.httpsAgent = httpsAgent;
interface GraphUpdateResult {
result: {
// eslint-disable-next-line @typescript-eslint/naming-convention
node_updates: [];
// eslint-disable-next-line @typescript-eslint/naming-convention
channel_updates: [];
// eslint-disable-next-line @typescript-eslint/naming-convention
closed_chans: [];
};
}
export class LndService {
ws: WebSocket;
channelUpdateSubject: Subject<any> = new Subject();
nodeUpdateSubject: Subject<any> = new Subject();
closedChannelSubject: Subject<any> = new Subject();
constructor(protected lndRestApiUrl: string, protected macaroon: string) {
this.ws = new WebSocket(
`wss://${this.lndRestApiUrl}/v1/graph/subscribe?method=GET`,
{
// Work-around for self-signed certificates.
rejectUnauthorized: false,
headers: {
'Grpc-Metadata-Macaroon': this.macaroon,
},
},
);
}
run() {
this.ws.on('open', () => {
this.ws.send('{}');
});
this.ws.on('error', (err: Error) => {
console.log(`Error: ${err}`);
});
this.ws.on('ping', (event: Buffer) => {});
this.ws.on('message', (event: WebSocket.RawData) => {
const data: GraphUpdateResult = JSON.parse(event.toString());
if (data.result.node_updates.length) {
this.nodeUpdateSubject.next(data.result.node_updates);
}
if (data.result.channel_updates.length) {
this.channelUpdateSubject.next(data.result.channel_updates);
}
if (data.result.closed_chans.length) {
this.closedChannelSubject.next(data.result.closed_chans);
}
});
}
async getNode(pubKey: string) {
return (
await this.doLndGet(`v1/graph/node/${pubKey}?include_channels=true`)
).data;
}
async getChannel(channelId: string) {
return (await this.doLndGet(`v1/graph/edge/${channelId}`)).data;
}
private doLndGet(endPoint: string) {
return axios.get(`https://${this.lndRestApiUrl}/${endPoint}`, {
responseType: 'json',
headers: {
'Grpc-Metadata-Macaroon': this.macaroon,
},
});
}
}

101
tsconfig.json Normal file
View File

@ -0,0 +1,101 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */
/* Projects */
// "incremental": true, /* Enable incremental compilation */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "resolveJsonModule": true, /* Enable importing .json files */
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
"sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}

3112
yarn.lock Normal file
View File

File diff suppressed because it is too large Load Diff