@gnosis.pm/dex-js
TypeScript icon, indicating that this package has built-in type declarations

0.14.0 • Public • Published

npm version   Build Status   Coverage Status

Develop:   Build Status   Coverage Status

Gnosis Protocol JS

Gnosis Protocol JS it's library, with typescript support for Gnosis 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

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

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

Import the contract:

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 are welcomed and are the best way to suggest new features.

Collaborate

Build

# Install dependencies
yarn install

# Build
yarn build

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

Run test

# Install dependencies
yarn install

# Run
yarn test

Readme

Keywords

none

Package Sidebar

Install

npm i @gnosis.pm/dex-js

Weekly Downloads

180

Version

0.14.0

License

MIT

Unpacked Size

252 kB

Total Files

197

Last publish

Collaborators

  • alfetopito
  • anxolin
  • bh2smith
  • fleupold
  • josojo
  • nlordell
  • w3stside
  • fedgiac
  • gnosisdex