ixo-apimodule
This is a node module that defines the functions that can be performed by the ixo protocol.
Install
npm install --save ixo-apimodule
Scripts
-
npm run build :
tsc -
npm run test :
mocha --timeout 5000 -r ts-node/register 'test/**/*.spec.ts' -
npm run readme :
node ./node_modules/.bin/node-readme -
npm run prep-publish :
rm -Rf node_modules/ package-lock.json dist/ && npm install && gulp
Documentation and Usage
Refer to the demo.ts file, which aims to run through the entire project lifecycle and more in one sequence of steps. Some documentation and context around these steps is also provided inline.
Dependencies
| Package | Version | Dev |
|---|---|---|
| @types/es6-promise | ^3.3.0 | |
| axios | ^0.18.1 | |
| base58 | 1.0.1 | |
| bip39 | 2.4.0 | |
| cross-fetch | ^2.2.1 | |
| elliptic | ^6.4.0 | |
| ethjs-query | ^0.3.3 | |
| immutable | ^3.8.2 | |
| jayson | ^2.0.5 | |
| json-hash | ^1.2.0 | |
| loadjs | ^3.5.2 | |
| node | ^9.3.0 | |
| sovrin-did | 1.2.0 | |
| stream | 0.0.2 | |
| tls | 0.0.1 | |
| @types/chai | ^4.1.0 | |
| @types/mocha | ^2.2.46 | |
| @types/node | ^9.3.0 | |
| babel-core | ^6.26.0 | |
| babel-preset-env | ^1.6.1 | |
| babelify | ^8.0.0 | |
| browserify | ^15.2.0 | |
| chai | ^4.1.2 | |
| chalk | ^2.3.0 | |
| crypto-js | ^3.1.9-1 | |
| dts-generator | ^3.0.0 | |
| ethereumjs-util | ^5.1.4 | |
| ethereumjs-wallet | ^0.6.0 | |
| ethjs-provider-http | ^0.1.6 | |
| ethjs-rpc | ^0.1.8 | |
| gulp | ^4.0.2 | |
| gulp-sequence | ^1.0.0 | |
| gulp-typescript | ^5.0.1 | |
| gulp-uglify | ^3.0.0 | |
| gulp-uglify-es | ^1.0.0 | |
| mocha | ^8.0.1 | |
| node-noop | ^1.0.0 | |
| node-readme | ^0.1.9 | |
| pump | ^3.0.0 | |
| ts-node | ^4.1.0 | |
| tsify | ^3.0.4 | |
| typescript | ^2.6.2 |
Contributing
Contributions welcome; Please submit all pull requests the against master branch. If your pull request contains JavaScript patches or features, you should include relevant unit tests. Please check the Contributing Guidelines for more details. Thanks!