feat: migrate to ts #1

dmbsk · 2021-12-21T12:29:15Z

Changes

migrate to typescript
setup karma to run test in browser
setup eslint
setup rollup
remove committed libs and replace them with npm packages (when possible)
- segwit_addr add minimal required amount of typing
- cnBase58 removed (only used for monero)
remove monero validator
remove stx

Docs

Lib requires fallbacks/polyfills/shimming to be used in the browser because the most popular cryptographic libs are written to be used in node (not browser)

webpack example

 resolve: {
     resolve: {
          fallback: {
            crypto: require.resolve('crypto-browserify'),
            stream: 'stream-browserify',
            buffer: require.resolve('buffer/'),
          },
          extensions: ['.ts', '.js'],
        },
        plugins: [
          new webpack.ProvidePlugin({
            Buffer: ['buffer', 'Buffer'],
          }),
        ],
  }

⚠️ Currently there is a problem with running test in browser context on macOS; read more here

src/xtz_validator.ts

Kraudia · 2022-01-19T11:26:32Z

.vscode/settings.json

@@ -0,0 +1,251 @@
+{
+  "cSpell.words": [
+    "bitcoincash"


missing comma , at the end of line

This is for the VSC extension so linting rules doesn't apply here

Kraudia · 2022-01-19T11:28:38Z

.vscode/settings.json

@@ -0,0 +1,251 @@
+{
+  "cSpell.words": [


Also I would suggest to sort these words alphabetically ;D

Kraudia · 2022-01-19T11:32:42Z

src/ae_validator.ts

+const regexp = new RegExp("^(ak_)([" + ALLOWED_CHARS + "]+)$"); // Begins with ak_ followed by
+
+const aeValidator: TChecksumValidator = {
+  isValidAddress(address) {


It is on purpose to remove old args? I see that they weren't used but maybe users that use this package will pass all 3 args.

The same also applies to methods for rest of crypto.

These are additional args - unused

Kraudia · 2022-01-19T11:37:27Z

src/ae_validator.ts

+
+  verifyChecksum: (address) => {
+    const decodedBuffer = base58.decode(address);
+    return decodedBuffer.length === 32 + 4; // add 4 because base is adding 4 characters, why is base 58 adding them?


I would suggest to leave a TODO comment ;D

I was wodneriing if we should leave original code here but it lgtm.

I changed it because npm package base58 decode function return type is different so that was cleanest&easiest refactor

Kraudia · 2022-01-19T11:44:19Z

src/bitcoincash_validator.js

-   * @param {String} address The target address
-   * @param {Object} currency A currency from the ./currencies.js array
-   * @param {String} networkType Network Type. Could be 'prod', 'both' and 'testnet'
-   * @param {Array} addressFormats Array of formats. Options are: 'legacy', 'cashaddr', 'bitpay', 'slpaddr', 'all'


You have declared thisjust as string:

export type TAddress = string;

Can another crypto addresess have different address format?

Btw. I see you have removed this comment for src/bitcoincash_validator.ts, but left simialr comment in src/wallet_address_validator.ts.

Kraudia · 2022-01-19T11:46:56Z

src/crypto/cnBase58.ts

+  return b58;
+})();
+
+export default cnBase58;


why cnBase58 not just base58 like before?

cnBase58 is not Base58. Maybe types names are wrong 🤔

Kraudia · 2022-01-19T11:48:08Z

src/crypto/sha3.js

-  }
-}
-
-module.exports = methods


Do we have ts version for sha3? I don't see.

src/types/validator.types.ts

tsconfig.json

Kraudia · 2022-01-19T12:06:45Z

.eslintrc.yml

+  - simple-import-sort
+  - eslint-plugin-prettier
+
+rules:


As I fan of single quotes I would recommend you to use single quotes for imports, strings etc :D

Also ramp-instant uses single quotes mostly

jakubsta · 2022-02-07T16:14:08Z

.eslintrc.yml

+ignorePatterns:
+  - '*.d.ts'
+  - 'dist'
+  - "rollup.config.ts"


Suggested change

- "rollup.config.ts"

- 'rollup.config.ts'

jakubsta · 2022-02-07T16:16:41Z

package.json

@@ -1,256 +1,11 @@
 {
-  "name": "@swyftx/api-crypto-address-validator",
+  "name": "@ramp/api-crypto-address-validator",


@macbem shouldn't it be @ramp-network/api-crypto-address-validator or just @ramp-network/crypto-address-validator?

@ramp-network/crypto-address-validator

jakubsta · 2022-02-07T16:17:26Z

package.json

+  "module": "dist/ramp-crypto-address-validator.es5.js",
+  "typings": "dist/types/wallet_address_validator.d.ts",
+  "version": "1.0.0",
+  "author": "RampNetwork",


Suggested change

"author": "RampNetwork",

"author": "Ramp Network <contact@ramp.network>",

Changed, I miss out this one 😨

jakubsta · 2022-02-07T16:26:22Z

src/bitcoincash_validator.ts

+  }
+};
+
+// TODO refactor


Is it done/resolved?

Same reason as here

jakubsta · 2022-02-07T16:27:20Z

src/bitcoincash_validator.ts

+    return BCH.isTestnetAddress(address);
+  }
+
+  // TODO: check if this is okay? Defaults to true if not prod or testnet? Probably 'both'?


so is it okay?

That's not my comment, was already in the lib

jakubsta · 2022-02-07T16:34:17Z

src/crypto/utils.ts

+  return hex;
+};
+
+// TODO refactor


