@arcblock/did 1.16.8 → 1.16.9

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>
 

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/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/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@arcblock/did",
-  "version": "1.16.8",
+  "version": "1.16.9",
   "description": "Javascript lib to work with ArcBlock DID",
   "keywords": [
-    "forge",
     "arcblock",
     "blockchain",
     "did",
@@ -17,6 +16,9 @@
     "email": "shijun@arcblock.io",
     "url": "https://github.com/wangshijun"
   },
+  "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",
@@ -45,11 +47,11 @@
     "url": "https://github.com/ArcBlock/asset-chain/issues"
   },
   "dependencies": {
-    "@ocap/mcrypto": "1.16.8",
-    "@ocap/util": "1.16.8",
+    "@ocap/mcrypto": "1.16.9",
+    "@ocap/util": "1.16.9",
     "bn.js": "^5.2.0",
     "debug": "^4.3.3",
     "lodash": "^4.17.21"
   },
-  "gitHead": "15e9623edafa6fcb628f67f0c9e26e64ab01bcd2"
+  "gitHead": "16fb7ce43033d07f83794914f2d5dda731f80814"
 }