View source for Node Litecoin

= node-litecoin =

node-litecoin is a simple node.js wrapper for the Litecoin client's JSON-RPC API.

The API is equivalent to the API document [https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list here]. The methods are exposed as lower camelcase methods on the <code>litecoin.Client</code> object.

== Install ==

<code>npm install litecoin</code>

== Setup ==

<ol style="list-style-type: decimal;">
<li><p>Traverse to <code>~/.litecoin</code> or <code>~/Library/Application Support/Litecoin</code> and add a file called <code>litecoin.conf</code> if it doesn't already exist.</p></li>
<li><p>Add these lines to the file:</p>
<p>rpcuser=username</p>
<p>rpcpassword=password</p></li></ol>

You will use these to login to the server.

<ol start="3" style="list-style-type: decimal;">
<li><p>Start your Litecoin client with the <code>-server</code> argument or run <code>litecoind</code></p></li>
<li><p>You should now be able to communicate with Litecoin JSON-RPC API using the node-litecoin library, try it out!</p></li></ol>

== Examples ==
=== Create client ===

<pre class="js">var litecoin = require('litecoin');
var client = new litecoin.Client('localhost', 9332, 'username', 'password');
</pre>


=== Create client with single object ===

<pre class="js">var client = new litecoin.Client({
  host: 'localhost',
  port: 9332,
  username: 'username',
  password: 'password'
});</pre>
=== Get balance across all accounts with minimum confirmations of 6 ===

<pre class="js">
client.getBalance('*', 6, function(err, balance) {
  if (err) console.log(err);
  console.log('Balance: ' + balance);
});</pre>
=== Get the network hash rate ===

<pre class="js">client.getNetworkHashPS(function(err, hashps) {
  if (err) console.log(err);
  console.log('Network Hash Rate: ' + hashps);
});</pre>