feat: add initial structure setup (#4)

* feat: add initial structure setup

* refactor: update job name

.eslintignore

@@ -0,0 +1 @@
+**/dist/**

.eslintrc.js

@@ -0,0 +1,22 @@
+/* eslint-env node */
+module.exports = {
+	extends: [
+		'eslint:recommended',
+		'plugin:@typescript-eslint/recommended',
+		'plugin:@typescript-eslint/recommended-type-checked',
+	],
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		tsconfigRootDir: __dirname,
+		project: [
+			'./tsconfig.eslint.json',
+			'./packages/*/tsconfig.json',
+			'./packages/*/test/tsconfig.json',
+		],
+	},
+	plugins: ['@typescript-eslint'],
+	root: true,
+	rules: {
+		'@typescript-eslint/require-await': 'off',
+	},
+};

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,15 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'type: bug'
+assignees: ''
+---
+
+### Expected behavior
+
+### Actual behavior
+
+### Steps to reproduce
+
+### Which version(s) does this affect? (Environment, OS, etc...)

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Propose an idea for new improvements/features
+title: ''
+labels: ''
+assignees: ''
+---
+
+### Description
+
+Please describe what functionality is needed
+
+### Motivation
+
+Please describe why it is needed
+
+### Additional Information

.github/ISSUE_TEMPLATE/feature_specification.md

@@ -0,0 +1,17 @@
+---
+name: Feature specification
+about: Specification of new features/improvements
+title: ''
+labels: ''
+assignees: ''
+---
+
+### Description
+
+Please describe the specification of new features/improvements
+
+### Acceptance Criteria
+
+Please describe the conditions which must be met for this issue to close
+
+### Additional Information

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+### What was the problem?
+
+This PR resolves #INSERT_ISSUE_NUMBER
+
+### How was it solved?
+
+<!--- Please describe your technical implementation -->
+
+### How was it tested?
+
+<!--- Please describe how you tested your changes -->

.github/workflows/pr.yaml

@@ -0,0 +1,33 @@
+name: 'PR'
+on:
+  pull_request:
+
+jobs:
+  build-and-test:
+    runs-on: self-hosted
+    timeout-minutes: 15
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Use Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install yarn
+        run: npm install --global yarn
+      - name: Install dependencies
+        shell: bash
+        run: yarn --prefer-offline
+      - name: Build
+        shell: bash
+        run: yarn build
+      - run: yarn format
+      - name: Check format
+        run: |
+          if [ -z "$(git status --untracked-files=no --porcelain)" ]; then
+            echo "All files formatted"
+          else
+            echo "Running format is required"
+            exit 1
+          fi
+      - run: yarn test

.gitignore

@@ -0,0 +1,73 @@
+ 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
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+
+# generate output
+dist
+.cache/
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test

.prettierignore

@@ -0,0 +1,32 @@
+# Files
+LICENSE
+.gitkeep
+mocha.opts
+.DS_Store
+REVISION
+
+# rc files
+.*rc
+## ignore files
+.*ignore
+
+# Ignore extensions
+*.png
+*.sql
+*.sh
+*.html
+*.info
+*.xml
+*.log
+*.proto
+*.csv
+*.cmd
+*.tsbuildinfo
+*.blob
+*.lock
+
+## jest snapshot
+*.snap
+
+# project specific paths
+dist/

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+	"printWidth": 100,
+	"singleQuote": true,
+	"trailingComma": "all",
+	"useTabs": true,
+	"arrowParens": "avoid"
+}

README.md

@@ -1 +1 @@
-# lisk-token-claim
+# lisk-token-claim

package.json

