@agrozyme/eckey 0.0.0

package/README.md

@@ -0,0 +1,108 @@
+## Elliptic Curve Key CLI
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+
+# Usage
+
+<!-- usage -->
+```sh-session
+$ npm install -g @agrozyme/eckey
+$ eckey COMMAND
+running command...
+$ eckey (--version)
+@agrozyme/eckey/0.0.0 win32-x64 node-v16.20.1
+$ eckey --help [COMMAND]
+USAGE
+  $ eckey COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+
+<!-- commands -->
+* [`eckey convert`](#eckey-convert)
+* [`eckey help [COMMANDS]`](#eckey-help-commands)
+* [`eckey make`](#eckey-make)
+
+## `eckey convert`
+
+convert string to other format
+
+```
+USAGE
+  $ eckey convert --data <value> [--from
+    base16|base32|base32crockford|base32hex|base58|base58check|base58flickr|base58xmr|base58xrp|base64|base64url|hex|utf
+    8] [--to base16|base32|base32crockford|base32hex|base58|base58check|base58flickr|base58xmr|base58xrp|base64|base64ur
+    l|hex|utf8]
+
+FLAGS
+  --data=<value>   (required)
+  --from=<option>  [default: hex]
+                   <options: base16|base32|base32crockford|base32hex|base58|base58check|base58flickr|base58xmr|base58xrp
+                   |base64|base64url|hex|utf8>
+  --to=<option>    [default: hex]
+                   <options: base16|base32|base32crockford|base32hex|base58|base58check|base58flickr|base58xmr|base58xrp
+                   |base64|base64url|hex|utf8>
+
+DESCRIPTION
+  convert string to other format
+
+EXAMPLES
+  $ eckey convert
+```
+
+_See code: [dist/commands/convert.ts](https://gitlab.com/agrozyme-package/TypeScript/eckey/blob/v0.0.0/dist/commands/convert.ts)_
+
+## `eckey help [COMMANDS]`
+
+Display help for eckey.
+
+```
+USAGE
+  $ eckey help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for eckey.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.11/src/commands/help.ts)_
+
+## `eckey make`
+
+make elliptic curve key pair
+
+```
+USAGE
+  $ eckey make --curve
+    bls12_381|bn254|ed448|ed448ph|ed25519|ed25519ctx|ed25519ph|jubjub|p256|p384|p521|pallas|schnorr|secp256k1|secp256r1|
+    secp384r1|secp521r1|vesta [--format base16|base32|base32crockford|base32hex|base58|base58check|base58flickr|base58xm
+    r|base58xrp|base64|base64url|hex|utf8] [--count <value>]
+
+FLAGS
+  --count=<value>    [default: 1]
+  --curve=<option>   (required)
+                     <options: bls12_381|bn254|ed448|ed448ph|ed25519|ed25519ctx|ed25519ph|jubjub|p256|p384|p521|pallas|s
+                     chnorr|secp256k1|secp256r1|secp384r1|secp521r1|vesta>
+  --format=<option>  [default: hex]
+                     <options: base16|base32|base32crockford|base32hex|base58|base58check|base58flickr|base58xmr|base58x
+                     rp|base64|base64url|hex|utf8>
+
+DESCRIPTION
+  make elliptic curve key pair
+
+EXAMPLES
+  $ eckey make
+```
+
+_See code: [dist/commands/make.ts](https://gitlab.com/agrozyme-package/TypeScript/eckey/blob/v0.0.0/dist/commands/make.ts)_
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/dist/commands/convert.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export default class Convert extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        data: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        from: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        to: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {};
+    run(): Promise<void>;
+}

package/dist/commands/convert.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const crypto_1 = require("@agrozyme/crypto");
+const core_1 = require("@oclif/core");
+const types_1 = require("../types");
+class Convert extends core_1.Command {
+    static description = 'convert string to other format';
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        data: core_1.Flags.string({ required: true }),
+        from: core_1.Flags.string({ options: types_1.bytesCoderKeys, default: 'hex' }),
+        to: core_1.Flags.string({ options: types_1.bytesCoderKeys, default: 'hex' }),
+    };
+    static args = {};
+    async run() {
+        const { args, flags } = await this.parse(Convert);
+        const { data, from, to } = flags;
+        const fromConveter = crypto_1.bytesCoderMap[from];
+        const toConveter = crypto_1.bytesCoderMap[to];
+        const items = fromConveter.decode(data);
+        const result = toConveter.encode(items);
+        console.info(`Convert data form ${from} to ${to}:`);
+        console.dir({ data, result });
+    }
+}
+exports.default = Convert;

