├── .gitignore
├── node-dogecoin.png
├── package.json
├── LICENSE
├── test
    ├── test.crt
    ├── npm-debug.log
    └── test-node-dogecoin.js
├── lib
    ├── commands.js
    ├── errors.js
    └── dogecoin.js
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | 


--------------------------------------------------------------------------------
/node-dogecoin.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/countable/node-dogecoin/HEAD/node-dogecoin.png


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "node-dogecoin",
 3 |     "version": "0.3.9",
 4 |     "description": "DogeCoin client",
 5 |     "keywords": ["dogecoin"],
 6 |     "repository": "git://github.com/countable/node-dogecoin.git",
 7 |     "author": "Clark Van Oyen <clark@countable.ca>",
 8 |     "main": "lib/dogecoin.js",
 9 |     "engines": { "node": ">= 0.4.0" },
10 |     "devDependencies": {
11 |         "nodeunit": "*"
12 |     }
13 | }
14 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright 2012-2013 Brandon Wilson
 4 | Copyright 2013-2014 Clark Van Oyen and other contributors
 5 | 
 6 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 7 | 
 8 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 9 | 
10 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
11 | 


--------------------------------------------------------------------------------
/test/test.crt:
--------------------------------------------------------------------------------
 1 | -----BEGIN CERTIFICATE-----
 2 | MIIC/zCCAeegAwIBAgIJAND9YlfIsQOoMA0GCSqGSIb3DQEBBQUAMBYxFDASBgNV
 3 | BAMMC2V4YW1wbGUuY29tMB4XDTE0MDMxMzAzNDgyNVoXDTI0MDMxMDAzNDgyNVow
 4 | FjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw
 5 | ggEKAoIBAQCq8z1WML4VAQ2o5YY1cig9/zFi7KuGwg/B8MuRWXvf+hlCOtCwMAH5
 6 | gOKNp9JN8hdL6y/fF/mLJYHpuJt5xT3yPe8xot3RrHHGMLWdc9D6su3f+qYLji5J
 7 | GgKozKgCLdiIGxevVrGcaQgb1zyX8aI0+7VBTF6DNsQA1zdaPT1mdQM5J39yrIXZ
 8 | 0VrmozdL4X+d3vFaxbixlxaL6T9T+1qWhuhHLxjzkGVTcWUoIQ8HipTNHs3HeisA
 9 | p40RdB6JIff7ALYIAaDJFjy0U1whQhq6CVYlcyKOzs8dkULDITxPe+hyj+amdVzy
10 | YjkKKAE6sTWIQtfHATYbTAmNvAynqi4lAgMBAAGjUDBOMB0GA1UdDgQWBBQs7LNz
11 | /kPGRNsqZKYO3cgEjMZwFzAfBgNVHSMEGDAWgBQs7LNz/kPGRNsqZKYO3cgEjMZw
12 | FzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQAdyg8mz8nMfy+XBtIS
13 | 5CtAiaiXDX5sAMN1po9nWZV8JmP9kNb4Sw5q/tBkFigOxNhpo5LukuzRXuHryUG7
14 | uRWxBebmrUqyeptSmrDhaQoUW1UA3KvjrT/EpBq6HHQZdZKHWdhI7cmEBMlPt5jm
15 | /pCQkgxnO2Q3+CDIfo+6N68v30OKSOwYP0wgRWnWEHiaXmPJcKPwvcfeKBAxrqet
16 | 8v29+B4xVG5SfZ8R8IOO61UWCNSV1061ETdXPdhpDGd3k3b8Z8EIKAnJs5ArRZgh
17 | 3ud3rT1bAXqxjfNr0bpVNLpkD9utBDFooLY40VJm/nOM4+cNiKBw9gT92FpnvuIG
18 | tQPj
19 | -----END CERTIFICATE-----
20 | 


--------------------------------------------------------------------------------
/lib/commands.js:
--------------------------------------------------------------------------------
 1 | 
 2 | var commands = module.exports.commands = [
 3 |     'addMultiSigAddress'
 4 |   , 'backupWallet'
 5 |   , 'createRawTransaction'
 6 |   , 'decodeRawTransaction'
 7 |   , 'dumpPrivKey'
 8 |   , 'encryptWallet'
 9 |   , 'getAccount'
10 |   , 'getAccountAddress'
11 |   , 'getAddressesByAccount'
12 |   , 'getBalance'
13 |   , 'getBlock'
14 |   , 'getBlockCount'
15 |   , 'getBlockHash'
16 |   , 'getBlockCount'
17 |   , 'getConnectionCount'
18 |   , 'getDifficulty'
19 |   , 'getGenerate'
20 |   , 'getHashesPerSec'
21 |   , 'getHashesPerSec'
22 |   , 'getInfo'
23 |   , 'getMemoryPool'
24 |   , 'getMemoryPool'
25 |   , 'getMiningInfo'
26 |   , 'getNewAddress'
27 |   , 'getRawTransaction'
28 |   , 'getReceivedByAccount'
29 |   , 'getReceivedByAddress'
30 |   , 'getTransaction'
31 |   , 'getWork'
32 |   , 'help'
33 |   , 'importPrivKey'
34 |   , 'importAddress'
35 |   , 'keyPoolRefill'
36 |   , 'listAccounts'
37 |   , 'listReceivedByAccount'
38 |   , 'listReceivedByAddress'
39 |   , 'listSinceBlock'
40 |   , 'listTransactions'
41 |   , 'listUnspent'
42 |   , 'move'
43 |   , 'sendFrom'
44 |   , 'sendMany'
45 |   , 'sendRawTransaction'
46 |   , 'sendToAddress'
47 |   , 'setAccount'
48 |   , 'setGenerate'
49 |   , 'setTxFee'
50 |   , 'signMessage'
51 |   , 'signRawTransaction'
52 |   , 'stop'
53 |   , 'validateAddress'
54 |   , 'verifyMessage'
55 |   , 'walletLock'
56 |   , 'walletPassphrase'
57 |   , 'walletPassphraseChange'
58 | ]
59 | 
60 | module.exports.isCommand = function(command) {
61 |   command = command.toLowerCase()
62 |   for (var i=0, len=commands.length; i<len; i++) {
63 |     if (commands[i].toLowerCase() === command) {
64 |         return true
65 |     }
66 |   }
67 | }
68 | 


