# node-eth-rpc

> Communicate with Geth via JSON-RPC

Latest version **0.0.4** (published 2020-01-26) · 0 weekly downloads

## Install

```sh
npm install node-eth-rpc
pnpm add node-eth-rpc
yarn add node-eth-rpc
bun add node-eth-rpc
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2020-01-26 |
| First published | 2017-07-18 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Unpacked size | 11.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Bruno Kenj |
| Maintainers | brunokenj |
| Keywords | ethereum, geth, eth, rpc |

## Links

- npm: https://www.npmjs.com/package/node-eth-rpc
- Repository: https://github.com/brunokenj/node-ethcoin
- Homepage: https://github.com/brunokenj/node-ethcoin#readme
- Issues: https://github.com/brunokenj/node-ethcoin/issues
- npm.io page: https://npm.io/package/node-eth-rpc

## Dependencies (1)

- [deprecate](https://npm.io/package/deprecate.md) ~0.1.0

## Recent versions

- 0.0.4 (latest) — 2020-01-26
- 0.0.3 — 2017-07-18
- 0.0.1 — 2017-07-18

## README

# node-ethcoin

node-ethcoin is a simple wrapper for the geth client's JSON-RPC API. V 0.0.4

## Install

`npm install node-eth-rpc`

## Examples

### Create client
```js
var client = new ethcoin.Client({
  host: 'localhost',
  port: 8545,
  user: '',
  pass: ''
});
```

### Create client for 
```js
var client = new ethcoin.Client({
  host: 'mainnet.infura.io',
  port: 443,
  path: '/v3/:projectId'
});
```

### Get all accounts

```js
client.cmd('personal_listAccounts', function(err, accounts){
  if (err) return console.log(err);
  console.log('personal_listAccounts:', accounts);
});
```
### Getting the balance directly using `cmd`

```js
client.cmd('eth_getBalance', 'accountAddress', 'latest', function(err, balance){
  if (err) return console.log(err);
  console.log('Balance:', balance);
});
```

### Batch multiple RPC calls into single HTTP request

```js
var batch = [];
for (var i = 0; i < 10; ++i) {
  batch.push({
    method: 'getnewaddress',
    params: ['myaccount']
  });
}
client.cmd(batch, function(err, address) {
  if (err) return console.log(err);
  console.log('Address:', address);
});
```

## SSL
See [Enabling SSL on original client](https://en.bitcoin.it/wiki/Enabling_SSL_on_original_client_daemon).

If you're using this to connect to darkcoind across a network it is highly
recommended to enable `ssl`, otherwise an attacker may intercept your RPC credentials
resulting in theft of your darkcoins.

When enabling `ssl` by setting the configuration option to `true`, the `sslStrict`
option (verifies the server certificate) will also be enabled by default. It is 
highly recommended to specify the `sslCa` as well, even if your darkcoind has
a certificate signed by an actual CA, to ensure you are connecting
to your own darkcoind.

```js
var client = new darkcoin.Client({
  host: 'localhost',
  port: 15715,
  user: 'username',
  pass: 'password',
  ssl: true,
  sslStrict: true,
  sslCa: fs.readFileSync(__dirname + '/server.cert')
});
```

If your using a self signed certificate generated with something like 

`openssl x509 -req -days 365 -in server.cert -signkey server.key -out server.cert`

then `sslStrict` should be set to `false` because by defult node wont work with 
untrusted certificates. 

## Forked
forked from doomhz/node-darkcoin

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