Skip to content
DogeCoin client for NodeJS, forked from Kapitalize.
Branch: master
Clone or download
Pull request Compare This branch is 56 commits behind countable:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
LICENSE
README.md
package.json

README.md

A Node.JS DogeCoin Client!

DogeCoin

node-dogecoin is a Dogecoin client for Node.JS. It is a fork of the excellent http://github.com/Weltschmerz/Kapitalize.git intended for use with Dogecoin. It's currently very nearly identical to Kaptialize, which can be used for Dogecoin too. The purpose of this repository is primarily:

  • Provide a one-stop resource for the Node.JS developer to get started with Dogecoin integration.
  • Prevent would-be Dogecoin web developers worrying whether the 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.

Dependencies

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

Example

var dogecoin = require('node-dogecoin')()

dogecoin.auth('myusername', 'mypassword')

dogecoin.getDifficulty(function() {
    console.log(arguments);
})

Chaining

Pretty much everything is chainable.

var dogecoin = require('dogecoin')()

dogecoin
.auth('MyUserName', 'mypassword')
.getNewAddress()
.getBalance()

Methods

TODO: Verify and test with Dogecoin.

The Bitcoin API is supported as direct methods. Use either camelcase or lowercase.

dogecoin.getNewAddress(function(err, address) {
    this.validateaddress(address, function(err, info) {

    })
})

.exec(command [string], ...arguments..., callback [function])

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) {

})

.set(key [string, object], value [optional])

Accepts either key & value strings or an Object containing settings, returns this for chainability.

dogecoin.set('host', '127.0.0.1')

.get(key [string])

Returns the specified option's value

dogecoin.get('user')

.auth(user [string], pass [string])

Generates authorization header, returns this for chainability

Commands

TODO: Verify and test these with Dogecoin.

All Bitcoin 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:
  • "version": block version
  • "previousblockhash": hash of current highest block
  • "transactions": contents of non-coinbase transactions that should be included in the next block
  • "coinbasevalue": maximum allowable input to coinbase transaction, including the generation award and transaction fees
  • "time": timestamp appropriate for next block
  • "bits": compressed target of next block

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:
  • blocks
  • currentblocksize
  • currentblocktx
  • difficulty
  • errors
  • generate
  • genproclimit
  • hashespersec
  • pooledtx
  • testnet
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:
  • "amount": total amount of the transaction
  • "confirmations": number of confirmations of the transaction
  • "txid": the transaction ID
  • "time": time the transaction occurred
  • "details" - An array of objects containing:
    • "account"
    • "address"
    • "category"
    • "amount"
N
getwork [data] If [data] is not specified, returns formatted hash data to work on:
  • "midstate": precomputed hash state after hashing the first half of the data
  • "data": block data
  • "hash1": formatted hash buffer for second hash
  • "target": little endian hash target

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:
  • "account": the account of the receiving addresses
  • "amount": total amount received by addresses with this account
  • "confirmations": number of confirmations of the most recent transaction included
N
listreceivedbyaddress [minconf=1] [includeempty=false] Returns an array of objects containing:
  • "address": receiving address
  • "account": the account of the receiving address
  • "amount": total amount received by the address
  • "confirmations": number of confirmations of the most recent transaction included

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

Options

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
You can’t perform that action at this time.