bsv v0.21.0

Principles

Bitcoin is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bitcoin network allows for highly resilient bitcoin infrastructure, and the developer community needs reliable, open-source tools to implement bitcoin apps and services. Bitcore provides a reliable API for JavaScript apps that need to interface with Bitcoin.

To get started, just npm install bsv or bower install bsv.

Documentation Index

Addresses and Key Management

Payment Handling

Bitcoin Internals

Extra

Module Development

Browser Builds

Modules

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

Examples

Create and Save a Private Key

var privateKey = new bsv.PrivateKey();

var exported = privateKey.toWIF();
// e.g. L3T1s1TYP9oyhHpXgkyLoJFGniEgkv2Jhi138d7R2yJ9F4QdDU2m
var imported = bsv.PrivateKey.fromWIF(exported);
var hexa = privateKey.toString();
// e.g. 'b9de6e778fe92aa7edb69395556f843f1dce0448350112e14906efc2a80fa61a'

Create an Address

var address = privateKey.toAddress();

Create a Multisig Address

// Build a 2-of-3 address from public keys
var p2shAddress = new bsv.Address([publicKey1, publicKey2, publicKey3], 2);

Request a Payment

var paymentInfo = {
  address: '1DNtTk4PUCGAdiNETAzQFWZiy2fCHtGnPx',
  amount: 120000 //satoshis
};
var uri = new bsv.URI(paymentInfo).toString();

Create a Transaction

var transaction = new Transaction()
    .from(utxos)          // Feed information about what unspent outputs one can use
    .to(address, amount)  // Add an output with the given amount of satoshis
    .change(address)      // Sets up a change address where the rest of the funds will go
    .sign(privkeySet)     // Signs all the inputs it can

Connect to the Network

var peer = new Peer('5.9.85.34');

peer.on('inv', function(message) {
  // new inventory
});

peer.connect();

torusjkl / bsv-docs Goto Github PK

bsv-docs's Introduction