--------------------------------------------------------------------------------
/lib/errors.js:
--------------------------------------------------------------------------------
 1 | module.exports = {
 2 |     RPC_INVALID_REQUEST  : -32600,
 3 |     RPC_METHOD_NOT_FOUND : -32601,
 4 |     RPC_INVALID_PARAMS   : -32602,
 5 |     RPC_INTERNAL_ERROR   : -32603,
 6 |     RPC_PARSE_ERROR      : -32700,
 7 | 
 8 |     // General application defined errors
 9 |     RPC_MISC_ERROR                  : -1,  // std::exception thrown in command handling
10 |     RPC_FORBIDDEN_BY_SAFE_MODE      : -2,  // Server is in safe mode, and command is not allowed in safe mode
11 |     RPC_TYPE_ERROR                  : -3,  // Unexpected type was passed as parameter
12 |     RPC_INVALID_ADDRESS_OR_KEY      : -5,  // Invalid address or key
13 |     RPC_OUT_OF_MEMORY               : -7,  // Ran out of memory during operation
14 |     RPC_INVALID_PARAMETER           : -8,  // Invalid, missing or duplicate parameter
15 |     RPC_DATABASE_ERROR              : -20, // Database error
16 |     RPC_DESERIALIZATION_ERROR       : -22, // Error parsing or validating structure in raw format
17 | 
18 |     // P2P client errors
19 |     RPC_CLIENT_NOT_CONNECTED        : -9,  // Bitcoin is not connected
20 |     RPC_CLIENT_IN_INITIAL_DOWNLOAD  : -10, // Still downloading initial blocks
21 | 
22 |     // Wallet errors
23 |     RPC_WALLET_ERROR                : -4,  // Unspecified problem with wallet (key not found etc.)
24 |     RPC_WALLET_INSUFFICIENT_FUNDS   : -6,  // Not enough funds in wallet or account
25 |     RPC_WALLET_INVALID_ACCOUNT_NAME : -11, // Invalid account name
26 |     RPC_WALLET_KEYPOOL_RAN_OUT      : -12, // Keypool ran out, call keypoolrefill first
27 |     RPC_WALLET_UNLOCK_NEEDED        : -13, // Enter the wallet passphrase with walletpassphrase first
28 |     RPC_WALLET_PASSPHRASE_INCORRECT : -14, // The wallet passphrase entered was incorrect
29 |     RPC_WALLET_WRONG_ENC_STATE      : -15, // Command given in wrong wallet encryption state (encrypting an encrypted wallet etc.)
30 |     RPC_WALLET_ENCRYPTION_FAILED    : -16, // Failed to encrypt the wallet
31 |     RPC_WALLET_ALREADY_UNLOCKED     : -17 // Wallet is already unlocked
32 | }
33 | 


--------------------------------------------------------------------------------
/test/npm-debug.log:
--------------------------------------------------------------------------------
 1 | 0 info it worked if it ends with ok
 2 | 1 verbose cli [ 'c:\\Program Files (x86)\\nodejs\\node.exe',
 3 | 1 verbose cli   'c:\\Program Files (x86)\\nodejs\\node_modules\\npm\\bin\\npm-cli.js',
 4 | 1 verbose cli   'install',
 5 | 1 verbose cli   'dogecoind' ]
 6 | 2 info using npm@1.3.24
 7 | 3 info using node@v0.10.25
 8 | 4 verbose readDependencies using package.json deps
 9 | 5 verbose cache add [ 'dogecoind', null ]