is it refactored?

I didn't want to make refactor in this PR, because finding a potential error will be much harder

src/lumen_validator.ts

akwodkiewicz

This is part of the output of yarn test (when run on macOS):

$ rollup -c rollup.config.ts

src/wallet_address_validator.ts → dist/ramp-crypto-address-validator.umd.js, dist/ramp-crypto-address-validator.es5.js...
(!) Missing shims for Node.js built-ins
Creating a browser bundle that depends on "buffer", "stream" and "string_decoder". You might need to include https://github.com/snowpackjs/rollup-plugin-polyfill-node
(!) Plugin node-resolve: preferring built-in module 'buffer' over local alternative at '/Users/andrzejwodkiewicz/Ramp/crypto-address-validator/node_modules/buffer/index.js', pass 'preferBuiltins: false' to disable this behavior or 'preferBuiltins: true' to disable this warning
(!) Plugin node-resolve: preferring built-in module 'string_decoder' over local alternative at '/Users/andrzejwodkiewicz/Ramp/crypto-address-validator/node_modules/string_decoder/lib/string_decoder.js', pass 'preferBuiltins: false' to disable this behavior or 'preferBuiltins: true' to disable this warning
(!) Missing global variable names
Use output.globals to specify browser global variable names corresponding to external modules
buffer (guessing 'require$$0')
readable-stream (guessing 'require$$0$1')
stream (guessing 'require$$0$2')
string_decoder (guessing 'require$$2')
created dist/ramp-crypto-address-validator.umd.js, dist/ramp-crypto-address-validator.es5.js in 3.1s

This is my first time with rollup (and karma as well), so I have some questions regarding the warnings:

Creating a browser bundle that depends on "buffer", "stream" and "string_decoder". You might need to include https://github.com/snowpackjs/rollup-plugin-polyfill-node

should we include this module?

(!) Plugin node-resolve: preferring built-in module (...) pass 'preferBuiltins: false' to disable this behavior or 'preferBuiltins: true' to disable this warning

Do we want to use built-ins or no? Please set the config appropriately.

(!) Missing global variable names

Is this something that we should fix?

dmbsk · 2022-03-07T12:19:15Z

Creating a browser bundle that depends on "buffer", "stream" and "string_decoder". You might need to include https://github.com/snowpackjs/rollup-plugin-polyfill-node

should we include this module?

Imho it is better to add them while using because other libs/deps can yous global polyfills also

(!) Plugin node-resolve: preferring built-in module (...) pass 'preferBuiltins: false' to disable this behavior or 'preferBuiltins: true' to disable this warning

Do we want to use built-ins or no? Please set the config appropriately.

preferBuiltins: true added

(!) Missing global variable names

Is this something that we should fix?

In our case this is because we don't include polyfills inside package. So imho no.

akwodkiewicz

LGTM, we'll fix potential errors if we find them when using the lib.

dmbsk · 2022-03-10T19:44:06Z

I recently checked if we can somehow move from karma to anything else but did not found anything.
Cypress was a good guess but cypress by default add a lot of polyfills to make testing easier 😞 (there is no way to disable auto polyfilling)

dmbsk · 2022-03-10T19:44:35Z

@macbem @jakubsta rereview/approve please

dmbsk added 3 commits December 17, 2021 13:18

feat: rename crypto files to .ts

cf34a32

feat: setup karma for TS

e076414

ref: change require to import, change to default export

46a91ef

dmbsk added the enhancement New feature or request label Dec 21, 2021

dmbsk self-assigned this Dec 21, 2021

dmbsk changed the title ~~feat: Migrate to ts~~ feat: migrate to ts Dec 21, 2021

dmbsk added 18 commits December 21, 2021 15:21

feat: validators related types

551fd14

feat: type all validators

