Port from blockstack.js

[vsund]

This issue documents my steps for porting over from blockstack.js. I forked at commit 286df82 and will backport coming changes from upstream blockstack.js.

I began with copying over the src/ directory over to here and then gradually fixing the problems tsccomplains about.

I try to document here everything that might be either relevant for fixing it upstream or needs some clarification. For all actions I took please review the commits starting from 11e1c78 (these may contain also minor things that might be relevant for upstream).

Steps

• yarn build (with strict=false)
• yarn build (with strict=true) (except the points below)
• yarn lint
• Restructuring
• yarn test
• Code review (and refactoring)
  • Improve file structure
  • Revisit class attribute visibility
  • Revisit exports
  • Document all code
  • Revisit provided developer interfaces

Issues

• Clarify dependencies: Clarify needed dependencies #4, possible solution in 7587875
• Types for custom-protocol-detection-blockstack: Types for custom-protocol-detection-blockstack #5, possible solution in my fork
• Types for jsontokens: possible solution in Add TypeScript declarations stacks-archive/jsontokens-js#20
• Types for zone-file: possible solution in Add TypeScript declarations stacks-network/zone-file-js#4
• Types for bn.js: Add TypeScript declarations indutny/bn.js#180
• Clarify whether writes to window.location.href are correct Clarify whether writes to window.location.href are correct #6, possible solution in 4ee243a
• Clarify whether getGracePeriod() needs a parameter or not: Clarify whether getGracePeriod() needs a parameter or not #7, possible solution in 329c6a6
• Where does the parameter for verifiedAccounts() should come from?: Where does the parameter for verifiedAccounts() should come from? #8
• Clarify return type of decryptPrivateKey(): Clarify return type of decryptPrivateKey() #9
• Can encryptECIES() take a Buffer as input? Can encryptECIES() take a Buffer as input? #10, possible solution in ae6bc60
• Is the form-data dependency needed?: Is the form-data dependency needed? #13
• @types/bitcoinjs-lib: ECPair should expose compressed: @types/bitcoinjs-lib: ECPair should expose compressed DefinitelyTyped/DefinitelyTyped#24453
• @types/bigi: Wrong return type for valueOf: @types/bigi: Wrong return type for valueOf DefinitelyTyped/DefinitelyTyped#24346

Flaws

• AuthMessage should be exported: 1a3810d
• ErrorType should be exported and wrong parameter name: 3116488
• UTXO should be exported: 35dd81d
• Use library-native UTXO type: 3c85b56

Things needed for a strict build

• Types for elliptic
• Types for ripemd160

---

Note: I'll update this issue consistently with links to other ones etc, while porting over. The solutions behind the issue numbers are most likely opinionated (but need them to go forward with the port).
Also please don't be frightened by all these imperatives, I just write all my git related messages as imperative :D

Edit: Just decided to make a new list of flaws for things that don't need a discussion (in my opinion).

Edit: These may contain false-positives because of style variations or dependency upgrades.

cc @kantai @larrysalibra