Micro Bitcoin Payment Service
A micro service for adding bitcoin payment to your node application. using node 8.0
Prerequisites
To install this module you need to have node installed in your loacl machine and also npm and/or yarn.
Testing
To run a unit test use the following command:
npm run test
Usage
To use with the micro service you need to install some modules first with:
npm install --save bitcoin-payment-mircoservice
Or you use yarn to install the package:
yarn add bitcoin-payment-mircoservice
then in your javascript file add
const bitcoinPayment = require('bitcoin-payment-mircoservice')
To get the current bitcoin balance of an address use:
const balance = bitcoinPayment.getBalance(address) // returns address balance
console.log('bitcoin Balance', balance)
returns
bitcoin Balance 0.009797
To generate a new bitcoin address
const address = bitcoinPayment.createAddress() // returns a bitcoin address with private key
console.log(address)
returns
{
address: '1K3QovFjbXG9HMYSfTE8WMc7EHhhpJSGwT',
privateKey: 'achgjxsdvhjahkjlxkdcbazagshkjlskncvgshjasluyihkjaknjxs'
}
** NOTE: Please always secure your private key
To send Bitcoin to an address
sendBTC (paperWallet, toAddress, amount, network) => transactionID
// paperWallet - Generated address with private key to validate the transaction
// amount - amount to be sent in satoshi
// toAddress - Bitcoin address to receive the amount
// network - which could either 'testnet' or 'livenet/mainnet'
To listen to an address on a network for a transaction
bitcoinPayment.listenToLiveTransaction(address) => tx
Will trigger the event in real time if a payment is done to that address:
Transaction detected! { address: '138WJKb1mXbkRGNpyMVEZ9EsoXjMEvJfT4',
amount: 381000 }
### Built with
- Node Js - javascript runtime engine
- Bitcoin-live-transactions NPM package
- Bitcoinjs-lib from bitcoinjs
- Bitcore-lib from bitcore-lib
- Bitcore-explorers from Bitcore-explorers
- Axios