@geekcash/geekcash-lib

GeekCash Library

A pure and powerful JavaScript Dash library.

Get Started

NodeJS

npm install @geekcash/geekcash-lib

Browser

See the section below to generate your own bundle, or download the pre-generated minified file

Docs

• Addresses
• Block
• Crypto
• Encoding
• Hierarchically-derived Private and Public Keys
• Networks
• PrivateKey
• PublicKey
• Script
• Transaction
• Using Different Units
• Unspent Output
• URI
• Governance Object / Proposal

Examples

Some examples can be find here, below is a list of direct link for some of them.

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.

Building the Browser Bundle

To build a geekcash-lib full bundle for the browser:

npm run build

This will generate files named geekcash-lib.js and geekcash-lib.min.js in the dist/ folder.

Usage on Browser

<script src='./dist/geekcash-lib.min.js' type="text/javascript"></script>
<script>
  const PrivateKey = geekcash.PrivateKey;
  const privateKey = new PrivateKey();
  const address = privateKey.toAddress().toString();
</script>

Development & Tests

git clone https://github.com/geekcash/geekcash-lib
cd geekcash-lib
npm install

Run all the tests:

npm test

You can also run just the Node.js tests with npm run test:node, just the browser tests with npm run test:browser or run a test coverage report with npm run coverage.

License

Code released under the MIT license.

Copyright 2013-2017 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc. Copyright 2016-2018 The Dash Foundation, Inc.