https://github.com/cowprotocol/cow-js

https://github.com/cowprotocol/cow-js

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/cowprotocol/cow-js
• Owner: cowprotocol
• License: mit
• Created: 2022-03-31T20:27:00.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-01T02:19:55.000Z (over 2 years ago)
• Last Synced: 2025-06-01T17:03:31.653Z (about 1 year ago)
• Language: TypeScript
• Size: 2.4 MB
• Stars: 1
• Watchers: 6
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![npm version](https://img.shields.io/npm/v/@cowprotocol/cow-js.svg?style=flat)](https://npmjs.org/package/@cowprotocol/cow-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 @cowprotocol/cow-js --save

#Alternatively

npm install @cowprotocol/cow-js --save

```

## Usage

```bash

# Using yarn

yarn add @cowprotocol/cow-js --save

#Alternatively

npm install @cowprotocol/cow-js --save

```

# 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

```