node-dogecoin is a Dogecoin client for Node.js. It is a fork of the excellent Kapitalize Bitcoin Client (now removed from GitHub) intended for use with Dogecoin. The purpose of this repository is:
- Provide a one-stop resource for the Node.js developer to get started with Dogecoin integration.
- Prevent would-be Dogecoin web developers worrying whether a Bitcoin client will work out of the box.
- Promote Node.js development of Dogecoin web apps.
- Identify and address any incompatibilities with the Dogecoin and Bitcoin APIs that exist now and/or in the future.
You'll need a running instance of dogecoind to connect with. If you're running Debian/Ubuntu, this worked for me: http://www.dogeco.in/wiki/index.php/Dogecoind
Then, install the node-dogecoin NPM package.
npm install node-dogecoin
Some code examples follow below, but for more complete examples, see these snippets, or this wallet app which was created to to test this module.
var dogecoin = require('node-dogecoin')()
dogecoin.auth('myusername', 'mypassword')
dogecoin.getDifficulty(function() {
console.log(arguments);
})Pretty much everything is chainable.
var dogecoin = require('node-dogecoin')()
dogecoin
.auth('MyUserName', 'mypassword')
.getNewAddress()
.getBalance()The Litecoin API is supported as direct methods. Use either camelcase or lowercase.
dogecoin.getNewAddress(function(err, address) {
this.validateaddress(address, function(err, info) {
})
})Executes the given command with optional arguments. Function callback defaults to console.log.
All of the API commands are supported in lowercase or camelcase. Or uppercase. Anycase!
dogecoin.exec('getNewAddress')
dogecoin.exec('getbalance', function(err, balance) {
})Accepts either key & value strings or an Object containing settings, returns this for chainability.
dogecoin.set('host', '127.0.0.1')Returns the specified option's value
dogecoin.get('user')Generates authorization header, returns this for chainability
TODO: Write tests for these.
All Litecoin API commands are supported, in lowercase or camelcase form.
| Command | Parameters | Description | Requires unlocked wallet? |
|---|---|---|---|
| addmultisigaddress | [nrequired] ["key","key"] [account] | Currently only available on testnet Add a nrequired-to-sign multisignature address to the wallet. Each key is a dogecoin address or hex-encoded public key. If [account] is specified, assign address to [account]. | N |
| backupwallet | [destination] | Safely copies wallet.dat to destination, which can be a directory or a path with filename. | N |
| dumpprivkey | [dogecoinaddress] | Reveals the private key corresponding to | Y |
| encryptwallet | [passphrase] | Encrypts the wallet with | N |
| getaccount | [dogecoinaddress] | Returns the account associated with the given address. | N |
| getaccountaddress | [account] | Returns the current dogecoin address for receiving payments to this account. | N |
| getaddressesbyaccount | [account] | Returns the list of addresses for the given account. | N |
| getbalance | [account] [minconf=1] | If [account] is not specified, returns the server's total available balance. If [account] is specified, returns the balance in the account. |
N |
| getblock | [hash] | Returns information about the given block hash. | N |
| getblockcount | Returns the number of blocks in the longest block chain. | N | |
| getblockhash | [index] | Returns hash of block in best-block-chain at | N |
| getblocknumber | Deprecated. Use getblockcount. | N | |
| getconnectioncount | Returns the number of connections to other nodes. | N | |
| getdifficulty | Returns the proof-of-work difficulty as a multiple of the minimum difficulty. | N | |
| getgenerate | Returns true or false whether dogecoind is currently generating hashes | N | |
| gethashespersec | Returns a recent hashes per second performance measurement while generating. | N | |
| getinfo | Returns an object containing various state info. | N | |
| getmemorypool | [data] | If [data] is not specified, returns data needed to construct a block to work on:
If [data] is specified, tries to solve the block and returns true if it was successful. |
N |
| getmininginfo | Returns an object containing mining-related information:
|
N | |
| getnewaddress | [account] | Returns a new dogecoin address for receiving payments. If [account] is specified (recommended), it is added to the address book so payments received with the address will be credited to [account]. | N |
| getreceivedbyaccount | [account] [minconf=1] | Returns the total amount received by addresses with [account] in transactions with at least [minconf] confirmations. If [account] not provided return will include all transactions to all accounts. (version 0.3.24-beta) | N |
| getreceivedbyaddress | [dogecoinaddress] [minconf=1] | Returns the total amount received by | N |
| gettransaction | [txid] | Returns an object about the given transaction containing:
|
N |
| getwork | [data] | If [data] is not specified, returns formatted hash data to work on:
If [data] is specified, tries to solve the block and returns true if it was successful. |
N |
| help | [command] | List commands, or get help for a command. | N |
| importprivkey | [dogecoinprivkey] [label] | Adds a private key (as returned by dumpprivkey) to your wallet. | Y |
| keypoolrefill | Fills the keypool, requires wallet passphrase to be set. | Y | |
| listaccounts | [minconf=1] | Returns Object that has account names as keys, account balances as values. | N |
| listreceivedbyaccount | [minconf=1] [includeempty=false] | Returns an array of objects containing:
|
N |
| listreceivedbyaddress | [minconf=1] [includeempty=false] | Returns an array of objects containing:
To get a list of accounts on the system, execute dogecoind listreceivedbyaddress 0 true |
N |
| listsinceblock | [blockhash] [target-confirmations] | Get all transactions in blocks since block [blockhash], or all transactions if omitted. | N |
| listtransactions | [account] [count=10] [from=0] | Returns up to [count] most recent transactions skipping the first [from] transactions for account [account]. If [account] not provided will return recent transaction from all accounts. | N |
| move | [fromaccount] [toaccount] [amount] [minconf=1] [comment] | Move from one account in your wallet to another | N |
| sendfrom | [fromaccount] [todogecoinaddress] [amount] [minconf=1] [comment] [comment-to] | Y | |
| sendmany | [fromaccount] [address:amount,...] [minconf=1] [comment] | amounts are double-precision floating point numbers | Y |
| sendtoaddress | [dogecoinaddress] [amount] [comment] [comment-to] | Y | |
| setaccount | [dogecoinaddress] [account] | Sets the account associated with the given address. Assigning address that is already assigned to the same account will create a new address associated with that account. | N |
| setgenerate | [generate] [genproclimit] | [generate] is true or false to turn generation on or off.
Generation is limited to [genproclimit] processors, -1 is unlimited. |
N |
| signmessage | [dogecoinaddress] [message] | Sign a message with the private key of an address. | Y |
| settxfee | [amount] | [amount] is a real and is rounded to the nearest 0.00000001 | N |
| stop | Stop dogecoin server. | N | |
| validateaddress | [dogecoinaddress] | Return information about [dogecoinaddress]. | N |
| verifymessage | [dogecoinaddress] [signature] [message] | Verify a signed message. | N |
| walletlock | Removes the wallet encryption key from memory, locking the wallet. After calling this method, you will need to call walletpassphrase again before being able to call any methods which require the wallet to be unlocked. | N | |
| walletpassphrase | [passphrase] [timeout] | Stores the wallet decryption key in memory for | N |
| walletpassphrasechange | [oldpassphrase] [newpassphrase] | Changes the wallet passphrase from | N |
You may pass options to the initialization function or to the set method.
var dogecoin = require('dogecoin')({
user:'user'
})
dogecoin.set('pass', 'somn')
dogecoin.set({port:22555})Available options and default values:
- host localhost
- port 22555
- user
- pass
- passphrasecallback
- https
- ca
With an encryped wallet, any operation that accesses private keys requires a wallet unlock. A wallet is unlocked using the walletpassphrase <passphrase> <timeout> JSON-RPC method: the wallet will relock after timeout seconds.
You may pass an optional function passphrasecallback to the node-dogecoin initialization function to manage wallet unlocks. passphrasecallback should be a function accepting three arguments:
function(command, args, callback) {}
- command is the command that failed due to a locked wallet.
- args is the arguments for the failed command.
- callback is a typical node-style continuation callback of the form
function(err, passphrase, timeout) {}. Call callback with the wallet passphrase and desired timeout from within your passphrasecallback to unlock the wallet.
You may hard code your passphrase (not recommended) as follows:
var dogecoin = require('node-dogecoin')({
passphrasecallback: function(command, args, callback) {
callback(null, 'passphrase', 30);
}
})Because passphrasecallback is a continuation, you can retrieve the passphrase in an asynchronous manner. For example, by prompting the user:
var readline = require('readline')
var rl = readline.createInterface({
input: process.stdin,
output: process.stdout
})
var dogecoin = require('node-dogecoin')({
passphrasecallback: function(command, args, callback) {
rl.question('Enter passphrase for "' + command + '" operation: ', function(passphrase) {
if (passphrase) {
callback(null, passphrase, 1)
} else {
callback(new Error('no passphrase entered'))
}
})
}
})By default dogecoind exposes its JSON-RPC interface via HTTP; that is, all RPC commands are transmitted in plain text across the network! To secure the JSON-RPC channel you can supply dogecoind with a self-signed SSL certificate and an associated private key to enable HTTPS. For example, in your dogecoin.conf:
rpcssl=1
rpcsslcertificatechainfile=/etc/ssl/certs/dogecoind.crt
rpcsslprivatekeyfile=/etc/ssl/private/dogecoind.pem
In order to securely access an SSL encrypted JSON-RPC interface you need a copy of the self-signed certificate from the server: in this case dogecoind.crt. Pass your self-signed certificate in the ca option and set https: true and node-dogecoin is secured!
var fs = require('fs')
var ca = fs.readFileSync('dogecoind.crt')
var dogecoin = require('node-dogecoin')({
user: 'rpcusername',
pass: 'rpcpassword',
https: true,
ca: ca
})npm install -g nodeunit
nodeunit test/test-node-dogecoin.js
Dogecoin donation address is DE4isu3m2RBma7nGEwnaX8cu4Y2m2J2g8Q
Donations in dogecoin will be used for bounties. The first bounty will be awarded for creating a unit test suite. As a side note: I encourage all GitHub repository owners to post a donation address so their community can easily support development financially. If you accept donations at your repository, I'll send you a reward!