Merge pull request #299 from bcnmy/development

Modular Account V2 Integration

.eslintignore

@@ -0,0 +1,14 @@
+# Ignore node_modules in the root and in all packages
+**/node_modules/
+
+# Ignore build or dist directories
+**/dist/
+**/build/
+**/coverage/
+
+# Ignore any auto-generated files
+**/typechain/
+
+# Ignore any config files
+*.config.js
+*.config.ts

.eslintrc.js

@@ -1,11 +1,39 @@
 module.exports = {
-  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
-  extends: [
-    'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
-    'plugin:prettier/recommended' // Enables eslint-plugin-prettier and displays prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
-  ],
+  parser: "@typescript-eslint/parser",
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "airbnb-typescript/base", "plugin:prettier/recommended"],
   parserOptions: {
-    ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
-    sourceType: 'module' // Allows for the use of imports
-  }
-}
+    ecmaVersion: 2020,
+    sourceType: "module",
+    project: "./tsconfig.eslint.json",
+  },
+  env: {
+    node: true,
+    es6: true,
+  },
+  plugins: ["@typescript-eslint", "prettier", "security", "import"],
+  rules: {
+    "prettier/prettier": "error",
+    "no-var": "error",
+    "prefer-const": "error",
+    "no-unused-vars": ["warn", { argsIgnorePattern: "^_" }], // needs to be set to "error" later
+    "no-console": "warn",
+    "@typescript-eslint/naming-convention": "off", // needs to be removed later
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+    "security/detect-object-injection": "warn",
+    "security/detect-unsafe-regex": "error",
+    "import/extensions": "off",
+    "security/detect-object-injection": "off", // turning off Injection Sink rule
+    "@typescript-eslint/no-throw-literal": "off", // temp deactivated needs to be removed once fixed
+  },
+  settings: {},
+  overrides: [
+    {
+      files: ["*.ts", "*.tsx"],
+      rules: {
+        "@typescript-eslint/explicit-function-return-type": ["warn", { allowExpressions: true }],
+      },
+    },
+  ],
+};

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +1,35 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
+## SDK Version
+
+<!-- Please specify the version of the SDK you are using. -->
+
+## Description
+
+<!-- Briefly describe the bug you are facing. -->
+
+## Steps to Reproduce
+
+1.
+2.
+3. <!-- Add any other context or screenshots about the feature request here. -->
+
+## Expected Behavior
+
+<!-- Describe what you expected to happen. -->
+
+## Actual Behavior
+
+<!-- Describe what actually happened. Include any error tracebacks if possible. -->
+
+## Possible Fix (optional)
+
+<!-- If you have an idea on how to fix this, please share! -->
+
+## Environment Details
+
+- **Browser Version**:
+- **Node.js Version**:
+- **NPM/Yarn Version**:
+
+## Additional Context
+
+<!-- Add any other details or context about the bug here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,27 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+name: Feature Request
+about: Propose an enhancement or new feature to improve the project
+title: "Feature: <Your Feature>"
+labels: feature-request, needs-review
+assignees: ""
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Problem You're Facing**
+
+<!-- Briefly describe the problem you're trying to solve or the limitation you've encountered. -->
+
+**Proposed Solution**
+
+<!-- What would you like to see happen? -->
+
+**Alternatives Considered**
+
+<!-- Any other solutions or features you've considered. -->
+
+## Use Cases
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+<!-- Help us understand the broader context by providing some typical use cases where this feature would be helpful. -->
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+**Additional Info**
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+<!-- Provide any additional details, context, or screenshots about the feature request. -->

.github/pull_request_template.md

@@ -1,36 +1,35 @@
-# Description
+# Summary
 
-Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+<!-- Please provide a brief summary of the changes and the issue number this PR addresses. -->
 
-Fixes # (issue)
+Related Issue: # (issue number)
 
-## Type of change
+## Change Type
 
