Package Exports
- decredjs-lib
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (decredjs-lib) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
DecredJS (decredjs-lib)
Warning: Project under development, please do not use in a production environment.
A pure and powerful JavaScript Decred library.
Principles
Decred is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Decred network allows for highly resilient decred infrastructure, and the developer community needs reliable, open-source tools to implement decred apps and services.
Get Started
npm install decredjs-libExamples
- Generate a random address
- Generate a address from a SHA256 hash
- Import an address via WIF
- Create a Transaction
- Sign a Decred message
- Verify a Decred message
- Create an OP RETURN transaction
- Create a 2-of-3 multisig P2SH address
- Spend from a 2-of-2 multisig P2SH address
Building the Browser Bundle
To build a decredjs-lib full bundle for the browser:
gulp browserThis will generate files named decredjs-lib.js and decredjs-lib.min.js.
You can also use our pre-generated files, provided for each release along with a PGP signature by one of the project's maintainers. To get them, checkout a release commit (for example, https://github.com/decredjs/decredjs-lib/commit/e33b6e3ba6a1e5830a079e02d949fce69ea33546 for v0.12.6).
To verify signatures, use the following PGP keys:
- @braydonf: https://pgp.mit.edu/pks/lookup?op=get&search=0x9BBF07CAC07A276D
- @pnagurny: https://pgp.mit.edu/pks/lookup?op=get&search=0x0909B33F0AA53013
Development & Tests
git clone https://github.com/decredjs/decredjs-lib
cd decredjs-lib
npm installRun all the tests:
gulp testYou can also run just the Node.js tests with gulp test:node, just the browser tests with gulp test:browser
or create a test coverage report (you can open coverage/lcov-report/index.html to visualize it) with gulp coverage.
Contributing
Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our CONTRIBUTING file.
License
Code released under the MIT license.