feat: add TypeScript types for whole app (components, functions, etc)

- Update eslint
- Add husky

Author: Muhamed-Ragab

.github/workflows/build_and_release.yml

@@ -12,25 +12,24 @@ jobs:
     permissions:
       contents: write
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4.2.2
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v3.10.0
-    - name: Get version
-      id: get_version
-      run: |
-        echo "VERSION=$(jq -r '.version' package.json)" >> $GITHUB_ENV
-    - name: Build Linux
-      run: DOCKER_BUILDKIT=1 docker build . -f dockerfiles/linux.dockerfile --output build
-    - name: Build Windows
-      run: DOCKER_BUILDKIT=1 docker build . -f dockerfiles/win.dockerfile --output build
-    - name: Release
-      uses: softprops/action-gh-release@v2.2.1
-      with:
-        tag_name: ${{ env.VERSION }}
-        generate_release_notes: true
-        files: |
-          ./build/wartlock.AppImage
-          ./build/wartlock.exe
-          ./build/win-portable.zip
-          
+      - name: Checkout code
+        uses: actions/checkout@v4.2.2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3.10.0
+      - name: Get version
+        id: get_version
+        run: |
+          echo "VERSION=$(jq -r '.version' package.json)" >> $GITHUB_ENV
+      - name: Build Linux
+        run: DOCKER_BUILDKIT=1 docker build . -f dockerfiles/linux.dockerfile --output build
+      - name: Build Windows
+        run: DOCKER_BUILDKIT=1 docker build . -f dockerfiles/win.dockerfile --output build
+      - name: Release
+        uses: softprops/action-gh-release@v2.2.1
+        with:
+          tag_name: ${{ env.VERSION }}
+          generate_release_notes: true
+          files: |
+            ./build/wartlock.AppImage
+            ./build/wartlock.exe
+            ./build/win-portable.zip

.gitignore

@@ -3,11 +3,14 @@ dist
 out
 .DS_Store
 .eslintcache
-pacakge-lock.json
 *.log*
 .vscode
 *.bak
 *.db
 *.original
 .idea
+
+# Lock files
+package-lock.json
 pnpm-lock.yaml
+bun.lock

.husky/pre-commit

@@ -0,0 +1,2 @@
+bun lint-staged
+bun run build

README.md

@@ -1,76 +1,96 @@
 # <img src="resources/wartlock_logo.png" width="30" height="30"> Wartlock
+
 Wartlock is a user-friendly and secure cryptocurrency wallet designed specifically for the WART blockchain. It provides a graphical interface for managing WART assets, sending and receiving transactions, and ensuring private key security.
 
 > Beta Notice: Wartlock is currently in its beta phase. Some security features are still in development, and the wallet is not yet fully audited. Use it at your own risk.
 
 > **Warning: Light mode is currently non-functional. Please avoid using it until the next update, which will include fixes.**
 
 ## Features
+
 - User-Friendly Interface – Simple and intuitive design for easy navigation.
 - Secure Key Management – Your private keys remain under your control.
 - Send & Receive WART – Easily manage your transactions with a seamless experience.
 - Lightweight & Fast – Optimized for performance without compromising security.
 - Cross Platform - Wartlock is supported for (Windows, Linux and MacOS)
 
 ## Installation & Setup
+
 ### Build from source
+
 > Choose the command for your system to build, then run the setup
+
 ```
 bun i
 bun run build:win
 bun run build:linux
 bun run build:mac
 ```
+
 OR
 
 > Wartlock is in beta. Avoid using it with large amounts of WART until a full security audit is completed.
