Merge pull request #201 from streamr-dev/typescript-tweaks

Typescript tweaks

Author: timoxley

.eslintrc.js

@@ -6,6 +6,16 @@ module.exports = {
     extends: [
         'streamr-nodejs'
     ],
+    parserOptions: {
+        ecmaVersion: 2020,
+        ecmaFeatures: {
+            modules: true
+        }
+    },
+    env: {
+        browser: true,
+        es6: true
+    },
     rules: {
         'max-len': ['warn', {
             code: 150
@@ -43,8 +53,6 @@ module.exports = {
         '@typescript-eslint/no-shadow': 'error',
         'no-unused-vars': 'off',
         '@typescript-eslint/no-unused-vars': ['error'],
-        'no-else-return': 'off',
-        'no-return-await': 'off'
     },
     settings: {
         'import/resolver': {

jest.config.js

@@ -76,7 +76,9 @@ module.exports = {
     // moduleNameMapper: {},
 
     // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-    // modulePathIgnorePatterns: [],
+    modulePathIgnorePatterns: [
+        '<rootDir>/dist',
+    ],
 
     // Activates notifications for test results
     // notify: false,
@@ -85,7 +87,7 @@ module.exports = {
     // notifyMode: "always",
 
     // A preset that is used as a base for Jest's configuration
-    // preset: null,
+    preset: 'ts-jest',
 
     // Run tests from one or more projects
     // projects: null,
@@ -170,9 +172,9 @@ module.exports = {
     },
 
     // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-    // transformIgnorePatterns: [
-    //   "/node_modules/"
-    // ],
+    transformIgnorePatterns: [
+        '/node_modules/(?!quick-lru)', // quick-lru is esm
+    ],
 
     // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
     // unmockedModulePathPatterns: undefined,

package-lock.json

@@ -6,28 +6,30 @@
     "type": "git",
     "url": "git://github.com/streamr-dev/streamr-client.git"
   },
-  "main": "dist/streamr-client.nodejs.js",
-  "browser": "dist/streamr-client.web.min.js",
   "types": "dist/types/src/StreamrClient.d.ts",
+  "main": "dist/node/src/StreamrClient.js",
+  "browser": "dist/streamr-client.web.min.js",
   "directories": {
     "example": "examples",
     "test": "test"
   },
   "scripts": {
-    "build": "rm -rf dist; NODE_ENV=production webpack --mode=production --progress && npm run build:types",
-    "build:types": "tsc --emitDeclarationOnly",
+    "build": "rm -rf dist; NODE_ENV=production webpack --mode=production --progress && npm run build-node && npm run build:types",
+    "build-node": "tsc --incremental --project ./tsconfig.node.json",
+    "watch-node": "tsc --incremental --watch --project ./tsconfig.node.json",
+    "build:types": "tsc --incremental --emitDeclarationOnly",
     "benchmarks": "node test/benchmarks/publish.js && node test/benchmarks/subscribe.js",
     "prebuild-benchmark": "npm run build -- --config-name=node-lib",
     "build-benchmark": "npm run benchmarks",
     "benchmark-build": "npm run build-benchmark",
     "benchmark": "npm run benchmarks",
     "prepack": "npm run build",
     "prebuild": "npm run eslint -- --cache",
-    "dev": "webpack --progress --colors --watch --mode=development",
+    "watch": "webpack --progress --watch --mode=development",
     "eslint": "eslint --cache-location=node_modules/.cache/.eslintcache/ '*/**/*.{js,ts}'",
     "test": "jest --detectOpenHandles",
     "test-unit": "jest test/unit --detectOpenHandles",
-    "test-types": "tsc --noEmit --project ./tsconfig.test.json",
+    "test-types": "tsc --noEmit --incremental --project ./tsconfig.test.json",
     "coverage": "jest --coverage",
     "test-integration": "jest --forceExit test/integration",
     "test-integration-no-resend": "jest --forceExit --testTimeout=10000 --testPathIgnorePatterns='resend|Resend' --testNamePattern='^((?!(resend|Resend|resent|Resent|gap|Gap)).)*$' test/integration/*.test.js",
@@ -45,62 +47,73 @@
   "author": "Streamr",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@babel/cli": "^7.12.10",
-    "@babel/core": "^7.12.10",
-    "@babel/plugin-proposal-class-properties": "^7.12.1",
-    "@babel/plugin-transform-classes": "^7.12.1",
-    "@babel/plugin-transform-modules-commonjs": "^7.12.1",
-    "@babel/plugin-transform-runtime": "^7.12.15",
-    "@babel/preset-env": "^7.12.11",
-    "@babel/preset-typescript": "^7.12.13",
+    "@babel/cli": "^7.12.17",
+    "@babel/core": "^7.12.17",
+    "@babel/helper-call-delegate": "^7.12.13",
+    "@babel/plugin-proposal-class-properties": "^7.12.13",
+    "@babel/plugin-transform-classes": "^7.12.13",
+    "@babel/plugin-transform-modules-commonjs": "^7.12.13",
+    "@babel/plugin-transform-runtime": "^7.12.17",
+    "@babel/preset-env": "^7.12.17",
+    "@babel/preset-typescript": "^7.12.17",
+    "@tsconfig/node14": "^1.0.0",
     "@types/debug": "^4.1.5",
     "@types/jest": "^26.0.20",
+    "@types/lodash.uniqueid": "^4.0.6",
+    "@types/node": "^14.14.31",
     "@types/qs": "^6.9.5",
+    "@types/uuid": "^8.3.0",
     "@typescript-eslint/eslint-plugin": "^4.15.1",
     "@typescript-eslint/parser": "^4.15.1",
-    "async-mutex": "^0.2.6",
+    "async-mutex": "^0.3.0",
     "babel-loader": "^8.2.2",
     "babel-plugin-add-module-exports": "^1.0.4",
     "babel-plugin-transform-class-properties": "^6.24.1",
     "benchmark": "^2.1.4",
     "buffer": "^6.0.3",
     "chromedriver": "^88.0.0",
-    "core-js": "^3.8.3",
+    "core-js": "^3.9.0",
+    "crypto-browserify": "^3.12.0",
     "eslint": "^7.20.0",
     "eslint-config-airbnb": "^18.2.1",
     "eslint-config-streamr-nodejs": "^1.3.0",
     "eslint-loader": "^4.0.2",
     "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-promise": "^4.2.1",
-    "ethers": "^5.0.26",
+    "eslint-plugin-promise": "^4.3.1",
+    "ethers": "^5.0.31",
     "express": "^4.17.1",
     "geckodriver": "^1.22.1",
     "git-revision-webpack-plugin": "^3.0.6",
     "jest": "^26.6.3",
     "jest-circus": "^26.6.3",
     "nightwatch": "^1.5.1",
+    "process": "^0.11.10",
     "sinon": "^9.2.4",
-    "streamr-test-utils": "^1.3.0",
-    "terser-webpack-plugin": "^4.2.3",
-    "webpack": "^4.46.0",
+    "streamr-test-utils": "^1.3.1",
+    "terser-webpack-plugin": "^5.1.1",
+    "ts-jest": "^26.5.1",
+    "ts-loader": "^8.0.17",
+    "typescript": "^4.1.5",
+    "util": "^0.12.3",
+    "webpack": "^5.23.0",
     "webpack-bundle-analyzer": "^4.4.0",
-    "webpack-cli": "^4.4.0",
+    "webpack-cli": "^4.5.0",
     "webpack-merge": "^5.7.3"
   },
   "#IMPORTANT": "babel-runtime must be in dependencies, not devDependencies",
   "dependencies": {
+    "@babel/runtime": "^7.12.18",
+    "@babel/runtime-corejs3": "^7.12.18",
     "@ethersproject/abi": "^5.0.12",
-    "@babel/runtime": "^7.12.13",
-    "@babel/runtime-corejs3": "^7.12.13",
-    "@ethersproject/address": "^5.0.9",
-    "@ethersproject/bignumber": "^5.0.13",
-    "@ethersproject/bytes": "^5.0.9",
-    "@ethersproject/contracts": "^5.0.9",
-    "@ethersproject/keccak256": "^5.0.7",
-    "@ethersproject/providers": "^5.0.19",
-    "@ethersproject/sha2": "^5.0.7",
-    "@ethersproject/transactions": "^5.0.9",
-    "@ethersproject/wallet": "^5.0.10",
+    "@ethersproject/address": "^5.0.10",
+    "@ethersproject/bignumber": "^5.0.14",
+    "@ethersproject/bytes": "^5.0.10",
+    "@ethersproject/contracts": "^5.0.11",
+    "@ethersproject/keccak256": "^5.0.8",
+    "@ethersproject/providers": "^5.0.23",
+    "@ethersproject/sha2": "^5.0.8",
+    "@ethersproject/transactions": "^5.0.10",
+    "@ethersproject/wallet": "^5.0.11",
     "debug": "^4.3.2",
     "eventemitter3": "^4.0.7",
     "lodash.uniqueid": "^4.0.1",
@@ -114,13 +127,13 @@
     "p-queue": "^6.6.2",
     "promise-memoize": "^1.2.1",
     "qs": "^6.9.6",
-    "quick-lru": "^5.1.1",
+    "quick-lru": "^6.0.0",
     "readable-stream": "^3.6.0",
     "streamr-client-protocol": "^8.0.0-beta.2",
-    "typescript": "^4.1.4",
+    "ts-toolbelt": "^9.3.12",
     "uuid": "^8.3.2",
     "webpack-node-externals": "^2.5.2",
-    "ws": "^7.4.2"
+    "ws": "^7.4.3"
   },
   "optionalDependencies": {
     "bufferutil": "^4.0.3",

package.json

@@ -1,17 +1,64 @@
 import qs from 'qs'
-import { ControlLayer, MessageLayer } from 'streamr-client-protocol'
 import Debug from 'debug'
-
+import { ControlLayer, MessageLayer } from 'streamr-client-protocol'
+import { ExternalProvider, JsonRpcFetchFunc } from '@ethersproject/providers'
+import { BigNumber } from '@ethersproject/bignumber'
+import { O } from 'ts-toolbelt'
 import { getVersionString, counterId } from './utils'
-import { StreamrClientOptions } from './StreamrClient'
+import { Todo } from './types'
+
+export type EthereumConfig = ExternalProvider|JsonRpcFetchFunc
+
+export type StreamrClientOptions = {
+    id?: string
+    debug?: Debug.Debugger,
+    auth?: {
+        privateKey?: string
+        ethereum?: EthereumConfig
+        apiKey?: string
+        username?: string
+        password?: string
+    }
+    url?: string
+    restUrl?: string
+    streamrNodeAddress?: string
+    autoConnect?: boolean
+    autoDisconnect?: boolean
+    orderMessages?: boolean,
+    retryResendAfter?: number,
+    gapFillTimeout?: number,
+    maxGapRequests?: number,
+    maxPublishQueueSize?: number,
+    publishWithSignature?: Todo,
+    verifySignatures?: Todo,
+    publisherStoreKeyHistory?: boolean,
+    groupKeys?: Todo
+    keyExchange?: Todo
+    mainnet?: Todo
+    sidechain?: {
+        url?: string
+    },
+    dataUnion?: string
+    tokenAddress?: string,
+    minimumWithdrawTokenWei?: BigNumber|number|string,
+    sidechainTokenAddress?: string
+    factoryMainnetAddress?: string
+    factorySidechainAddress?: string
+    payForSignatureTransport?: boolean
+    cache?: {
+        maxSize?: number,
+        maxAge?: number
+    }
+}
 
+export type StreamrClientConfig = O.Compulsory<StreamrClientOptions, 'url' | 'restUrl'>
 const { ControlMessage } = ControlLayer
 const { StreamMessage } = MessageLayer
 
 export default function ClientConfig(opts: Partial<StreamrClientOptions> = {}) {
     const { id = counterId('StreamrClient') } = opts
 
-    const options: StreamrClientOptions = {
+    const defaults = {
         debug: Debug(id),
         // Authentication: identity used by this StreamrClient instance
         auth: {}, // can contain member privateKey or (window.)ethereum
@@ -39,23 +86,30 @@ export default function ClientConfig(opts: Partial<StreamrClientOptions> = {}) {
 
         // Ethereum and Data Union related options
         // For ethers.js provider params, see https://docs.ethers.io/ethers.js/v5-beta/api-providers.html#provider
-        mainnet: null, // Default to ethers.js default provider settings
+        mainnet: undefined, // Default to ethers.js default provider settings
         sidechain: {
-            // @ts-expect-error
-            url: null, // TODO: add our default public service sidechain node, also find good PoA params below
+            url: undefined, // TODO: add our default public service sidechain node, also find good PoA params below
             // timeout:
             // pollingInterval:
         },
         tokenAddress: '0x0Cf0Ee63788A0849fE5297F3407f701E122cC023',
         minimumWithdrawTokenWei: '1000000', // Threshold value set in AMB configs, smallest token amount to pass over the bridge
-        factoryMainnetAddress: 'TODO', // TODO define this value when we know it // Data Union factory that creates a new Data Union
-        factorySidechainAddress: 'TODO', // TODO define this value when we know it
+        sidechainTokenAddress: undefined, // TODO // sidechain token
+        factoryMainnetAddress: undefined, // TODO // Data Union factory that creates a new Data Union
+        factorySidechainAddress: undefined,
         payForSignatureTransport: true, // someone must pay for transporting the withdraw tx to mainnet, either us or bridge operator
-        ...opts,
         cache: {
             maxSize: 10000,
             maxAge: 30 * 60 * 1000, // 30 minutes
+        }
+    }
+
+    const options: StreamrClientConfig = {
+        ...defaults,
+        ...opts,
+        cache: {
             ...opts.cache,
+            ...defaults.cache,
         }
     }
 
@@ -91,8 +145,13 @@ export default function ClientConfig(opts: Partial<StreamrClientOptions> = {}) {
         options.auth.apiKey = options.apiKey
     }
 
-    if (options.auth!.privateKey && !options.auth!.privateKey.startsWith('0x')) {
-        options.auth!.privateKey = `0x${options.auth!.privateKey}`
+    options.auth = options.auth || {}
+
+    if ('privateKey' in options.auth) {
+        const { privateKey } = options.auth
+        if (typeof privateKey === 'string' && !privateKey.startsWith('0x')) {
+            options.auth.privateKey = `0x${options.auth!.privateKey}`
+        }
     }
 
     return options