Skip to content
This repository has been archived by the owner on Mar 8, 2024. It is now read-only.

v1.0.0

Compare
Choose a tag to compare
@0xCLARITY 0xCLARITY released this 18 Jun 13:03
· 148 commits to master since this release
1.0.0

Features

  • Moved functionality intended to be overridden into the src/hooks directory
  • Added a default Prometheus server for pushing metrics in config.ts
  • Added Lefthook (a git hook helper) to repo to assist in linting and testing code before pushes.
  • Added a docker-compose.yml file to easily allow spinning up a containerized Postgres database, or a database + Node.JS PayID HTTP server for easy development.
  • Added issue templates for bugs and features to the PayID repository
  • Added a health check HTTP endpoint for the Private API
  • Added Prettier formatting of Markdown and JSON files to our lint script

Fixes

  • Allow CORS requests for the public API / PayID Protocol
    • Totally reasonable for browsers to make PayID queries
  • Fix private API not accepting PayIDs with capital letters.
    • PayIDs are, by definition, case-insensitive, but there was a bug requiring all PayIDs provided to the private API to be all lowercase. It is now smart enough to call .toLowerCase() itself.
  • Updated the Dockerfile to use a non-root user.

Documentation

  • Added documentation for version headers
  • Clean up some existing documentation
  • Add a CONTRIBUTING.md file

Project Internals

Refactors

  • Refactor tests to one describe block per test file
  • JSDoc the entire codebase
  • Update package.json
    • Sort properties to their canonical order
    • Add an engines property
    • Move nyc code coverage configuration to a standalong config file
  • Update tsconfig
    • Change target to ES2019
    • Check that we are consistent in filename casing
    • Tell TypeScript to do incremental compilation which might speed up repeated build commands
  • Refactor code for calculating & collecting metrics

Dependencies Updated

  • Update typescript to 3.9.5
  • Update mocha from 7.2.0 => 8.0.1
  • Update boom dependency since v7 was deprecated
  • Various linting dependencies updated
  • Various typing files updated