@@ -0,0 +1,45 @@
+{
+	"name": "lisk-token-claim",
+	"private": true,
+	"version": "0.1.0",
+	"description": "Packages for token claim process",
+	"author": "Lisk Foundation <[email protected]>, lightcurve GmbH <[email protected]>",
+	"license": "Apache-2.0",
+	"keywords": [
+		"lisk",
+		"blockchain"
+	],
+	"homepage": "https://github.com/LiskHQ/lisk-token-claim#readme",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/LiskHQ/lisk-token-claim.git"
+	},
+	"bugs": {
+		"url": "https://github.com/LiskHQ/lisk-token-claim/issues"
+	},
+	"engines": {
+		"node": ">=18.0.0",
+		"npm": ">=8.1.0"
+	},
+	"workspaces": [
+		"packages/*"
+	],
+	"scripts": {
+		"prepare": "husky install",
+		"postinstall": "husky install",
+		"lint": "eslint . --ext .ts",
+		"format": "prettier --write '**/*'",
+		"build": "yarn workspaces run build",
+		"test": "yarn workspaces run test"
+	},
+	"devDependencies": {
+		"husky": "8.0.2",
+		"lint-staged": "13.0.3",
+		"prettier": "^3.1.1",
+		"yarn": "^1.22.19",
+		"eslint": "^8.56.0",
+		"eslint-config-oclif": "^5",
+		"eslint-config-oclif-typescript": "^3",
+		"eslint-config-prettier": "^9.1.0"
+	}
+}

packages/claim-backend/.mocharc.json

@@ -0,0 +1,7 @@
+{
+	"require": ["ts-node/register"],
+	"watch-extensions": ["ts"],
+	"recursive": true,
+	"reporter": "spec",
+	"timeout": 60000
+}

packages/claim-backend/package.json

@@ -0,0 +1,39 @@
+{
+	"name": "@liskhq/claim-backend",
+	"version": "0.1.0",
+	"private": true,
+	"description": "Server to provide proof of the claim",
+	"author": "Lisk Foundation <[email protected]>, lightcurve GmbH <[email protected]>",
+	"license": "Apache-2.0",
+	"keywords": [
+		"blockchain",
+		"lisk"
+	],
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/LiskHQ/lisk-token-claim.git"
+	},
+	"bugs": {
+		"url": "https://github.com/LiskHQ/lisk-token-claim/issues"
+	},
+	"homepage": "https://github.com/LiskHQ/lisk-token-claim#readme",
+	"engines": {
+		"node": ">=18.0.0"
+	},
+	"scripts": {
+		"build": "shx rm -rf dist && tsc -b",
+		"test": "mocha --forbid-only \"test/**/*.test.ts\""
+	},
+	"dependencies": {},
+	"devDependencies": {
+		"@types/chai": "^4",
+		"@types/mocha": "^9.0.0",
+		"@types/node": "^18",
+		"chai": "^4",
+		"mocha": "^10",
+		"shx": "^0.3.3",
+		"ts-node": "^10.9.2",
+		"typescript": "^5"
+	}
+}

packages/claim-backend/test/index.test.ts

@@ -0,0 +1,7 @@
+import { expect } from 'chai';
+
+describe('Test', () => {
+	it('should return true', () => {
+		expect(true).to.be.true;
+	});
+});

packages/claim-backend/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"extends": "../../tsconfig",
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist"
+	},
+	"include": ["src/**/*"]
+}

packages/tree-builder/.mocharc.json

@@ -0,0 +1,7 @@
+{
+	"require": ["ts-node/register"],
+	"watch-extensions": ["ts"],
+	"recursive": true,
+	"reporter": "spec",
+	"timeout": 60000
+}

packages/tree-builder/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

packages/tree-builder/bin/dev.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node_modules/.bin/ts-node
+// eslint-disable-next-line node/shebang, unicorn/prefer-top-level-await
+(async () => {
+	const oclif = await import('@oclif/core');
+	await oclif.execute({ development: true, dir: __dirname });
+})();

packages/tree-builder/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

packages/tree-builder/bin/run.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+// eslint-disable-next-line unicorn/prefer-top-level-await
+(async () => {
+	const oclif = await import('@oclif/core');
+	await oclif.execute({ development: false, dir: __dirname });
+})();