Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 4.53 KB

user-guide.md

File metadata and controls

100 lines (75 loc) · 4.53 KB
Raw

User Guide

All information for developers using wshjs-util should consult this document.

Install

npm install --save wshjs-util

Usage

const util = require('wshjs-util');

const value = util.intToBuffer(38272);

// returns <Buffer ...>

Available Methods

arrayContainsArray   <Function (Array, Array) : (Boolean)>
getBinarySize        <Function (String) : (Number)>
intToBuffer          <Function (Number) : (Buffer)>
isHexPrefixed        <Function (String) : (Boolean)>
stripHexPrefix       <Function (String) : (String)>
padToEven            <Function (String) : (String)>
intToHex             <Function (Number) : (String)>
fromAscii,           <Function (String) : (String)>
fromUtf8,            <Function (String) : (String)>
toAscii,             <Function (String) : (String)>
toUtf8,              <Function (String) : (String)>
getKeys,             <Function (Array, String) : (Array)>
isHexString,         <Function (String) : (Boolean)>

Why BN.js?

wshjs has made a policy of using BN.js across all of its repositories. Here are some of the reasons why:

  1. lighter than alternatives (BigNumber.js)
  2. faster than most alternatives, see benchmarks
  3. used by the Wiseplat foundation across all wiseplatjs repositories
  4. is already used by a critical JS dependency of many wiseplat packages, see package elliptic
  5. purposefully does not support decimals or floats numbers (for greater precision), remember, the Wiseplat blockchain cannot and will not support float values or decimal numbers.

Browser Builds

wshjs provides production distributions for all of its modules that are ready for use in the browser right away. Simply include either dist/wshjs-util.js or dist/wshjs-util.min.js directly into an HTML file to start using this module. Note, an wshUtil object is made available globally.

<script type="text/javascript" src="wshjs-util.min.js"></script>
<script type="text/javascript">
wshUtil(...);
</script>

Note, even though wshjs should have transformed and polyfilled most of the requirements to run this module across most modern browsers. You may want to look at an additional polyfill for extra support.

Use a polyfill service such as Polyfill.io to ensure complete cross-browser support: https://polyfill.io/

Latest Webpack Figures

Hash: 28b387e39e1016183a78                                                         
Version: webpack 2.1.0-beta.15
Time: 734ms
            Asset     Size  Chunks             Chunk Names
    wshjs-util.js  65.1 kB       0  [emitted]  main
wshjs-util.js.map  79.3 kB       0  [emitted]  main
    + 8 hidden modules

Hash: 4d26e1d501227158f8ab                                                         
Version: webpack 2.1.0-beta.15
Time: 1523ms
            Asset     Size  Chunks             Chunk Names
wshjs-util.min.js  25.4 kB       0  [emitted]  main
    + 8 hidden modules

Other Awesome Modules, Tools and Frameworks

  • web3.js -- the original Wiseplat swiss army knife Wiseplat Foundation
  • wiseplatjs -- critical wiseplatjs infrastructure Wiseplat Foundation
  • browser-solidity -- an in browser Solidity IDE Wiseplat Foundation
  • wafr -- a super simple Solidity testing framework
  • truffle -- a solidity/js dApp framework
  • embark -- a solidity/js dApp framework
  • dapple -- a solidity dApp framework
  • chaitherium -- a JS web3 unit testing framework
  • contest -- a JS testing framework for contracts

Our Relationship with Wiseplat & WiseplatJS

We would like to mention that we are not in any way affiliated with the Wiseplat Foundation or wiseplatjs. However, we love the work they do and work with them often to make Wiseplat great! Our aim is to support the Wiseplat ecosystem with a policy of diversity, modularity, simplicity, transparency, clarity, optimization and extensibility.

Many of our modules use code from web3.js and the wiseplatjs- repositories. We thank the authors where we can in the relevant repositories. We use their code carefully, and make sure all test coverage is ported over and where possible, expanded on.