Joseph-Cardwell/depay-decentralized-exchanges

💱 JavaScript library containing abstractions and aggregated information for decentralized exhanges.

Quickstart

yarn add depay-decentralized-exchanges

or

npm install --save depay-decentralized-exchanges

import { DEX } from 'depay-decentralized-exchanges'

DEX.all
// [
//   { name: 'uniswap_v3', label: 'Uniswap v3', logo: '...' }
//   { name: 'pancakeswap_v2', label: 'PancakeSwap v2', logo: '...' }
//   ...
// ]

DEX.findByName('uniswap_v3')
// { name: 'uniswap_v3', label: 'Uniswap v3', logo: '...' }

Support

This library supports the following decentralized exchanges:

• Uniswap v3
• Uniswap v2
• PancakeSwap v2
• SushiSwap
• Curve

Data Structure

Decentralized exchange data is provided in the following structure:

{
  name: String,
  alternativeNames: Array,
  label: String,
  logo: String (base64 encoded PNG)
}

Functionalities

all: Retreive all information for all blockchains

import { DEX } from 'depay-decentralized-exchanges'

DEX.all
// [
//   { name: 'uniswap_v3', label: 'Uniswap v3', logo: '...' }
//   { name: 'pancakeswap_v2', label: 'PancakeSwap v2', logo: '...' }
//   ...
// ]

findByName: Get decentralized exchanged by name (name usually contains version, too)

import { DEX } from 'depay-decentralized-exchanges'

DEX.findByName('uniswap_v3')
// { name: 'uniswap_v3', label: 'Uniswap v3', logo: '...' }

DEX.findByName('pancakeswap_v2')
// { name: 'pancakeswap_v2', label: 'PancakeSwap v2', logo: '...' }

Development

Get started

yarn install
yarn start

Release

npm publish