@glosfer/bitbox-nodejs

Node implementation of the communication layer using `node-hid` (USB)

Stats

StarsIssuesVersionUpdatedCreatedSize
@glosfer/bitbox-nodejs
001.0.33 years ago3 years agoMinified + gzip package size for @glosfer/bitbox-nodejs in KB

Readme

BitBox NodeJS

Node implementation of the communication layer using node-hid (USB).

** This is not officially maintained by Digital BitBox developers. But we will do our best to keep it updated. **

Example

import { hid } from "@glosfer/bitbox-nodejs";

const hidInfo = hid.getDeviceInfo()
if (!hidInfo) {
  console.log(`Digital BitBox is not plugged in`)
} else {
  console.log(`Successfully retrieved info: ${hidInfo}`)
}

Install dependencies

npm install

Deploy

Checklist before deploying a new release:

  • you have the right in the glosfer org on NPM
  • you have run npm login once (check npm whoami)
  • Go to master branch
    • your master point on glosfer repository (check with git config remote.$(git config branch.master.remote).url and fix it with git branch --set-upstream master origin/master)
    • you are in sync (git pull) and there is no changes in git status
  • Run npm once, there is still no changes in git status

deploy a new release

npm run clean
npm install
npm test
npm publish

then, go to /releases and create a release with change logs.

Issues & Pull Requests

If you have an issue, feel free to add it to the Issues tab. If you'd like to help us out, the Pull Request tab is a great place to start.

If you have found a security bug, please contact us at security@glosfer.com.

Credits

Kudos to SHIFT team (Digital BitBox hardware wallet developers)

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.