# litecoin-cli

> Communicate with litecoind via JSON-RPC

Latest version **1.0.3** (published 2019-07-31) · GNU General Public License v3.0 license · 0 weekly downloads

## Install

```sh
npm install litecoin-cli
pnpm add litecoin-cli
yarn add litecoin-cli
bun add litecoin-cli
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-07-31 |
| First published | 2019-07-30 |
| Weekly downloads | 0 |
| License | GNU General Public License v3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 0 |
| Unpacked size | 45.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Datta Gsr |
| Maintainers | gsrdatta |
| Keywords | litecoin-cli, rpc |

## Links

- npm: https://www.npmjs.com/package/litecoin-cli
- Repository: https://github.com/gsrdatta/litecoin-cli
- Homepage: https://github.com/gsrdatta/litecoin-cli#readme
- Issues: https://github.com/gsrdatta/litecoin-cli/issues
- npm.io page: https://npm.io/package/litecoin-cli

## Recent versions

- 1.0.3 (latest) — 2019-07-31
- 1.0.2 — 2019-07-30
- 1.0.1 — 2019-07-30
- 2.0.5 — 2019-07-30

## README

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

clone of https://github.com/Dexon95/node-litecoin (added some more commands)

The API is equivalent to the API document [here](https://web.archive.org/web/20160430054919/https://litecoin.info/Litecoin_API).
The methods are exposed as lower camelcase methods on the `litecoin.Client` object.

## Install

`npm install litecoin-cli`

## Setup

1. Traverse to `~/.litecoin` or `~/Library/Application Support/Litecoin` and add a file called `litecoin.conf` if it doesn't already exist.

2. Add these lines to the file:

    rpcuser=username

    rpcpassword=password

You will use these to login to the server.

3. Start your Litecoin client with the `-server` argument or run `litecoind`

4. You should now be able to communicate with Litecoin JSON-RPC API using the
node-litecoin library, try it out!

## Examples

### Create client
```js
var litecoin = require('litecoin-cli');
var client = new litecoin.Client({
  host: 'localhost',
  port: 9332,
  user: 'username',
  pass: '$3cr37P@s5w0rd',
  timeout: 30000,
  ssl: false/* true,
  sslStrict: true,
  sslCa: fs.readFileSync(__dirname + '/myca.cert')*/
});
```

### Get balance across all accounts with minimum confirmations of 6
```js
client.getBalance('*', 6, function(err, balance) {
  if (err) console.error(err);
  console.log('Balance: ' + balance);
});
```

### Get the network hash rate
```js
client.getNetworkHashPs(function(err, hashps) {
  if (err) console.error(err);
  console.log('Network Hash Rate: ' + hashps);
});
```

---
_Source: https://npm.io/package/litecoin-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._