swaprhq / swapr-sdk Goto Github PK

View Code? Open in Web Editor NEW

8.0 3.0 12.0 6.47 MB

🛠 An SDK for building applications on top of Swapr.

Home Page: https://swapr.eth.limo/

License: GNU Affero General Public License v3.0

TypeScript 99.95% JavaScript 0.05%

defi dxdao swapr

swapr-sdk's Introduction

Swapr SDK

Getting Started

First clone the repository:

git clone https://github.com/levelkdev/swapr-sdk.git

Move into the dxswap-sdk working directory

cd swapr-sdk

Install dependencies

yarn install

Generate GraphQL

yarn codegen

Build

yarn build

Connect package an app to sdk locally

yarn link

And on the app repo

yarn link "../swapr-sdk/" #e.g. path to sdk

Running tests

To run the tests, follow these steps. You must have at least node v16 installed.

Run tests

yarn test

Eco Router Trades

Swapr uses multiple trades to find best protocol and route for traders. Currently supported DEXs are

Protocol	Ethereum	Arbitrum One	Gnosis Chain	Polygon	BNB Chain	Optimism	ZkSync Era
0x	✅	✅	❌	✅	✅	✅	❌
1Inch	✅	✅	✅	✅	✅	✅	✅
Baoswap	❌	❌	✅	❌	❌	❌	❌
BiSwap	❌	❌	❌	❌	✅	❌	❌
CoW Protocol	✅	❌	✅	❌	❌	❌	❌
Curve	✅	✅	✅	❌	❌	❌	❌
DFYN	❌	❌	❌	✅	❌	❌	❌
Honeyswap	❌	❌	✅	❌	❌	❌	❌
Levinswap	❌	❌	✅	❌	❌	❌	❌
Pancakeswap	❌	❌	❌	❌	✅	❌	❌
Quickswap	❌	❌	❌	✅	❌	❌	❌
SushiSwap	✅	✅	✅	✅	✅	❌	❌
Swapr	✅	✅	✅	❌	❌	❌	❌
Uniswap v2	✅	✅	✅	✅	❌	✅	❌
Velodrome	❌	❌	❌	❌	❌	✅	❌

The Trade class is extendable. New DEXs can be added to the SDK by extending the Trade and adding required methods.

How To Add Routable Platforms

For UniV2 Forks

First, open the file UniswapV2RoutablePlatform.ts. Here, you'll find several examples of already integrated DEXs.

Next, you need to search for the following information about the platform you want to integrate:

Supported chains by the DEX.
Factory Address: You can find it in the protocol docs.
Router Address: You can find it in the protocol docs.
Init Code Hash: Looking at the Factory Address in a blockchain explorer, you can go to the Contract tab > Read Contract > INIT_CODE_HASH.
Default Swap Fee: You may find it in the protocol official docs or in the Factory Address code.
Subgraph Endpoint (optional).

Once you have this information, you can create an instance of UniswapV2RoutablePlatform for the DEX you're trying to integrate and then consume it from the file entities/pair.ts so you can add it to the PAIR_ADDRESS_CACHE.

swapr-sdk's People

Contributors

Stargazers

Watchers

Forkers

luzzif ether-dex 0xvenky mi-lan bunsdev fortressdex wonderlyfi satelitestudio corantin syntax-byte-solution bitbeen rodsouto

swapr-sdk's Issues

Add UniswapV3Trade class

Add `approveAddress` to `Trade`

Deprecate Rinkeby and add Göerli

Deprecate Rinkeby in the next release, and add Göerli (chain ID: 5)

Checksum token addresses

Add approve address to Uniswapv2Trade

So we can dry up code in front-end and not do this

Add support for xDAI in Curve trade

Curve does not support the native xDAI token on Gnosis Chain. It only works with ERC20 stable tokens: WXDAI, USDC, and USDT.

Curve Trade can return a quote for trading XDAI to/from USDC and USDT.
A multicall interceptor should wrap the XDAI before sending it to the Curve 3CRV pool.

Update CoW `appData` to latest schema

From Felix:

Actually, we recently changed the format slightly (the bottom level "referrer" is now called "address"). Updated schema is here: https://github.com/cowprotocol/cow-sdk/blob/e086d9edeb24b25bb873a11c462019fa1ea4c021/README.md#create-a-meta-data-document-for-attaching-to-an-order and there is now even SDK functionality to create and upload the correct document

Native currency support for `CoWTrade`

If I try to swap from XDAI to USDC or USDT I don't get COW swap as an option in the exchange list
and when I try from USDC to 1INCH I get this error message.

Swapr.28.07_01.mp4

