Requirements for an open source JS library for Decred

DecredJSLibsRQRMNTS.md

Decred Open-Source JS Library Requirements

Basic Coding Requirements

• Typescript - See https://www.typescriptlang.org/docs/home.html for details
• Follow Decred Code Contributions 4 to 6 - See https://github.com/decred/dcrd/blob/master/docs/code_contribution_guidelines.md for details. Summary/Outline:
  • 4.1 Share Early, Share Often (Announce plans, share iterations as developed)
  • 4.2 Ensure Adequate Testing (Testing should reflect that this is financial software)
  • 4.3 Document and Comment (EG. functions should be commented with intended purpose and assumptions)
  • 4.4 Git Commit per Message Model (clean commit history with well-formed commit messages, see example in link)
  • 5.1 Follow Code Review (establish maintainers/owners and ensure peer review, see specifics in link)
  • 5.2 Rework Code (ensure all rework requests from code review are completed)
  • 5.3 Code Acceptance (integrate accepted code with the master to keep a clean commit history rather than merge commits)
  • 6.1 Contribution Checklist - Follow all steps in code contribution checklist (replace the GO step with Typescript above)
  • 6.1 Licensing of Contributions - All contributions must be licensed with the ISC license: https://github.com/decred/dcrd/blob/master/LICENSE

Functionality Requirements

• Create and sign regular transactions.
• Create and sign stake transactions.
• Understand/Generate addresses.
• Work with p2pkh, p2sh and multisig scripts.
• Clean, and versioned, API for consumers.

JS library is tracked in decredcommunity/issues#115 where I copied the above comment from Paul.

edit: note that issue is better for discussion as it allows to follow it via subscription, can be labeled, etc.