feat(server): nestjs setup (#345)

* feat(server): nestjs setup

* remove nvmrc

* feature(api): added api for faucet to allocate fund to user (#346)

* feature(api): added api for faucet to allocate fund to user

* added e2e test

* fixed pr comments

* added e2e for ratelimiting

* added invalid address test case

* fix lint

* fix typo

* fix lint

* fix ci

* fix ci

* fix ci

* fix ci

* fix ci

* fix ci

* fix ci

* fix ci

* fix ci-e2e

* fix ci-e2e

---------

Co-authored-by: Harsh R <53080940+fullstackninja864@users.noreply.github.com>
Co-authored-by: pierregee <pierre@cakedefi.com>

.github/workflows/ci-e2e.yml

@@ -39,12 +39,11 @@ jobs:
           install: false
           record: true
           parallel: true
-          build: pnpm run cypress:build
-          start: pnpm run start
-          wait-on: "http://localhost:3000"
+          start: pnpm dev
           browser: chrome
           spec: cypress/e2e/**
           tag: ${{ github.event_name }}
+          working-directory: ./apps/web
         env:
           CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -16,17 +16,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
-
       - run: corepack enable pnpm
-
       - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
         with:
           node-version-file: ".nvmrc"
           cache: pnpm
 
       - run: pnpm install --frozen-lockfile
-      - run: tsc
-      - run: pnpm run lint
+      - run: npx turbo typecheck
+      - run: npx turbo lint
 
   lint_prettier:
     name: Lint - Prettier
@@ -42,4 +40,4 @@ jobs:
           cache: pnpm
 
       - run: pnpm install --frozen-lockfile
-      - run: npx --no-install prettier --check "src/**/*.{js,jsx,ts,tsx}"
+      - run: npx --no-install prettier --check "apps/**/*.{js,jsx,ts,tsx}"

.gitignore

@@ -1,16 +1,17 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
 # dependencies
-/node_modules
+node_modules/
 /.pnp
 .pnp.js
 
 # testing
-/coverage
+coverage
 
 # next.js
-/.next/
+.next/
 /out/
+dist
 
 # production
 /build
@@ -34,3 +35,10 @@ yarn-error.log*
 # typescript
 *.tsbuildinfo
 next-env.d.ts
+
+# nyc test coverage
+.nyc_output
+
+# turborepo
+*.tgz
+.turbo

.npmrc

@@ -7,16 +7,21 @@ public-hoist-pattern[]=*jest*
 public-hoist-pattern[]=*eslint*
 public-hoist-pattern[]=*prettier*
 public-hoist-pattern[]=@types/*
+public-hoist-pattern[]=*defichain*
 public-hoist-pattern[]=*react*
 public-hoist-pattern[]=*next*
 public-hoist-pattern[]=next*
-public-hoist-pattern[]=*react*
+public-hoist-pattern[]=*@waveshq*
 public-hoist-pattern[]=*@netlify*
 public-hoist-pattern[]=*follow-redirects*
-public-hoist-pattern[]=*@waveshq*
-public-hoist-pattern[]=*defichain*
+public-hoist-pattern[]=*nestjs*
+public-hoist-pattern[]=*fastify*
+public-hoist-pattern[]=async-mutex
+public-hoist-pattern[]=cache-manager
+public-hoist-pattern[]=helmet
 
 engine-strict=true
 auto-install-peers=true
+strict-peer-dependencies=false
 enable-pre-post-scripts=true
 node-linker=hoisted

.vscode/settings.json

@@ -0,0 +1,29 @@
+{
+  "editor.formatOnSave": true,
+  "editor.formatOnPaste": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "eslint.workingDirectories": [
+    {
+      "mode": "auto"
+    }
+  ],
+  "files.exclude": {
+    "**/node_modules": true,
+    "**/.git": true,
+    "**/.svn": true,
+    "**/.hg": true,
+    "**/CVS": true,
+    "**/.DS_Store": true,
+    "**/Thumbs.db": true
+  },
+  "cSpell.words": [
+    "birthdaycloud",
+    "fastify",
+    "Middie"
+  ]
+}

