@unifyroom/unfycore-lib NPM

unfycore Library

A pure and powerful JavaScript Unifyroom library.

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

Install

NodeJS

npm install @unifyroom/unfycore-lib

Browser

CDN Standalone

<script src="https://unpkg.com/@unifyroom/unfycore-lib"></script>
<script>
  const { PrivateKey } = unfycore;
  const privateKey = new PrivateKey();
  const address = privateKey.toAddress().toString();
  ...
</script>

Building the Browser Bundle

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

npm run build

This will generate a file named unfycore-lib.min.js in the dist/ folder.

Usage

Browser

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

Modules

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

Development & Tests

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

Concepts

How To Use

Use Case Examples

Some examples can be found here, below is a list of direct links 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.