@streamr/cli-tools 5.0.1 → 6.0.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamr/cli-tools",
-  "version": "5.0.1",
+  "version": "6.0.0-alpha.0",
   "description": "Command line tools for Streamr.",
   "bin": {
     "streamr": "dist/bin/streamr.js"
@@ -13,7 +13,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:streamr-dev/cli-tools.git"
+    "url": "git+https://github.com/streamr-dev/network-monorepo.git",
+    "directory": "packages/cli-tools"
   },
   "keywords": [
     "streamr",
@@ -30,19 +31,20 @@
   "dependencies": {
     "commander": "^7.2.0",
     "easy-table": "^1.1.1",
+    "ethers": "^5.3.1",
     "event-stream": "^4.0.1",
-    "streamr-client": "^5.4.2"
+    "streamr-client": "6.0.0-alpha.17"
   },
   "devDependencies": {
     "@streamr/dev-config": "^1.0.0",
     "@types/easy-table": "0.0.32",
     "@types/event-stream": "^3.3.34",
-    "@types/jest": "^26.0.23",
-    "@typescript-eslint/eslint-plugin": "^4.24.0",
-    "@typescript-eslint/parser": "^4.24.0",
-    "eslint": "^7.26.0",
-    "eslint-config-streamr-ts": "^3.0.1",
+    "@types/jest": "^27.0.1",
+    "@typescript-eslint/eslint-plugin": "^4.31.2",
+    "@typescript-eslint/parser": "^4.31.2",
+    "eslint": "^7.32.0",
+    "eslint-config-streamr-ts": "^4.0.1",
     "eslint-plugin-promise": "^5.1.0",
-    "typescript": "^4.2.4"
+    "typescript": "^4.3.4"
   }
 }

package/src/create.ts

@@ -1,11 +1,14 @@
 import { StreamProperties, StreamrClient, StreamrClientOptions} from 'streamr-client'
 
