Web3 utils full test coverage for types

docs/_build/html/_sources/web3-utils.txt

@@ -212,8 +212,8 @@ sha3
 
 .. code-block:: javascript
 
- web3.utils.sha3(string)
- web3.utils.keccak256(string) // ALIAS
+ web3.utils.sha3(mixed)
+ web3.utils.keccak256(mixed) // ALIAS
 
 Will calculate the sha3 of the input.
 
@@ -223,7 +223,7 @@ Will calculate the sha3 of the input.
 Parameters
 ----------
 
-1. ``string`` - ``String``: A string to hash.
+1. ``mixed`` - ``String|BN|BigNumber``: A input to hash.
 
 -------
 Returns

package.json

@@ -94,7 +94,9 @@
  "rollup-plugin-auto-external": "^2.0.0",
  "rollup-plugin-babel": "^4.0.3",
  "rollup-plugin-cleanup": "^3.0.0",
- "rollup-plugin-json": "^3.1.0"
+ "rollup-plugin-json": "^3.1.0",
+ "@types/bn.js": "^4.11.3",
+ "typescript": "^3.2.1"
  },
  "dependencies": {
  "@babel/polyfill": "^7.0.0"

packages/web3-eth-abi/src/AbiCoder.js

@@ -56,7 +56,7 @@ export default class AbiCoder {
  */
  encodeFunctionSignature(functionName) {
  if (isObject(functionName)) {
- functionName = this.utils._jsonInterfaceMethodToString(functionName);
+ functionName = this.utils.jsonInterfaceMethodToString(functionName);
  }
 
  return this.utils.sha3(functionName).slice(0, 10);
@@ -73,7 +73,7 @@ export default class AbiCoder {
  */
  encodeEventSignature(functionName) {
  if (isObject(functionName)) {
- functionName = this.utils._jsonInterfaceMethodToString(functionName);
+ functionName = this.utils.jsonInterfaceMethodToString(functionName);
  }
 
  return this.utils.sha3(functionName);

packages/web3-eth-contract/src/mappers/AbiMapper.js

@@ -55,7 +55,7 @@ export default class AbiMapper {
  abiItem.payable = self.isPayable(abiItem);
 
  if (abiItem.name) {
- abiItem.funcName = self.utils._jsonInterfaceMethodToString(abiItem);
+ abiItem.funcName = self.utils.jsonInterfaceMethodToString(abiItem);
  }
 
  let abiItemModel;

packages/web3-utils/README.md

@@ -27,6 +27,8 @@ This will expose the `Web3Utils` object on the window object.
 
 ## Usage
 
+Import all of the utils functions
+
 ```js
 import * as Utils from 'web3-utils';
 
@@ -39,12 +41,19 @@ console.log(Utils);
 }
 ```
 
+Import what you need
+
+```js
+import { asciiToHex } from 'web3-utils';
+
+console.log(asciiToHex('I have 100!'));
+> "0x49206861766520313030e282ac"
+```
+
 ## Types 
 
 If you are using TypeScript all the types are defined in the `index.d.ts` file
 
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js
-
-