Difference between revisions of "Node Litecoin"

From Litecoin Wiki
Jump to: navigation, search
Line 1: Line 1:
−
# node-litecoin
+
= node-litecoin =
  
 
node-litecoin is a simple node.js wrapper for the Litecoin client's JSON-RPC API.
 
node-litecoin is a simple node.js wrapper for the Litecoin client's JSON-RPC API.
  
−
The API is equivalent to the API document [here](https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list).
+
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 methods are exposed as lower camelcase methods on the `litecoin.Client`
+
−
object.
+
  
 
== Install ==
 
== Install ==
  
−
`npm install litecoin`
+
<code>npm install litecoin</code>
  
 
== Setup ==
 
== Setup ==
  
−
1. Traverse to `~/.litecoin` or `~/Library/Application Support/Litecoin` and add a file called `litecoin.conf` if it doesn't already exist.
+
<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>
−
2. Add these lines to the file:
+
<li><p>Add these lines to the file:</p>
−
 
+
<p>rpcuser=username</p>
−
    rpcuser=username
+
<p>rpcpassword=password</p></li></ol>
−
 
+
−
    rpcpassword=password
+
  
 
You will use these to login to the server.
 
You will use these to login to the server.
  
−
3. Start your Litecoin client with the `-server` argument or run `litecoind`
+
<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>
−
4. You should now be able to communicate with Litecoin JSON-RPC API using the
+
<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>
−
node-litecoin library, try it out!
+
−
 
+
−
## Examples
+
−
 
+
−
### Create client
+
−
```js
+
−
var litecoin = require('litecoin');
+
−
var client = new litecoin.Client('localhost', 9332, 'username', 'password');
+
−
```
+
−
 
+
−
### Create client with single object
+
−
```js
+
−
var client = new litecoin.Client({
+
−
  host: 'localhost',
+
−
  port: 9332,
+
−
  username: 'username',
+
−
  password: 'password'
+
−
});
+
−
```
+
−
 
+
−
### Get balance across all accounts with minimum confirmations of 6
+
−
 
+
−
```js
+
−
 
+
−
client.getBalance('*', 6, function(err, balance) {
+
−
  if (err) console.log(err);
+
−
  console.log('Balance: ' + balance);
+
−
});
+
−
```
+
−
 
+
−
### Get the network hash rate
+
  
−
```js
+
== Examples ==
−
client.getNetworkHashPS(function(err, hashps) {
+
−
  if (err) console.log(err);
+
−
  console.log('Network Hash Rate: ' + hashps);
+
−
});
+
−
```
+

Revision as of 09:23, 30 April 2013

Retrieved from "http://en.litecoinpedia.org/w/index.php?title=Node_Litecoin&oldid=455"
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox