Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.15 KB

README.md

File metadata and controls

52 lines (33 loc) · 2.15 KB

burstjs

The BurstCoin Type/Javascript Reference Library

npm lerna Codacy Badge Build Status Known Vulnerabilities codecov

@burstjs is a modern library written in Typescript providing common functionalities for browsers and nodejs to interact with the BurstCoin blockchain, an advanced community-driven blockchain technology.

Installation

npm install @burstjs/core
npm install @burstjs/crypto
npm install @burstjs/util

Then import the methods you need, e.g. import { generateSignature } from '@burstjs/crypto'.

Go to BurstJS Online Documentation to discover what's possible!

Development

When contributing to the Phoenix wallet and updates in burstjs are necessary, simply do

npm install && npm run bootstrap

That's it!

Running Tests

  1. Single test run npm run test
  2. Run in watch mode npm run test:watch
  3. Run end-to-end test npm run test:e2e | Keep in mind that these tests are slow as they run against true servers. And therefore, it cannot be guaranteed that all E2E tests always work

Documentation