5aeb433

feat: type utils

a1b2dd1

feat: add more hash function types

e4f01c4

fix: improve btc typing

119482e

ref: karma and ts config

540b442

feat: basic rollup setup

479a66f

ref: remove biginteger.js use bignumber.js instead

ba5bacf

ref: remove ts expect errors

57a8f8b

ref: remove base58 and move to base58-js

034974e

fix: change how we test in browser POC

905a40d

feat: migrate most of utils to npm packages

623253d

feat: webpack karma config

5b9c309

fix: uncomment one test

4871454

feat: replace blake256, use bech32 in segwit

2b31219

style: use spread instead of picking

bb20d2e

feat: eslint

6a087ca

fix: run chrome headless

332c69e

dmbsk commented Jan 12, 2022

View reviewed changes

src/xtz_validator.ts Show resolved Hide resolved

fix: cleanup commented code

c5ae421

Kraudia suggested changes Jan 19, 2022

View reviewed changes

dmbsk added 3 commits January 24, 2022 20:44

fix: replace base58_to_binary with bs58

fdb1974

chore: remove base58js, add bs58 types

9c88394

chore: sort vscode settings

536f361

dmbsk added 9 commits February 2, 2022 16:09

feat: remove iota and monero

f84cb55

ref: simpler building process

c8b5593

chore: package json cleanup

61122cb

fix(wid): fix browser context tests

5dea8cb

chore: cleanup

7adc547

ref: bitcoin cash validator

fc769ec

chore: update bitcoincash deps

0c93f41

fix: uncomment tests

40640b0

docs: improve js doc

f1ea4e2

dmbsk marked this pull request as ready for review February 3, 2022 17:05

feat: add uglify

20388df

jakubsta reviewed Feb 7, 2022

View reviewed changes

dmbsk and others added 5 commits February 11, 2022 15:34

feat: remove stx

3f59501

feat: remove bindings from build

50109c9

test: remove unused tests

01f6d55

chore: update package author

c930d56

style: change " to '

e23589b

dmbsk requested review from jakubsta and akwodkiewicz February 24, 2022 11:37

akwodkiewicz reviewed Mar 3, 2022

View reviewed changes

dmbsk added 2 commits March 7, 2022 13:21

fix: building builtins warning

c4593c2

fix: remove unused file

286bc45

dmbsk requested a review from akwodkiewicz March 7, 2022 19:54

akwodkiewicz approved these changes Mar 9, 2022

View reviewed changes

dmbsk requested review from macbem and Kraudia March 10, 2022 19:38

dmbsk merged commit 764a913 into dev Mar 11, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: migrate to ts #1

feat: migrate to ts #1

dmbsk commented Dec 21, 2021 •

edited

Loading

Kraudia Jan 19, 2022

dmbsk Jan 24, 2022

Kraudia Jan 19, 2022

dmbsk Jan 24, 2022

Kraudia Jan 19, 2022

Kraudia Jan 19, 2022

dmbsk Jan 24, 2022 •

edited

Loading

Kraudia Jan 19, 2022

Kraudia Jan 19, 2022

dmbsk Jan 24, 2022

Kraudia Jan 19, 2022

Kraudia Jan 19, 2022

Kraudia Jan 19, 2022

dmbsk Jan 24, 2022

Kraudia Jan 19, 2022

Kraudia Jan 19, 2022

Kraudia Jan 19, 2022

jakubsta Feb 7, 2022

jakubsta Feb 7, 2022

macbem Feb 21, 2022

jakubsta Feb 7, 2022

dmbsk Feb 21, 2022

jakubsta Feb 7, 2022

dmbsk Feb 11, 2022

jakubsta Feb 7, 2022

dmbsk Feb 11, 2022

jakubsta Feb 7, 2022

dmbsk Feb 11, 2022

akwodkiewicz left a comment

dmbsk commented Mar 7, 2022

akwodkiewicz left a comment

dmbsk commented Mar 10, 2022

dmbsk commented Mar 10, 2022

	"author": "RampNetwork",
	"author": "Ramp Network <contact@ramp.network>",

feat: migrate to ts #1

feat: migrate to ts #1

Conversation

dmbsk commented Dec 21, 2021 • edited Loading

Changes

Docs

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dmbsk Jan 24, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akwodkiewicz left a comment

Choose a reason for hiding this comment

dmbsk commented Mar 7, 2022

akwodkiewicz left a comment

Choose a reason for hiding this comment

dmbsk commented Mar 10, 2022

dmbsk commented Mar 10, 2022

dmbsk commented Dec 21, 2021 •

edited

Loading

dmbsk Jan 24, 2022 •

edited

Loading