@ocap/mcrypto 1.17.2 → 1.17.3

package/lib/encode.d.ts

@@ -1,2 +1,9 @@
+/// <reference types="node" />
 import { BytesType, EncodingType } from '@ocap/util';
-export default function encode(data: BytesType, encoding?: EncodingType): BytesType;
+export declare function encode(data: BytesType, encoding?: 'hex'): string;
+export declare function encode(data: BytesType, encoding?: 'base16'): string;
+export declare function encode(data: BytesType, encoding?: 'base58'): string;
+export declare function encode(data: BytesType, encoding?: 'base64'): string;
+export declare function encode(data: BytesType, encoding?: 'buffer'): Buffer;
+export declare function encode(data: BytesType, encoding?: 'Uint8Array'): Uint8Array;
+export declare function encode(data: BytesType, encoding?: EncodingType): BytesType;

package/lib/encode.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.encode = void 0;
 const util_1 = require("@ocap/util");
 function encode(data, encoding = 'hex') {
     if (['hex', 'base16'].includes(encoding)) {
@@ -19,4 +20,4 @@ function encode(data, encoding = 'hex') {
     }
     return data;
 }
-exports.default = encode;
+exports.encode = encode;

package/lib/hasher/keccak.js

@@ -7,7 +7,7 @@ exports.KeccakHasher = void 0;
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 const js_sha3_1 = __importDefault(require("js-sha3"));
 const util_1 = require("@ocap/util");
-const encode_1 = __importDefault(require("../encode"));
+const encode_1 = require("../encode");
 /**
  * Keccak support with different hash length
  *
@@ -34,7 +34,7 @@ class KeccakHasher {
                     // Do nothing
                 }
                 const res = hashFn(input, round);
-                return (0, encode_1.default)(`0x${res}`, encoding);
+                return (0, encode_1.encode)(`0x${res}`, encoding);
             };
         });
     }

package/lib/hasher/sha2.js

@@ -1,13 +1,10 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Sha2Hasher = void 0;
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 const util_1 = require("@ocap/util");
 const hash_js_1 = require("hash.js");
-const encode_1 = __importDefault(require("../encode"));
+const encode_1 = require("../encode");
 const hashFns = {
     sha224: hash_js_1.sha224,
     sha256: hash_js_1.sha256,
@@ -40,7 +37,7 @@ class Sha2Hasher {
             };
             this[name] = (data, round = 2, encoding = 'hex') => {
                 const res = hashFn(data, round);
-                return (0, encode_1.default)(res, encoding);
+                return (0, encode_1.encode)(res, encoding);
             };
         });
     }

package/lib/hasher/sha3.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Sha3Hasher = void 0;
 const js_sha3_1 = __importDefault(require("js-sha3"));
 const util_1 = require("@ocap/util");
-const encode_1 = __importDefault(require("../encode"));
+const encode_1 = require("../encode");
 /**
  * Sha3 support with different hash length
  *
@@ -34,7 +34,7 @@ class Sha3Hasher {
                     // Do nothing
                 }
                 const res = hashFn(input, round);
-                return (0, encode_1.default)(`0x${res}`, encoding);
+                return (0, encode_1.encode)(`0x${res}`, encoding);
             };
         });
     }

package/lib/index.d.ts

@@ -1,19 +1,41 @@
+/// <reference types="node" />
 import { BytesType, EncodingType, KeyPairType } from '@ocap/util';
-export declare type KeyType = 'ED25519' | 'SECP256K1' | 'ETHEREUM';
-export declare type HashType = 'KECCAK' | 'SHA3' | 'KECCAK_384' | 'SHA3_384' | 'KECCAK_512' | 'SHA3_512' | 'SHA2';
-export declare type RoleType = 'ROLE_ACCOUNT' | 'ROLE_NODE' | 'ROLE_DEVICE' | 'ROLE_APPLICATION' | 'ROLE_SMART_CONTRACT' | 'ROLE_BOT' | 'ROLE_ASSET' | 'ROLE_STAKE' | 'ROLE_VALIDATOR' | 'ROLE_GROUP' | 'ROLE_GROUP' | 'ROLE_TX' | 'ROLE_TETHER' | 'ROLE_SWAP' | 'ROLE_DELEGATION' | 'ROLE_VC' | 'ROLE_BLOCKLET' | 'ROLE_REGISTRY' | 'ROLE_TOKEN' | 'ROLE_FACTORY' | 'ROLE_ROLLUP' | 'ROLE_ANY';
-export declare type AddressType = 'BASE16' | 'BASE58';
-export declare type HasherType = (data: BytesType, round: number, encoding?: EncodingType) => BytesType;
-export declare type SignerType = {
-    genKeyPair: (encoding?: EncodingType, seed?: BytesType) => KeyPairType;
-    getPublicKey: (sk: BytesType, encoding?: EncodingType) => BytesType;
-    sign: (data: BytesType, sk: BytesType, encoding?: EncodingType) => BytesType;
-    verify: (data: BytesType, pk: BytesType, signature: BytesType) => boolean;
-    ethHash?: (data: string) => string;
-    ethSign?: (data: BytesType, sk: BytesType) => string;
-    ethVerify?: (data: BytesType, pk: BytesType, signature: BytesType) => boolean;
-    ethRecover?: (hash: BytesType, signature: BytesType) => string;
-};
+import { LiteralUnion } from 'type-fest';
+export declare type KeyType = LiteralUnion<'ED25519' | 'SECP256K1' | 'ETHEREUM', string>;
+export declare type HashType = LiteralUnion<'KECCAK' | 'SHA3' | 'KECCAK_384' | 'SHA3_384' | 'KECCAK_512' | 'SHA3_512' | 'SHA2', string>;
+export declare type RoleType = LiteralUnion<'ROLE_ACCOUNT' | 'ROLE_NODE' | 'ROLE_DEVICE' | 'ROLE_APPLICATION' | 'ROLE_SMART_CONTRACT' | 'ROLE_BOT' | 'ROLE_ASSET' | 'ROLE_STAKE' | 'ROLE_VALIDATOR' | 'ROLE_GROUP' | 'ROLE_GROUP' | 'ROLE_TX' | 'ROLE_TETHER' | 'ROLE_SWAP' | 'ROLE_DELEGATION' | 'ROLE_VC' | 'ROLE_BLOCKLET' | 'ROLE_REGISTRY' | 'ROLE_TOKEN' | 'ROLE_FACTORY' | 'ROLE_ROLLUP' | 'ROLE_ANY', string>;
+export declare type AddressType = LiteralUnion<'BASE16' | 'BASE58', string>;
+export interface HashFnType {
+    (data: BytesType, round: number, encoding?: 'hex'): string;
+    (data: BytesType, round: number, encoding?: 'base16'): string;
+    (data: BytesType, round: number, encoding?: 'base58'): string;
+    (data: BytesType, round: number, encoding?: 'base64'): string;
+    (data: BytesType, round: number, encoding?: 'buffer'): Buffer;
+    (data: BytesType, round: number, encoding?: 'Uint8Array'): Uint8Array;
+    (data: BytesType, round: number, encoding?: EncodingType): BytesType;
+}
+export interface SignerType {
+    genKeyPair(encoding?: EncodingType, seed?: BytesType): KeyPairType;
+    getPublicKey(sk: BytesType, encoding?: 'hex'): string;
+    getPublicKey(sk: BytesType, encoding?: 'base16'): string;
+    getPublicKey(sk: BytesType, encoding?: 'base58'): string;
+    getPublicKey(sk: BytesType, encoding?: 'base64'): string;
+    getPublicKey(sk: BytesType, encoding?: 'buffer'): Buffer;
+    getPublicKey(sk: BytesType, encoding?: 'Uint8Array'): Uint8Array;
+    getPublicKey(sk: BytesType, encoding?: EncodingType): BytesType;
+    sign(data: BytesType, sk: BytesType, encoding?: 'hex'): string;
+    sign(data: BytesType, sk: BytesType, encoding?: 'base16'): string;
+    sign(data: BytesType, sk: BytesType, encoding?: 'base58'): string;
+    sign(data: BytesType, sk: BytesType, encoding?: 'base64'): string;
+    sign(data: BytesType, sk: BytesType, encoding?: 'buffer'): Buffer;
+    sign(data: BytesType, sk: BytesType, encoding?: 'Uint8Array'): Uint8Array;
+    sign(data: BytesType, sk: BytesType, encoding?: EncodingType): BytesType;
+    verify(data: BytesType, pk: BytesType, signature: BytesType): boolean;
+    ethHash?(data: string): string;
+    ethSign?(data: string, sk: string): string;
+    ethVerify?(data: string, pk: string, signature: BytesType): boolean;
+    ethRecover?(hash: string, signature: string): string;
+}
 /**
  * Contains all supported signers, eg: `Ed25519` and `Secp256k1`
  *
@@ -187,14 +209,17 @@ export declare function getSigner(type: number): SignerType;
  * const hashFn = getHasher(types.HashType.SHA3);
  * const hash2 = hashFn(message);
  */
-export declare function getHasher(type: number): HasherType;
+export declare function getHasher(type: number): HashFnType;
 /**
  * Get random bytes in specified encoding
- *
- * @param {number} [length=32]
- * @returns {buffer|hex|uint8|base64}
  */
-export declare function getRandomBytes(length?: number, encoding?: EncodingType): BytesType;
+export declare function getRandomBytes(length: number, encoding?: 'hex'): string;
+export declare function getRandomBytes(length: number, encoding?: 'base16'): string;
+export declare function getRandomBytes(length: number, encoding?: 'base58'): string;
+export declare function getRandomBytes(length: number, encoding?: 'base64'): string;
+export declare function getRandomBytes(length: number, encoding?: 'buffer'): Buffer;
+export declare function getRandomBytes(length: number, encoding?: 'Uint8Array'): Uint8Array;
+export declare function getRandomBytes(length: number, encoding?: EncodingType): BytesType;
 export declare const Signers: Readonly<{
     [x: number]: import("./signer/ed25519").Ed25519Signer | import("./signer/secp256k1").Secp256k1Signer;
 }>;

package/lib/index.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Hashers = exports.Signers = exports.getRandomBytes = exports.getHasher = exports.getSigner = exports.types = exports.Hasher = exports.Signer = void 0;
 const randombytes_1 = __importDefault(require("randombytes"));
-const encode_1 = __importDefault(require("./encode"));
+const encode_1 = require("./encode");
 const keccak_1 = __importDefault(require("./hasher/keccak"));
 const sha2_1 = __importDefault(require("./hasher/sha2"));
 const sha3_1 = __importDefault(require("./hasher/sha3"));
@@ -170,6 +170,7 @@ function getSigner(type) {
     if (typeof exports.Signers[type] === 'undefined') {
         throw new Error(`Unsupported signer type: ${type}`);
     }
+    // @ts-ignore
     return exports.Signers[type];
 }
 exports.getSigner = getSigner;
@@ -195,17 +196,12 @@ function getHasher(type) {
     if (typeof exports.Hashers[type] === 'undefined') {
         throw new Error(`Unsupported hash type: ${type}`);
     }
+    // @ts-ignore
     return exports.Hashers[type];
 }
 exports.getHasher = getHasher;
-/**
- * Get random bytes in specified encoding
- *
- * @param {number} [length=32]
- * @returns {buffer|hex|uint8|base64}
- */
 function getRandomBytes(length = 32, encoding = 'hex') {
-    return (0, encode_1.default)((0, randombytes_1.default)(length), encoding);
+    return (0, encode_1.encode)((0, randombytes_1.default)(length), encoding);
 }
 exports.getRandomBytes = getRandomBytes;
 exports.Signers = Object.freeze({

package/lib/signer/ed25519.d.ts

@@ -1,11 +1,11 @@
 import { BytesType, EncodingType, KeyPairType } from '@ocap/util';
-import Signer from '../protocols/signer';
+import BaseSigner from '../protocols/signer';
 /**
  * Signer implementation for ed25519, based on `tweetnacl`
  *
  * @class Ed25519Signer
  */
-declare class Ed25519Signer extends Signer {
+declare class Ed25519Signer extends BaseSigner {
     constructor();
     /**
      * @public

package/lib/signer/ed25519.js

@@ -9,7 +9,7 @@ const tweetnacl_1 = __importDefault(require("tweetnacl"));
 const randombytes_1 = __importDefault(require("randombytes"));
 const util_1 = require("@ocap/util");
 const signer_1 = __importDefault(require("../protocols/signer"));
-const encode_1 = __importDefault(require("../encode"));
+const encode_1 = require("../encode");
 const ed25519 = tweetnacl_1.default.sign;
 /**
  * Signer implementation for ed25519, based on `tweetnacl`
@@ -41,8 +41,8 @@ class Ed25519Signer extends signer_1.default {
             throw new Error('Invalid seed to generate key pair');
         }
         const keyPair = ed25519.keyPair.fromSeed(seed);
-        keyPair.publicKey = (0, encode_1.default)(keyPair.publicKey, encoding);
-        keyPair.secretKey = (0, encode_1.default)(keyPair.secretKey, encoding);
+        keyPair.publicKey = (0, encode_1.encode)(keyPair.publicKey, encoding);
+        keyPair.secretKey = (0, encode_1.encode)(keyPair.secretKey, encoding);
         return keyPair;
     }
     /**
@@ -54,7 +54,7 @@ class Ed25519Signer extends signer_1.default {
     getPublicKey(sk, encoding = 'hex') {
         const skBytes = (0, util_1.toUint8Array)(sk);
         const pk = ed25519.keyPair.fromSecretKey(skBytes).publicKey;
-        return (0, encode_1.default)(pk, encoding);
+        return (0, encode_1.encode)(pk, encoding);
     }
     /**
      * Sign a message and get the signature hex
@@ -67,7 +67,7 @@ class Ed25519Signer extends signer_1.default {
         const skBytes = (0, util_1.toUint8Array)(sk);
         const messageBytes = (0, util_1.toUint8Array)(message);
         const signature = ed25519.detached(messageBytes, skBytes);
-        return (0, encode_1.default)(signature, encoding);
+        return (0, encode_1.encode)(signature, encoding);
     }
     /**
      * Verify if a signature is valid

package/lib/signer/ethereum.d.ts

@@ -1,4 +1,3 @@
-import { BytesType } from '@ocap/util';
 import { Secp256k1Signer } from './secp256k1';
 /**
  * Signer implementation for secp256k1, based on `elliptic`, and ethereum compatible
@@ -9,8 +8,8 @@ declare class EthereumSigner extends Secp256k1Signer {
     pkHasFormatPrefix: boolean;
     constructor();
     ethHash(data: string): string;
-    ethSign(data: BytesType, privateKey: BytesType): string;
-    ethRecover(data: BytesType, signature: BytesType): string;
+    ethSign(data: string, privateKey: string): string;
+    ethRecover(data: string, signature: string): string;
 }
 declare const _default: EthereumSigner;
 export default _default;

package/lib/signer/secp256k1.js

@@ -8,7 +8,7 @@ const elliptic_1 = __importDefault(require("elliptic"));
 const util_1 = require("@ocap/util");
 const randombytes_1 = __importDefault(require("randombytes"));
 const signer_1 = __importDefault(require("../protocols/signer"));
-const encode_1 = __importDefault(require("../encode"));
+const encode_1 = require("../encode");
 /* eslint-disable class-methods-use-this */
 /* eslint-disable no-useless-constructor */
 const EC = elliptic_1.default.ec;
@@ -44,7 +44,7 @@ class Secp256k1Signer extends signer_1.default {
             sk = new Uint8Array((0, randombytes_1.default)(32));
         } while (!this.isValidSK(sk));
         const pk = this.getPublicKey((0, util_1.toHex)(sk));
-        return { secretKey: (0, encode_1.default)(sk, encoding), publicKey: (0, encode_1.default)(pk, encoding) };
+        return { secretKey: (0, encode_1.encode)(sk, encoding), publicKey: (0, encode_1.encode)(pk, encoding) };
     }
     /**
      * Get publicKey from secretKey
@@ -54,7 +54,7 @@ class Secp256k1Signer extends signer_1.default {
         if (this.pkHasFormatPrefix === false) {
             pk = pk.slice(2);
         }
-        return (0, encode_1.default)(`0x${pk}`, encoding);
+        return (0, encode_1.encode)(`0x${pk}`, encoding);
     }
     /**
      * Sign a message and get the signature hex
@@ -71,7 +71,7 @@ class Secp256k1Signer extends signer_1.default {
             .keyFromPrivate((0, util_1.toBuffer)(sk))
             .sign((0, util_1.stripHexPrefix)(msg), { canonical: true })
             .toDER('hex');
-        return (0, encode_1.default)(`0x${signature}`, encoding);
+        return (0, encode_1.encode)(`0x${signature}`, encoding);
     }
     /**
      * Verify if a signature is valid

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ocap/mcrypto",
-  "version": "1.17.2",
+  "version": "1.17.3",
   "description": "Crypto lib that provides signer,crypter,hasher interface",
   "keywords": [
     "crypto",
@@ -56,7 +56,7 @@
     "url": "https://github.com/ArcBlock/asset-chain/issues"
   },
   "dependencies": {
-    "@ocap/util": "1.17.2",
+    "@ocap/util": "1.17.3",
     "bn.js": "5.2.1",
     "crypto-js": "^4.1.1",
     "elliptic": "^6.5.3",
@@ -65,11 +65,12 @@
     "interface": "^1.2.1",
     "js-sha3": "^0.8.0",
     "randombytes": "^2.1.0",
-    "tweetnacl": "^1.0.3"
+    "tweetnacl": "^1.0.3",
+    "type-fest": "^2.13.1"
   },
   "resolutions": {
     "bn.js": "5.2.1",
     "elliptic": "6.5.3"
   },
-  "gitHead": "ddb64b9727c9d07bd3df4665444545e43b24a071"
+  "gitHead": "7a74e4e2b362a6e6ea8d14617f0480966c3363d5"
 }