10 | 6 verbose cache add name=undefined spec="dogecoind" args=["dogecoind",null]
11 | 7 verbose parsed url { protocol: null,
12 | 7 verbose parsed url   slashes: null,
13 | 7 verbose parsed url   auth: null,
14 | 7 verbose parsed url   host: null,
15 | 7 verbose parsed url   port: null,
16 | 7 verbose parsed url   hostname: null,
17 | 7 verbose parsed url   hash: null,
18 | 7 verbose parsed url   search: null,
19 | 7 verbose parsed url   query: null,
20 | 7 verbose parsed url   pathname: 'dogecoind',
21 | 7 verbose parsed url   path: 'dogecoind',
22 | 7 verbose parsed url   href: 'dogecoind' }
23 | 8 silly lockFile 07d5bd33-dogecoind dogecoind
24 | 9 verbose lock dogecoind C:\Users\heavy shit\AppData\Roaming\npm-cache\07d5bd33-dogecoind.lock
25 | 10 silly lockFile 07d5bd33-dogecoind dogecoind
26 | 11 silly lockFile 07d5bd33-dogecoind dogecoind
27 | 12 verbose addNamed [ 'dogecoind', '' ]
28 | 13 verbose addNamed [ null, '*' ]
29 | 14 silly lockFile 5747b487-dogecoind dogecoind@
30 | 15 verbose lock dogecoind@ C:\Users\heavy shit\AppData\Roaming\npm-cache\5747b487-dogecoind.lock
31 | 16 silly addNameRange { name: 'dogecoind', range: '*', hasData: false }
32 | 17 verbose url raw dogecoind
33 | 18 verbose url resolving [ 'https://registry.npmjs.org/', './dogecoind' ]
34 | 19 verbose url resolved https://registry.npmjs.org/dogecoind
35 | 20 info trying registry request attempt 1 at 20:17:51
36 | 21 http GET https://registry.npmjs.org/dogecoind
37 | 22 http 404 https://registry.npmjs.org/dogecoind
38 | 23 silly registry.get cb [ 404,
39 | 23 silly registry.get   { date: 'Thu, 13 Mar 2014 03:17:53 GMT',
40 | 23 silly registry.get     server: 'CouchDB/1.5.0 (Erlang OTP/R16B)',
41 | 23 silly registry.get     'content-type': 'application/json',
42 | 23 silly registry.get     via: '1.1 varnish',
43 | 23 silly registry.get     'cache-control': 'max-age=0',
44 | 23 silly registry.get     'content-length': '52',
45 | 23 silly registry.get     'accept-ranges': 'bytes',
46 | 23 silly registry.get     age: '0',
47 | 23 silly registry.get     'x-served-by': 'cache-v43-ASH, cache-lax1427-LAX',
48 | 23 silly registry.get     'x-cache': 'MISS, MISS',
49 | 23 silly registry.get     'x-cache-hits': '0, 0',
50 | 23 silly registry.get     'x-timer': 'S1394680673.516013622,VS0,VS0,VE13,VE77',
51 | 23 silly registry.get     'keep-alive': 'timeout=10, max=50',
52 | 23 silly registry.get     connection: 'Keep-Alive' } ]
53 | 24 silly lockFile 5747b487-dogecoind dogecoind@
54 | 25 silly lockFile 5747b487-dogecoind dogecoind@
55 | 26 error 404 'dogecoind' is not in the npm registry.
56 | 26 error 404 You should bug the author to publish it
57 | 26 error 404 It was specified as a dependency of 'node-dogecoin'
58 | 26 error 404
59 | 26 error 404 Note that you can also install from a
60 | 26 error 404 tarball, folder, or http url, or git url.
61 | 27 error System Windows_NT 6.1.7601
62 | 28 error command "c:\\Program Files (x86)\\nodejs\\node.exe" "c:\\Program Files (x86)\\nodejs\\node_modules\\npm\\bin\\npm-cli.js" "install" "dogecoind"
63 | 29 error cwd c:\Users\heavy shit\Projects\Web Dev\node-dogecoin\test
64 | 30 error node -v v0.10.25
65 | 31 error npm -v 1.3.24
66 | 32 error code E404
67 | 33 verbose exit [ 1, true ]
68 | 


--------------------------------------------------------------------------------
/test/test-node-dogecoin.js:
--------------------------------------------------------------------------------
  1 | var fs = require('fs'),
  2 | 	events = require('events');
  3 | 
  4 | var config = {
  5 |     rpchost: "127.0.0.1",
  6 |     rpcport: 44555,
  7 |     rpcuser: "testnet_user",
  8 |     rpcpassword: "testnet_pass"
  9 | };
 10 | ca = fs.readFileSync('./test/test.crt')
 11 | options = {
 12 |       host: config.rpchost,
 13 |       port: config.rpcport,
 14 |       user: config.rpcuser,
 15 |       pass: config.rpcpassword,
 16 |       passphrasecallback: function () { return "passphrasecallback";},
 17 |       https: true,
 18 |       ca: ca
 19 |     };
 20 | var dogecoin = require('../lib/dogecoin')(options);
 21 | 
 22 | exports.get = function (test) {
 23 | 	var options_keys = Object.keys(options);
 24 | 
 25 | 	var num_propt = Object.keys(options_keys).length;
 26 | 	test.expect(num_propt);
 27 | 	
 28 | 
 29 | 	if( options.length < config.length ){
 30 | 		throw new Error('not all config options being used');
 31 | 		test.done();
 32 | 	}
 33 | 
 34 | 	var idx = 0;
 35 | 	for(var propt in options){
 36 | 		test.deepEqual(dogecoin.get(''+options_keys[idx]), options[''+propt]);
 37 | 		idx ++;
 38 | 	}
 39 | 	
 40 | 	test.done();
 41 | }
 42 | exports.set = function (test) {
 43 | 
 44 | 	var new_options = {
 45 |       host: '133.7.7.7',
 46 |       port: 22556,
 47 |       user: 'new_1337_^*)()',
 48 |       pass: '*&@#cra$%zy@',
 49 |       passphrasecallback: function () { return 1+1;},
 50 |       https: false,
 51 |       ca: 'nothing here'
 52 |     };
 53 | 	var options_keys = Object.keys(new_options);
 54 | 
 55 | 	var num_propt = Object.keys(new_options).length;
 56 | 	test.expect(num_propt);
 57 | 
 58 | 	if( new_options.length < config.length ){
 59 | 		throw new Error('not all config options being used');
 60 | 		test.done();
 61 | 	}
 62 | 
 63 | 	var idx = 0;
 64 | 	for(var propt in new_options){
 65 | 		dogecoin.set(''+options_keys[idx], new_options[ ''+options_keys[idx] ]);
 66 | 		test.deepEqual(dogecoin.get(''+options_keys[idx]), new_options[''+propt]);
 67 | 		idx ++;
 68 | 	}
 69 | 	test.done();
 70 | }
 71 | 
 72 | 
 73 | // NOTE:
 74 | // 			All the code below has beencommented out as
 75 | // 			not sure if account name is the same as the user name or not
 76 | 
 77 | /*
 78 | /* BEFORE RUNNING read below:
 79 |  * Either run dogecoind directly or run dogecoin-qt with the -server
 80 |  * command line option. Make sure you have a ~/.dogecoin/dogecoin.conf
 81 |  * with rpcuser and rpcpassword config values filled out. Note that
 82 |  * newer versions of dogecoin (1.5 and above) don't allow identical
 83 |  * your rpc username and password to be identical.
 84 |  *
 85 |  */
 86 | /*
 87 | exports.commands_noAuth = {		
 88 | 	//NOTE: Before running the getBalance test add some testdoge to your wallet here: http://testdoge.lionservers.de/
 89 | 	// 			or add "gen=1" to the bottom of your dogecoin.conf file
 90 | 	getBalance: function(test){
 91 | 		var curr_balance;
 92 | 		dogecoin.getBalance(function(err, balance) {
 93 | 			test.ifError(err);
 94 | 		  if (err) {
 95 | 		    console.error('Failed to fetch balance', err.message);
 96 | 		  }else {
 97 | 		  	console.log('DOGE balance is', balance);
 98 | 			}
 99 | 		  test.done();
100 | 		});
101 | 	},
102 | 	getBalance: function(test){
103 | 
104 | 	},
105 | 
106 | 	getGenerate: function(test){
107 | 		test.expect(2);
108 | 		dogecoin.setGenerate(true,1);	
109 | 		test.equal(dogecoin.getGenerate(), true);
110 | 
111 | 		dogecoin.setGenerate(false,1);	
112 | 		test.equal(dogecoin.getGenerate(), false);
113 | 		test.done();
114 | 	},
115 | 	getreceived_: function(test){
116 | 		var amount= 0.0001;
117 | 		//dogecoin.setAccount()
118 | 		sendfrom("testnet_user", dogecoin.getaccountaddress('testnet_user'),amount, function(err,addr){
119 | 			test.equal(getreceivedbyaccount('testnet_user', amount);
120 | 			test.equal( getreceivedbyaddress( dogecoin.getaccountaddress('testnet_user') ), amount);
121 | 			test.done();
122 | 
123 | 		});
124 | 
125 | 
126 | 
127 | 	}
128 | 
129 | 	
130 | }
131 | 
132 | //all api commands that need .auth()
133 | exports.commands_Auth = {		
134 | 	
135 | 	setUp: function () {
136 | 		dogecoin.auth('testnet_user', 'testnet_pass');
137 | 	}
138 | 
139 | 	
140 | }
141 | */


