Difference between revisions of "Node Litecoin"
From Litecoin Wiki
Line 1: | Line 1: | ||
− | + | 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. | 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. | ||
Line 14: | Line 12: | ||
<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>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> | <li><p>Add these lines to the file:</p> | ||
− | <p>rpcuser=username</p> | + | <code><p>rpcuser=username</p> |
− | <p>rpcpassword=password</p></li></ol> | + | <p>rpcpassword=password</p></code></li></ol> |
You will use these to login to the server. | You will use these to login to the server. | ||
Line 24: | Line 22: | ||
== Examples == | == 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> | ||
+ | |||
+ | :''Sourced from [https://github.com/litecoin-project/litecoin/wiki/node-litecoin Node Litcoin] |