# exc-balance-checker

> One-function solution for checking an address' balance on Eximchain's main or gamma networks.

Latest version **2.2.0** (published 2019-04-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install exc-balance-checker
pnpm add exc-balance-checker
yarn add exc-balance-checker
bun add exc-balance-checker
```

## 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 | 2.2.0 |
| Published | 2019-04-12 |
| First published | 2018-09-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | John O'Sullivan |
| Maintainers | fcolon, godokoro, john-osullivan, louis-eximchain |

## Links

- npm: https://www.npmjs.com/package/exc-balance-checker
- Repository: https://github.com/Eximchain/exc-balance-checker
- Homepage: https://github.com/Eximchain/exc-balance-checker#readme
- Issues: https://github.com/Eximchain/exc-balance-checker/issues
- npm.io page: https://npm.io/package/exc-balance-checker

## Dependencies (4)

- [web3](https://npm.io/package/web3.md) 1.0.0-beta.34
- [@types/node](https://npm.io/package/@types/node.md) ^11.13.4
- [lodash.sample](https://npm.io/package/lodash.sample.md) ^4.2.1
- [@babel/polyfill](https://npm.io/package/@babel/polyfill.md) ^7.0.0

## Recent versions

- 2.2.0 (latest) — 2019-04-12
- 2.1.2 — 2019-02-22
- 2.1.1 — 2019-02-21
- 2.1.0 — 2019-02-11
- 2.0.1 — 2019-02-08
- 2.0.0 — 2019-02-08
- 1.1.2 — 2018-11-20
- 1.1.1 — 2018-11-20
- 1.1.0 — 2018-11-19
- 1.0.4 — 2018-09-26
- 1.0.3 — 2018-09-26
- 1.0.2 — 2018-09-26
- 1.0.1 — 2018-09-26
- 1.0.0 — 2018-09-25
- 0.1.1 — 2018-09-25
- … 1 more at https://npm.io/package/exc-balance-checker/versions

## README

# exc-balance-checker
Code for checking an address' balance on Eximchain's main and test networks.

## Usage
Install via:
```
npm install --save exc-balance-checker
```

Import the checker function:
```
import excChecker from 'exc-balance-checker';
```

The balance checker returns a Promise and comes with URLs to our Community Nodes already baked in, so you're ready to go:
```
const acctBalance = await excChecker(yourAddr, options);
```

The options object has a few possible keys:

| Key Name | Default Value | Usage |
| -- | -- | -- |
| `useTestNet` | `false` | Boolean, set true to query test net instead of main net. |
| `customEndpoint` | `undefined` | Set if you want to plug in your own node address.  Cannot be specified along with `useTestNet`. |
| `requireChecksum` | `false` | Web3 typically requires that addresses follow checksum capitalization, but we disable that check.  Set to true to re-enable. |
| `user` | `null` | `user` argument for `web3.HttpProvider`. |
| `timeout` | `null` | `timeout` argument for `web3.HttpProvider`. |
| `password` | `null` | `password` argument for `web3.HttpProvider`. |
| `headers` | `null` | `headers` argument for `web3.HttpProvider`.  Useful for setting the CORS `Access-Control-Allow-Origin` header, as Firefox and Safari will block requests which do not have that set. |

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