Bitcoin Payments

Use Case

You want to accept a bitcoin payment from another party, programmatically.

License

UNLICENSED

Requirements

Running bitcoin-qt (or even having it installed) is not necessary.

How it Works

You initiate a Payment, and then wait for it to be fulfilled and confirmed on the bitcoin network. Uses bitcoin-live-transactions (npm) to listen for transactions on the bitcoin network, bitcoinjs-lib and bitcore-lib to initiate transactions. The steps in usage are:

• initiate payment to receive (specify expected amount)
• temporary wallet address is created to receive this one and only payment
• give the temporary wallet address to the payer
• wait for event indicating that payment is detected (but not yet confirmed)
• wait for event indicating that payment is confirmed
• the payment is transferred from temporary wallet to another (specified) wallet (optional)

Options

Can operate on testnet or mainnet.

Usage

const Payment = require('./index.js').Payment;

//initiate a payment for 0.0001 bitcoin. 
//  - amount expected: 0.0001
//  - number of confirmations before payment is 'confirmed': 7 (default is 6)
//  - network is testnet (not mainnet) 
//  - mainWallet is specified; payment will be sent here once confirmed 
//  - 
const payment = new Payment({
    amount: 0.0001,
    confirmations: 7,
    mainWallet: 'mysyjyXetrnkFwkvNmDjmtzC4YktgoGSfW',
    testnet:true
});

//get temp wallet address by calling payment.getReceiverAddress()
console.log('waiting for payment of ' + payment.getExpectedAmount() + ' to ' + payment.getReceiverAddress()); 

//react to 'detected' event - payment of some amount has been made 
payment.on('detected', (payment) => {
    console.log('payment detected...');
    console.log('amount: ' + payment.amount); 
    console.log('confirmations: ' + payment.confirmations); 
    console.log('from: ' + payment.sender); 
});

//react to 'confirmed' event - payment has been made in full, and confirmed 
// will be sent to mainWallet now automatically, if mainWallet is specified in payment options
payment.on('confirmed', (payment) => {
    console.log('payment confirmed!');
    console.log('amount: ' + payment.amount); 
    console.log('confirmations: ' + payment.confirmations); 
    console.log('from: ' + payment.sender); 
});