# @mutopad/connex-driver

> Connex framework driver implementation

Latest version **0.0.2** (published 2023-05-05) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @mutopad/connex-driver
pnpm add @mutopad/connex-driver
yarn add @mutopad/connex-driver
bun add @mutopad/connex-driver
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2023-05-05 |
| First published | 2023-05-03 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 154.8 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | qianbin |
| Maintainers | mutopad |
| Keywords | Connex, Driver, VeChain |

## Links

- npm: https://www.npmjs.com/package/@mutopad/connex-driver
- Repository: https://github.com/mohsin-laeeque/mutopad-connex
- Homepage: https://github.com/mohsin-laeeque/mutopad-connex/tree/marster/packages/driver/#readme
- Issues: https://github.com/mohsin-laeeque/mutopad-connex/issues
- npm.io page: https://npm.io/package/@mutopad/connex-driver

## Dependencies (7)

- [ws](https://npm.io/package/ws.md) ^7.1.0
- [axios](https://npm.io/package/axios.md) ^0.21.1
- [lru-cache](https://npm.io/package/lru-cache.md) ^5.1.1
- [thor-devkit](https://npm.io/package/thor-devkit.md) ^2.0.5
- [bignumber.js](https://npm.io/package/bignumber.js.md) ^7.2.1
- [isomorphic-ws](https://npm.io/package/isomorphic-ws.md) ^4.0.1
- [@mutopad/connex-types](https://npm.io/package/@mutopad/connex-types.md) ^0.0.5

## Recent versions

- 0.0.2 (latest) — 2023-05-05
- 0.0.1 — 2023-05-03

## README

# Connex Driver

[![npm version](https://badge.fury.io/js/%40vechain%2Fconnex-driver.svg)](https://badge.fury.io/js/%40vechain%2Fconnex-driver)

This library implement Connex.Driver, which drives Connex Framework.

## Installation

```bash
# install driver along with framework
npm i @mutopad/connex-framework @mutopad/connex-driver
```

## Usage

The [REPL playground](https://github.com/mohsin-laeeque/mutopad-connex/tree/master/packages/repl) is a good start.


```typescript
import { Framework } from '@mutopad/connex-framework'
import { Driver, SimpleNet, SimpleWallet } from '@mutopad/connex-driver'

const wallet = new SimpleWallet()
// add account by importing private key
wallet.import('<private key>')

const driver = await Driver.connect(new SimpleNet('http://localhost:8669/'), wallet)
const connex = new Framework(driver)
// here get connex object ready to use
...

// config tx parameters, e.g. expiration, gasPriceCoef
driver.txParams.expiration = 18
driver.txParams.gasPriceCoef = 128

// watch committed tx
driver.onTxCommit = txObj => {
    // 
}
```

## License

This package is licensed under the
[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.html), also included
in *LICENSE* file in the repository.

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