# zcash

> zcash library for Node

Latest version **0.2.0** (published 2018-03-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install zcash
pnpm add zcash
yarn add zcash
bun add zcash
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2018-03-12 |
| First published | 2016-10-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Maintainers | montyanderson |

## Links

- npm: https://www.npmjs.com/package/zcash
- Repository: https://github.com/montyanderson/zcash
- Homepage: https://github.com/montyanderson/zcash#readme
- Issues: https://github.com/montyanderson/zcash/issues
- npm.io page: https://npm.io/package/zcash

## Recent versions

- 0.2.0 (latest) — 2018-03-12
- 0.1.0 — 2017-07-19
- 0.0.6 — 2017-07-19
- 0.0.5 — 2016-11-12
- 0.0.4 — 2016-11-11
- 0.0.3 — 2016-11-10
- 0.0.2 — 2016-10-31
- 0.0.1 — 2016-10-31

## README

# zcash

:dollar: Minimal [Zcash](https://z.cash/) library for Node.js

> Note: This library has been succeeded by the isomorphic library [stdrpc](https://github.com/montyanderson/stdrpc).

```
npm install zcash --save
```

## Features

* A fast, concise codebase, with zero dependencies.
* Supports all commands listed in the [zcash Payment API](https://github.com/zcash/zcash/blob/master/doc/payment-api.md).
* Test suite!

## To Do

* Write a more full test suite.

## API

### Zcash.auto()

Returns a new `Zcash` instance, after reading the username and password from `HOME/.zcash/zcash.conf`. You can then use all the RPC commands as normal.

``` javascript
const rpc = Zcash.auto();

rpc.z_listaddresses().then(addresses => {
	console.log(addresses);
});
```

### new Zcash(options)

Returns a new `Zcash` instances, with the specified options.

#### options

Type: `object`

###### username

The RPC username.

Type: `string`

###### password

The RPC password.

Type: `string`

###### host

The RPC host.

Type: `string`

###### port

The RPC port.

Type: `number`

``` javascript
const Zcash = require("zcash");

const rpc = new Zcash({
	username: "__username__",
	password: "__password__"
});

rpc.z_listaddresses().then(addresses => {
	console.log(addresses);
});
```

``` javascript
[ 'zcW36oxxUKViWZsFUb6SUDLr61b3N6EaY9oRt8zPYhxFAUGRwUNCLuGFfd2yxYrDgM5ouLkTDHMRdGNgVqJgriHncbjRedN' ]
```

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