Originally posted by @MilanVojnovic95 in SwaprHQ/swapr-dapp#1280 (comment)

Fix Uniswap support on Polygon

Uniswap underlying Ether implementation does not support MATIC. The solution is creating another NativeCurrecny called MaticNativeCurrency. This is what Uniswap interfaces use internally.

UniswapTrade supports Polygon's Matic.

Add Görli testnet contracts config

Compute Uniswap v2 common pairs from The Graph

common pairs list is a collection of pairs that could link currencyA to currencyB. For instance, I trade from WETH to CRV. A possible trade route would be:

WETH > WETH-USDC > USDC-CRV > CRV

WETH-USDC and USDC-CRV are the common pairs between WETH and CRV. This is list is computed in the SDK by assuming that every token will have a pool of the token and a stablecoin or the native token of the given chain. For example, CRV will likely to have a pair of CRV-WETH and CRV-USDC. This approach discriminates against less known tokens by skipping potential pairs that would be more liquid and given better rates.

The solution is to utilize The Graph and find these pairs by running such query with the following conditions:

where token0 = tokenA OR token1 = tokenA OR token0 = tokenB OR token1 = tokenB

This yields all the pairs that have either currencyA or currencyB. The above query can include reserves, which leads to a slight gain in performance.

The common pairs list is computed from the subgraph. If the subgraph query fails due to network, default to the current SDK implementation.

Add factory pools to Curve

Description

Curve v2 has a factory contract to deploy new Curve pools.

Acceptance Criteria

CurveTrade can find and get quotes from Curve v2 pools

Curve Router not going through ETH pools

Description
When users tries to route through eth/seth, eth/steth, reth/eth etc...Router doesn't pick them up

Definition of done

All eth pools mentioned should return a quote from curve since they are liquid and existing
Swapr
Curve

Add GNO to base tokens on Gnosis Chain

Send back quote ID to CoW API order endpoint

Every CoW quote has an ID. By sending back the quote ID, the API can reference it again. This shall fix InsufficientFee.

Upgrade to Multicall3

Currently, the SDK uses Multicall2. Upgrade to Multicall3 and add a factory function.

Remove JSBI in favor of BigNumber

Jumping between JSBI and BigNumber/parseUnits from ethers.js is not ideal.

JSBI is replaced with BigNumber instance and parseUnit/formatUnits

Wrong `approveAddress` is used in CoWTrade

The correct address the GPv2VaultRelayer

Add Optimism

Consult the docs

https://community.optimism.io/docs/useful-tools/networks/#optimism-mainnet

Acceptance Criteria

ChainId has Optimism Mainnet and optimism Göerli

Update core modules: `Currency` and `CurrencyAmount`

Update these modules according to what Uniswap core package standards.

`getAllCommonUniswapV2Pairs` does not return pairs for standard Uniswap V2 platforms

Description

getAllCommonUniswapV2Pairs works only for Swapr because swapFee property is not available on the standard UniswapV2Pair contract. Here's the snippet of where it breaks:

https://github.com/levelkdev/swapr-sdk/blob/4f7229330e91c126bd4757378f85f1099df6257f/src/entities/trades/uniswap-v2/pairs/pairs.ts#L90-L97

Add COW app data

Add wrapper for the Balancer

Create a wrapper for the balancer project.

`Pair` class bug with default parameters

The Pair constructor parameter uses Swapr as the default platform:

https://github.com/levelkdev/swapr-sdk/blob/dae13a9fcd8aa7a6a05edaa298ce21e44ae64c74/src/entities/pair.ts#L114-L134

Pair.getOutputAmount and Pair.getInputAmount do not pass the same platform back to the construct when calling creating new Pair instances

https://github.com/levelkdev/swapr-sdk/blob/dae13a9fcd8aa7a6a05edaa298ce21e44ae64c74/src/entities/pair.ts#L205-L231

https://github.com/levelkdev/swapr-sdk/blob/dae13a9fcd8aa7a6a05edaa298ce21e44ae64c74/src/entities/pair.ts#L233-L263

When the wrong platform (Swapr for example on Polygon) is used, the Pair.getAddress throws an unsupported platform error:

https://github.com/levelkdev/swapr-sdk/blob/dae13a9fcd8aa7a6a05edaa298ce21e44ae64c74/src/entities/pair.ts#L84-L92

The fix is to pass back the instance platform property in Pair.getOutputAmount and Pair.getInputAmount.

This logic error affects any EVM chain where Swapr is not supported and potentially leads to calculating the wrong UniswapV2Pair address using keccak256 method.

Pair.getOutputAmount and Pair.getInputAmount pass back the current instance's platform.
Platforms, where Swapr is not deployed, should return a trade list.