SDK Modernization

[Shaptic]

Epic: stellar/js-stellar-sdk#792

This is an overhaul to bring the stellar-base package to the modern JavaScript world.

Summary

This involves a large set of changes, but I will do my best to summarize them to expedite review.

Main Changes

• Webpack 5 + Babel is now the main build system
• GulpJS is no longer used for any build pipelines
• All dependencies have either been upgraded to their latest versions OR replaced with maintained equivalents.
  • This involved code changes to bring the library up to compatibility with BigNumber.js.

Cascading Changes

These main changes motivate a cascade of other changes, broken down into a handful of categories:

• Building: Packaging is done via Webpack for the browser and Babel for Node
• Linting: ESLint is updated, JS/TS linting is better
• Testing: Libraries are updated + modernized
• Running: yarn scripts are different

Building

Webpack 5 support is here!

• the node package is built using Babel via yarn build:node
• the browser bundle is built using Webpack via yarn build:browser
  • this is configured in cfg/webpack.config.browser.js
  • its accessible after including the script via the StellarBase variable
  • it adds a handful of important polyfills
  • it does linting via ESLint

Linting

ESLint, Prettier, and DTSLint are all updated:

• ESLint works with Babel via the @babel/eslint-parser in each .eslintrc.js file and is implicitly part of building via Webpack (see above)
• DTSLint is part of the @definitelytyped project and has additional configuration implicitly as part of the types/.eslintrc.js file which uses @typescript-eslint/parser, instead
• Prettier is configured in cfg/prettier.config.js (and cfg/.prettierignore) and runs on all files now. It's also (still) a pre-commit hook.

Just run yarn pretty && yarn lint to format your files and check that everything is up to par.

Testing

Istanbul: Istanbul is unmaintained and superceded by the nyc package.

• the istanbul plugin in .babelrc tells Babel about it
• cfg/.nycrc extends a Babel-compatible configuration file (docs)
• the nyc key in package.json configures instrumentation behavior
• the coverage is actually provided by babel-plugin-istanbul (docs), which is why "instrument": false in the above

Node Testing: Mocha (and its helper friends Sinon and Chai) has been updated.

• the mocha key in package.json configures Mocha (replacing mocha.opts)
• this does Babel transpiling and hooks in the helper script
• code coverage is provided by nyc (see above)

Browser Testing: Karma has been updated.

• the SauceLabs Karma configuration has been removed entirely because it wasn't being used
• Karma has been updated with a code coverage integration with nyc (docs, see above)
• It relies on the Webpack configuration but makes some minor changes

Run yarn test to run both suites.

Scripts

Development has a slightly different workflow now:

• build+test locally with yarn test:node
• this will only run node tests (which are faster/simpler)
• you can yarn build && yarn test:all to get the both test suites (note that building first is required)
• run yarn preversion when you want a thorough, clean test of the whole system in "production" mode

[Shaptic]

@BenRacicot would appreciate your review as well

[paulbellamy]

Outstanding work! 💯 🚀

Couple questions...

[silence48]

I think this should be using the url for current:
https://github.com/stellar/stellar-core/tree/master/src/protocol-curr/xdr
for next:
https://github.com/stellar/stellar-core/tree/master/src/protocol-next

[paulbellamy]

The main xdr repository has moved out of core to https://github.com/stellar/stellar-xdr repo, curr and next branches respectively.

[silence48]

I only came across one questionable thing which was the address to the xdr library...

Many of these changes are code linting, which is fine, but I'd prefer to see those broken into a separate commit to be able to quickly find the substantive changes.

Otherwise it looks good.

[silence48]

that works, /generated after all.

[paulbellamy]

LGTM, but I'm not an expert here.

[paulbellamy]

Also, if you could merge these changes into the soroban branch, after they are merged into main. 🙏