Skip to content

[Task] General project modernization and refresh #73

Description

@adamantmm

Overview

The project needs a general refresh to align the codebase, tooling, and documentation with current practices. The goal is to modernize the repository without changing intended behavior or weakening backward compatibility.

Scope

  • Update project dependencies to their latest stable versions where feasible
  • Refresh ESLint and Prettier configuration to current recommended rules and project conventions
  • Update Husky to current version and best practices
  • Remove legacy code paths, outdated packages, and obsolete patterns
  • Update README.md to reflect the current setup, usage, scripts, and contribution workflow
  • Add JSDoc to public modules, exported functions, and other important developer-facing APIs
  • Add short clarifying comments in non-obvious parts of the codebase

Proposed Work Breakdown

  • Audit and group required major/minor dependency updates
  • Update dependencies and resolve breaking changes where needed
  • Review and modernize ESLint/Prettier setup (migrate to flat config if applicable)
  • Update Husky to current version and review git hooks configuration
  • Remove dead code, deprecated utilities, and outdated patterns
  • Refresh README and other developer-facing documentation
  • Add missing JSDoc to public and reusable code paths (API surface, helpers, transactions, coins)
  • Add comments only where intent is not obvious from the code itself
  • Run lint, tests, and build validation after all changes

Acceptance Criteria

  • Dependency tree is updated and the project still installs and runs correctly
  • Linting and formatting configuration are aligned with current project standards
  • Husky git hooks are functional and current
  • Legacy or unused code is removed without changing expected behavior
  • README reflects the actual project state and developer workflow
  • Public and reusable modules have JSDoc coverage where it adds maintenance value
  • Non-obvious logic has concise explanatory comments
  • All validation commands pass: npm run compile, npm test, npm run lint
  • No secret exposure, unsafe logging, or avoidable security regressions are introduced

Constraints

  • Preserve backward compatibility unless a deliberate breaking change is separately approved
  • Do not change transaction byte layout, IDs, signing, or cryptographic behavior
  • Keep all repository artifacts in English
  • Prefer focused cleanups over broad rewrites without clear value
  • Avoid introducing unnecessary new dependencies

Related

  • None yet

Metadata

Metadata

Labels

Composite taskLarge or complex task that consists of multiple subtaskGuidelineBest practices, coding standards, contribution rulesNodeJSBackend logic, APIs, and Node.js environmentTaskGeneral task not necessarily related to codeTypeScriptCode and typing improvements in TypeScriptdocumentationImprovements or additions to documentation

Type

No fields configured for Task.

Projects

Status
Released v0.10.0

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions