Merge pull request #134 from LightningDotSpace/develop

Release: develop -> main

Author: TaprootFreak

.env.example

@@ -1,14 +1,19 @@
-PORT=
-ENVIRONMENT=
-SQL_HOST=
-SQL_PORT=
-SQL_USERNAME=
-SQL_PASSWORD=
-SQL_DB=
-SQL_SYNCHRONIZE=
-SQL_MIGRATE=
+# --- Local Development (Docker MSSQL) ---
+# Copy this file to .env and fill in the values
+# Start MSSQL: docker compose up -d
+# Create DB once: docker exec lds-mssql /opt/mssql-tools18/bin/sqlcmd -S localhost -U sa -P "YourStrong!Passw0rd" -C -Q "CREATE DATABASE LightningSpace"
+# For local dev, only the settings below are required:
+ENVIRONMENT=loc
+PORT=3000
+SQL_HOST=localhost
+SQL_PORT=1433
+SQL_USERNAME=sa
+SQL_PASSWORD=YourStrong!Passw0rd
+SQL_DB=LightningSpace
+SQL_SYNCHRONIZE=true
+SQL_MIGRATE=false
 JWT_SECRET=
-DISABLED_PROCESSES=
+DISABLED_PROCESSES=*
 
 # Debug endpoint (scripts/db-debug.sh, scripts/log-debug.sh)
 DEBUG_ADDRESS=

.gitignore

@@ -41,4 +41,10 @@ placeholder.env
 placeholder.env
 
 # Custom
-thunder-tests/env
+thunder-tests/env
+
+# Local SQLite databases
+testDB/
+*.db
+*.sqlite
+*.sqlite3

docker-compose.yml

@@ -0,0 +1,21 @@
+services:
+  mssql:
+    image: mcr.microsoft.com/mssql/server:2022-latest
+    container_name: lds-mssql
+    environment:
+      ACCEPT_EULA: 'Y'
+      MSSQL_SA_PASSWORD: 'YourStrong!Passw0rd'
+      MSSQL_PID: Developer
+    ports:
+      - '1433:1433'
+    volumes:
+      - mssql-data:/var/opt/mssql
+    healthcheck:
+      test: /opt/mssql-tools18/bin/sqlcmd -S localhost -U sa -P "YourStrong!Passw0rd" -C -Q "SELECT 1" -b -o /dev/null
+      interval: 10s
+      timeout: 3s
+      retries: 10
+      start_period: 10s
+
+volumes:
+  mssql-data:

src/config/config.ts

@@ -34,7 +34,7 @@ export class Configuration {
   database: TypeOrmModuleOptions = {
     type: 'mssql',
     host: process.env.SQL_HOST,
-    port: Number.parseInt(process.env.SQL_PORT ?? '3000'),
+    port: Number.parseInt(process.env.SQL_PORT ?? '1433'),
     username: process.env.SQL_USERNAME,
     password: process.env.SQL_PASSWORD,
     database: process.env.SQL_DB,
@@ -46,6 +46,7 @@ export class Configuration {
     connectionTimeout: 30000,
     requestTimeout: 30000,
     logging: false,
+    options: { trustServerCertificate: this.environment === Environment.LOC },
   };
 
   auth = {

src/integration/blockchain/citrea/citrea-client.ts

@@ -1,4 +1,4 @@
-import { GetConfig } from 'src/config/config';
+import { Environment, GetConfig } from 'src/config/config';
 import { EvmUtil } from 'src/subdomains/evm/evm.util';
 import { LightningHelper } from '../lightning/lightning-helper';
 import { EvmClient, EvmClientParams } from '../shared/evm/evm-client';
@@ -9,7 +9,11 @@ export class CitreaClient extends EvmClient {
   constructor(params: EvmClientParams) {
     super(params);
 
-    this.walletAddress = EvmUtil.createWallet({ seed: GetConfig().evm.walletSeed, index: 0 }).address;
+    const config = GetConfig();
+    this.walletAddress =
+      config.environment === Environment.LOC
+        ? ''
+        : EvmUtil.createWallet({ seed: config.evm.walletSeed, index: 0 }).address;
   }
 
   async getNativeCoinBalance(): Promise<number> {

src/integration/blockchain/lightning/services/lightning-ws.service.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
-import { Observable, map } from 'rxjs';
-import { Configuration, GetConfig } from 'src/config/config';
+import { EMPTY, Observable, map } from 'rxjs';
+import { Configuration, Environment, GetConfig } from 'src/config/config';
 import { LightningLogger } from 'src/shared/services/lightning-logger';
 import { LndOnchainTransactionDto, LndTransactionDto } from '../dto/lnd.dto';
 import { LightningWebSocketClient } from '../lightning-ws-client';
@@ -19,6 +19,15 @@ export class LightningWebSocketService {
 
   constructor() {
     const config = GetConfig();
+
+    if (config.environment === Environment.LOC) {
+      this.logger.info('Local environment detected, skipping WebSocket connections');
+      this.onChainTransactions = EMPTY;
+      this.invoiceTransactions = EMPTY;
+      this.paymentTransactions = EMPTY;
+      return;
+    }
+
     this.setupOnchainWebSocketClient(config);
     this.setupInvoiceWebSocketClient(config);
     this.setupPaymentWebSocketClient(config);

src/subdomains/alchemy/services/alchemy-webhook.service.ts

@@ -1,7 +1,7 @@
 import { Injectable, NotFoundException, OnModuleInit } from '@nestjs/common';
 import { AddressActivityWebhook, Alchemy, Network, Webhook, WebhookType } from 'alchemy-sdk';
 import { Observable, Subject, filter } from 'rxjs';
-import { Config, GetConfig } from 'src/config/config';
+import { Config, Environment, GetConfig } from 'src/config/config';
 import { Blockchain } from 'src/shared/enums/blockchain.enum';
 import { Util } from 'src/shared/utils/util';
 import { AlchemyNetworkMapper } from '../alchemy-network-mapper';
@@ -31,6 +31,8 @@ export class AlchemyWebhookService implements OnModuleInit {
   }
 
   async onModuleInit() {
+    if (GetConfig().environment === Environment.LOC) return;
+
     const allWebhooks = await this.getAllWebhooks();
     allWebhooks.forEach((w) => this.webhookCache.set(w.id, w.signingKey));
   }

src/subdomains/evm/payment/strategies/common/evm-payment.strategy.ts

@@ -1,4 +1,5 @@
 import { Inject, NotFoundException, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
+import { Environment, GetConfig } from 'src/config/config';
 import { LightningLogger } from 'src/shared/services/lightning-logger';
 import { QueueHandler } from 'src/shared/utils/queue-handler';
 import { Util } from 'src/shared/utils/util';
@@ -27,6 +28,8 @@ export abstract class EvmPaymentStrategy extends RegisterStrategy implements OnM
 
     this.addressWebhookMessageQueue = new QueueHandler();
 
+    if (GetConfig().environment === Environment.LOC) return;
+
     const network = AlchemyNetworkMapper.toAlchemyNetworkByBlockchain(this.blockchain);
     if (!network) throw new Error(`Cannot detect network by blockchain ${this.blockchain}`);