package/dist/commands/make.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export default class Make extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        curve: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        count: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {};
+    run(): Promise<void>;
+}

package/dist/commands/make.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const crypto_1 = require("@agrozyme/crypto");
+const core_1 = require("@oclif/core");
+const types_1 = require("../types");
+class Make extends core_1.Command {
+    static description = 'make elliptic curve key pair';
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        curve: core_1.Flags.string({ required: true, options: types_1.curveKeys }),
+        format: core_1.Flags.string({ options: types_1.bytesCoderKeys, default: 'hex' }),
+        count: core_1.Flags.integer({ min: 1, default: 1 }),
+    };
+    static args = {};
+    async run() {
+        const { args, flags } = await this.parse(Make);
+        const curve = crypto_1.curveMap[flags.curve];
+        const keyConveter = crypto_1.bytesCoderMap[flags.format];
+        const items = [];
+        for (let index = 0; index < flags.count; index++) {
+            const privateKey = curve.randomPrivateKey();
+            const publicKey = curve.getPublicKey(privateKey, true);
+            const item = { privateKey: keyConveter.encode(privateKey), publicKey: keyConveter.encode(publicKey) };
+            items.push(item);
+        }
+        console.log(`make ${flags.curve} curve ${flags.count} keypair(s) with ${flags.format} format:`);
+        console.dir(items);
+    }
+}
+exports.default = Make;

package/dist/commands/test.d.ts

@@ -0,0 +1,9 @@
+import { Command } from '@oclif/core';
+export default class Test extends Command {
+    static hidden: boolean;
+    static description: string;
+    static examples: string[];
+    static flags: {};
+    static args: {};
+    run(): Promise<void>;
+}

package/dist/commands/test.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+class Test extends core_1.Command {
+    static hidden = true;
+    static description = 'test the command here';
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {};
+    static args = {};
+    async run() {
+        const { args, flags } = await this.parse(Test);
+        //    console.dir(bytesCoderMap, { depth: 0 });
+    }
+}
+exports.default = Test;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/dist/types.d.ts

@@ -0,0 +1,2 @@
+export declare const bytesCoderKeys: string[];
+export declare const curveKeys: string[];

package/dist/types.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.curveKeys = exports.bytesCoderKeys = void 0;
+const crypto_1 = require("@agrozyme/crypto");
+exports.bytesCoderKeys = Object.keys(crypto_1.bytesCoderMap);
+exports.curveKeys = Object.keys(crypto_1.curveMap);

package/oclif.manifest.json

