# gonweb

> JavaScript SDK that encapsulates the GON HTTP API

Latest version **1.0.6** (published 2020-11-06) · MIT license · 0 weekly downloads

## Install

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

## 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.6 |
| Published | 2020-11-06 |
| First published | 2020-09-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 6.4 MB |
| Known vulnerabilities | 0 (+26 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | woodypawn |
| Maintainers | woodypawn |

## Links

- npm: https://www.npmjs.com/package/gonweb
- Repository: https://github.com/gaia-chain/gonweb
- Homepage: https://github.com/gaia-chain/gonweb#readme
- Issues: https://github.com/gaia-chain/gonweb/issues
- npm.io page: https://npm.io/package/gonweb

## Dependencies (9)

- [axios](https://npm.io/package/axios.md) ^0.19.0
- [ethers](https://npm.io/package/ethers.md) ^4.0.7
- [elliptic](https://npm.io/package/elliptic.md) ^6.4.1
- [eth-crypto](https://npm.io/package/eth-crypto.md) ^1.8.0
- [bignumber.js](https://npm.io/package/bignumber.js.md) ^7.2.1
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.26.0
- [injectpromise](https://npm.io/package/injectpromise.md) ^1.0.0
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.0.0
- [ethereumjs-util](https://npm.io/package/ethereumjs-util.md) ^7.0.5

## Recent versions

- 1.0.6 (latest) — 2020-11-06
- 1.0.5 — 2020-10-19
- 1.0.4 — 2020-10-09
- 1.0.3 — 2020-10-09
- 1.0.2 — 2020-10-09
- 1.0.1 — 2020-09-29
- 1.0.0 — 2020-09-23

## README

# gonweb - GON JavaScript SDK

## Installation

### Node.js
```bash
npm install gonweb
```
or
```bash
yarn add gonweb
```

### Browser
First, don't use the release section of this repo, it has not updated in a long time.

Then easiest way to use GonWeb in a browser is to install it as above and copy the dist file to your working folder. For example:
```
cp node_modules/gonweb/dist/GonWeb.js ./js/GonWeb.js
```
so that you can call it in your HTML page as
```
<script src="./js/GonWeb.js"><script>
```

## Creating an Instance

First off, in your javascript file, define GonWeb:

```js
const GonWeb = require('gonweb')
```

When you instantiate GonWeb you can define

* fullNode
* privateKey


```js
const gonWeb = new GonWeb({
    fullHost: 'https://testnet.gonscan.com/v1/api/',
    privateKey: 'your private key'
})
```

## Contributions

In order to contribute you can

* fork this repo and clone it locally
* install the dependencies — `npm i`
* do your changes to the code
* build the GonWeb dist files — `npm run build`
* push your changes and open a pull request

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