Export public types, update DU config (#210)

Export parameters/return types for objects which are publicly available to the JS-client users.

Updated getDataUnionMainnetAddress and getDataUnionSidechainAddress in Contracts.ts to support new DataUnion addresses.

BREAKING CHANGE:
- moved DataUnion related StreamrClient options into a new dataUnion block: factoryMainnetAddress, 
- factorySidechainAddress, minimumWithdrawTokenWei
- renamed payForSignatureTransport to freeWithdraw and reversed the value
- new required options in that block: templateMainnetAddress, templateSidechainAddress

Author: teogeb

.babel.config.js

@@ -24,7 +24,7 @@ module.exports = {
     plugins: [
          "add-module-exports",
         ['@babel/plugin-transform-runtime', {
-            corejs: false,
+            corejs: 3,
             helpers: true,
             regenerator: false
         }],

.eslintignore

@@ -6,3 +6,5 @@ test/legacy/**
 src/shim/**
 test/unit/StubbedStreamrClient.js
 streamr-docker-dev/**
+vendor/**
+test/exports/**

.github/workflows/nodejs.yml

@@ -48,8 +48,6 @@ jobs:
         run: npm ci
       - name: npm run eslint
         run: npm run eslint
-      - name: test-types
-        run: npm run test-types
 
   test:
     name: Test Unit using Node ${{ matrix.node-version }}
@@ -107,7 +105,7 @@ jobs:
       - name: npm ci
         run: npm ci
       - name: Start Streamr Docker Stack
-        uses: streamr-dev/streamr-docker-dev-action@v1.0.0-alpha.2
+        uses: streamr-dev/streamr-docker-dev-action@v1.0.0-alpha.3
         with:
           services-to-start: "mysql redis engine-and-editor cassandra parity-node0 parity-sidechain-node0 bridge broker-node-storage-1 nginx smtp"
       - name: Run Test
@@ -129,7 +127,7 @@ jobs:
       - name: npm ci
         run: npm ci
       - name: Start Streamr Docker Stack
-        uses: streamr-dev/streamr-docker-dev-action@v1.0.0-alpha.2
+        uses: streamr-dev/streamr-docker-dev-action@v1.0.0-alpha.3
         with:
           services-to-start: "mysql redis engine-and-editor cassandra parity-node0 parity-sidechain-node0 bridge broker-node-storage-1 nginx smtp"
       - uses: nick-invision/retry@v2
@@ -140,6 +138,26 @@ jobs:
           retry_on: error
           command: npm run test-flakey || echo "::warning::Flakey Tests Failed"
 
+  test-exports:
+    name: Test Exports using Node 14.x
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "14.x"
+      - uses: actions/download-artifact@v2
+        with:
+          name: build
+          path: dist
+      - name: npm ci
+        run: npm ci
+      - name: test-types
+        run: npm run test-types
+      - name: npm run test-exports
+        run: npm run test-exports
+
   browser:
     name: Test Browser using Node 14.x
     runs-on: ubuntu-latest
@@ -156,7 +174,7 @@ jobs:
       - name: npm ci
         run: npm ci
       - name: Start Streamr Docker Stack
-        uses: streamr-dev/streamr-docker-dev-action@v1.0.0-alpha.2
+        uses: streamr-dev/streamr-docker-dev-action@v1.0.0-alpha.3
         with:
           services-to-start: "mysql redis engine-and-editor cassandra parity-node0 parity-sidechain-node0 bridge broker-node-storage-1 nginx smtp"
 
@@ -186,7 +204,7 @@ jobs:
           name: build
           path: dist
       - name: Start Streamr Docker Stack
-        uses: streamr-dev/streamr-docker-dev-action@v1.0.0-alpha.2
+        uses: streamr-dev/streamr-docker-dev-action@v1.0.0-alpha.3
         with:
           services-to-start: "mysql redis engine-and-editor cassandra parity-node0 parity-sidechain-node0 bridge broker-node-storage-1 nginx smtp"
       - name: npm ci
@@ -233,17 +251,20 @@ jobs:
           name: build
           path: dist
       - name: Start Streamr Docker Stack
-        uses: streamr-dev/streamr-docker-dev-action@v1.0.0-alpha.2
+        uses: streamr-dev/streamr-docker-dev-action@v1.0.0-alpha.3
         with:
           services-to-start: "mysql redis engine-and-editor cassandra parity-node0 parity-sidechain-node0 bridge broker-node-storage-1 nginx smtp"
       - name: npm ci
         run: npm ci
       - name: npm link
-        run: npm link
+        run: cd dist && npm link
       - uses: actions/checkout@v2
         with:
           repository: streamr-dev/streamr-client-testing
           path: streamr-client-testing
+      - uses: actions/setup-java@v1
+        with:
+          java-version: '8'
       - name: setup-client-testing
         working-directory: streamr-client-testing
         run: |

.gitignore

@@ -40,3 +40,6 @@ examples/webpack/dist/*
 reports
 tests_outputbenchmarks.txt
 tests_output
+test/exports/dist
+test/exports/package-lock.json
+vendor

README.md

@@ -43,10 +43,10 @@ const client = new StreamrClient({
 })
 ```
 
-When using Node.js remember to require the library with:
+When using Node.js remember to import the library with:
 
 ```js
-const StreamrClient = require('streamr-client')
+import { StreamrClient } from 'streamr-client';
 ```
 
 ### Subscribing to real-time events in a stream
@@ -329,11 +329,15 @@ This library provides functions for working with Data Unions. To get a DataUnion
 TODO: All `options`-parameters should be documented (see TypeScript interfaces for the definitions)
 
 These DataUnion-specific options are used from `StreamrClient` options:
-| Property                 | Default                                                | Description                                                                                                      |
-| :----------------------- | :----------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- |
-| tokenAddress             | 0x0Cf0Ee637<br>88A0849fE52<br>97F3407f701<br>E122cC023 | Token used by the DU                                                                                             |
-| factoryMainnetAddress    | TODO                                                   | Data Union factory that creates a new Data Union                                                                 |
-| minimumWithdrawTokenWei  | 1000000                                                | Threshold value set in AMB configs, smallest token amount that can pass over the bridge                          |
+| Property                            | Default                                                | Description                                                                                                      |
+| :---------------------------------- | :----------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- |
+| tokenAddress                        | 0x0Cf0Ee637<br>88A0849fE52<br>97F3407f701<br>E122cC023 | Token used by the DU                                                                                             |
+| dataUnion.minimumWithdrawTokenWei   | 1000000                                                | Threshold value set in AMB configs, smallest token amount that can pass over the bridge                          |
+| dataUnion.freeWithdraw              | false                                                  | true = someone else pays for the gas when transporting the withdraw tx to mainnet; false = client does the transport as self-service and pays the mainnet gas costs |
+| dataUnion.factoryMainnetAddress     | TODO                                                   | Data Union factory that creates a new Data Union                                                                 |
+| dataUnion.factorySidechainAddress   | TODO                                                   |                                                                                                                  |
+| dataUnion.templateMainnetAddress    | TODO                                                   |                                                                                                                  |
+| dataUnion.templateSidechainAddress  | TODO                                                   |                                                                                                                  |
 
 
 ### Admin Functions

copy-package.js

@@ -0,0 +1,15 @@
+const fs = require('fs')
+// eslint-disable-next-line
+const pkg = Object.assign({}, require('./package.json'))
+
+delete pkg.scripts
+
+try {
+    fs.mkdirSync('./dist/')
+} catch (err) {
+    if (err.code !== 'EEXIST') {
+        throw err
+    }
+}
+
+fs.writeFileSync('./dist/package.json', JSON.stringify(pkg, null, 2))

examples/node/node-example-produce.js

@@ -1,4 +1,4 @@
-const StreamrClient = require('streamr-client')
+import { StreamrClient } from 'streamr-client';
 
 // Create the client and supply either an API key or an Ethereum private key to authenticate
 const client = new StreamrClient({

examples/node/node-example-subscribe.js

@@ -1,4 +1,4 @@
-const StreamrClient = require('streamr-client')
+import { StreamrClient } from 'streamr-client';
 
 // Create the client and supply either an API key or an Ethereum private key to authenticate
 const client = new StreamrClient({