Upgrade and refactor (v4.0.0)

.gitignore

@@ -1,6 +1,12 @@
-node_modules
+node_modules/
+
 config.test.jsonc
 config.json
 config.jsonc
-logs
-.vscode
+
+logs/
+
+.vscode/
+.idea/
+
+.DS_Store

.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run --prefix ./web lint && npm run --prefix ./server lint
+npm run lint

README.md

@@ -36,80 +36,108 @@
 
 Clone the repository with pool into a newly created directory:
 
-```
+```bash
 git clone https://github.com/Adamant-im/pool
 ```
 
 Move to directory with the cloned repository:
 
-```
+```bash
 cd pool
 ```
 
 Install dependencies using npm or any other package manager:
 
-```
+```bash
 npm install
 ```
 
 Build a website:
 
-```
+```bash
 npm run build:web
 ```
 
 ### Pre-launch tuning
 
 Copy default config as `config.jsonc`:
 
-```
+```bash
 cp config.default.jsonc config.jsonc
 ```
 
 And edit that file by inserting the pool's secret phrase as the minimum configuration, e.g. using `nano`:
 
-```
+```bash
 nano config.jsonc
 ```
 
 > See comments in `config.default.jsonc` for more parameters.
 
-### Migration from v2
+### Migration from v2 to v3
 
 To migrate a database from v2 run the migration script with the specified path to the target pool or database:
 
-```sh
+```bash
 # or ~/adamant-pool/db
 $ node scripts/migrate.mjs ~/adamant-pool
 ```
 
 In order for the changes to take effect, you will need to restart your pool.
 
+### Migration from v3 to v4
+
+To migrate a database from v3 prepare the migration script:
+
+```bash
+$ cd scripts/migrate-lowdb-mongodb
+$ npm i
+```
+
+Configure MongoDB connection string and LowDB storage path with environment variables and run the migration script, e.g.:
+
+```bash
+$ MONGODB_URI=mongodb://localhost:27017 LOWDB_STORAGE_PATH=../../server/db node index.js
+```
+
+Specify MongoDB connection parameters at your config file:
+
+```jsonc
+  ...,
+  /** MongoDB connection parameters **/
+  "mongodb": {
+    "uri": "mongodb://localhost:27017",
+    "dbName": "adamant-pool"
+  }
+```
+
+In order for the changes to take effect, you will need to restart your pool.
+
 ## Launching
 
 You can start the pool using `npm` command:
 
-```
+```bash
 npm run start
 ```
 
 but we recommend to use a process manager to start the pool, f.e. [`pm2`](https://pm2.keymetrics.io/):
 
-```
+```bash
 pm2 start ./scripts/start.sh --name "adamantpool"
 ```
 
 ## Add pool to cron
 
 Edit crontab file using the command below:
 
-```
+```bash
 crontab -e
 ```
 
 and paste the string:
 
-```
+```bash
 @reboot cd /home/adamant/pool && pm2 start /home/adamant/pool/scripts/start.sh --name "adamantpool"
 ```
 

config.default.jsonc

@@ -40,7 +40,7 @@
   **/
   "maintenancewallet": "",
 
-  /** 
+  /**
     How often the pool will do payouts. All at 00:00.
     1d -> every day
     5d -> days 1, 5, 10, 15, 20, 25 of the month
@@ -74,5 +74,17 @@
   "log_level": "log",
 
   /** Port for pool's public Web panel **/
-  "port": 36667
+  "port": 36667,
+
+  /** Express server CORS configuration **/
+  "cors": {
+    "origin": "*",
+    "credentials": true
+  },
+
+  /** MongoDB connection parameters **/
+  "mongodb": {
+    "uri": "mongodb://localhost:27017",
+    "dbName": "adamant-pool"
+  }
 }