# @gnosis.pm/dex-js

> Gnosis Protocol JS integration: utils, contracts and other goodies

Latest version **0.14.0** (published 2021-12-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gnosis.pm/dex-js
pnpm add @gnosis.pm/dex-js
yarn add @gnosis.pm/dex-js
bun add @gnosis.pm/dex-js
```

## 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.14.0 |
| Published | 2021-12-15 |
| First published | 2019-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 246.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | alfetopito, anxolin, bh2smith, fleupold, josojo, nlordell, w3stside, fedgiac, gnosisdex |

## Links

- npm: https://www.npmjs.com/package/@gnosis.pm/dex-js
- Repository: https://github.com/gnosis/dex-js
- Homepage: https://github.com/gnosis/dex-js#readme
- Issues: https://github.com/gnosis/dex-js/issues
- npm.io page: https://npm.io/package/@gnosis.pm/dex-js

## Dependencies (2)

- [bignumber.js](https://npm.io/package/bignumber.js.md) ^9.0.2
- [@gnosis.pm/dex-contracts](https://npm.io/package/@gnosis.pm/dex-contracts.md) ^0.5.0

## Recent versions

- 0.14.0 (latest) — 2021-12-15
- 0.13.0 — 2021-12-03
- 0.12.0 — 2021-08-25
- 0.11.0 — 2021-07-07
- 0.10.0 — 2021-05-03
- 0.10.0-RC.0 — 2021-04-30
- 0.9.0 — 2021-02-10
- 0.8.1-rc.0 — 2020-10-12
- 0.8.0 — 2020-10-01
- 0.7.1 — 2020-09-25
- 0.6.1 — 2020-09-25
- 0.7.1-rc.0 — 2020-09-25
- 0.7.0 — 2020-09-24
- 0.6.0 — 2020-09-22
- 0.5.0 — 2020-09-17
- … 74 more at https://npm.io/package/@gnosis.pm/dex-js/versions

## README

[![npm version](https://img.shields.io/npm/v/@gnosis.pm/dex-js.svg?style=flat)](https://npmjs.org/package/@gnosis.pm/dex-js 'View this project on npm')
 
[![Build Status](https://travis-ci.org/gnosis/dex-js.svg?branch=develop)](https://travis-ci.org/gnosis/dex-js)
 
[![Coverage Status](https://coveralls.io/repos/github/gnosis/dex-js/badge.svg?branch=master)](https://coveralls.io/github/gnosis/dex-js?branch=master)

Develop:
 
[![Build Status](https://travis-ci.org/gnosis/dex-js.svg?branch=develop)](https://travis-ci.org/gnosis/dex-js)
 
[![Coverage Status](https://coveralls.io/repos/github/gnosis/dex-js/badge.svg?branch=develop)](https://coveralls.io/github/gnosis/dex-js?branch=develop)

# Gnosis Protocol JS

Gnosis Protocol JS it's library, with typescript support for [Gnosis Protocol](https://docs.gnosis.io/protocol).

Gnosis Protocol introduces a new, fully decentralized exchange mechanism for ERC20 tokens with the following
properties:

- Batch auctions
- Multidimensional order books with ring trades
- Uniform clearing prices in every batch

This library provides:

- Typescrypt version of the contracts of Gnosis Protocol
- Some handy utils and constants

## Usage

```bash
# Using yarn
yarn add @gnosis.pm/dex-js --save

#Alternatively
npm install @gnosis.pm/dex-js --save
```

Import the contract:

```js
import { BatchExchangeContract } from ' @gnosis.pm/dex-js'

// Instanciate the smart contract
const web3 = new Web3()
const batchExchangeContract = new BatchExchangeContract({ web3 })

// Alternativelly provide the address
const batchExchangeContract = new BatchExchangeContract({ web3, address: '0x89593E017D4A88c60347257DAfB95384a422da09' })
```

# Issues

If you find any issue, or you want to request a feature use [https://github.com/gnosis/dex-js/issues]()

[Pull requests](https://github.com/gnosis/dex-js/pulls) are welcomed and are the best way to suggest new features.

# Collaborate

## Build

```bash
# Install dependencies
yarn install

# Build
yarn build

# Build and watch (useful when using "npm link")
yarn build:watch
```

## Run test

```bash
# Install dependencies
yarn install

# Run
yarn test
```

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