@@ -0,0 +1,151 @@
+{
+  "version": "0.0.0",
+  "commands": {
+    "convert": {
+      "id": "convert",
+      "description": "convert string to other format",
+      "strict": true,
+      "pluginName": "@agrozyme/eckey",
+      "pluginAlias": "@agrozyme/eckey",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "data": {
+          "name": "data",
+          "type": "option",
+          "required": true,
+          "multiple": false
+        },
+        "from": {
+          "name": "from",
+          "type": "option",
+          "multiple": false,
+          "options": [
+            "base16",
+            "base32",
+            "base32crockford",
+            "base32hex",
+            "base58",
+            "base58check",
+            "base58flickr",
+            "base58xmr",
+            "base58xrp",
+            "base64",
+            "base64url",
+            "hex",
+            "utf8"
+          ],
+          "default": "hex"
+        },
+        "to": {
+          "name": "to",
+          "type": "option",
+          "multiple": false,
+          "options": [
+            "base16",
+            "base32",
+            "base32crockford",
+            "base32hex",
+            "base58",
+            "base58check",
+            "base58flickr",
+            "base58xmr",
+            "base58xrp",
+            "base64",
+            "base64url",
+            "hex",
+            "utf8"
+          ],
+          "default": "hex"
+        }
+      },
+      "args": {}
+    },
+    "make": {
+      "id": "make",
+      "description": "make elliptic curve key pair",
+      "strict": true,
+      "pluginName": "@agrozyme/eckey",
+      "pluginAlias": "@agrozyme/eckey",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "curve": {
+          "name": "curve",
+          "type": "option",
+          "required": true,
+          "multiple": false,
+          "options": [
+            "bls12_381",
+            "bn254",
+            "ed448",
+            "ed448ph",
+            "ed25519",
+            "ed25519ctx",
+            "ed25519ph",
+            "jubjub",
+            "p256",
+            "p384",
+            "p521",
+            "pallas",
+            "schnorr",
+            "secp256k1",
+            "secp256r1",
+            "secp384r1",
+            "secp521r1",
+            "vesta"
+          ]
+        },
+        "format": {
+          "name": "format",
+          "type": "option",
+          "multiple": false,
+          "options": [
+            "base16",
+            "base32",
+            "base32crockford",
+            "base32hex",
+            "base58",
+            "base58check",
+            "base58flickr",
+            "base58xmr",
+            "base58xrp",
+            "base64",
+            "base64url",
+            "hex",
+            "utf8"
+          ],
+          "default": "hex"
+        },
+        "count": {
+          "name": "count",
+          "type": "option",
+          "multiple": false,
+          "default": 1
+        }
+      },
+      "args": {}
+    },
+    "test": {
+      "id": "test",
+      "description": "test the command here",
+      "strict": true,
+      "pluginName": "@agrozyme/eckey",
+      "pluginAlias": "@agrozyme/eckey",
+      "pluginType": "core",
+      "hidden": true,
+      "aliases": [],
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {},
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@agrozyme/eckey",
+  "version": "0.0.0",
+  "description": "Elliptic Curve Key CLI",
+  "author": "",
+  "bin": {
+    "eckey": "./bin/run"
+  },
+  "homepage": "https://gitlab.com/agrozyme-package/TypeScript/eckey",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": "https://gitlab.com/agrozyme-package/TypeScript/eckey.git",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@agrozyme/crypto": "^1",
+    "@oclif/core": "^2",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^3"
+  },
+  "devDependencies": {
+    "@oclif/test": "^2",
+    "@types/chai": "^4",
+    "@types/jasmine": "^4",
+    "@types/node": "^16",
+    "chai": "^4",
+    "jasmine": "^5",
+    "oclif": "^3",
+    "pkg": "^5",
+    "shx": "^0",
+    "ts-node": "^10",
+    "ts-node-test-register": "^10",
+    "tslib": "^2",
+    "typescript": "^5",
+    "yarpm": "^1"
+  },
+  "oclif": {
+    "bin": "eckey",
+    "dirname": "eckey",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help"
+    ],
+    "topicSeparator": ":"
+  },
+  "pkg": {
+    "scripts": "dist/**/*.js",
+    "assets": "assets/**/*",
+    "outputPath": "package",
+    "targets": [
+      "node16-win",
+      "node16-linux",
+      "node16-macos"
+    ]
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "bugs": "https://gitlab.com/agrozyme-package/TypeScript/eckey/issues",
+  "keywords": [
+    "oclif"
+  ],
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "clean": "shx rm -rf dist/ tmp/ package/ && shx rm -f *-debug.log *-error.log .*-debug.log .*-error.log *.tsbuildinfo *.manifest.json",
+    "clean:pack": "shx rm -f *.tgz npm-shrinkwrap.json",
+    "clean:lock": "shx rm -f package-lock.json yarn.lock pnpm-lock.yaml",
+    "clean:all": "yarpm run clean && yarpm run clean:pack && yarpm run clean:lock",
+    "build": "yarpm run clean && tsc --build --force && shx cp -R ./src/assets ./dist",
+    "test": "jasmine --require=ts-node-test-register test/**/*.ts",
+    "oclif:readme": "yarpm run build && oclif readme",
+    "oclif:pack": "yarn generate-lock-entry > yarn.lock && oclif pack",
+    "package": "yarpm run build && pkg --no-bytecode --public --public-packages=* --compress=GZip .",
+    "dev": "node ./bin/dev",
+    "start": "node ./bin/run"
+  }
+}