Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

bsv

Package Overview
Dependencies
Maintainers
1
Versions
115
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bsv

Javascript library for Bitcoin SV (BSV).

  • 2.0.0-beta.4
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2K
decreased by-7.81%
Maintainers
1
Weekly downloads
 
Created
Source

bsv

bsv is a javascript library for Bitcoin SV (BSV) intended to satisfy certain goals:

  1. Support ease-of-use by being internally consistent. It should not be necessary to read the source code of a class or function to know how to use it. Once you know how to use part of the library, the other parts should feel natural.

  2. Have 100% test coverage, or nearly so, so that the library is known to be reliable. This should include running standard test vectors from the reference implementation.

  3. Library objects have an interface suitable for use with a command-line interface or other libraries and tools, in particular having toString, fromString, toJSON, fromJSON, toBuffer, fromBuffer, toHex, fromHex methods.

  4. All standard features of the blockchain are implemented (or will be) and saved in lib/. All BIPs are correctly implemented and, where appropriate, saved as bip-xx.js in lib/ (since that is their standard name). In order to allow rapid development, Yours Bitcoin includes non-standard and experimental features. Any non-standard features (such as colored coins or stealth addresses) are labeled as such in index.js as well as in comments.

  5. Expose everything, including dependencies. This makes it possible to develop apps that require fine-grained control over the basics, such as big numbers and points. However, it also means that you can hurt yourself if you misuse these primitives.

  6. Use standard javascript conventions wherever possible so that other developers find the code easy to understand.

  7. Minimize the use of dependencies so that all code can be easily audited.

  8. All instance methods modify the state of the object and return the object, unless there is a good reason to do something different. To access the result of an instance method, you must access the object property(s) that it modifies.

  9. Support web workers to unblock web wallet UIs when performing cryptography.

Environment Variables

  • BSV_JS_BASE_URL - Default "/".
  • BSV_JS_BUNDLE_FILE - Default "bsv.js"
  • BSV_JS_WORKER_FILE - Default "bsv-worker.js"
  • NETWORK - Default "mainnet"

You can change the network to run the CLI in testnet mode:

NETWORK=testnet ./bin/bsv.js

Documentation

There is some documentation, and it can be built with groc:

npm install -g groc
groc

Keywords

FAQs

Package last updated on 19 Apr 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc