Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sagivo/accept-bitcoin
Accept bitcoin payments using Node.js
https://github.com/sagivo/accept-bitcoin
bitcoin coffeescript nodejs
Last synced: 7 days ago
JSON representation
Accept bitcoin payments using Node.js
- Host: GitHub
- URL: https://github.com/sagivo/accept-bitcoin
- Owner: sagivo
- License: apache-2.0
- Created: 2014-07-15T06:05:04.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-04-17T00:41:33.000Z (over 7 years ago)
- Last Synced: 2024-12-26T19:07:38.084Z (14 days ago)
- Topics: bitcoin, coffeescript, nodejs
- Language: CoffeeScript
- Homepage: http://bit.ly/accept-bitcoin
- Size: 16.3 MB
- Stars: 163
- Watchers: 9
- Forks: 51
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Accept Bitcoin 
Finally a developer-friendly tool to simply accept bitcoins in your site.
- Lite and fast, built on top of [bitcore](http://bitcore.io).
- No need to install local bitcoin node RPC client. We use [blockr](http://blockr.io) API instead.
- No need to install any wallet client.
- Create ad-hoc address to accept bitcoins and transfer incomes to your offline account.
- Easy configurations.
## Get Started
Simply install via [npm](https://npmjs.org/):
```javascript
npm install accept-bitcoin
```
Load AC and you're ready to go!
```javascript
var acceptBitcoin = require('accept-bitcoin');
var ac = new acceptBitcoin('YOUR_BITCOIN_ADDRESS');
```
## Motivation
Accepting bitcoins online can be complex to program and require you to install a bitcoin RPC client in order to read and write to the blockchain. This client require a lot of resources (in terms of CPU, networking and storage).
Most of the users are using a wallet to store their bitcoins. This wallet is a simple way to secure your public and private key. For security reasons you better save this wallet offline in a "cold storage".
More about the motivation behind this project at [my blog post](http://sagivo.com/post/97125970778/bitcoin-on-node-js-do-it-yourself).
## Example
You can override the default settings on creating
Examples are provided [here](https://github.com/sagivo/accept-bitcoin/tree/master/examples)
```javascript
var settings = {network: 'live'}
var acceptBitcoin = require('accept-bitcoin');
var ac = new acceptBitcoin('YOUR_BITCOIN_ADDRESS', settings);
key = ac.generateAddress({alertWhenHasBalance: true});
console.log("Hello buyer! please pay to: " + key.address());
key.on('hasBalance', function(amount){
console.log("thanks for paying me " + amount); //do stuff
key.transferBalanceToMyAccount(function(err, d){
if (d.status === 'success') console.log("Cool, the bitcoins are in my private account!");
});
});
```
## Settings
You can override the default settings:
| name | type | default value | comment |
|-------------------------|--------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `payToAddress` | string | - | Your bitcoin adress you wish to transfer incomes to. |
| `network` | string | test | choose your bitcoin RPC env. values are: `test` and `live`more info [here](https://github.com/bitpay/bitcore/blob/cd353ac02e76fb3294c40366d8d5dc04ce1939d7/networks.js) |
| `password` | string | - | choose your random password to encrypt generated keys. |
| `storePath` | string | `./keys.txt` | path to store a file containing all the ad-hoc generated keys. |
| `encryptPrivateKey` | bool | false | in case you want the stored keys to be encrypted (using `password`). |
| `payReminderToAddress` | string | payToAddress | In case transfer amount is smaller than income and fees. |
| `includeUnconfirmed` | bool | false | include unconfirmed transactions when checking for unspent incomes |
| `checkTransactionEvery` | int | 1000 * 60 * 2 (2 minutes) | how often (in millisecond) to ping the network when checking for transactions. |
| `checkBalanceTimeout` | int | 1000 * 60 * 60 * 2 (2 hours) | timeout (in millisecond) when checking balance of an address. |
| `checkUnspentTimeout` | int | 1000 * 60 * 60 * 2 (2 hours) | timeout (in millisecond) when checking unspent transactions of an address. |
| `minimumConfirmations` | int | 6 | minimum confirmations needed in order to trigger `hasBalance` event. |
| `txFee` | float | 0.0001 | fee (in bitcoin) for transferring amount from ad hoc address to your address. |
### Key class
This class is responsible for creating new bitcoin addresses, storing them and transferring funds between them. Some key functions are:
`storeKey(wk)` - store your key in a local file. Can be encrypted.
`checkBalance()`- check and notify you when an address has minimum balance.
`payTo(payToAddress, options, callback)` - transfer all balance of this address to another address.
### Encrypt class
Contains helpers to encrypt and decrypt strings. Used for storing your keys data locally.
## Contribute
Please do. Fork it, star it, share it and add your code to the project. Help others.
All the src code is written in [coffeescript](http://coffeescript.org) and is under `src`. There's a tool that convert it automatically to js each time you change a file and put it under `lib` folder. Simply run `cake build` for that.
## License
MIT