-Please delete options that are not relevant.
+- [ ] Bug Fix
+- [ ] Refactor
+- [ ] New Feature
+- [ ] Breaking Change
+- [ ] Documentation Update
+- [ ] Performance Improvement
+- [ ] Other
 
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] This change requires a documentation update
+# Checklist
 
-# How Has This Been Tested?
-
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+- [ ] My code follows this project's style guidelines
+- [ ] I've reviewed my own code
+- [ ] I've added comments for any hard-to-understand areas
+- [ ] I've updated the documentation if necessary
+- [ ] My changes generate no new warnings
+- [ ] I've added tests that prove my fix is effective or my feature works
+- [ ] All unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published
 
+# Additional Information
 
-**Test Configuration**:
-* Firmware version:
-* Hardware:
-* Toolchain:
-* SDK:
+<!-- Any additional information or context about the PR. -->
 
-# Checklist:
+# Branch Naming
 
-- [ ] My code follows the style guidelines of this project
-- [ ] I have performed a self-review of my code
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
-- [ ] My changes generate no new warnings
-- [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] New and existing unit tests pass locally with my changes
-- [ ] Any dependent changes have been merged and published in downstream modules
+<!-- Make sure your branch name follows the pattern: `features/`, `fixes/`, or `releases/`. -->
+<!-- **Note**: The person creating the PR is responsible for merging and deleting the branch. Ensure the code has been tested, commented, linted, and documents updated if needed. -->

.github/workflows/check_branch_name.yml

@@ -0,0 +1,21 @@
+name: Check Branch Name
+
+on:
+  create:
+    types: [branch]
+
+jobs:
+  check-branch-name:
+    runs-on: ubuntu-latest
+    if: github.event.ref_type == 'branch'
+    steps:
+      - name: Ensure branch name follows GitFlow conventions
+        run: |
+          BRANCH_NAME="${{ github.ref#refs/heads/ }}"
+          echo "Created branch: $BRANCH_NAME"
+
+          # Checking against GitFlow naming conventions for branches
+          if [[ ! $BRANCH_NAME =~ ^(features/|fixes/|releases/) ]]; then
+            echo "error: Branch names should follow GitFlow naming convention (features/, fixes/, releases/)."
+            exit 1
+          fi

.github/workflows/mark_stale.yml

@@ -0,0 +1,22 @@
+name: Mark Inactive Issues and PRs
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/stale@v5
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          stale-issue-message: "This issue has been inactive for 30 days. It will be closed due to inactivity. If this issue is still relevant, please comment to keep it open. Alternatively, you can create a new issue with updated information."
+          stale-pr-message: "This PR has been inactive for 30 days. If it's waiting for a review, please reach out to the team. Otherwise, please update the PR or it will be closed due to inactivity."
+          stale-issue-label: "inactive-issue"
+          stale-pr-label: "inactive-pr"
+          days-before-stale: 30

.github/workflows/push_check.yml

@@ -0,0 +1,43 @@
+name: Test workflow
+on: push
+jobs:
+  lint:
+    name: Lint sources
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - name: Checkout
+        uses: "actions/checkout@master"
+
+      - name: Set Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Lint sources
+        run: yarn run lint
+
+  unit_test:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - name: Checkout
+        uses: "actions/checkout@master"
+
+      - name: Set Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile && yarn build
+      - name: Run tests
+        run: yarn test

.nycrc.json

@@ -1,5 +1,3 @@
 {
-  "include": [
-    "src/**/*.ts"
-  ]
+  "include": ["src/**/*.ts"]
 }

.prettierignore

@@ -0,0 +1,14 @@
+# Ignore node_modules in the root and in all packages
+**/node_modules/
+
+# Ignore build or dist directories
+**/dist/
+**/build/
+**/coverage/
+
+# Ignore any auto-generated files
+**/typechain/
+
+# Ignore any config files
+*.config.js
+*.config.ts

.prettierrc.json

@@ -1,6 +1,7 @@
 {
-    "printWidth": 100,
-    "semi": false,
-    "singleQuote": true,
-    "trailingComma": "none"
+  "printWidth": 150,
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "all",
+  "tabWidth": 2
 }