@ocap/wallet 1.17.2 → 1.17.3

package/lib/index.d.ts

@@ -1,4 +1,5 @@
-import { BytesType } from '@ocap/util';
+/// <reference types="node" />
+import { EncodingType, BytesType } from '@ocap/util';
 import { DidType, DIDType, DIDTypeStr, DIDTypeArg } from '@arcblock/did';
 declare type KeyPairType = {
     sk?: BytesType;
@@ -11,41 +12,43 @@ export declare type SerializedWallet = {
     sk: string;
     address: string;
 };
-export declare type WalletObject = {
+export interface WalletObject {
     type: DIDType;
     secretKey: BytesType;
     publicKey: BytesType;
     address: string;
-    hash: (data: BytesType, round?: number) => string;
-    sign: (data: BytesType, hashBeforeSign?: boolean) => BytesType;
-    verify: (data: BytesType, signature: BytesType, hashBeforeVerify?: boolean) => boolean;
-    ethHash: (data: string) => string;
-    ethSign: (data: string, hashBeforeSign?: boolean) => string;
-    ethVerify: (data: string, signature: BytesType, hashBeforeVerify?: boolean) => boolean;
-    toAddress: () => string;
-    toJSON: () => SerializedWallet;
-};
+    hash(data: BytesType, round?: number, encoding?: 'hex'): string;
+    hash(data: BytesType, round?: number, encoding?: 'base16'): string;
+    hash(data: BytesType, round?: number, encoding?: 'base58'): string;
+    hash(data: BytesType, round?: number, encoding?: 'base64'): string;
+    hash(data: BytesType, round?: number, encoding?: 'buffer'): Buffer;
+    hash(data: BytesType, round?: number, encoding?: 'Uint8Array'): Uint8Array;
+    hash(data: BytesType, round?: number, encoding?: EncodingType): BytesType;
+    sign(data: BytesType, hashBeforeSign?: boolean, encoding?: 'hex'): string;
+    sign(data: BytesType, hashBeforeSign?: boolean, encoding?: 'base16'): string;
+    sign(data: BytesType, hashBeforeSign?: boolean, encoding?: 'base58'): string;
+    sign(data: BytesType, hashBeforeSign?: boolean, encoding?: 'base64'): string;
+    sign(data: BytesType, hashBeforeSign?: boolean, encoding?: 'buffer'): Buffer;
+    sign(data: BytesType, hashBeforeSign?: boolean, encoding?: 'Uint8Array'): Uint8Array;
+    sign(data: BytesType, hashBeforeSign?: boolean, encoding?: EncodingType): BytesType;
+    verify(data: BytesType, signature: BytesType, hashBeforeVerify?: boolean): boolean;
+    ethHash(data: string): string;
+    ethSign(data: string, hashBeforeSign?: boolean): string;
+    ethVerify(data: string, signature: string, hashBeforeVerify?: boolean): boolean;
+    toJSON(): SerializedWallet;
+    /**
+     * @deprecated ES6: use `wallet.address` instead
+     */
+    toAddress(): string;
+}
 export declare const WalletType: typeof DidType;
 /**
  * Generate an wallet instance that can be used to sign a message or verify a signature
- *
- * @public
- * @static
- * @param {object} keyPair - the key pair
- * @param {string} keyPair.sk - the secretKey
- * @param {string} keyPair.pk - the wallet publicKey
- * @param {DIDTypeArg} [type='default'] - wallet type
- * @returns {WalletObject} wallet object that can be used to sign/verify/getAddress
  */
 export declare function Wallet(keyPair: KeyPairType, t?: DIDTypeArg): WalletObject;
 /**
  * Generate a wallet from secretKey
  *
- * @public
- * @static
- * @param {string} sk - the secret key, `hex encoded string`
- * @param {DIDTypeArg} [type='default'] - wallet type
- * @returns {WalletObject} wallet object that can be used to sign/verify/getAddress
  * @example
  * const assert = require('assert');
  * const { fromSecretKey } = require('@ocap/wallet');
@@ -64,32 +67,16 @@ export declare function Wallet(keyPair: KeyPairType, t?: DIDTypeArg): WalletObje
 export declare function fromSecretKey(sk: BytesType, _type?: DIDTypeArg): WalletObject;
 /**
  * Generate a wallet from publicKey
- *
- * @public
- * @static
- * @param {string} pk - the public key, `hex encoded string`
- * @param {DIDTypeArg} [type='default'] - wallet type
- * @returns {WalletObject} wallet object that can be used to sign/verify/getAddress
  */
 export declare function fromPublicKey(pk: BytesType, _type?: DIDTypeArg): WalletObject;
 /**
  * Generate a wallet from address (did)
  *
  * Since we do not know the publicKey and secretKey, this kind of wallet cannot be used for signing and verifying
- *
- * @public
- * @static
- * @param {string} address - the wallet address
- * @returns {WalletObject} wallet object that can be used to sign/verify/getAddress
  */
 export declare function fromAddress(address: string): WalletObject;
 /**
  * Generate a wallet by generating a random secretKey
- *
- * @public
- * @static
- * @param {DIDTypeArg} [type='default'] - wallet type
- * @returns {WalletObject} wallet object that can be used to sign/verify/getAddress
  */
 export declare function fromRandom(_type?: DIDTypeArg): WalletObject;
 /**
@@ -98,11 +85,6 @@ export declare function fromRandom(_type?: DIDTypeArg): WalletObject;
 export declare function fromJSON(json: SerializedWallet): WalletObject;
 /**
  * Check if an object is valid wallet object
- *
- * @public
- * @static
- * @param {object} wallet
- * @param {boolean} canSign - should the wallet support sign
  */
 export declare function isValid(wallet: WalletObject, canSign?: boolean): boolean;
 export {};

package/lib/index.js

@@ -7,14 +7,6 @@ const did_1 = require("@arcblock/did");
 exports.WalletType = did_1.DidType;
 /**
  * Generate an wallet instance that can be used to sign a message or verify a signature
- *
- * @public
- * @static
- * @param {object} keyPair - the key pair
- * @param {string} keyPair.sk - the secretKey
- * @param {string} keyPair.pk - the wallet publicKey
- * @param {DIDTypeArg} [type='default'] - wallet type
- * @returns {WalletObject} wallet object that can be used to sign/verify/getAddress
  */
 function Wallet(keyPair, t = 'default') {
     const type = (0, did_1.DidType)(t);
@@ -25,10 +17,12 @@ function Wallet(keyPair, t = 'default') {
         secretKey: keyPair.sk,
         publicKey: keyPair.pk,
         address: keyPair.pk ? (0, did_1.fromPublicKey)(keyPair.pk, type) : keyPair.address,
-        hash(data, round = 1) {
-            return hasher(data, round);
+        // @ts-ignore
+        hash(data, round = 1, encoding = 'hex') {
+            return hasher(data, round, encoding);
         },
-        sign(data, hashBeforeSign = true) {
+        // @ts-ignore
+        sign(data, hashBeforeSign = true, encoding = 'hex') {
             if (!keyPair.sk) {
                 throw new Error('Cannot sign data without a secretKey');
             }
@@ -36,7 +30,7 @@ function Wallet(keyPair, t = 'default') {
                 const hash = hasher(data, 1);
                 return signer.sign(hash, keyPair.sk);
             }
-            return signer.sign(data, keyPair.sk);
+            return signer.sign(data, keyPair.sk, encoding);
         },
         verify(data, signature, hashBeforeVerify = true) {
             if (!keyPair.pk) {
@@ -59,9 +53,9 @@ function Wallet(keyPair, t = 'default') {
                 throw new Error('ethSign is not supported by signer');
             }
             if (hashBeforeSign) {
-                return signer.ethSign(signer.ethHash(data), keyPair.sk);
+                return signer.ethSign(signer.ethHash(data), (0, util_1.toHex)(keyPair.sk));
             }
-            return signer.ethSign(data, keyPair.sk);
+            return signer.ethSign(data, (0, util_1.toHex)(keyPair.sk));
         },
         ethVerify(data, signature, hashBeforeVerify = true) {
             if (typeof signer.ethHash !== 'function') {
@@ -88,11 +82,6 @@ exports.Wallet = Wallet;
 /**
  * Generate a wallet from secretKey
  *
- * @public
- * @static
- * @param {string} sk - the secret key, `hex encoded string`
- * @param {DIDTypeArg} [type='default'] - wallet type
- * @returns {WalletObject} wallet object that can be used to sign/verify/getAddress
  * @example
  * const assert = require('assert');
  * const { fromSecretKey } = require('@ocap/wallet');
@@ -116,12 +105,6 @@ function fromSecretKey(sk, _type = 'default') {
 exports.fromSecretKey = fromSecretKey;
 /**
  * Generate a wallet from publicKey
- *
- * @public
- * @static
- * @param {string} pk - the public key, `hex encoded string`
- * @param {DIDTypeArg} [type='default'] - wallet type
- * @returns {WalletObject} wallet object that can be used to sign/verify/getAddress
  */
 function fromPublicKey(pk, _type = 'default') {
     return Wallet({ pk }, (0, did_1.DidType)(_type));
@@ -131,11 +114,6 @@ exports.fromPublicKey = fromPublicKey;
  * Generate a wallet from address (did)
  *
  * Since we do not know the publicKey and secretKey, this kind of wallet cannot be used for signing and verifying
- *
- * @public
- * @static
- * @param {string} address - the wallet address
- * @returns {WalletObject} wallet object that can be used to sign/verify/getAddress
  */
 function fromAddress(address) {
     return Wallet({ address: (0, did_1.toAddress)(address) }, (0, did_1.toTypeInfo)(address));
@@ -143,11 +121,6 @@ function fromAddress(address) {
 exports.fromAddress = fromAddress;
 /**
  * Generate a wallet by generating a random secretKey
- *
- * @public
- * @static
- * @param {DIDTypeArg} [type='default'] - wallet type
- * @returns {WalletObject} wallet object that can be used to sign/verify/getAddress
  */
 function fromRandom(_type = 'default') {
     const type = (0, did_1.DidType)(_type);
@@ -166,11 +139,6 @@ function fromJSON(json) {
 exports.fromJSON = fromJSON;
 /**
  * Check if an object is valid wallet object
- *
- * @public
- * @static
- * @param {object} wallet
- * @param {boolean} canSign - should the wallet support sign
  */
 function isValid(wallet, canSign = true) {
     if (!wallet || typeof wallet !== 'object') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ocap/wallet",
-  "version": "1.17.2",
+  "version": "1.17.3",
   "description": "Utility function to create and use an forge compatible crypto wallet",
   "keywords": [
     "crypto",
@@ -52,9 +52,9 @@
     "url": "https://github.com/ArcBlock/asset-chain/issues"
   },
   "dependencies": {
-    "@arcblock/did": "1.17.2",
-    "@ocap/mcrypto": "1.17.2",
-    "@ocap/util": "1.17.2"
+    "@arcblock/did": "1.17.3",
+    "@ocap/mcrypto": "1.17.3",
+    "@ocap/util": "1.17.3"
   },
-  "gitHead": "ddb64b9727c9d07bd3df4665444545e43b24a071"
+  "gitHead": "7a74e4e2b362a6e6ea8d14617f0480966c3363d5"
 }