+
 1. Download the latest release from [Releases](https://github.com/riven-labs/Wartlock/releases).
 2. Install & Run
 3. Create or Import Wallet
 
 ## Import from other wallets
+
 If you were already using [andrewcrypto777/wart-wallet](https://github.com/andrewcrypto777/wart-wallet) you can import your wallet by your mnemonic using the **Recover Wallet** option, **Yet it's also still possible to import your wallets by copying `wartlock.db` into Wartlock directory**, Wartlock do have an almost identical database integrations to andrew's wallet and we do have migrations in place to make `wartwallet.db` work for wartlock.
 
 > Note: **Copying the database would leave all your wallets without names, if you want to name your wallet you must edit `wartwallet.db` manually using something like DB SQLite browser**
 
 ## Docker build
+
 ### Build Linux:
+
 ```
 DOCKER_BUILDKIT=1 docker build . -f dockerfiles/linux.dockerfile --output build
 ```
+
 ### Build Windows:
+
 ```
 DOCKER_BUILDKIT=1 docker build . -f dockerfiles/win.dockerfile --output build
 ```
 
 ## Contributing
+
 We welcome feedback and contributions! If you find bugs or have feature suggestions, open an issue or submit a pull request
 
 ## Developer fees (Optional)
+
 To keep Wartlock growing and improving, we’ve included an optional 5% developer fee on wallet transactions. This small contribution helps **fund ongoing development, security enhancements, and new features.**
 
 When sending a transaction, the developer fee is automatically calculated—but you’re in full control! **You can adjust it to any amount, even zero, or increase it if you’d like to give back more.**
 
 Every contribution, big or small, helps make Wartlock even better. Thank you for your support! ❤️
+
 > Developer donations don’t include network fees—your full contribution goes to Wartlock. The transaction is optimized for low network fees, but since it’s sent from your wallet, the fee will be deducted from your balance separately.
 
 ## Support Wartlock
 
 Wartlock is an open-source project, and community support helps drive its development. If you find value in Wartlock and would like to contribute, consider donating or mining to support ongoing improvements.
 
 ## Donate WART
+
 Send WART to the developer address:
+
 ```
 aca4916c89b8fb47784d37ad592d378897f616569d3ee0d4
 ```
 
 ## Mine to Support Wartlock
+
 You can also support Wartlock by mining on the developer address using **BZMiner**:
+
 ```bash
 bzminer -a warthog -p stratum+tcp://de.warthog.herominers.com:1143 -w aca4916c89b8fb47784d37ad592d378897f616569d3ee0d4.donation --nc 1
 ```
 
 Or janusminer ( Make sure to replace `YOUR_NODE_IP` and `YOUR_NODE_PORT` with your node information )
+
 ```bash
 janusminer -a aca4916c89b8fb47784d37ad592d378897f616569d3ee0d4 -h YOUR_NODE_IP -p YOUR_NODE_PORT
 ```

eslint.config.mjs

@@ -20,10 +20,12 @@ export default tseslint.config(
     files: ['**/*.{ts,tsx}'],
     plugins: {
       'react-hooks': eslintPluginReactHooks,
+      'react-refresh': eslintPluginReactRefresh,
     },
     rules: {
       ...eslintPluginReactHooks.configs.recommended.rules,
       ...eslintPluginReactRefresh.configs.vite.rules,
+      'react-refresh/only-export-components': 'off',
     },
   },
   eslintConfigPrettier,

package.json

@@ -20,7 +20,8 @@
     "build:unpack": "npm run build && electron-builder --dir",
     "build:win": "npm run build && electron-builder --win",
     "build:mac": "electron-vite build && electron-builder --mac",
-    "build:linux": "electron-vite build && electron-builder --linux"
+    "build:linux": "electron-vite build && electron-builder --linux",
+    "prepare": "husky"
   },
   "dependencies": {
     "@electron-toolkit/preload": "^3.0.1",
@@ -59,13 +60,15 @@
     "@types/react-dom": "^18.3.5",
     "@vitejs/plugin-react": "^4.3.4",
     "autoprefixer": "^10.4.21",
+    "electron": "^35.0.3",
     "electron-builder": "^25.1.8",
     "electron-vite": "^3.0.0",
-    "electron": "^35.0.3",
     "eslint": "^9.22.0",
     "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.19",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.5.0",
     "postcss": "^8.5.3",
     "prettier": "^3.5.3",
     "prettier-plugin-organize-imports": "^4.1.0",
@@ -83,5 +86,14 @@
     ],
     "singleQuote": true,
     "semi": false
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{json,yml,yaml,md}": [
+      "prettier --write"
+    ]
   }
 }

src/main/backend/crypto.ts

@@ -1,34 +1,43 @@
+/* eslint-disable @typescript-eslint/no-require-imports */
 import base64url from 'base64url' // Install via `npm install base64url`
 import crypto from 'crypto'
 
-
 const { Secret, Token } = require('fernet')
 const PBKDF2_ITERATIONS = 480000
 const KEY_LENGTH = 32
-const SALT_LENGTH = 16;
+const SALT_LENGTH = 16
 
 /**
  * Encrypts a private key using Fernet-like encryption.
  */
