@arcblock/did 1.6.3 → 1.6.10

package/README.md

@@ -2,7 +2,7 @@
 
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![docs](https://img.shields.io/badge/powered%20by-arcblock-green.svg)](https://docs.arcblock.io)
-[![Gitter](https://badges.gitter.im/ArcBlock/community.svg)](https://gitter.im/ArcBlock/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Gitter](https://badges.gitter.im/ArcBlock/community.svg)](https://gitter.im/ArcBlock/community?utm_source=badge\&utm_medium=badge\&utm_campaign=pr-badge)
 
 > Javascript library to manipulate ArcBlock DID: <https://github.com/ArcBlock/abt-did-spec>
 
@@ -49,4 +49,4 @@ console.log(`abt:did:${userDID}`);
 
 ## Documentation
 
-For full documentation, checkout [https://ocap-js.netlify.com](https://ocap-js.netlify.com/)
+For full documentation, checkout [https://asset-chain.netlify.com](https://asset-chain.netlify.com/)

package/lib/index.d.ts

@@ -1,5 +1,13 @@
 // Generate by [js2dts@0.3.3](https://github.com/whxaxes/js2dts#readme)
 
+/**
+ * Ensure the hex length is even number, 2, 4, 6, 8
+ *
+ * @param {string} hex
+ * @param {number} length
+ * @returns {string} hex
+ */
+declare function toStrictHex(hex: string, length: number): string;
 /**
  * Convert did to address: remove `did:abt:` prefix
  *
@@ -18,6 +26,34 @@ declare function toAddress(did: string): string;
  * @returns {string}
  */
 declare function toDid(address: any): string;
+/**
+ * Checks if the given string is an address
+ *
+ * @method isEthereumDid
+ * @param {String} address the given HEX address
+ * @return {Boolean}
+ */
+declare function isEthereumDid(did: any): boolean;
+declare function isEthereumType(type: any): any;
+/**
+ * Get type info from did (base58 format)
+ *
+ * @public
+ * @static
+ * @param {string} did - address string
+ * @param {boolean} [returnString=true]
+ * @returns {object} wallet type {@see @arcblock/did#DidType}
+ */
+declare function toTypeInfo(did: string, returnString?: boolean): object;
+/**
+ * Convert type info object to hex string
+ *
+ * @public
+ * @static
+ * @param {object} type - wallet type, {@see @arcblock/did#DidType}
+ * @returns string
+ */
+declare function fromTypeInfo(type: object): string;
 /**
  * The structure of a forge wallet type
  *
@@ -48,21 +84,12 @@ declare function toDid(address: any): string;
  *   hash: types.HashType.SHA3,
  * });
  */
-declare function DidType(type?: string | DidType_1): any;
-declare const _Lib: _Lib.T102;
+declare function DidType(type?: DidType | string): object;
+declare const _Lib: _Lib.T100;
 declare namespace _Lib {
   export interface T100 {
-    [key: string]: any;
-  }
-  export interface T101 {
-    role: any;
-    pk: any;
-    hash: any;
-    address: any;
-  }
-  export interface T102 {
     types: any;
-    toStrictHex: (hex: string, length: number) => string;
+    toStrictHex: typeof toStrictHex;
     fromSecretKey: (sk: string, type: any) => string;
     fromPublicKey: (pk: string, type: any) => string;
     fromPublicKeyHash: (buffer: any, type: any) => string;
@@ -71,11 +98,13 @@ declare namespace _Lib {
     toDid: typeof toDid;
     isFromPublicKey: (did: string, pk: string) => boolean;
     isValid: (did: string) => boolean;
-    toTypeInfo: (did: string, returnString?: boolean) => any;
-    fromTypeInfo: (type: any) => string;
+    isEthereumDid: typeof isEthereumDid;
+    isEthereumType: typeof isEthereumType;
+    toTypeInfo: typeof toTypeInfo;
+    fromTypeInfo: typeof fromTypeInfo;
     DidType: typeof DidType;
-    DID_TYPE_FORGE: _Lib.T101;
-    DID_TYPE_ETHEREUM: _Lib.T101;
+    DID_TYPE_ARCBLOCK: typeof DID_TYPE_ARCBLOCK;
+    DID_TYPE_ETHEREUM: typeof DID_TYPE_ETHEREUM;
   }
 }
 export = _Lib;

package/lib/index.js

@@ -13,8 +13,8 @@ const {
   toTypeInfo,
   fromTypeInfo,
   isEthereumType,
-  isEthereumAddress,
-  DID_TYPE_FORGE,
+  isEthereumDid,
+  DID_TYPE_ARCBLOCK,
   DID_TYPE_ETHEREUM,
   toChecksumAddress,
 } = require('./type');
@@ -137,19 +137,22 @@ const isFromPublicKey = (did, pk) => {
  * @returns {boolean}
  */
 const isValid = (did) => {
-  const { hash } = toTypeInfo(did);
+  const address = toAddress(did);
+  const { hash } = toTypeInfo(address);
+
   if (typeof hash === 'undefined') {
     return false;
   }
 
-  if (isEthereumAddress(did)) {
+  if (isEthereumDid(address)) {
     return true;
   }
 
   const hashFn = getHasher(hash);
-  const bytes = toBytes(did);
+  const bytes = toBytes(address);
   const bytesHex = toStrictHex(Buffer.from(bytes.slice(0, 22)).toString('hex'));
   const didChecksum = toStrictHex(Buffer.from(bytes.slice(22, 26)).toString('hex'));
+
   const checksum = stripHexPrefix(hashFn(`0x${bytesHex}`, 1)).slice(0, 8);
 
   return didChecksum === checksum;
@@ -170,9 +173,12 @@ module.exports = {
   isFromPublicKey,
   isValid,
 
+  isEthereumDid,
+  isEthereumType,
+
   toTypeInfo,
   fromTypeInfo,
   DidType,
-  DID_TYPE_FORGE,
+  DID_TYPE_ARCBLOCK,
   DID_TYPE_ETHEREUM,
 };

package/lib/type.d.ts

@@ -0,0 +1,103 @@
+/**
+ * The structure of a forge wallet type
+ */
+export type DidType = {
+    /**
+     * - Enum field to identify wallet role type
+     */
+    role: number;
+    /**
+     * - Crypto algorithm to derive publicKey from the secretKey
+     */
+    pk: number;
+    /**
+     * - Hash algorithm used to hash data before sign them
+     */
+    hash: number;
+};
+export namespace DID_TYPE_ARCBLOCK {
+    const role: any;
+    const pk: any;
+    const hash: any;
+    const address: any;
+}
+export namespace DID_TYPE_ETHEREUM {
+    const role_1: any;
+    export { role_1 as role };
+    const pk_1: any;
+    export { pk_1 as pk };
+    const hash_1: any;
+    export { hash_1 as hash };
+    const address_1: any;
+    export { address_1 as address };
+}
+/**
+ * Convert type info object to hex string
+ *
+ * @public
+ * @static
+ * @param {object} type - wallet type, {@see @arcblock/did#DidType}
+ * @returns string
+ */
+export function fromTypeInfo(type: object): string;
+/**
+ * Get type info from did (base58 format)
+ *
+ * @public
+ * @static
+ * @param {string} did - address string
+ * @param {boolean} [returnString=true]
+ * @returns {object} wallet type {@see @arcblock/did#DidType}
+ */
+export function toTypeInfo(did: string, returnString?: boolean): object;
+export function isEthereumType(type: any): any;
+/**
+ * Checks if the given string is an address
+ *
+ * @method isEthereumDid
+ * @param {String} address the given HEX address
+ * @return {Boolean}
+ */
+export function isEthereumDid(did: any): boolean;
+/**
+ * Converts to a checksum address
+ *
+ * @method toChecksumAddress
+ * @param {String} address the given HEX address
+ * @return {String}
+ */
+export function toChecksumAddress(address: string): string;
+/**
+ * The structure of a forge wallet type
+ *
+ * @public
+ * @static
+ * @global
+ * @typedef {Object} DidType
+ * @prop {number} role - Enum field to identify wallet role type
+ * @prop {number} pk - Crypto algorithm to derive publicKey from the secretKey
+ * @prop {number} hash - Hash algorithm used to hash data before sign them
+ */
+/**
+ * Create an wallet type object that be used as param to create a new wallet
+ *
+ * @public
+ * @static
+ * @param {DidType|string} [type='default']
+ * @returns {object}
+ * @example
+ * const assert = require('assert');
+ * const { DidType } = require('@arcblock/did');
+ * const { types } = require('@ocap/mcrypto');
+ *
+ * const type = DidType({
+ *   role: types.RoleType.ROLE_APPLICATION,
+ *   pk: types.KeyType.ED25519,
+ *   hash: types.HashType.SHA3,
+ * });
+ */
+export function DidType(type?: DidType | string): object;
+export namespace DidType {
+    function toJSON(type: any): {};
+    function fromJSON(json: any): {};
+}

package/lib/type.js

@@ -1,9 +1,9 @@
-const BN = require('bn.js');
+const { BN } = require('@ocap/util');
 const upperFirst = require('lodash/upperFirst');
 const isEqual = require('lodash/isEqual');
 const pick = require('lodash/pick');
 const { types, Hasher } = require('@ocap/mcrypto');
-const { numberToHex, stripHexPrefix } = require('@ocap/util');
+const { numberToHex, stripHexPrefix, toAddress, isHex } = require('@ocap/util');
 const { toBits, toBytes, toStrictHex } = require('./util');
 
 // eslint-disable-next-line
@@ -14,7 +14,7 @@ const mapping = {
   address: 'encoding',
 };
 
-const DID_TYPE_FORGE = {
+const DID_TYPE_ARCBLOCK = {
   role: types.RoleType.ROLE_ACCOUNT,
   pk: types.KeyType.ED25519,
   hash: types.HashType.SHA3,
@@ -36,11 +36,13 @@ const isEthereumType = (type) => {
 /**
  * Checks if the given string is an address
  *
- * @method isEthereumAddress
+ * @method isEthereumDid
  * @param {String} address the given HEX address
  * @return {Boolean}
  */
-const isEthereumAddress = (address) => {
+const isEthereumDid = (did) => {
+  const address = toAddress(did);
+
   // check if it has the basic requirements of an address
   if (!/^(0x)?[0-9a-f]{40}$/i.test(address)) {
     return false;
@@ -144,11 +146,11 @@ const toChecksumAddress = (address) => {
 function DidType(type = 'default') {
   let input = null;
   if (type === 'default' || type === 'forge') {
-    input = DID_TYPE_FORGE;
+    input = DID_TYPE_ARCBLOCK;
   } else if (type === 'eth') {
     input = DID_TYPE_ETHEREUM;
   } else {
-    input = { ...DID_TYPE_FORGE, ...type };
+    input = { ...DID_TYPE_ARCBLOCK, ...type };
   }
 
   const { role, pk, hash, address } = input;
@@ -227,7 +229,7 @@ const fromTypeInfo = (type) => {
 const toTypeInfo = (did, returnString = false) => {
   try {
     let type = null;
-    if (isEthereumAddress(did)) {
+    if (isEthereumDid(did)) {
       type = DID_TYPE_ETHEREUM;
     } else {
       const bytes = toBytes(did);
@@ -241,6 +243,7 @@ const toTypeInfo = (did, returnString = false) => {
         role: parseInt(roleBits, 2),
         pk: parseInt(keyBits, 2),
         hash: parseInt(hashBits, 2),
+        address: isHex(toAddress(did)) ? types.EncodingType.BASE16 : types.EncodingType.BASE58,
       };
     }
 
@@ -266,12 +269,12 @@ const toTypeInfo = (did, returnString = false) => {
 };
 
 module.exports = {
-  DID_TYPE_FORGE,
+  DID_TYPE_ARCBLOCK,
   DID_TYPE_ETHEREUM,
   fromTypeInfo,
   toTypeInfo,
   isEthereumType,
-  isEthereumAddress,
+  isEthereumDid,
   toChecksumAddress,
   DidType,
 };

package/lib/util.d.ts

@@ -0,0 +1,24 @@
+export const DID_PREFIX: "did:abt:";
+/**
+ * Convert number to bit string with predefined length
+ *
+ * @param {string} decimal
+ * @param {number} length
+ * @returns String
+ */
+export function toBits(decimal: string, length: number): any;
+/**
+ * Convert did to bytes with length of 26
+ *
+ * @param {string} did
+ * @returns {Buffer}
+ */
+export function toBytes(did: string): Buffer;
+/**
+ * Ensure the hex length is even number, 2, 4, 6, 8
+ *
+ * @param {string} hex
+ * @param {number} length
+ * @returns {string} hex
+ */
+export function toStrictHex(hex: string, length: number): string;

package/lib/util.js

@@ -1,5 +1,5 @@
 const padStart = require('lodash/padStart');
-const { toBN, fromBase58 } = require('@ocap/util');
+const { toBN, fromBase58, isHexStrict, stripHexPrefix } = require('@ocap/util');
 
 const DID_PREFIX = 'did:abt:';
 
@@ -11,6 +11,10 @@ const DID_PREFIX = 'did:abt:';
  */
 const toBytes = (did) => {
   try {
+    if (isHexStrict(did)) {
+      return Buffer.from(stripHexPrefix(did), 'hex');
+    }
+
     let bytes = fromBase58(did.replace(DID_PREFIX, ''));
     while (bytes.length < 26) {
       bytes = Buffer.concat([Buffer.from([0]), bytes]);

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@arcblock/did",
-  "version": "1.6.3",
+  "version": "1.6.10",
   "description": "Javascript lib to work with ArcBlock DID",
   "keywords": [
-    "forge",
     "arcblock",
     "blockchain",
     "did",
@@ -17,39 +16,42 @@
     "email": "shijun@arcblock.io",
     "url": "https://github.com/wangshijun"
   },
-  "homepage": "https://github.com/ArcBlock/ocap-js/tree/master/did/did",
+  "contributors": [
+    "wangshijun <shijun@arcblock.io> (https://github.com/wangshijun)"
+  ],
+  "homepage": "https://github.com/ArcBlock/asset-chain/tree/master/did/did",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "files": [
     "lib"
   ],
   "devDependencies": {
-    "jest": "^24.8.0"
+    "jest": "^27.3.1"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ArcBlock/ocap-js.git"
+    "url": "git+https://github.com/ArcBlock/asset-chain.git"
   },
   "scripts": {
     "lint": "eslint tests lib",
     "lint:fix": "eslint --fix tests lib",
     "docs": "yarn gen-dts && yarn gen-docs && yarn cleanup-docs && yarn format-docs",
-    "cleanup-docs": "node ../../tools/cleanup-docs.js docs/README.md $npm_package_name",
+    "cleanup-docs": "node ../../scripts/cleanup-docs.js docs/README.md $npm_package_name",
     "gen-docs": "jsdoc2md lib/index.js > docs/README.md",
     "gen-dts": "j2d lib/index.js",
     "format-docs": "remark . -o",
-    "test": "node tools/jest.js",
+    "test": "jest --forceExit --detectOpenHandles",
     "coverage": "yarn test -- --coverage"
   },
   "bugs": {
-    "url": "https://github.com/ArcBlock/ocap-js/issues"
+    "url": "https://github.com/ArcBlock/asset-chain/issues"
   },
   "dependencies": {
-    "@ocap/mcrypto": "^1.6.3",
-    "@ocap/util": "^1.6.3",
-    "bn.js": "^5.1.3",
-    "debug": "^4.3.1",
-    "lodash": "^4.17.20"
+    "@ocap/mcrypto": "1.6.10",
+    "@ocap/util": "1.6.10",
+    "bn.js": "^5.2.0",
+    "debug": "^4.3.3",
+    "lodash": "^4.17.21"
   },
-  "gitHead": "5246168dbbc268a3e6f95c3992d9d343647ca25b"
+  "gitHead": "ab272e8db3a15c6571cc7fae7cc3d3e0fdd4bdb1"
 }