apps/server/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  preset: 'ts-jest',
+  testRegex: '((\\.|/)(e2e|test|spec))\\.[jt]sx?$',
+  verbose: true,
+  clearMocks: true,
+  testTimeout: 300000,
+  coveragePathIgnorePatterns: ['/node_modules/', '/examples/', '/website/', '.*/__tests__/.*', '.*/testing/.*'],
+};

apps/server/nest-cli.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}

apps/server/package.json

@@ -0,0 +1,114 @@
+{
+  "name": "server",
+  "version": "1.0.0",
+  "description": "",
+  "keywords": [],
+  "license": "ISC",
+  "author": "",
+  "main": "index.js",
+  "scripts": {
+    "build": "nest build",
+    "dev": "NODE_ENV=dev nest start --watch",
+    "lint": "eslint .",
+    "playground:start": "docker-compose rm -fsv && docker-compose up",
+    "prettier": "npx prettier --write .",
+    "start": "nest start",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "test": "jest",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "test:watch": "jest --watch"
+  },
+  "lint-staged": {
+    "*": [
+      "prettier --write --ignore-unknown"
+    ],
+    "*.{js,ts}": [
+      "eslint --fix"
+    ]
+  },
+  "prettier": "@stickyjs/prettier",
+  "eslintConfig": {
+    "parserOptions": {
+      "project": "./tsconfig.json"
+    },
+    "extends": [
+      "@stickyjs"
+    ],
+    "overrides": [
+      {
+        "files": [
+          "*.ts"
+        ],
+        "rules": {
+          "no-prototype-builtins": "off",
+          "no-restricted-properties": "warn",
+          "check-file/filename-naming-convention": "off",
+          "unused-imports/no-unused-vars": "warn"
+        }
+      }
+    ]
+  },
+  "dependencies": {
+    "@defichain/jellyfish-api-core": "^4.0.0-beta.11",
+    "@defichain/jellyfish-network": "^4.0.0-beta.11",
+    "@defichain/jellyfish-transaction": "^4.0.0-beta.11",
+    "@defichain/whale-api-client": "^4.0.0-beta.11",
+    "@nestjs/cache-manager": "^2.1.1",
+    "@nestjs/common": "^10.2.5",
+    "@nestjs/config": "^3.1.1",
+    "@nestjs/core": "^10.2.5",
+    "@nestjs/platform-express": "^10.2.5",
+    "@nestjs/throttler": "^5.0.1",
+    "@waveshq/standard-defichain-jellyfishsdk": "^2.6.1",
+    "@waveshq/walletkit-core": "^1.3.4",
+    "axios": "^1.5.0",
+    "bignumber.js": "^9.1.2",
+    "cache-manager": "^5.2.4",
+    "class-validator": "^0.14.0",
+    "ethers": "^6.7.1",
+    "express": "^4.18.2",
+    "joi": "^17.10.1",
+    "node-fetch": "^3.3.2",
+    "pg": "^8.11.3",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.8.1",
+    "smart-buffer": "^4.2.0",
+    "viem": "^1.10.14"
+  },
+  "devDependencies": {
+    "@defichain/jellyfish-testing": "4.0.0-beta.11",
+    "@defichain/playground-api-client": "4.0.0-beta.11",
+    "@defichain/testcontainers": "4.0.0-beta.11",
+    "@nestjs/cli": "^10.1.17",
+    "@nestjs/platform-fastify": "^10.2.5",
+    "@nestjs/schematics": "^10.0.2",
+    "@nestjs/testing": "^10.2.5",
+    "@stickyjs/eslint-config": "^1.3.3",
+    "@stickyjs/prettier": "^1.3.3",
+    "@stickyjs/testcontainers": "^1.3.3",
+    "@stickyjs/typescript": "^1.3.3",
+    "@types/express": "^4.17.17",
+    "@types/jest": "^29.5.4",
+    "@types/node": "^20.5.0",
+    "@types/supertest": "^2.0.12",
+    "@waveshq/standard-web-linter": "^2.6.1",
+    "dotenv": "^16.3.1",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "lint-staged": "^14.0.1",
+    "nodemon": "^3.0.1",
+    "prettier": "^3.0.3",
+    "source-map-support": "^0.5.21",
+    "supertest": "^6.3.3",
+    "testcontainers": "^9.12.0",
+    "ts-jest": "^29.1.1",
+    "ts-loader": "^9.4.4",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.2.2",
+    "wait-for-expect": "^3.0.2"
+  }
+}