-export function encryptPrivateKey(pk: string, password: string): { encrypted: string; salt: string } {
+export function encryptPrivateKey(
+  pk: string,
+  password: string,
+): { encrypted: string; salt: string } {
   // Generate a random salt (16 bytes)
-  const salt = crypto.randomBytes(SALT_LENGTH);
+  const salt = crypto.randomBytes(SALT_LENGTH)
 
   // Derive a 32-byte key using PBKDF2-HMAC-SHA256
-  const key = crypto.pbkdf2Sync(password, salt, PBKDF2_ITERATIONS, KEY_LENGTH, "sha256");
+  const key = crypto.pbkdf2Sync(
+    password,
+    salt,
+    PBKDF2_ITERATIONS,
+    KEY_LENGTH,
+    'sha256',
+  )
 
   // Encode key in base64 (Fernet requires 32-byte base64-encoded keys)
-  const fernetKey = base64url.encode(key);
+  const fernetKey = base64url.encode(key)
 
   // Create a Fernet token and encrypt the private key
-  const secret = new Secret(fernetKey);
-  const token = new Token({ secret });
-  const encrypted = token.encode(pk); // Encrypt the private key
+  const secret = new Secret(fernetKey)
+  const token = new Token({ secret })
+  const encrypted = token.encode(pk) // Encrypt the private key
 
   return {
     encrypted, // Encrypted private key (Fernet format)
-    salt: salt.toString("base64"), // Convert salt to base64 string
-  };
+    salt: salt.toString('base64'), // Convert salt to base64 string
+  }
 }
 
 /**
@@ -38,7 +47,7 @@ export function decryptPrivateKey(
   encrypted: string,
   password: string,
   salt: string,
-) {
+): string | null {
   const key = crypto.pbkdf2Sync(
     password,
     Buffer.from(salt, 'base64'),
@@ -58,7 +67,7 @@ export function decryptPrivateKey(
 
   try {
     return token.decode()
-  } catch (err) {
+  } catch {
     return null // Wrong password or corrupted data
   }
 }

src/main/backend/db.ts

@@ -8,7 +8,7 @@ if (fs.existsSync('wartwallet.db')) {
   // Function to check if a column exists in a table
   function columnExists(table: string, column: string): boolean {
     const columns = db.prepare(`PRAGMA table_info(${table});`).all()
-    return columns.some(col => col.name === column)
+    return columns.some((col) => col.name === column)
   }
 
   // Function to check if a table exists
@@ -20,7 +20,10 @@ if (fs.existsSync('wartwallet.db')) {
   }
 
   // Fix missing columns by migrating the wallets table
-  if (!columnExists('wallets', 'name') || !columnExists('wallets', 'last_modified')) {
+  if (
+    !columnExists('wallets', 'name') ||
+    !columnExists('wallets', 'last_modified')
+  ) {
     console.log("Migrating 'wallets' table to add missing columns...")
 
     // Drop incomplete migration tables if they exist
@@ -120,45 +123,50 @@ if (count.count === 0) {
 }
 
 export class WalletDB {
-  static getWallets() {
+  static getWallets(): unknown[] {
     return db
       .prepare('SELECT *, last_modified as lastModified FROM wallets;')
       .all()
   }
 
-  static getWalletByAddress(address: string) {
+  static getWalletByAddress(address: string): unknown {
     return db
       .prepare(
         'SELECT *, last_modified as lastModified FROM wallets WHERE address = ?;',
       )
       .get(address)
   }
 
-  static getWalletById(id: number) {
+  static getWalletById(id: number): unknown {
     return db
       .prepare(
         'SELECT *, last_modified as lastModified FROM wallets WHERE id = ?;',
       )
       .get(id)
   }
 
-  static insertWallet(name: string, address: string, pk: string, salt: string) {
+  static insertWallet(
+    name: string,
+    address: string,
+    pk: string,
+    salt: string,
+  ): void {
     db.prepare(
       'INSERT INTO wallets (name, address, pk, salt, last_modified) VALUES (?, ?, ?, ?, CURRENT_TIMESTAMP);',
     ).run(name, address, pk, salt)
   }
 
-  static updateBalance(address: string, balance: string) {
+  static updateBalance(address: string, balance: string): void {
     db.prepare(
       'UPDATE wallets SET last_balance = ?, last_modified = CURRENT_TIMESTAMP WHERE address = ?;',
     ).run(balance, address)
   }
 
-  static deleteWallet(address: string) {
+  static deleteWallet(address: string): void {
     db.prepare('DELETE FROM wallets WHERE address = ?;').run(address)
   }
 
-  static updatePeer(peer: string) {
+  static updatePeer(peer: string): void {
     db.prepare(
       "UPDATE data SET value = ?, last_modified = CURRENT_TIMESTAMP WHERE key = 'peer';",
     ).run(peer)

src/main/backend/mnemo.ts

@@ -1,9 +1,14 @@
-import * as bip39 from "bip39";
+import * as bip39 from 'bip39'
 
-export function generateMnemonic(strength: 256 | 128 | 160 | 192 | 224 = 256): string {
-  return bip39.generateMnemonic(strength);
+export function generateMnemonic(
+  strength: 256 | 128 | 160 | 192 | 224 = 256,
+): string {
+  return bip39.generateMnemonic(strength)
 }
 
-export function mnemonicToSeed(mnemonic: string, passphrase: string = ""): Buffer {
-  return bip39.mnemonicToSeedSync(mnemonic, passphrase);
-}
+export function mnemonicToSeed(
+  mnemonic: string,
+  passphrase: string = '',
+): Buffer {
+  return bip39.mnemonicToSeedSync(mnemonic, passphrase)
+}