-export const create = (body: Partial<StreamProperties>, streamrOptions: StreamrClientOptions): void => {
+export const create = (
+    // id is required
+    body: Partial<StreamProperties> & Required<Pick<StreamProperties, "id">>,
+    streamrOptions: StreamrClientOptions
+): void => {
     const options = { ...streamrOptions }
 
     const client = new StreamrClient(options)
     client.createStream(body).then((stream) => {
-        // @ts-expect-error TODO: toObject() is internal in streamr-client-javascript
         console.info(JSON.stringify(stream.toObject(), null, 2))
         process.exit(0)
         return true

package/src/publish.ts

@@ -35,8 +35,7 @@ export const publishStream = (
         }
     })
 
-    client.on('error', (err) => writable.emit('error', err))
-    // disconnect client when upstream pipe ends and data flushed
-    writable.once('finish', () => client.ensureDisconnected())
+    // destroy client when upstream pipe ends and data flushed
+    writable.once('finish', () => client.destroy())
     return writable
 }

package/src/resend.ts

@@ -8,7 +8,6 @@ export const resend = async (
     const options = { ...streamrOptions }
     const client = new StreamrClient(options)
 
-    let sub
     try {
         const subscribeOpts = {
             stream: streamId,
@@ -19,29 +18,12 @@ export const resend = async (
         }
 
         if (options.subscribe) {
-            sub = await client.subscribe(subscribeOpts, handler)
+            await client.subscribe(subscribeOpts, handler)
         } else {
-            sub = await client.resend(subscribeOpts, handler)
+            await client.resend(subscribeOpts, handler)
         }
     } catch (err) {
         console.error(err.message ? err.message : err)
         process.exit(1)
     }
-
-    sub.on('error', (err: any) => {
-        console.error(err)
-        process.exit(1)
-    })
-
-    sub.on('resent', () => {
-        if (!options.subscribe) {
-            process.exit(0)
-        }
-    })
-
-    sub.on('no_resend', () => {
-        if (!options.subscribe) {
-            process.exit(0)
-        }
-    })
 }

package/src/show.ts

@@ -8,9 +8,9 @@ export const show = (
     const options = { ...streamrOptions }
     const client = new StreamrClient(options)
     client.getStream(streamId).then(async (stream) => {
-        // @ts-expect-error accessing internal method, should be made public perhaps?
         const obj = stream.toObject()
         if (includePermissions) {
+            // @ts-expect-error permissions not on {}
             obj.permissions = await stream.getPermissions()
         }
         console.info(JSON.stringify(obj, null, 2))

package/src/subscribe.ts

@@ -1,9 +1,9 @@
 import { StreamrClient, StreamrClientOptions } from 'streamr-client'
 
-export const subscribe = (stream: string, partition: number, streamrOptions: StreamrClientOptions): void => {
+export const subscribe = (streamId: string, streamPartition: number, streamrOptions: StreamrClientOptions): void => {
     const options = { ...streamrOptions }
     new StreamrClient(options).subscribe({
-        stream,
-        partition,
+        streamId,
+        streamPartition,
     }, (message) => console.info(JSON.stringify(message)))
 }

package/dist/commands/common.js

@@ -1,76 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFnParseInt = exports.formStreamrOptionsWithEnv = exports.exitWithHelpIfArgsNotBetween = exports.authOptions = exports.envOptions = void 0;
-function envOptions(program) {
-    return program
-        .option('--dev', 'use pre-defined development environment')
-        .option('--stg', 'use pre-defined staging environment')
-        .option('--ws-url <url>', 'alternative websocket url to use')
-        .option('--http-url <url>', 'alternative http url to use');
-}
-exports.envOptions = envOptions;
-function authOptions(program) {
-    return program
-        .option('--private-key <key>', 'use an Ethereum private key to authenticate')
-        .option('--api-key <key>', 'use an API key to authenticate (deprecated)');
-}
-exports.authOptions = authOptions;
-function exitWithHelpIfArgsNotBetween(program, min, max) {
-    if (program.args.length < min || program.args.length > max) {
-        program.help();
-    }
-}
-exports.exitWithHelpIfArgsNotBetween = exitWithHelpIfArgsNotBetween;
-function formStreamrOptionsWithEnv({ dev, stg, wsUrl, httpUrl, privateKey, apiKey }) {
-    const options = {};
-    if (dev && stg) {
-        console.error('flags --dev and --stg cannot be enabled at the same time');
-        process.exit(1);
-    }
-    if (dev) {
-        options.url = 'ws://localhost/api/v1/ws';
-        options.restUrl = 'http://localhost/api/v1';
-        options.storageNode = {
-            // "broker-node-storage-1" on Docker environment
-            address: '0xde1112f631486CfC759A50196853011528bC5FA0',
-            url: 'http://10.200.10.1:8891'
-        };
-    }
-    else if (stg) {
-        options.url = 'wss://staging.streamr.com/api/v1/ws';
-        options.restUrl = 'https://staging.streamr.com/api/v1/';
-    }
-    if (wsUrl) {
-        options.url = wsUrl;
-    }
-    if (httpUrl) {
-        options.restUrl = httpUrl;
-    }
-    if (privateKey && apiKey) {
-        console.error('flags --privateKey and --apiKey cannot be used at the same time');
-        process.exit(1);
-    }
-    if (privateKey) {
-        options.auth = {
-            privateKey
-        };
-    }
-    else if (apiKey) {
-        options.auth = {
-            apiKey
-        };
-    }
-    return options;
-}
-exports.formStreamrOptionsWithEnv = formStreamrOptionsWithEnv;
-function createFnParseInt(name) {
-    return (str) => {
-        const n = parseInt(str, 10);
-        if (isNaN(n)) {
-            console.error(`${name} must be an integer (was "${str}")`);
-            process.exit(1);
-        }
-        return n;
-    };
-}
-exports.createFnParseInt = createFnParseInt;

package/dist/commands/streamor.js

@@ -1,16 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const package_json_1 = __importDefault(require("../package.json"));
-commander_1.program
-    .version(package_json_1.default.version)
-    .usage('<command> <subcommand> [<args>]')
-    .description('command line tools for interacting with Streamr https://streamr.network')
-    .command('stream', 'stream subcommands')
-    .command('storage-node', 'storage node subcommands')
-    .command('mock-data', 'mock data subcommands')
-    .parse(process.argv);

package/dist/commands/streamr-mock-data-generate.js

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const generate_1 = require("../src/generate");
-const common_1 = require("./common");
-const package_json_1 = __importDefault(require("../package.json"));
-const program = new commander_1.Command();
-program
-    .description('generate and print semi-random JSON data to stdout')
-    .option('-r, --rate <n>', 'rate in milliseconds', common_1.createFnParseInt('--rate'), 500)
-    .version(package_json_1.default.version)
-    .action((options) => {
-    generate_1.generate(options.rate);
-})
-    .parse(process.argv);
-common_1.exitWithHelpIfArgsNotBetween(program, 0, 0);

package/dist/commands/streamr-mock-data.js

@@ -1,14 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const package_json_1 = __importDefault(require("../package.json"));
-commander_1.program
-    .version(package_json_1.default.version)
-    .usage('<command> [<args>]')
-    .description('mock-data subcommands')
-    .command('generate', 'generate JSON data')
-    .parse(process.argv);

package/dist/commands/streamr-storage-node-add-stream.js

@@ -1,24 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const streamr_client_1 = require("streamr-client");
-const common_1 = require("./common");
-const package_json_1 = __importDefault(require("../package.json"));
-const program = new commander_1.Command();
-program
-    .arguments('<storageNodeAddress> <streamId>')
-    .description('add stream to a storage node');
-common_1.authOptions(program);
-common_1.envOptions(program)
-    .version(package_json_1.default.version)
-    .action((storageNodeAddress, streamId, options) => {
-    const client = new streamr_client_1.StreamrClient(common_1.formStreamrOptionsWithEnv(options));
-    client.getStream(streamId)
-        .then((stream) => stream.addToStorageNode(storageNodeAddress));
-})
-    .parse(process.argv);
-common_1.exitWithHelpIfArgsNotBetween(program, 2, 2);

package/dist/commands/streamr-storage-node-list-stream-parts.js

@@ -1,32 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const streamr_client_1 = require("streamr-client");
-const common_1 = require("./common");
-const package_json_1 = __importDefault(require("../package.json"));
-const easy_table_1 = __importDefault(require("easy-table"));
-const program = new commander_1.Command();
-program
-    .arguments('<storageNodeAddress>')
-    .description('list streams parts in a storage node');
-common_1.authOptions(program);
-common_1.envOptions(program)
-    .version(package_json_1.default.version)
-    .action((storageNodeAddress, options) => {
-    const client = new streamr_client_1.StreamrClient(common_1.formStreamrOptionsWithEnv(options));
-    client.getStreamPartsByStorageNode(storageNodeAddress)
-        .then((streamParts) => {
-        if (streamParts.length > 0) {
-            console.info(easy_table_1.default.print(streamParts.map((streamPart) => ({
-                streamId: streamPart.getStreamId(),
-                streamPartition: streamPart.getStreamPartition()
-            }))));
-        }
-    });
-})
-    .parse(process.argv);
-common_1.exitWithHelpIfArgsNotBetween(program, 1, 1);

package/dist/commands/streamr-storage-node-list.js

@@ -1,44 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const streamr_client_1 = require("streamr-client");
-const common_1 = require("./common");
-const package_json_1 = __importDefault(require("../package.json"));
-const easy_table_1 = __importDefault(require("easy-table"));
-const getStorageNodes = async (streamId, client) => {
-    if (streamId !== undefined) {
-        return client.getStream(streamId)
-            .then(stream => stream.getStorageNodes())
-            .then(storegeNodes => {
-            return storegeNodes.map(storageNode => storageNode.getAddress());
-        });
-    }
-    else {
-        // all storage nodes (currently there is only one)
-        // @ts-expect-error
-        return [client.options.storageNode.address];
-    }
-};
-const program = new commander_1.Command();
-program
-    .description('fetch a list of storage nodes')
-    .option('-s, --stream <streamId>', 'only storage nodes which store the given stream (needs authentication)');
-common_1.authOptions(program);
-common_1.envOptions(program)
-    .version(package_json_1.default.version)
-    .action((options) => {
-    const client = new streamr_client_1.StreamrClient(common_1.formStreamrOptionsWithEnv(options));
-    getStorageNodes(options.stream, client).then((addresses) => {
-        if (addresses.length > 0) {
-            console.info(easy_table_1.default.print(addresses.map((address) => ({
-                address
-            }))));
-        }
-    });
-})
-    .parse(process.argv);
-common_1.exitWithHelpIfArgsNotBetween(program, 0, 0);

package/dist/commands/streamr-storage-node-remove-stream.js

@@ -1,24 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const streamr_client_1 = require("streamr-client");
-const common_1 = require("./common");
-const package_json_1 = __importDefault(require("../package.json"));
-const program = new commander_1.Command();
-program
-    .arguments('<storageNodeAddress> <streamId>')
-    .description('remove stream from a storage node');
-common_1.authOptions(program);
-common_1.envOptions(program)
-    .version(package_json_1.default.version)
-    .action((storageNodeAddress, streamId, options) => {
-    const client = new streamr_client_1.StreamrClient(common_1.formStreamrOptionsWithEnv(options));
-    client.getStream(streamId)
-        .then((stream) => stream.removeFromStorageNode(storageNodeAddress));
-})
-    .parse(process.argv);
-common_1.exitWithHelpIfArgsNotBetween(program, 2, 2);

package/dist/commands/streamr-storage-node.js

@@ -1,17 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const package_json_1 = __importDefault(require("../package.json"));
-commander_1.program
-    .version(package_json_1.default.version)
-    .usage('<command> [<args>]')
-    .description('storage node subcommands')
-    .command('list', 'list storage nodes')
-    .command('add-stream', 'add stream')
-    .command('remove-stream', 'remove stream')
-    .command('list-stream-parts', 'list stream parts in a storage node')
-    .parse(process.argv);

package/dist/commands/streamr-stream-create.js

@@ -1,31 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const create_1 = require("../src/create");
-const common_1 = require("./common");
-const package_json_1 = __importDefault(require("../package.json"));
-const program = new commander_1.Command();
-program
-    .arguments('<name>')
-    .description('create a new stream')
-    .option('-d, --description <description>', 'define a description')
-    .option('-c, --config <config>', 'define a configuration as JSON', (s) => JSON.parse(s))
-    .option('-p, --partitions <count>', 'define a partition count', common_1.createFnParseInt('--partitions'));
-common_1.authOptions(program);
-common_1.envOptions(program)
-    .version(package_json_1.default.version)
-    .action((name, options) => {
-    const body = {
-        name,
-        description: options.description,
-        config: options.config,
-        partitions: options.partitions
-    };
-    create_1.create(body, common_1.formStreamrOptionsWithEnv(options));
-})
-    .parse(process.argv);
-common_1.exitWithHelpIfArgsNotBetween(program, 1, 1);

package/dist/commands/streamr-stream-grant-permission.js

@@ -1,62 +0,0 @@
-#!/usr/bin/env node -r ts-node/register
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const common_1 = require("./common");
-const package_json_1 = __importDefault(require("../package.json"));
-const streamr_client_1 = require("streamr-client");
-const easy_table_1 = __importDefault(require("easy-table"));
-const PUBLIC_PERMISSION_ID = 'public';
-const OPERATION_PREFIX = 'stream_';
-const getOperation = (id) => {
-    // we support both short ids (e.g. "publish"), and long ids (e.g. "stream_publish")
-    // the actual StreamOperation constant is the long id string
-    // backend does the validation of invalid constants
-    if (!id.startsWith(OPERATION_PREFIX)) {
-        return (OPERATION_PREFIX + id);
-    }
-    else {
-        return id;
-    }
-};
-const getShortOperationId = (operation) => {
-    const longOperationId = operation;
-    if (longOperationId.startsWith(OPERATION_PREFIX)) {
-        return longOperationId.substring(OPERATION_PREFIX.length);
-    }
-    else {
-        throw new Error(`Assertion failed: unknown prefix for in ${longOperationId}`);
-    }
-};
-const getTarget = (user) => {
-    if (user === PUBLIC_PERMISSION_ID) {
-        return undefined;
-    }
-    else {
-        return user;
-    }
-};
-const program = new commander_1.Command();
-program
-    .arguments('<streamId> <user> <operations...>')
-    .description('grant permission: use keyword "public" as a user to grant a public permission');
-common_1.authOptions(program);
-common_1.envOptions(program)
-    .version(package_json_1.default.version)
-    .action(async (streamId, user, operationIds, options) => {
-    const operations = operationIds.map((o) => getOperation(o));
-    const target = getTarget(user);
-    const client = new streamr_client_1.StreamrClient(common_1.formStreamrOptionsWithEnv(options));
-    const stream = await client.getStream(streamId);
-    const tasks = operations.map((operation) => stream.grantPermission(operation, target));
-    const permissions = await Promise.all(tasks);
-    console.info(easy_table_1.default.print(permissions.map((permission) => ({
-        id: permission.id,
-        operation: getShortOperationId(permission.operation),
-        user: permission.anonymous ? PUBLIC_PERMISSION_ID : permission.user
-    }))));
-})
-    .parseAsync(process.argv);

package/dist/commands/streamr-stream-list.js

@@ -1,33 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const list_1 = require("../src/list");
-const common_1 = require("./common");
-const package_json_1 = __importDefault(require("../package.json"));
-const program = new commander_1.Command();
-program
-    .description('fetch a list of streams that are accessible by the authenticated user')
-    .option('-s, --search [term]', 'search for term in name or description')
-    // TODO could support shorter forms of operations: e.g. "publish" instead of "stream_publish", see streamr-stream-grant-permission.ts
-    .addOption(new commander_1.Option('-o, --operation [permission]', 'filter by permission').choices(['stream_get', 'stream_subscribe', 'stream_publish', 'stream_delete', 'stream_share']).default('stream_get'))
-    .option('--public-access', 'include publicly available streams')
-    .option('--no-granted-access', 'exclude streams that user has directly granted permissions to');
-common_1.authOptions(program);
-common_1.envOptions(program)
-    .version(package_json_1.default.version)
-    .action((options) => {
-    const query = {
-        operation: options.operation,
-        noConfig: true,
-        publicAccess: options.publicAccess,
-        search: options.search,
-        grantedAccess: options.grantedAccess
-    };
-    list_1.list(query, common_1.formStreamrOptionsWithEnv(options));
-})
-    .parse(process.argv);
-common_1.exitWithHelpIfArgsNotBetween(program, 0, 0);

package/dist/commands/streamr-stream-publish.js

@@ -1,32 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const event_stream_1 = __importDefault(require("event-stream"));
-const publish_1 = require("../src/publish");
-const common_1 = require("./common");
-const package_json_1 = __importDefault(require("../package.json"));
-const program = new commander_1.Command();
-program
-    .arguments('<streamId>')
-    .description('publish to a stream by reading JSON messages from stdin line-by-line')
-    .option('-k, --partition-key <string>', 'field name in each message to use for assigning the message to a stream partition');
-common_1.authOptions(program);
-common_1.envOptions(program)
-    .version(package_json_1.default.version)
-    .action((streamId, options) => {
-    const ps = publish_1.publishStream(streamId, options.partitionKey, common_1.formStreamrOptionsWithEnv(options));
-    process.stdin
-        .pipe(event_stream_1.default.split())
-        .pipe(ps)
-        .on('error', (err) => {
-        console.error(err);
-        process.exit(1);
-        // process.stdin.pipe(ps) recover pipe to continue execution
-    });
-})
-    .parse(process.argv);
-common_1.exitWithHelpIfArgsNotBetween(program, 1, 1);