omg-js icon indicating copy to clipboard operation
omg-js copied to clipboard

Published 20 hours ago • verified publisher icon omgnetwork

v5: typescript

Open nicholasmueller opened this issue 3 years ago • 0 comments

This is a big one, includes breaking changes so will be part of a v5 release.

Issues

https://github.com/omgnetwork/omg-js/issues/317 https://github.com/omgnetwork/omg-js/issues/282 https://github.com/omgnetwork/omg-js/issues/187

Changes

  • Refactored everything into typescript. Lib interfaces are exported so clients are able to use them. Nicer developer experience both for maintainers and library users. Inputs and returned objects are all typed.
  • Refactored internal library structure. Simplified logic into a new folder structure. Easier to reason about what logic goes where.
  • Removed lerna, no more multipackages in favor of a single package. This also removes any lerna magic and simplifies our release process.
  • Taking advantage of typescript with new docs that are more expressive and include all type data
  • Typescript compiler is awesome

To do

  • [x] setup ci to run all integration tests
  • [x] add in from field to eth_call's https://github.com/omgnetwork/omg-js/pull/333
  • [x] browserified version / test compiled in simple html script

Intellisense cleaned up Screen Shot 2020-10-28 at 15 44 09

Lists available methods Screen Shot 2020-10-28 at 15 44 24

Return types Screen Shot 2020-10-28 at 15 44 49

Exported interfaces Screen Shot 2020-10-28 at 15 48 33

nicholasmueller avatar Oct 28 '20 08:10 nicholasmueller