--------------------------------------------------------------------------------
/lib/dogecoin.js:
--------------------------------------------------------------------------------
  1 | var http = require('http')
  2 | ,   https = require('https')
  3 | 
  4 | var api  = require('./commands')
  5 | ,   errors = require('./errors')
  6 | 
  7 | function Client(options) { 
  8 |     this.opts = {
  9 |         host:    'localhost'
 10 |      ,  port:    22555
 11 |      ,  method:  'POST'
 12 |      ,  user:    ''
 13 |      ,  pass:    ''
 14 |      ,  headers:  {
 15 |             'Host': 'localhost'
 16 |          ,  'Authorization':  ''
 17 |        }
 18 |      , passphrasecallback: null
 19 |      , https: false
 20 |      , ca: null
 21 |     }
 22 | 
 23 |     if (options) {
 24 |         this.set(options)
 25 |     }
 26 | }
 27 | 
 28 | Client.prototype = {
 29 | 
 30 |     invalid:function(command) {
 31 |         var args = Array.prototype.slice.call(arguments, 1)
 32 |         ,   fn   = args.pop()
 33 | 
 34 |         if (typeof fn !== 'function') {
 35 |             fn = console.log
 36 |         }
 37 | 
 38 |         return fn(new Error('No such command "' + command  + '"'))
 39 |     },
 40 | 
 41 |     send:function(command) {
 42 |         var args = Array.prototype.slice.call(arguments, 1)
 43 |          ,  self = this
 44 |          ,  fn
 45 |         
 46 |         if (typeof args[args.length-1] === 'function') {
 47 |             fn = args.pop().bind(this)
 48 |         }else {
 49 |             fn = console.log
 50 |         }
 51 | 
 52 |         var rpcData = JSON.stringify({
 53 |             id:      new Date().getTime()
 54 |          ,  method:  command.toLowerCase()
 55 |          ,  params:  args
 56 |         })
 57 | 
 58 |         var options = this.opts
 59 |         options.headers['Content-Length'] = rpcData.length
 60 | 
 61 |         var request;
 62 |         if (options.https === true){
 63 |           request = https.request;
 64 |         } else{ 
 65 |           request = http.request;
 66 |         }
 67 | 
 68 |         var req = request(options, function(res) {
 69 |             var data = ''
 70 |             res.setEncoding('utf8')
 71 |             res.on('data', function(chunk) {
 72 |                 data += chunk
 73 |             })
 74 |             res.on('end', function() {
 75 |                 try {
 76 |                     data = JSON.parse(data)
 77 |                 }catch(exception) {
 78 |                     var errMsg = res.statusCode !== 200
 79 |                         ? 'Invalid params ' + res.statusCode
 80 |                         : 'Failed to parse JSON'
 81 |                     errMsg += ' : '+JSON.stringify(data)
 82 |                     return fn(new Error(errMsg))
 83 |                 }
 84 |                 if (data.error) {
 85 |                     if (data.error.code === errors.RPC_WALLET_UNLOCK_NEEDED &&
 86 |                         options.passphrasecallback) {
 87 |                       return self.unlock(command, args, fn)
 88 |                     } else {
 89 |                       var err = new Error(JSON.stringify(data))
 90 |                       err.code = data.error.code
 91 |                       return fn(err)
 92 |                     }
 93 |                 }
 94 |                 fn(null, data.result !== null ? data.result : data)
 95 |             })
 96 |         })
 97 | 
 98 |         req.on('error', fn)
 99 |         req.end(rpcData)
100 |         return this
101 |     },
102 | 
103 |     exec:function(command) {
104 |         var func = api.isCommand(command) ? 'send' : 'invalid'
105 |         return this[func].apply(this, arguments)
106 |     },
107 | 
108 |     auth:function(user, pass) {
109 |         if (user && pass) {
110 |             var authString = ('Basic ') + new Buffer(user+':'+pass).toString('base64')
111 |             this.opts.headers['Authorization'] = authString
112 |         }
113 |       return this
114 |     },
115 | 
116 |     unlock:function(command, args, fn) {
117 |       var self = this
118 | 
119 |       var retry = function(err) {
120 |         if (err) {
121 |           fn(err)
122 |         } else {
123 |           var sendargs = args.slice();
124 |           sendargs.unshift(command);
125 |           sendargs.push(fn)
126 |           self.send.apply(self, sendargs)
127 |         }
128 |       }
129 | 
130 |       this.opts.passphrasecallback(command, args, function(err, passphrase, timeout) {
131 |         if (err) {
132 |           fn(err)
133 |         } else {
134 |           self.send('walletpassphrase', passphrase, timeout, retry)
135 |         }
136 |       })
137 |     },
138 | 
139 |     set:function(k, v) {
140 |         var type = typeof(k);
141 | 
142 |         if (typeof(k) === 'object') {
143 |             for (var key in k) {
144 |                 this.set(key, k[key]);
145 |             };
146 |             return;
147 |         };
148 | 
149 |         var opts = this.opts;
150 |         var k = k.toLowerCase();
151 | 
152 |         if (opts.hasOwnProperty(k)) {
153 |             opts[k] = v
154 |            if (/^(user|pass)$/.test(k)) {
155 |                 this.auth(opts.user, opts.pass)
156 |              }else if (k === 'host') {
157 |                 opts.headers['Host'] = v
158 |             }else if (k === 'passphrasecallback' ||
159 |                       k === 'https' ||
160 |                       k === 'ca') {
161 |                 opts[k] = v
162 |             }
163 |         }
164 | 
165 |         return this;
166 |     },
167 | 
168 |     get:function(k) {
169 |         //Special case for booleans
170 |         if(this.opts[k] === false){
171 |           return false;
172 |         }else {
173 |           if(this.opts[k] !== false){
174 |             var opt = this.opts[k.toLowerCase()]
175 |           }
176 |           return  opt; //new Error('No such option "'+k+'" exists');
177 |         }
178 |     },
179 | 
180 |     errors: errors
181 | 
182 | }
183 | 
184 | api.commands.forEach(function(command) {
185 |     var cp  = Client.prototype;
186 |     var tlc = [command.toLowerCase()];
187 | 
188 |     cp[command] = cp[tlc] = function() {
189 |         cp.send.apply(this, tlc.concat(([]).slice.call(arguments)));
190 |     };
191 | })
192 | 
193 | module.exports = function(options) {
194 |     return new Client(options)
195 | }
196 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # A Node.js DogeCoin Client!
  2 | 
  3 | ![DogeCoin](https://raw.githubusercontent.com/countable/node-dogecoin/master/node-dogecoin.png)
  4 | 
  5 | 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:
  6 | 
  7 | * Provide a one-stop resource for the Node.js developer to get started with Dogecoin integration.
  8 | * Prevent would-be Dogecoin web developers worrying whether a Bitcoin client will work out of the box.
  9 | * Promote Node.js development of Dogecoin web apps.
 10 | * Identify and address any incompatibilities with the Dogecoin and Bitcoin APIs that exist now and/or in the future.
 11 | 
 12 | ## Dependencies
 13 | 
 14 | You'll need a running instance of [dogecoind](https://github.com/dogecoin/dogecoin) to connect with. If you're running Debian/Ubuntu, this worked for me: http://www.dogeco.in/wiki/index.php/Dogecoind
 15 | 
 16 | Then, install the node-dogecoin NPM package.
 17 | 
 18 | `npm install node-dogecoin`
 19 | 
 20 | ## Examples
 21 | 
 22 | Some code examples follow below, but for more complete examples, see [these snippets](https://github.com/brotchie/dogecoin-code-snippets), or this [wallet app](https://github.com/countable/dogelet) which was created to to test this module.
 23 | 
 24 | ```js
 25 | var dogecoin = require('node-dogecoin')()
 26 | 
 27 | dogecoin.auth('myusername', 'mypassword')
 28 | 
 29 | dogecoin.getDifficulty(function() {
 30 |     console.log(arguments);
 31 | })
 32 | 
 33 | ```
 34 | 
 35 | ## Chaining
 36 | 
 37 | Pretty much everything is chainable.
 38 | 
 39 | ```js
 40 | var dogecoin = require('node-dogecoin')()
 41 | 
 42 | dogecoin
 43 | .auth('MyUserName', 'mypassword')
 44 | .getNewAddress()
 45 | .getBalance()
 46 | ```
 47 | 
 48 | ## Methods
 49 | 
 50 | The [Litecoin API](https://litecoin.info/Litecoin_API) is supported as direct methods. Use either camelcase or lowercase.
 51 | 
 52 | ```js
 53 | dogecoin.getNewAddress(function(err, address) {
 54 |     this.validateaddress(address, function(err, info) {
 55 | 
 56 |     })
 57 | })
 58 | ```
 59 | ### .exec(command [string], ...arguments..., callback [function])
 60 | 
 61 | Executes the given command with optional arguments. Function `callback` defaults to `console.log`.
 62 | All of the API commands are supported in lowercase or camelcase. Or uppercase. Anycase!
 63 | 
 64 | ```js
 65 | dogecoin.exec('getNewAddress')
 66 | 
 67 | dogecoin.exec('getbalance', function(err, balance) {
 68 | 
 69 | })
 70 | ```
 71 | 
 72 | ### .set(key [string, object], value [optional])
 73 | 
 74 | Accepts either key & value strings or an Object containing settings, returns `this` for chainability.
 75 | 
 76 | ```js
 77 | dogecoin.set('host', '127.0.0.1')
 78 | ```
 79 | 
 80 | ### .get(key [string])
 81 | 
 82 | Returns the specified option's value
 83 | 
 84 | ```js
 85 | dogecoin.get('user')
 86 | ```
 87 | 
 88 | ### .auth(user [string], pass [string])
 89 | 
 90 | Generates authorization header, returns `this` for chainability
 91 | 
 92 | ## Commands
 93 | 
 94 | TODO: Write tests for these.
 95 | 
 96 | All [Litecoin API](https://litecoin.info/Litecoin_API) commands are supported, in lowercase or camelcase form.
 97 | 
 98 | <table>
 99 | <tr>
100 | <th> Command </th>
101 | <th> Parameters </th>
102 | <th> Description </th>
103 | <th> Requires unlocked wallet?
104 | </th></tr>
105 | <tr>
106 | <td> addmultisigaddress </td>
107 | <td> [nrequired] ["key","key"] [account] </td>
108 | <td> <b>Currently only available on testnet</b> 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]. </td>
109 | <td> N
110 | </td></tr>
111 | <tr>
112 | <td> backupwallet </td>
113 | <td> [destination] </td>
114 | <td> Safely copies wallet.dat to destination, which can be a directory or a path with filename. </td>
115 | <td> N
116 | </td></tr>
117 | <tr>
118 | <td> dumpprivkey </td>
119 | <td> [dogecoinaddress] </td>
120 | <td> Reveals the private key corresponding to <dogecoinaddress< </td>
121 | <td> Y
122 | </td></tr>
123 | <tr>
124 | <td> encryptwallet </td>
125 | <td> [passphrase] </td>
126 | <td> Encrypts the wallet with <passphrase<. </td>
127 | <td> N
128 | </td></tr>
129 | <tr>
130 | <td> getaccount </td>
131 | <td> [dogecoinaddress] </td>
132 | <td> Returns the account associated with the given address. </td>
133 | <td> N
134 | </td></tr>
135 | <tr>
136 | <td> getaccountaddress </td>
137 | <td> [account] </td>
138 | <td> Returns the current dogecoin address for receiving payments to this account. </td>
139 | <td> N
140 | </td></tr>
141 | <tr>
142 | <td> getaddressesbyaccount </td>
143 | <td> [account] </td>
144 | <td> Returns the list of addresses for the given account. </td>
145 | <td> N
146 | </td></tr>
147 | <tr>
148 | <td> getbalance </td>
149 | <td> [account] [minconf=1] </td>
150 | <td> If [account] is not specified, returns the server's total available balance.<br />If [account] is specified, returns the balance in the account. </td>
151 | <td> N
152 | </td></tr>
153 | <tr>
154 | <td> getblock </td>
155 | <td> [hash] </td>
156 | <td> Returns information about the given block hash. </td>
157 | <td> N
158 | </td></tr>
159 | <tr>
160 | <td> getblockcount </td>
161 | <td> </td>
162 | <td> Returns the number of blocks in the longest block chain. </td>
163 | <td> N
164 | </td></tr>
165 | <tr>
166 | <td> getblockhash </td>
167 | <td> [index] </td>
168 | <td> Returns hash of block in best-block-chain at <index< </td>
169 | <td> N
170 | </td></tr>
171 | <tr>
172 | <td> getblocknumber </td>
173 | <td> </td>
174 | <td> <b>Deprecated</b>. Use getblockcount. </td>
175 | <td> N
176 | </td></tr>
177 | <tr>
178 | <td> getconnectioncount </td>
179 | <td> </td>
180 | <td> Returns the number of connections to other nodes. </td>
181 | <td> N
182 | </td></tr>
183 | <tr>
184 | <td> getdifficulty </td>
185 | <td> </td>
186 | <td> Returns the proof-of-work difficulty as a multiple of the minimum difficulty. </td>
187 | <td> N
188 | </td></tr>
189 | <tr>
190 | <td> getgenerate </td>
191 | <td> </td>
192 | <td> Returns true or false whether dogecoind is currently generating hashes </td>
193 | <td> N
194 | </td></tr>
195 | <tr>
196 | <td> gethashespersec </td>
197 | <td> </td>
198 | <td> Returns a recent hashes per second performance measurement while generating. </td>
199 | <td> N
200 | </td></tr>
201 | <tr>
202 | <td> getinfo </td>
203 | <td> </td>
204 | <td> Returns an object containing various state info. </td>
205 | <td> N
206 | </td></tr>
207 | <tr>
208 | <td> getmemorypool </td>
209 | <td> [data] </td>
210 | <td> If [data] is not specified, returns data needed to construct a block to work on:
211 | <ul><li> "version": block version
212 | </li><li> "previousblockhash": hash of current highest block
213 | </li><li> "transactions": contents of non-coinbase transactions that should be included in the next block
214 | </li><li> "coinbasevalue": maximum allowable input to coinbase transaction, including the generation award and transaction fees
215 | </li><li> "time": timestamp appropriate for next block
216 | </li><li> "bits": compressed target of next block
217 | </li></ul>
218 | <p>If [data] is specified, tries to solve the block and returns true if it was successful.
219 | </p>
220 | </td>
221 | <td> N
222 | </td></tr>
223 | <tr>
224 | <td> getmininginfo </td>
225 | <td> </td>
226 | <td> Returns an object containing mining-related information:
227 | <ul><li> blocks
228 | </li><li> currentblocksize
229 | </li><li> currentblocktx
230 | </li><li> difficulty
231 | </li><li> errors
232 | </li><li> generate
233 | </li><li> genproclimit
234 | </li><li> hashespersec
235 | </li><li> pooledtx
236 | </li><li> testnet
237 | </li></ul>
238 | </td>
239 | <td> N
240 | </td></tr>
241 | <tr>
242 | <td> getnewaddress </td>
243 | <td> [account] </td>
244 | <td> 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]. </td>
245 | <td> N
246 | </td></tr>
247 | <tr>
248 | <td> getreceivedbyaccount </td>
249 | <td> [account] [minconf=1] </td>
250 | <td> 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) </td>
251 | <td> N
252 | </td></tr>
253 | <tr>
254 | <td> getreceivedbyaddress </td>
255 | <td> [dogecoinaddress] [minconf=1] </td>
256 | <td> Returns the total amount received by <dogecoinaddress< in transactions with at least [minconf] confirmations. While some might consider this obvious, value reported by this only considers *receiving* transactions. It does not check payments that have been made *from* this address. In other words, this is not "getaddressbalance". Works only for addresses in the local wallet, external addresses will always show 0. </td>
257 | <td> N
258 | </td></tr>
259 | <tr>
260 | <td> gettransaction </td>
261 | <td> [txid] </td>
262 | <td> Returns an object about the given transaction containing:
263 | <ul><li> "amount": total amount of the transaction
264 | </li><li> "confirmations":  number of confirmations of the transaction
265 | </li><li> "txid": the transaction ID
266 | </li><li> "time": time the transaction occurred
267 | </li><li> "details" - An array of objects containing:
268 | <ul><li> "account"
269 | </li><li> "address"
270 | </li><li> "category"
271 | </li><li> "amount"
272 | </li></ul>
273 | </li></ul>
274 | </td>
275 | <td> N
276 | </td></tr>
277 | <tr>
278 | <td> getwork </td>
279 | <td> [data] </td>
280 | <td> If [data] is not specified, returns formatted hash data to work on:
281 | <ul><li> "midstate": precomputed hash state after hashing the first half of the data
282 | </li><li> "data": block data
283 | </li><li> "hash1": formatted hash buffer for second hash
284 | </li><li> "target": little endian hash target
285 | </li></ul>
286 | <p>If [data] is specified, tries to solve the block and returns true if it was successful. 
287 | </p>
288 | </td>
289 | <td> N
290 | </td></tr>
291 | <tr>
292 | <td> help </td>
293 | <td> [command] </td>
294 | <td> List commands, or get help for a command. </td>
295 | <td> N
296 | </td></tr>
297 | <tr>
298 | <td> importprivkey </td>
299 | <td> [dogecoinprivkey] [label] </td>
300 | <td> Adds a private key (as returned by dumpprivkey) to your wallet. </td>
301 | <td> Y
302 | </td></tr>
303 | <tr>
304 | <td> keypoolrefill </td>
305 | <td> </td>
306 | <td> Fills the keypool, requires wallet passphrase to be set. </td>
307 | <td> Y
308 | </td></tr>
309 | <tr>
310 | <td> listaccounts </td>
311 | <td> [minconf=1] </td>
312 | <td> Returns Object that has account names as keys, account balances as values. </td>
313 | <td> N
314 | </td></tr>
315 | <tr>
316 | <td> listreceivedbyaccount </td>
317 | <td> [minconf=1] [includeempty=false] </td>
318 | <td> Returns an array of objects containing:
319 | <ul><li> "account": the account of the receiving addresses
320 | </li><li> "amount": total amount received by addresses with this account
321 | </li><li> "confirmations": number of confirmations of the most recent transaction included
322 | </li></ul>
323 | </td>
324 | <td> N
325 | </td></tr>
326 | <tr>
327 | <td> listreceivedbyaddress </td>
328 | <td> [minconf=1] [includeempty=false] </td>
329 | <td> Returns an array of objects containing:
330 | <ul><li> "address": receiving address
331 | </li><li> "account": the account of the receiving address
332 | </li><li> "amount": total amount received by the address
333 | </li><li> "confirmations": number of confirmations of the most recent transaction included
334 | </li></ul>
335 | <p>To get a list of accounts on the system, execute dogecoind listreceivedbyaddress 0 true
336 | </p>
337 | </td>
338 | <td> N
339 | </td></tr>
340 | <tr>
341 | <td> listsinceblock</td>
342 | <td> [blockhash] [target-confirmations] </td>
343 | <td> Get all transactions in blocks since block [blockhash], or all transactions if omitted. </td>
344 | <td> N
345 | </td></tr>
346 | <tr>
347 | <td> listtransactions </td>
348 | <td> [account] [count=10] [from=0] </td>
349 | <td> 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.
350 | </td>
351 | <td> N
352 | </td></tr>
353 | <tr>
354 | <td> move </td>
355 | <td> [fromaccount] [toaccount] [amount] [minconf=1] [comment] </td>
356 | <td> Move from one account in your wallet to another </td>
357 | <td> N
358 | </td></tr>
359 | <tr>
360 | <td> sendfrom </td>
361 | <td> [fromaccount] [todogecoinaddress] [amount] [minconf=1] [comment] [comment-to] </td>
362 | <td> <amount< is a real and is rounded to 8 decimal places. Will send the given amount to the given address, ensuring the account has a valid balance using [minconf] confirmations. Returns the transaction ID if successful (not in JSON object). </td>
363 | <td> Y
364 | </td></tr>
365 | <tr>
366 | <td> sendmany </td>
367 | <td> [fromaccount] [address:amount,...] [minconf=1] [comment] </td>
368 | <td> amounts are double-precision floating point numbers </td>
369 | <td> Y
370 | </td></tr>
371 | <tr>
372 | <td> sendtoaddress </td>
373 | <td> [dogecoinaddress] [amount] [comment] [comment-to] </td>
374 | <td> <amount< is a real and is rounded to 8 decimal places. Returns the transaction ID <txid< if successful. </td>
375 | <td> Y
376 | </td></tr>
377 | <tr>
378 | <td> setaccount </td>
379 | <td> [dogecoinaddress] [account] </td>
380 | <td> 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. </td>
381 | <td> N
382 | </td></tr>
383 | <tr>
384 | <td> setgenerate </td>
385 | <td> [generate] [genproclimit] </td>
386 | <td> [generate] is true or false to turn generation on or off.
387 | 
388 | Generation is limited to [genproclimit] processors, -1 is unlimited. </td>
389 | <td> N
390 | </td></tr>
391 | <tr>
392 | <td> signmessage </td>
393 | <td> [dogecoinaddress] [message] </td>
394 | <td> Sign a message with the private key of an address. </td>
395 | <td> Y
396 | </td></tr>
397 | <tr>
398 | <td> settxfee </td>
399 | <td> [amount] </td>
400 | <td> [amount] is a real and is rounded to the nearest 0.00000001 </td>
401 | <td> N
402 | </td></tr>
403 | <tr>
404 | <td> stop </td>
405 | <td> </td>
406 | <td> Stop dogecoin server. </td>
407 | <td> N
408 | </td></tr>
409 | <tr>
410 | <td> validateaddress </td>
411 | <td> [dogecoinaddress] </td>
412 | <td> Return information about [dogecoinaddress]. </td>
413 | <td> N
414 | </td></tr>
415 | <tr>
416 | <td> verifymessage </td>
417 | <td> [dogecoinaddress] [signature] [message] </td>
418 | <td> Verify a signed message. </td>
419 | <td> N
420 | </td></tr>
421 | <tr>
422 | <td> walletlock </td>
423 | <td>  </td>
424 | <td> 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. </td>
425 | <td> N
426 | </td></tr>
427 | <tr>
428 | <td> walletpassphrase </td>
429 | <td> [passphrase] [timeout] </td>
430 | <td> Stores the wallet decryption key in memory for <timeout< seconds. </td>
431 | <td> N
432 | </td></tr>
433 | <tr>
434 | <td> walletpassphrasechange </td>
435 | <td> [oldpassphrase] [newpassphrase] </td>
436 | <td> Changes the wallet passphrase from <oldpassphrase< to <newpassphrase<. </td>
437 | <td> N
438 | </td></tr></table>
439 | 
440 | ## Options
441 | 
442 | You may pass options to the initialization function or to the `set` method.
443 | 
444 | ```js
445 | 
446 | var dogecoin = require('dogecoin')({
447 |     user:'user'
448 | })
449 | 
450 | dogecoin.set('pass', 'somn')
451 | dogecoin.set({port:22555})
452 | 
453 | ```
454 | 
455 | Available options and default values:
456 | 
457 | + host *localhost*
458 | + port *22555*
459 | + user
460 | + pass
461 | + passphrasecallback
462 | + https
463 | + ca
464 | 
465 | ### Passphrase Callback
466 | 
467 | 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.
468 | 
469 | 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:
470 | 
471 |     function(command, args, callback) {}
472 | 
473 | + **command** is the command that failed due to a locked wallet.
474 | + **args** is the arguments for the failed command.
475 | + **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.
476 | 
477 | You may hard code your passphrase (not recommended) as follows:
478 | 
479 | ```js
480 | var dogecoin = require('node-dogecoin')({
481 |     passphrasecallback: function(command, args, callback) {
482 |         callback(null, 'passphrase', 30);
483 |     }
484 | })
485 | ```
486 | 
487 | Because `passphrasecallback` is a continuation, you can retrieve the passphrase in an asynchronous manner. For example, by prompting the user:
488 | 
489 | ```js
490 | var readline = require('readline')
491 | 
492 | var rl = readline.createInterface({
493 |   input: process.stdin,
494 |   output: process.stdout
495 | })
496 | 
497 | var dogecoin = require('node-dogecoin')({
498 |   passphrasecallback: function(command, args, callback) {
499 |     rl.question('Enter passphrase for "' + command + '" operation: ', function(passphrase) {
500 |       if (passphrase) {
501 |         callback(null, passphrase, 1)
502 |       } else {
503 |         callback(new Error('no passphrase entered'))
504 |       }
505 |     })
506 |   }
507 | })
508 | ```
509 | 
510 | ### Secure RPC with SSL
511 | 
512 | 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`:
513 | 
514 |     rpcssl=1
515 |     rpcsslcertificatechainfile=/etc/ssl/certs/dogecoind.crt
516 |     rpcsslprivatekeyfile=/etc/ssl/private/dogecoind.pem
517 | 
518 | 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!
519 |     
520 | ```js
521 | var fs = require('fs')
522 | 
523 | var ca = fs.readFileSync('dogecoind.crt')
524 | 
525 | var dogecoin = require('node-dogecoin')({
526 |   user: 'rpcusername',
527 |   pass: 'rpcpassword',
528 |   https: true,
529 |   ca: ca
530 | })
531 | ```
532 | 
533 | ## Testing
534 | 
535 | ```
536 | npm install -g nodeunit
537 | 
538 | nodeunit test/test-node-dogecoin.js
539 | ```
540 | 
541 | ## Bounties
542 | 
543 | [Dogecoin](http://www.dogecoin.com) donation address is DE4isu3m2RBma7nGEwnaX8cu4Y2m2J2g8Q
544 | 
545 | Donations in [dogecoin](http://www.dogecoin.com) 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!](http://www.reddit.com/r/dogecoindev/comments/203ojs/add_a_dogecoin_donation_link_in_your_github_repo/)
546 | 
547 | 
548 | 
549 | 


--------------------------------------------------------------------------------