umbrucore-lib

Umbrucore Library

A pure and powerful JavaScript Umbru library.

Umbru is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Umbru network allows for highly resilient Umbru infrastructure, and the developer community needs reliable, open-source tools to implement Umbru apps and services.

Table of Contents

• Install
• Usage
• Documentation
• Contributing
• License

Install

NodeJS

npm install @umbru/umbrucore-lib

Browser

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

Building the Browser Bundle

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

npm run build

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

Usage

Browser

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

Modules

Some functionality is implemented as a module that can be installed separately:

• Payment Protocol Support
• Peer to Peer Networking
• Umbru Core JSON-RPC
• Payment Channels
• Mnemonics
• Elliptical Curve Integrated Encryption Scheme
• Signed Messages

Development & Tests

git clone https://github.com/umbru/umbrucore-lib
cd umbrucore-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.

Documentation

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

Examples

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

• Generate a random address
• Generate an address from a SHA256 hash
• Import an address via WIF
• Create a Transaction
• Sign a Umbru message
• Verify a Umbru message
• Create an OP RETURN transaction
• Create a 2-of-3 multisig P2SH address
• Spend from a 2-of-2 multisig P2SH address

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.

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