@ocap/sdk 1.17.1 → 1.17.4

package/index.d.ts

@@ -1,9 +1,14 @@
 /// <reference types="node" />
+/// <reference types="jest" />
+import { LiteralUnion } from 'type-fest';
 import rightPad from 'lodash/padEnd';
 import leftPad from 'lodash/padStart';
 import BN from 'bn.js';
 export declare type BytesType = string | Buffer | Uint8Array;
-export declare type EncodingType = 'hex' | 'base16' | 'base58' | 'base64' | 'Uint8Array' | 'buffer';
+export declare type EncodingType = LiteralUnion<
+  'hex' | 'base16' | 'base58' | 'base64' | 'Uint8Array' | 'buffer',
+  string
+>;
 export declare type KeyPairType = {
   publicKey: BytesType;
   secretKey: BytesType;
@@ -11,8 +16,8 @@ export declare type KeyPairType = {
 export { BN, leftPad, rightPad };
 /**
  * Returns a BN object, converts a number value to a BN
- * @param {String|Number|Object} `arg` input a string number, hex string number, number, BigNumber or BN object
- * @return {Object} `output` BN object of the number
+ * @param {string|number|BN} `arg` input a string number, hex string number, number, BigNumber or BN object
+ * @return {BN} `output` BN object of the number
  * @throws if the argument is not an array, object that isn't a bignumber, not a string number or number
  */
 export declare const numberToBN: (arg: string | number | BN) => BN;
@@ -31,10 +36,8 @@ export declare const isHexPrefixed: (str: string) => boolean;
  *
  * @public
  * @static
- * @param {String} str the string value
- * @return {String|Optional} a string by pass if necessary
  */
-export declare const stripHexPrefix: (str: $TSFixMe) => any;
+export declare const stripHexPrefix: (str: string | any) => any;
 /**
  * Returns true if object is BN, otherwise false
  *
@@ -114,7 +117,7 @@ export declare const hexToUtf8: (hex: string) => string;
  * @param {String|Number|BN} value
  * @returns {Number}
  */
-export declare const hexToNumber: (value: string | number | BN) => string | number | BN;
+export declare const hexToNumber: (value: string | number | BN) => number;
 /**
  * Converts value to hex representation
  *
@@ -146,7 +149,7 @@ export declare const bytesToHex: (bytes: $TSFixMe) => string;
  * @param {String} hex
  * @returns {Array} the byte array
  */
-export declare const hexToBytes: (hex: $TSFixMe) => number[];
+export declare const hexToBytes: (hex: $TSFixMe) => Array<any>;
 /**
  * Auto converts any given value into it's hex representation.
  * And even stringify objects before.
@@ -180,14 +183,6 @@ export declare const toHex: (
 export declare const numberToString: (arg: $TSFixMe) => any;
 /**
  * Format a big number to human readable number, such as 1_0000_0000_0000_000 => 1 Token
- *
- * @public
- * @static
- * @method fromUnitToToken
- * @param {string|number} input
- * @param {number} [decimal=18]
- * @param {object} [optionsInput=undefined]
- * @returns {string}
  */
 export declare const fromUnitToToken: (
   input: string | number | BN,
@@ -196,119 +191,55 @@ export declare const fromUnitToToken: (
 ) => string;
 /**
  * Convert human readable token number to big number instance
- *
- * @public
- * @static
- * @param {string} input
- * @param {number} [decimal=18]
- * @returns {BN}
  */
 export declare const fromTokenToUnit: (input: string | number, decimal?: number) => BN;
 /**
  * Validates if a value is an Uint8Array.
- *
- * @public
- * @static
- * @param {*} value - value to validate
- * @returns {Boolean} boolean indicating if a value is an Uint8Array
  */
 export declare function isUint8Array(value: $TSFixMe): boolean;
 /**
  * Generate a random UUID
- *
- * @public
- * @static
- * @returns {string} Generated uuid
  */
 export declare function UUID(): string;
 /**
  * Check if a string is valid UUID
- *
- * @public
- * @static
- * @param {string} str
- * @returns {boolean}
  */
 export declare function isUUID(str: string): boolean;
 /**
  * Convert input to Uint8Array on best effort, base64 node supported
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array|string} v
- * @returns {Uint8Array}
- * @throws {Error}
  */
-export declare function toUint8Array(v: $TSFixMe): Uint8Array;
+export declare function toUint8Array(v: any): Uint8Array;
 /**
  * Convert input to Buffer on best effort, base64 not supported
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array} v
- * @returns {buffer}
- * @throws {Error}
  */
-export declare function toBuffer(v: $TSFixMe): Buffer;
+export declare function toBuffer(v: any): Buffer;
 /**
  * Convert input to base58btc format on best effort
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array} v
- * @returns {string}
- * @throws {Error}
  */
-export declare function toBase58(v: $TSFixMe): string;
+export declare function toBase58(v: any): string;
 /**
  * Decode base58 string
- *
- * @public
- * @static
- * @param {string} v
- * @returns {buffer}
  */
 export declare function fromBase58(v: string): Buffer;
 /**
  * Convert input to base64 format
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array} v
- * @param {escape} [escape=true]
- * @returns {string}
- * @throws {Error}
  */
-export declare function toBase64(v: $TSFixMe, escape?: boolean): string;
+export declare function toBase64(v: any, escape?: boolean): string;
 /**
  * Decode base64(base64_url) string to buffer
- *
- * @public
- * @static
- * @param {string} v
- * @returns {buffer}
  */
 export declare function fromBase64(v: string): Buffer;
 /**
  * Convert did to address: remove `did:abt:` prefix
- *
- * @public
- * @static
- * @param {string} did - address string
- * @returns {string}
  */
 export declare function toAddress(did: string): string;
 /**
  * Convert address to did: prepend `did:abt:` prefix
- *
- * @public
- * @static
- * @param {string} did - address string
- * @returns {string}
  */
 export declare function toDid(address: string): string;
-export declare const formatTxType: (type: string) => string;
-import { BytesType } from '@ocap/util';
+export declare function formatTxType(type: string): any;
+/// <reference types="node" />
+import { EncodingType, BytesType } from '@ocap/util';
 import { DidType, DIDType, DIDTypeStr, DIDTypeArg } from '@arcblock/did';
 declare type KeyPairType = {
   sk?: BytesType;
@@ -321,41 +252,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');
@@ -374,32 +307,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;
 /**
@@ -408,11 +325,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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocap/sdk",
   "description": "Forge javascript SDK packages all-in-one",
-  "version": "1.17.1",
+  "version": "1.17.4",
   "author": {
     "name": "wangshijun",
     "email": "shijun@arcblock.io",
@@ -18,11 +18,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@arcblock/did-util": "1.17.1",
-    "@ocap/client": "1.17.1",
-    "@ocap/message": "1.17.1",
-    "@ocap/util": "1.17.1",
-    "@ocap/wallet": "1.17.1",
+    "@arcblock/did-util": "1.17.4",
+    "@ocap/client": "1.17.4",
+    "@ocap/message": "1.17.4",
+    "@ocap/util": "1.17.4",
+    "@ocap/wallet": "1.17.4",
     "debug": "^4.3.3",
     "react-app-polyfill": "^1.0.1"
   },
@@ -79,5 +79,5 @@
     "test": "jest --forceExit --detectOpenHandles",
     "coverage": "yarn test -- --coverage"
   },
-  "gitHead": "ca2ac264d9d6358680d5be99fcdd4685d0c999fc"
+  "gitHead": "296f3dccba7a691244212a51481fffcf142fc138"
 }